Content Server Opentext

OpenText™ Content Server
Admin Online Help Collection
This document is a collection of the OpenText Content Server

Admin online help (core installation). Optional module help
pages are not included in this document.
Important: The order of some topics in this document may vary
from the order in which they appear in the product help system.
In case of any inconsistencies or contradictions, please refer to
the online help available from the Content Server user interface
for clarification.
LLESCOR160000-H-AGD-EN
OpenText™ Content Server
Admin Online Help Collection
Rev.: 2016-Apr-03
This documentation has been created for software version 16.0.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.
Open Text SA
40 Avenue Monterey , Luxembourg, Luxembourg L-2163
Tel: 35 2 264566 1
Open Text Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: http://support.opentext.com
For more information, visit https://www.opentext.com
Copyright © 2016 Open Text SA or Open Text ULC (in Canada). All Rights Reserved.
Trademarks owned by Open Text SA or Open Text ULC (in Canada).
Disclaimer
No Warranties and Limitation of Liability
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
Part 1 Getting Started 15
1 Accessing the Content Server Administration Page ........... 17

1.1 Understanding the Administration Page ............................................ 17
2 Administering Permissions .................................................... 21

2.1 Setting User Tab Permissions .......................................................... 21
2.2 Choosing Types of Permissions ....................................................... 22
2.3 Understanding Document Management Permissions ......................... 22
2.4 Understanding Role-Based Permissions ........................................... 24
2.5 Copying, Mapping, and Deferring To Permissions ............................. 25
2.6 Applying Permissions to Subitems .................................................... 25
2.7 Strategies for Administering Permissions .......................................... 26
Part 2 Server Configuration 29
3 Configuring General Environment Settings .......................... 31

3.1 Editing the Enterprise Menu ............................................................. 31
3.2 Setting Date and Time Formats ........................................................ 32
3.3 Configuring the Functions Menu ....................................................... 34
3.4 Configuring Presentation Settings .................................................... 35
3.5 Configuring System Messages ......................................................... 47
3.6 Customizing the User Interface with Appearances ............................. 48
4 Configuring and Customizing Faceted Browsing ................ 49

4.1 Configuring Faceted Browsing ......................................................... 49
4.2 Working with the Facets Volume ...................................................... 53
4.3 Working With the Facets Volume Control Panel ................................ 67
5 Configuring Virtual Folders .................................................... 69

5.1 To Assign Users Permissions to Create Virtual Folders ..................... 69
6 Configuring Server Parameters and Settings ....................... 71

6.1 Configuring Basic Server Parameters ............................................... 71
6.2 Configuring Performance Settings .................................................... 75
6.3 Configuring Security Parameters ...................................................... 77
6.4 Specifying the Server Port Number .................................................. 85
6.5 Limiting Admin Account Log-ins by IP Address .................................. 85
6.6 Configuring SLD Registration ........................................................... 86
6.7 Generating a System Report ............................................................ 87
6.8 Modifying System Configuration Files ............................................... 88
OpenText Content Server – Admin Online Help Collection iii

Table of Contents
7 Understanding the opentext.ini File ...................................... 91

7.1 Modifying the opentext.ini File .......................................................... 91
7.2 Node Type Number to Name Mappings ............................................ 92
7.3 Opentext.ini File Settings Reference ................................................. 95
8 Administering MIME Types and Icons ................................. 221

8.1 Modifying the MIME Types List ...................................................... 221
8.2 Modifying Icon-to-MIME type Mappings .......................................... 223
8.3 Associating MIME Types and Categories ........................................ 225
9 Managing the Servers in Content Server ............................ 227

9.1 Stopping and Starting the Servers .................................................. 227
9.2 Backing Up and Restoring Content Server ...................................... 230
9.3 Renaming a Content Server Host Computer ................................... 231
10 Managing Licenses in Content Server ................................ 233

10.1 Licenses in Content Server ............................................................ 233
10.2 Managing Content Server Licenses ................................................ 235
Part 3 System Administration 239
11 Managing UI Languages ....................................................... 241

11.1 Creating, Installing and Upgrading Language Packs ........................ 241
11.2 Configuring Languages ................................................................. 245
12 Working with Multilingual Metadata .................................... 247

12.1 Configuring Multilingual Metadata .................................................. 247
13 Working with Memcache ....................................................... 249

13.1 To View the Memcached Processes ............................................... 249
13.2 To View the Memcached Statistics ................................................. 249
13.3 To View or Change the Properties of a Memcached Process ........... 249
13.4 To Start or Stop a Memcached Process .......................................... 250
13.5 To Add a Memcached Process ...................................................... 250
14 Configuring Rendering Settings .......................................... 251

14.1 To Configure Rendering Settings ................................................... 251
15 Working with the Distributed Agent .................................... 253

15.1 Managing the Distributed Agent and Workers ................................. 253
15.2 Managing Distributed Agent Workers ............................................. 258
Part 4 Database Administration 261
16 Changing Your Content Server Database ........................... 263
iv OpenText Content Server – Admin Online Help Collection

Table of Contents
16.1 Deselecting Your Current Database ............................................... 264

16.2 Adding and Connecting to a new Content Server Database ............. 265
16.3 Connecting to an Existing Database ............................................... 275
16.4 Configuring Content Server After Changing Your Database ............. 282
17 Maintaining an Existing Database ....................................... 283

17.1 Viewing Content Server Tables ...................................................... 283
17.2 Viewing Tablespace Usage (Oracle) ............................................... 283
17.3 Performing Database Maintenance Tasks ....................................... 284
17.4 Purging Deleted Data (Oracle) ....................................................... 291
17.5 Upgrading the Database ................................................................ 292
17.6 Verifying the Database .................................................................. 293
17.7 Testing or Repairing Known Database Issues ................................. 297
17.8 Changing the Password of the Content Server Database User ......... 299
18 Administering Blob Deletion Failures ................................. 301

18.1 To Monitor Blob Deletion Failures .................................................. 302
18.2 To Configure the Provider Blob Deletion Failure Retry Agent ........... 302
19 Administering Event Auditing .............................................. 303

19.1 Managing Audit Interests ............................................................... 303
19.2 Managing Audit Records ............................................................... 315
19.3 Managing Audit Security Settings ................................................... 319
20 Administering Item Control .................................................. 323

20.1 To Configure Item Control Parameters ........................................... 323
21 Administering Modified Date Trigger .................................. 325

21.1 To Set Modification Date Restrictions ............................................. 325
22 Administering Object and Usage Privileges ....................... 327

22.1 Object Privileges ........................................................................... 327
22.2 Usage Privileges ........................................................................... 328
23 Configuring Access Control ................................................. 345

23.1 To Configure Access Control ......................................................... 346
24 Working with Copy and Delete Item Operations ................ 347

24.1 Configuring the Status Page for Multi-Select Actions ....................... 347
24.2 Configuring the Operations for Copy, Delete and Move .................... 347
Part 5 Item Administration 349
25 Storage Providers and Storage Management ..................... 351

25.1 Managing Internal and External Storage ......................................... 351
25.2 Configuring Storage Providers ....................................................... 352
OpenText Content Server – Admin Online Help Collection v

Table of Contents
25.3 Configuring Storage Rules ............................................................. 355
26 Recycle Bin Administration .................................................. 371

26.1 The Recycle Bin Manager Usage Privilege ..................................... 371
26.2 Restoring and Purging Deleted Items ............................................. 372
26.3 Configuring Recycle Bin ................................................................ 374
Part 6 Module Administration 377
27 Administering Modules ......................................................... 379

27.1 Installing Modules ......................................................................... 379
27.2 Uninstalling Modules ..................................................................... 381
27.3 Upgrading Modules ....................................................................... 384
27.4 Updating the User and Admin Online Help ...................................... 386
Part 7 User Setting Administration 389
28 Administering Users and Groups ........................................ 391

28.1 Configuring User Settings .............................................................. 391
28.2 Administering Users ...................................................................... 392
28.3 Administering Groups .................................................................... 394
28.4 Configuring Department Selection .................................................. 395
29 Administering Domains ........................................................ 397

29.1 Working with Domains ................................................................... 397
29.2 Configuring Search for Domains ..................................................... 401
Part 8 Search and Collaboration Administration 403
30 Administering Search ........................................................... 405

30.1 Creating Indexes Using Templates ................................................. 405
30.2 Creating Index Components Individually ......................................... 433
30.3 Setting Up High-Volume Indexing ................................................... 457
30.4 Administering Data Flows .............................................................. 465
30.5 Configuring Data Flow Processes .................................................. 481
30.6 Configuring Indexing Processes ..................................................... 587
30.7 Administering Partitions ................................................................. 597
30.8 Administering Control Rules ........................................................... 609
30.9 Maintaining Indexes ...................................................................... 622
30.10 Backing Up and Restoring Indexes ................................................. 647
30.11 Administering Searching ................................................................ 661
30.12 Administering Thesauruses ............................................................ 740
30.13 Configuring Security Settings for Searching and Indexing ................ 746
30.14 Content Server Error Messages ..................................................... 748
vi OpenText Content Server – Admin Online Help Collection

Table of Contents
31 Administering Prospectors .................................................. 793

31.1 Adding Prospectors Importer Processes ......................................... 793
31.2 Maintaining Prospectors ................................................................ 795
32 Administering Recommender .............................................. 797

32.1 Configuring Recommender Components ........................................ 797
32.2 Configuring Recommender System Settings ................................... 801
32.3 Customizing Recommender ........................................................... 803
32.4 Adding Rating Images ................................................................... 805
32.5 Exporting Recommendation Data to XML ....................................... 806
32.6 Exporting Rating Data to XML ........................................................ 813
33 Administering eLink .............................................................. 821

33.1 Administering eLink General and Advanced Settings ....................... 821
33.2 Testing the eLink Connection ......................................................... 826
33.3 Administering eLink Global Workflow Settings ................................. 827
33.4 Using eLink LiveReports ................................................................ 828
34 Working with Notifications ................................................... 831

34.1 Enabling and Disabling Notifications ............................................... 831
34.2 Clearing Outstanding Events .......................................................... 832
34.3 Configuring Notifications ................................................................ 832
34.4 Configuring Scheduled Activities .................................................... 837
34.5 Testing Email to Deliver Notifications .............................................. 842
34.6 Viewing Scheduling Statistics ......................................................... 844
35 Administering Pulse .............................................................. 845

35.1 Configuring Pulse Settings ............................................................. 845
35.2 Configuring the Activity Feeds ........................................................ 849
36 Configuring Collaboration Settings ..................................... 857

36.1 Configuring System-level Collaboration Features ............................ 859
36.2 Configuring Object-level Collaboration Features .............................. 863
37 Content Server Collaboration Widget Configuration ......... 869

37.1 Activity Feed Widget Configuration ................................................. 869
Part 9 Document Administration 873
38 Working with Item Templates ............................................... 875

38.1 Creating Templates ....................................................................... 875
38.2 Exporting Item Templates .............................................................. 877
39 Configuring Web Edit Settings ............................................. 879

39.1 To Configure Web Edit Settings ..................................................... 881
OpenText Content Server – Admin Online Help Collection vii

Table of Contents
40 Administering and Configuring Renditions ........................ 885

40.1 Administering Renditions ............................................................... 887
40.2 Adding or Editing a Rendition Folder .............................................. 889
40.3 Adding or Editing a Version Folder ................................................. 891
40.4 Viewing and Purging the Rendition Log .......................................... 892
40.5 Viewing the Selective Rendition Report .......................................... 893
41 Administering Collections .................................................... 895

41.1 Enabling Collections Options ......................................................... 895
41.2 Configuring the Make Disk Image Option ........................................ 901
41.3 Purging Audit Records for Collected Items ...................................... 904
42 Administering the Multi-File Output Module ....................... 905

42.1 Working with General Settings ....................................................... 906
43 Administering OpenText™ WebDAV ................................... 907

43.1 Configuring a Web Server .............................................................. 907
43.2 Configuring WebDAV Access ......................................................... 911
43.3 Configuring WebDAV Client Launchers .......................................... 913
43.4 Configuring WebDAV Version Management .................................... 913
43.5 Configuring Host Translation .......................................................... 914
43.6 Specifying a Weblink Coserver Port ................................................ 915
43.7 Specifying a Logging Level ............................................................ 915
43.8 Configuring WebDAV Authentication .............................................. 916
Part 10 Node Attribute and Categories Administration 925
44 Administering Additional Node Attributes .......................... 927

44.1 Managing Node Attributes ............................................................. 928
44.2 Managing Attribute Settings ........................................................... 930
45 Working with the Categories Volume .................................. 933

45.1 Managing Categories .................................................................... 933
Part 11 Server Clusters Administration 937
46 OpenText Content Server Cluster Management ................. 939

46.1 Using Cluster Audit History ............................................................ 940
46.2 Managing Cluster Agents ............................................................... 941
46.3 Managing Cluster Settings ............................................................. 944
46.4 Applying Patches, Updates, and Language Packs ........................... 947
46.5 Analyzing Updates ........................................................................ 958
46.6 Rolling Back a Deployment Manually .............................................. 959
46.7 Editing the Cluster Management config.ini File ................................ 961
viii OpenText Content Server – Admin Online Help Collection

Table of Contents
Part 12 Reports Administration 971
47 Administering LiveReports ................................................... 973

47.1 Running LiveReports ..................................................................... 973
47.2 Importing and Exporting LiveReports .............................................. 974
47.3 Understanding Privileges and Permissions for LiveReports .............. 975
47.4 Configuring LiveReports Security ................................................... 979
47.5 Configuring LiveReports in the opentext.ini File ............................... 980
48 Administering WebReports .................................................. 981

48.1 Restricting Access to WebReports ................................................. 982
48.2 Using the WebReports Administration Section ................................ 982
48.3 Content Server Functions Available for WebReports ..................... 1000
49 Administering Content Server Applications ..................... 1015

49.1 Applications Management ............................................................ 1015
49.2 Applications Management Configuration ....................................... 1028
49.3 Applications Volume .................................................................... 1029
50 Content Server WebReports Widget Configuration ......... 1031

50.1 Configuring the Nodes List WebReport Widget .............................. 1031
50.2 Configuring the HTML WebReport Widget .................................... 1033
Part 13 Workflow and Forms Administration 1037
51 Administering Workflows ................................................... 1039

51.1 Administering Workflow User Settings .......................................... 1039
51.2 Administering Workflow Agent Parameters ................................... 1041
51.3 Administering Access to the Workflow Volume .............................. 1043
51.4 Administer Access to the Workflow Agent and Item Handler Step ... 1044
52 Planning Forms Usage ........................................................ 1047

52.1 Administering Creation Privileges ................................................. 1047
52.2 Administering Usage Privileges .................................................... 1048
53 Administering Web Forms .................................................. 1051

53.1 Managing Secure Database Connections ..................................... 1051
53.2 Managing Secure Database Lookups ........................................... 1053
53.3 Adding JavaScript File to All Templates Exported as HTML ........... 1055
53.4 Database Connection Information from Previous Releases ............ 1056
Part 14 Enterprise Connect Administration 1057
54 Configuring OpenText Enterprise Connect Advanced

Settings ................................................................................ 1059
OpenText Content Server – Admin Online Help Collection ix

Table of Contents
54.1 Configuring Double-click Actions for Microsoft Office Documents ... 1059
54.2 Configuring Double-click Actions for Compound Emails ................. 1060
54.3 Making Enterprise Connect Accessible from the Content Server
Web Interface ............................................................................. 1061
54.4 Controlling the Name of Content Server Shortcuts Created by
Dragging .................................................................................... 1063
54.5 Configuring Content Capture Options ........................................... 1064
54.6 Specifying Link Paths .................................................................. 1065
54.7 Configuring Object Types When Dragging Folders ........................ 1066
54.8 Mapping Custom Subtypes to File Extensions ............................... 1067
55 Configuring OpenText Enterprise Connect Browse View

Columns Settings ................................................................ 1069
55.1 Configuring Column Displays ....................................................... 1069
56 Configuring Enterprise Connect Display Settings ........... 1071

56.1 Configuring the Enterprise Connect Tree Structure and List Pane .. 1071
56.2 Selecting a Viewer for the Reading Pane ...................................... 1073
56.3 Displaying Hidden Items in Enterprise Connect ............................. 1073
57 Configuring Enterprise Connect Email Settings .............. 1075

57.1 Configuring Email Archiving ......................................................... 1075
57.2 Configuring Settings for Capturing Email Attachments, Duplicate
Emails, and Email Subtypes ........................................................ 1077
57.3 Specifying a Format for IBM Notes Emails .................................... 1080
57.4 Defining Email Naming Conventions ............................................. 1081
57.5 Handling Email Attachments With the Same Name ....................... 1087
58 Configuring OpenText Enterprise Connect Menu Settings 1089

58.1 Configuring Enterprise Connect Context Menu Items ..................... 1089
58.2 Configuring the Advanced Context Menu ...................................... 1090
58.3 Configuring Context Menu Actions ............................................... 1092
58.4 Launching Context Menu Commands in a Full Browser ................. 1094
58.5 Specifying Which Subtypes Can Be Taken Offline ......................... 1096
58.6 Specifying Which Subtypes Can Be Sent to the Desktop ............... 1097
58.7 Configuring the Copy/Move Command ......................................... 1098
59 Configuring OpenText Enterprise Connect Search

Settings ................................................................................ 1101
59.1 Configuring Search Profiles ......................................................... 1101
59.2 Specifying the Number of Search Results on Each Page ............... 1104
59.3 Enabling Searching for Shortcuts and Cross-References ............... 1105
59.4 Specifying the Default Advanced Search Location ......................... 1106
x OpenText Content Server – Admin Online Help Collection

Table of Contents
60 Configuring OpenText Enterprise Connect System

Settings ................................................................................ 1107
60.1 Supporting Previous Versions of Enterprise Connect Framework ... 1107
60.2 Configuring Version Management Settings ................................... 1108
60.3 Configuring Storage of Enterprise Connect Credentials ................. 1109
60.4 Accessing Administrative Pages for External Modules ................... 1110
61 Administering the CAP Connector Module ....................... 1111

61.1 To Configure the Web Service Connection .................................... 1111
61.2 To Map the User ID ..................................................................... 1112
Part 15 Enterprise Archive Administration 1113
62 Working with Archive Storage Provider ............................ 1115

62.1 Configuring Archive Storage Provider ........................................... 1115
63 Archive Storage Provider logging settings ....................... 1117
64 Understanding Content Move ............................................ 1119
65 Configuring Content Move ................................................. 1121

65.1 Configuring move jobs ................................................................. 1121
65.2 Configuring storage provider rules ................................................ 1133
65.3 Configuring customer-specific settings in the opentext.ini file ......... 1136
65.4 Configuring auditing for Content Move .......................................... 1137
Part 16 Object Importer Administration 1139
66 Configuring Object Importer .............................................. 1141

66.1 To Configure Object Importer ....................................................... 1146
66.2 To View Import Status Information ................................................ 1148
66.3 To Manually Import a Document ................................................... 1148
66.4 To Configure or Disable Import Schedules .................................... 1150
66.5 To Validate an Import Control File ................................................ 1150
66.6 To View or Delete Log Files ......................................................... 1151
67 Object Importer Best Practices .......................................... 1153
68 Working with Object Importer Control Files ..................... 1157
69 Object Importer Control File Syntax .................................. 1163

69.1 node Control File Syntax ............................................................. 1163
69.2 alias Control File Syntax .............................................................. 1165
69.3 compounddoc Control File Syntax ................................................ 1166
69.4 customview Control File Syntax ................................................... 1167
OpenText Content Server – Admin Online Help Collection xi

Table of Contents
69.5 discussion Control File Syntax ..................................................... 1168

69.6 document Control File Syntax ...................................................... 1168
69.7 folder Control File Syntax ............................................................. 1173
69.8 project Control File Syntax ........................................................... 1174
69.9 reply Control File Syntax .............................................................. 1181
69.10 task Control File Syntax ............................................................... 1182
69.11 taskgroup Control File Syntax ...................................................... 1187
69.12 tasklist Control File Syntax ........................................................... 1188
69.13 taskmilestone Control File Syntax ................................................ 1189
69.14 topic Control File Syntax .............................................................. 1191
69.15 url Control File Syntax ................................................................. 1192
70 Object Importer Tag Descriptions and Syntax ................. 1195

70.1 acl Tag Control File Syntax .......................................................... 1195
70.2 category Tag Control File Syntax ................................................. 1199
70.3 createby / createdby Tags Control File Syntax .............................. 1203
70.4 created Tag Control File Syntax ................................................... 1204
70.5 description Tag Control File Syntax .............................................. 1205
70.6 location Tag Control File Syntax ................................................... 1207
70.7 modified Tag Control File Syntax .................................................. 1209
70.8 nickname Tag Control File Syntax ................................................ 1210
70.9 owner Tag Control File Syntax ..................................................... 1210
70.10 ownergroup Tag Control File Syntax ............................................. 1211
70.11 title Tag Control File Syntax ......................................................... 1212
71 Object Importer Import Control File Examples ................. 1215

71.1 acl Import Control File Examples .................................................. 1216
71.2 alias Import Control File Examples ............................................... 1217
71.3 compounddoc Import Control File Examples ................................. 1218
71.4 description Import Control File Examples ...................................... 1219
71.5 document Import Control File Examples ....................................... 1221
71.6 folder Import Control File Examples .............................................. 1224
71.7 project Import Control File Examples ............................................ 1227
71.8 task Import Control File Examples ................................................ 1229
71.9 title Import Control File Examples ................................................. 1230
71.10 url Import Control File Examples .................................................. 1231
Part 17 Directory Services Administration 1233
72 Configuring Directory Services Integration ...................... 1235

72.1 Configuring Directory Services ..................................................... 1235
72.2 Configuring Integration Settings ................................................... 1236
xii OpenText Content Server – Admin Online Help Collection

Table of Contents
Part 18 ActiveView Administration 1243
73 Important ActiveView Development Information .............. 1245
74 Template Upgrades ............................................................. 1247
75 Administering ActiveView Login Users ............................. 1249
76 Allowing AVID In URL ......................................................... 1251
77 Managing ActiveView Templates and Override Types .... 1253

77.1 Enabling or Disabling an Override Component .............................. 1253
78 Managing ActiveView Overrides ........................................ 1255

78.1 Converting ActiveView Overrides that use Appearance .................. 1255
78.2 Enabling or Disabling ActiveView Override Types .......................... 1256
78.3 Enabling or Disabling ActiveView Templates ................................. 1257
78.4 Viewing All Local and Global ActiveView Overrides ....................... 1257
78.5 Managing Global ActiveView Overrides ........................................ 1258
79 Managing Perspectives ....................................................... 1265

79.1 Working in the Perspectives Volume ............................................ 1265
79.2 Creating a Global Perspective ...................................................... 1265
79.3 Viewing All Local and Global Perspectives .................................... 1267
79.4 Using the Perspective Manager Tool ............................................ 1268
Part 19 Transport Administration 1269
80 Configuring Transport Warehouse Settings ..................... 1271

80.1 To Configure Warehouse Settings ................................................ 1272
80.2 To Designate a Warehouse Manager ........................................... 1272
80.3 To Provide Users Access to the Transport Warehouse .................. 1273
80.4 To Restrict User Access to Transport Objects ............................... 1273
OpenText Content Server – Admin Online Help Collection xiii

Part 1
Getting Started
Chapter 1
Accessing the Content Server Administration Page
The Content Server Administration pages have their own, separate online help
content. The online help can help you accomplish and understand most of the
routine system administration tasks required to maintain Content Server.
Like the Administration pages themselves, the Admin help is not accessible by end
users. To access the Content Server Administration page, you must use the special
administration URL and password.
1.1 Understanding the Administration Page

The Administration page is the starting point for most system-administration tasks
that you perform. This page contains sections with links to other administrative
pages. If you install optional modules, links to the module administration pages
appear in a new section of the Administration page.
The Administration page is not accessible from the standard user interface. To access
the Administration page, users who have system administration privileges must use
a specific URL and password. For added security, you can limit access to the
Administration page to a list of approved IP addresses. For more information, see
“Limiting Admin Account Log-ins by IP Address” on page 85.
The Admin user is a user account created specifically for the Content Server
Administrator. The Content Server Administrator is also referred to in the help as
the administrator. It is the only user permitted to perform certain administrative
tasks. In addition, the administrator has a bypass privilege that automatically grants
full permissions to all items and locations in Content Server without permissions
verification.
Important
It is important to note that the system administration password is not the
same as the password for the admin user account. In certain cases, some
Administration pages, such as pages that permit you to manipulate the
system's data, will prompt you to log in as the administrator to gain access.
You log in as administrator the same way as for any other user.
You can choose to display the items on the Administration page in a single list view,
organized by heading, or in a tabbed view.
Changing the Administrator Password and the Admin User

Password
As previously noted, the administrator and the Admin user have separate accounts
and, therefore, separate settings and passwords. New in Content Server version 16,
OpenText Content Server – Admin Online Help Collection 17

Chapter 1 Accessing the Content Server Administration Page
the Admin user can change their password in the Directory Services web
administration page as well as in Content Server.
• To change the system administrator password, see the Content Server
Administrator Password section in “Configuring Basic Server Parameters”
on page 71.
• The Admin user can change their password in Content Server, which will update
the Content Server database, and they can change their password through
Directory Services, which will update the password in OTDS:
• To change the Admin user password in Content Server, login to Content
Server as the Admin user. From the Global Menu bar, under the My Account
menu, select My Profile. Follow the instructions in OpenText Content Server
User Online Help - Working with Users and Groups (LLESWBU-H-UGD).
Note: Changing the password in Content Server pushes the changed

password to OTDS.
• To change the Admin user password through Directory Services, login to
Content Server as the Admin user. From the Global Menu bar, under the My
Account menu, select Change Password. Follow the instructions in OpenText
Content Server User Online Help - Getting Started (LLESRT-H-UGD).
For more information about Directory Services, see OpenText Directory
Services - Installation and Administration Guide (OTDS-IWC).
1.1.1 To log onto the Content Server Administration page

To log onto the Content Server Administration page:
1. Open the Content Server system-administration URL in a web browser.
2. On the Administrator Log-in page, type the administrator password in the

Administrator Password field.
3. Click Log-in.
Tip: If you installed Content Server on Windows, you can also access the
Administration page by clicking the Windows Start menu, clicking Programs,
opening <Content Server_folder_name>, and then clicking Content Server
Administration.
18 OpenText Content Server – Admin Online Help Collection

1.1. Understanding the Administration Page
1.1.2 To Use the Content Server Administration Page

To use the Content Server Administration page:
1. On the Administration page, navigate to the area that you want to administer,
and then click the link that corresponds to the operation that you want to
perform.
2. To view the Content Server Administration page:
• In a condensed format that displays the sections as tabs, click the Show As
Tabs link.
• In a single list format, click the Show All Section link.

Chapter 2
Administering Permissions
When you set permissions on an item or item type, you specify which users can
work on it and what operations those users can perform.
Permissions are nested to indicate dependencies. For example, you cannot have
permission to modify a document without having permission to see it. Initially, an
item's permission settings are defined by the item's location in Content Server. For
example, when you add an item to a folder, the permissions on the folder are
applied by default to the new item. You can modify the item's permissions, provided
that you have the permission to do so.
Although any user or group can be given the ability to edit permissions,
administering appropriate permissions requires a thorough understanding of access
control throughout Content Server. Before you begin creating users and groups,
OpenText recommends that you carefully review the following information about
permissions: “Choosing Types of Permissions” on page 22, “Copying, Mapping,
and Deferring To Permissions” on page 25, and “Strategies for Administering
Permissions” on page 26.
2.1 Setting User Tab Permissions

You can set permissions for users to modify user information tabs. Users can have
the Edit Self or Edit Anyone privileges for either the General tab or the Personal tab.
By default, users with the System Administration Rights privilege also receive full
Edit Anyone privileges. You can grant other users the Edit Anyone privilege for the
Personal tab, but not the General tab. You can set all users to have the Edit Self
privilege for either or both tabs.
2.1.1 To Set User Tab Permissions

To set User Tab Permissions:
1. On the Administration page, select Users and Groups Administration.

2. Select User Tab Permissions.
3. To modify the privileges for all users, do the following:
• Click the <Public Access> link.

• Select or clear the Allow Edit of Self check box for each tab.
• Click the Update button.
4. To allow a new user or group to have Edit Anyone privileges, do the following:
• Click the Grant Access icon .

Chapter 2 Administering Permissions
• Find the user or group to which you want to grant access.

• Select the Grant Access check box.
• Click the Submit button.
• Select the Allow Edit of Anyone check box for each tab you want available.
• Click the Update button.
5. Click the Done button.
2.2 Choosing Types of Permissions

Permissions specify which users or groups can operate on an item and which
operations those users or groups can perform. The Admin user always has full
access to all items in Content Server. By default, individual users also have full
access to all items in their own Personal Workspace. For more information on this
topic, see OpenText Content Server User Online Help - Getting Started (LLESRT-H-
UGD).
There are three distinct but related types of permissions:
• Work Item permissions, which apply to Channels, Discussions, and Task Lists.
• Document Management permissions, which apply to most item types.
• Role-Based permissions, which apply to Projects.
For more information on this topic, see OpenText Content Server User Online Help -
Getting Started (LLESRT-H-UGD).
2.3 Understanding Document Management

Permissions
Document management permissions apply to document management items, such as
documents, folders, compound documents, workflow maps, URLs, aliases, and
generations. Document management permissions are more detailed than work item
permissions and provide more precise control over the operations performed on
document management items.
The following list describes the document management permissions:
• See - The user or group can view the item name.

• See Contents - The user or group can view the item name and open the item.
• Modify - The user or group can rename the item and modify some of its
properties (for container items, such as folders, this includes the properties that
are listed on the item's Presentation Info page).
• Edit Attributes - The user or group can assign a category to an item, modify an
item's custom attributes, or modify its category.

2.3. Understanding Document Management Permissions
• Reserve - The user or group can reserve the item, modify it, and then unreserve
the item. The user can also add versions to items. The Reserve permission is only
available for items that can be reserved, such as documents and workflow maps.
• Add Items - The user or group can add items to the item. The Add Items
permission is only available for items that can contain other items, such as
folders and compound documents.
• Delete Versions - The user or group can delete versions of the item. The Delete
Versions permission is only available for items that have versions, such as
documents and workflow maps.
• Delete - The user or group can delete the item.
• Edit Permissions - The user or group can change the permissions that other users
or groups have on the item.
All permissions are nested within the See permission. Users and groups cannot have
permission to see an item or its contents, modify, add, delete, or reserve items unless
they first have the See permission. For example, you cannot modify an item that you
cannot see. Similarly, the Edit Attributes, Reserve, Add Items, and Delete Versions
permissions are nested within the Modify permission. The Delete and Edit
Permissions permissions are nested within the Delete Versions permission.
Note: The Delete Versions and Reserve permissions do not apply directly to
folders or compound documents. These permissions are available in the
permissions set for compound documents and folders primarily so that you
can specify default permissions for items that are added to the folder or
compound document.
When you select a document management permission, Content Server verifies that
the base set of dependent permissions required for that permission are also selected.
For example, in the image above, if you select the Reserve check box when no other

permissions are selected, Content Server automatically selects the See, See Contents,
and Modify, check boxes.
2.4 Understanding Role-Based Permissions

Projects simplify the definition of access control by providing a role-based
permissions model. When you create a Project, Content Server automatically creates
a Coordinator, Member, and Guest group for the Project. Each of these groups is
assigned a Project role and therefore receives a different level of permissions.
The following list describes the different Project roles and the permissions associated
with it:
• Guest – users who are made guests of a Project can open the items contained in
the Project.
• Member – Project members can open and modify the items contained in the
Project. Members can also add items, edit attributes, add and delete versions, and
reserve items contained in the Project. Members can also delete the items they
create or add to the Project.
• Coordinator – In addition to the Guest and Member permissions, Coordinators
can establish access privileges, define permissions, add or remove participants,
and change a participant's role within the Project.
Adding Projects to Folders
When you add a Project to a folder, users and groups who have access to the folder
become participants in the Project. In addition, the folder's permissions are mapped
to the three types of Project roles. The type of permissions that a user or group has
for a folder determines whether they become Guests, Members, or Coordinators of
any new Project added to that folder. Permissions are mapped in the following
manner:
• Users or groups with See and See Contents permissions on the folder become
Guests of the Project.
• Users or groups with See, See Contents, and Add Items permissions on the
folder become Members of the Project.
• Users or groups with Modify, Edit Attributes, Delete Versions, and Reserve
permissions on the folder (in addition to See, See Contents, and Add Items
permissions) also become Members of the Project.
• Users or groups with all permissions on the folder become Coordinators of the
Project.
By default, when you add an item to a Project you can modify the permissions
assigned to that item. However, you cannot reduce the permissions for a
Coordinator of a Project. Coordinators always have full access to all items in the
Project.

2.5. Copying, Mapping, and Deferring To Permissions
To expand or reduce the access for certain Guests or Members of a Project, a

Coordinator of a Project can edit their permissions on items in the Project
Workspace. Coordinators can also change the roles of participants in a Project.
Members of a Project can create a subproject by adding a Project within the parent
Project. In this case, Coordinator, Member, and Guest groups are initially copied to
the subproject. The creator of the subproject can expand or reduce the access for
certain Guests or Members of the parent Project, but cannot remove Coordinators of
the parent Project from the subproject's Coordinator group.
2.5 Copying, Mapping, and Deferring To Permissions

Content Server items establish permissions by copying or mapping permissions
from other items or by deferring to the permissions of other items. For example,
items that you add to a folder or compound document automatically inherit the
same permissions assigned to the folder or compound document. Items that you add
to a Channel, Discussion, or Task List defer to the permissions assigned to the
Channel, Discussion, or Task List in which they reside. Content Server items that
contain other items are called parent items and the items that they contain are called
child items.
Permissions are automatically assigned to items when they are added, copied, or
moved in Content Server and when you apply them to subitems. Permissions are
mapped from one item to another when you add work items or Projects to folders or
compound documents. Permissions are also mapped when you add document
management items, such as documents, folders, compound documents, workflow
maps, URLs, aliases, and generations, to Projects.
2.6 Applying Permissions to Subitems

Although some items copy their permissions from their parent items, the items in
which they are contained, you can overwrite those permissions to customize the
access control for particular items. Another way of overwriting permissions is to
apply the permissions that you set for a container to all of the items stored inside it.
When you click the Apply To subitems button on the Permissions page for a
container, Content Server applies the container's permissions to all items below it in
the hierarchy. For example, if you change a folder's permissions and you want to
apply the new permissions to the contents of the folder, you can click the Apply To
subitems button. When you apply the current item's permissions to all subitems in
the hierarchy, you overwrite any customized permissions previously applied to the
subitems. After you click the Apply To subitems button, a message indicates the
number of items that were affected.
If you do not have the Edit Permissions permission for certain items in the hierarchy,
the permissions for those items are not affected when you click the Apply To
subitems button. Use the Apply To subitems button with caution, however,
because it overwrites other permissions in the hierarchy. If you grant more access to
items high in the hierarchy and then apply your changes to all subitems, you could

unintentionally open up access on a restricted item. For more information about the
Apply To subitems button, see “Strategies for Administering Permissions”
on page 26.
If you click the Apply To subitems button in a folder that contains Projects,
subprojects, task lists, Channels, or Discussions, the folder's permissions do not take
effect. That is because the permissions for these items are protected.
2.7 Strategies for Administering Permissions

Understanding access control and administering permissions lets you create a
secure, organized environment for the users and groups in Content Server.
Although Content Server defines the rules for assigning permissions for you, the
way that you assign permissions to the items depends on the knowledge
management strategy that you adopt. You can administer permissions, establish
knowledge managers to administer permissions for you, or trust users and groups to
administer permissions individually. The strategy that you choose depends on your
organization and its knowledge management needs. Although there is no single
solution, there are some strategies that can help you work more efficiently.
1. Establish Knowledge Managers for the primary containers in the Enterprise Workspace.
Knowledge managers are users or groups who have ownership and
administrative responsibilities for items. They are responsible for administering
permissions and monitoring activity. Consider appointing knowledge managers
and letting them administer key areas, assign permissions, and manage the
content of the folders and containers in those areas.
• Specifying knowledge managers as the Owner Group for a container and
opening up their permissions—while restricting the permissions of other
users and groups—grants them primary ownership of key areas.
• Allowing knowledge managers to edit the permissions of a container item is
an effective way to regulate access control for primary areas.
2. Define the Personal Workspace.
Defining the purpose of Personal Workspaces ensures that all users and groups
follow the strategy that you outline. You can let individual users determine the
permissions for their Personal Workspaces based on that strategy.
• Using Personal Workspaces as storage areas for works in progress is an
effective way of backing-up data.
• Using Personal Workspaces as storage areas for sensitive items lets you
maintain control over the content of items while granting access as needed.
• Creating aliases lets you share items in your Personal Workspace with other
users and groups in the Enterprise Workspace.
3. Segregate sensitive items.
Identify sensitive items and segregate them from less sensitive items. Sensitive
items include private documents, Discussions, Projects, or other items for which
security is especially important.

2.7. Strategies for Administering Permissions
• Moving sensitive items to a separate folder lets you administer strict

permissions to all related items without restricting access to less sensitive
items.
•Creating aliases to sensitive items in less sensitive folders lets you group
related items while retaining access permissions.
4. Create Projects.
Create Projects for simpler access control. Projects offer a default set of
permissions that are clearly defined and easy to understand.
• Creating Projects lets you administer permissions using a simple, role-based
permissions model.
•Editing the ACL and Project roles for participants within a Project lets you
expand or restrict permissions.
5. Avoid applying Permissions to subitems.
Beware of the Apply To subitems button—especially when opening up
permissions at the top of a hierarchy.
• Applying permissions to all subitems copies the entire ACL to all items
below the current item in the hierarchy.
• Logging in as a user other than Admin can limit your permissions and
prevent you from making changes to all permissions in a hierarchy using the
Apply To subitems button.
• Notifying knowledge managers and other interested users or groups after
applying permissions to subitems lets them readjust their custom permission
settings, if necessary.

Part 2
Server Configuration
Chapter 3
Configuring General Environment Settings
Configuring the appearance and behavior of your Content Server system includes
the following tasks:
• “Editing the Enterprise Menu” on page 31

• “Setting Date and Time Formats” on page 32
• “Configuring Faceted Browsing” on page 49
• “Configuring the Functions Menu” on page 34
• “Configuring Presentation Settings” on page 35
• “Configuring System Messages” on page 47
• “Customizing the User Interface with Appearances” on page 48
Some related settings are administered elsewhere in the Administration interface.

For information about configuring user password options and the user name
display, see “Configuring User Settings” on page 391. For information about
configuring global user interface preferences, such as the default start page that
appears when users log in to Content Server, see “Configuring Basic Server
Parameters” on page 71. For setting Date and Time Formats, see “Setting Date and
Time Formats” on page 32.
3.1 Editing the Enterprise Menu

You can add URLs to the Enterprise menu quickly and easily from the
Administration page. A URL that you add can be to any webpage that Content
Server can access using the HTTP protocol, either on the Internet, on your
organization's intranet, or within Content Server itself. The added items appear
beneath a separator under the default Enterprise menu items.
3.1.1 To Edit the Enterprise Menu

To add an item to the Enterprise menu:
1. Click the Additional Enterprise Menu Items link in the Server Configuration
section on the Administration page.
2. In the Name field, type the name of the item. This is the text that you want to
display in the Enterprise menu.
3. Type a URL in the URL field.
4. Click Add Menu Item.

Chapter 3 Configuring General Environment Settings
5. Click the and buttons to move the item either up or down in the menu
order.
6. Click Submit.
7. Restart Content Server.
Note: Click the button to remove the selected item from the Enterprise
menu.
3.2 Setting Date and Time Formats

You can configure the time and date formats so that they conform to the standard
formats used at your organization. If more than one language is enabled, the date
and time formats can be configured individually for each language. You can specify
formats for the following date settings:
• Time Zone, which lets you set Content Server to automatically calculate and
display the correct time in each user's local time zone. By default, Content Server
displays the local time at the server's location
• Input Date, which specifies how users must enter dates and times when
prompted for this information by Content Server.
• Short Display Date, which controls how Content Server displays short-format
dates. This format includes the day of the week, which precedes the date display.
• Long Display Date, which governs how Content Server displays long-format
dates.
By default, all three date settings are the same: month/day/year, with a two-digit
month, a four-digit year, a 12-hour clock, and the slash (/) as the separator.
3.2.1 To Set Date and Time Formats

To set date and time formats:
1. In the Administration page, under either Server Configuration or Languages,

click the Administer Date/Time link.
2. In the Time Zone Configuration section, to override the server time, click the
Enable Time Zone Offset check box.
3. In the Input Date Format section, do the following:
• In the Date Order drop-down list, select the order in which you want input
fields to appear for the day, month, and year. The default setting at install is
MM/DD/YYYY. Any change you make will display in the Example field
below.
• Select the Two-part Year check box to have two drop-down lists for year
inputs. One list will refer to the century, 19 and 20. One list will refer to the
decade, 00 through 99. The default setting for this check box is unchecked.

3.2. Setting Date and Time Formats
• Select the 24-Hour Clock check box to display times in the 24-hour clock
format, for example, 14:41. The default setting displays the time in 12-hour
AM/PM format, for example, 02:41 PM. Any change you make will display
in the Example field below.
4. In the Short Display Date Format section, do the following:
• In the Date Order drop-down list, select the order in which you want
display fields to appear for the day, month, and year. The default setting at
install is MM/DD/YYYY. Any change you make will display in the Example
field below.
• Select the Two-Digit Year check box to display years as two-digit numbers,
for example, 09 to represent 2009. The default setting at install will display
the year as a four-digit number, for example, 2009 to represent 2009. Any
change you make will display in the Example field below.
• Type the characters that you want to use to separate the elements of the date
in the Date Separators fields. In the first field, type the character that you
want to use between the first and second elements. In the second field, type
the character that you want to use between the second and third elements.
The default setting at install will use the forward slash character, /, as
separators. Any change you make will display in the Example field below.
5. In the Long Display Date Format section, do the following:
• In the Date Order drop-down list, select the order in which you want
display fields to appear for the day, month, and year. The default setting at
install is MM/DD/YYYY. Any change you make will display in the Example
field below.
• Select the Two-Digit Year check box to display years as two-digit numbers,
for example, 09 to represent 2009. The default setting at install will display
the year as a four-digit number, for example, 2009 to represent 2009. Any
change you make will display in the Example field below.
• Type the characters that you want to use to separate the elements of the date
in the Date Separators fields. In the first field, type the character that you
want to use between the first and second elements. In the second field, type
the character that you want to use between the second and third elements.
The default setting at install will use the forward slash character, /, as
separators. Any change you make will display in the Example field below.
• Select the 24-Hour Clock check box to display times in the 24-hour clock
format, for example, 14:41. The default setting displays the time in 12-hour
AM/PM format, for example, 02:41 PM. Any change you make will display
in the Example field below.
6. To save your changes, click OK. On the Restart Content Server page, click
Restart to restart Content Server automatically, or click Continue if you prefer
to use the operating system to restart Content Server.

3.3 Configuring the Functions Menu

On the Configure Function Menu page, you can determine where functions appear
on the Functions Menu for every item. You decide whether an item's function
appears in the main part of the Functions menu or hidden from users in the More
submenu. Item functions are categorized based on their similarities, with the most
common functions appearing at the top of the menu.
For example, opening, downloading, or viewing a Document as a webpage are

similar concepts and are grouped together.
The following list describes the different types of functions:

• Group 1 GET IT, which allows the user to retrieve the item or its data.
• Group 2 AFFECT ITS CONTENT, which allows the user to change an aspect of
the item.
• Group 3 AFFECT ITS LOCATION, which allows the user to copy, move, or
create an item from another item.
• Group 4 TRACK IT, which informs the user that something happened to the
item.
• Group 5 COMMUNICATE ABOUT IT, which allows the user to inform other
users about the item.
• Group 6 AFFECT ACCESS, which allows the user to control or permit access to
items.
• Group 7 SUB AREAS, which allows the user to access module functionality.
• Group 8 STILL LOOKING, which allows the user to find similar items.
• Group 9 REMOVE IT, which allows the user to delete items.
• Group 10 DETAILS, which allows the user to view, delete, or change item
information.
Note: Whether item functions appear in the main menu or the More submenu,
standard item permissions only allow users to see functions for which they
have permission.
When Content Server is upgraded to 10.0.0, the Admin user must go the
Configure Functions Menu page and click the Save Changes button in order
for the More menu to appear in Content Server.

3.4. Configuring Presentation Settings
3.3.1 To Configure the Functions Menu

To configure the Functions menu:
1. In the Server Configuration section on the Administration page, click the

Configure Function Menu link.
2. On the Configure Function Menu page, click one of the following radio buttons
for each function:
• Main, which displays the function in the main section of the Functions
menu.
• More, which displays the function in the hidden section of the Functions
menu.
3. Click the Save Changes button.
Note: When Content Server is upgraded to 10.0.0, the Admin user must go the
Configure Functions Menu page and click the Save Changes button in order
for the More menu to appear in Content Server.
3.4 Configuring Presentation Settings

The Configure Presentation administrative pages enable you to set some of the
basic appearance and behavior of Content Server. The settings on these pages affect
the Content Server logon page, browsing, sorting and filtering Content Server
folders and other containers, methods of uploading and opening Content Server
items, the appearance of icons and thumbnails, and other such settings.
For information about configuring user password options and the user name
display, see “Configuring User Settings” on page 391.
3.4.1 Configuring Container Options

The Configure Container Options page allows you to specify the way users browse
containers in Content Server, to enable pagination, filtering and column
customization, to set the behavior of Featured Items and Custom Views, and to
enable Drag and Drop.
Navigation
You can select how the path to the current item or location is displayed, as a list or as
a hyperlink trail. You can also allow users to select which style they prefer.
If you want to allow users to access Content Server Smart View interface, you must
select the Enable Smart View Link option. When this option is enabled, and users
are within a container that is accessible through the current (Classic View) and the
widget-based view (Smart View), a Smart View option will appear on the My
Account menu that allows them to open the current container in the Smart View.

Pagination
Enabling Folders and Workspaces to use pagination makes browsing containers
with large numbers of items more efficient. When pagination is enabled, users can
sort contents in a container, making it easier for them to find items. Administrators
can configure the number of items that display in containers throughout Content
Server. If the number of items in a container is smaller than the number specified,
the arrows that appear for browsing to previous and subsequent pages do not
appear. Pagination for the entire system can also be disabled. When pagination is
disabled, users will see all contents within a container on one page.
If the Store page information in cookie option is selected, Content Server will
remember the page number you were last accessing. If the option is cleared, when
the user opens a new tab or window the filter results will start at the first page again
by default.
Note: Pagination is enabled by default.
Column Customization
When enabled, users are able to customize the way that columns are displayed in a
browse list.
Note: Column customization is disabled by default.
Featured Items
When enabled, items which have been selected as featured items will no longer
appear in the browse list.
Note: Featured items appear in the browse list by default.
Filtering
Enabling Folders and Workspaces to use filtering makes finding items inside a
container with a large number of items more efficient. When filtering is enabled,
users can search for an item by typing the name of the item in a text field. The results
of the search are returned on a new page.
Administrators can enable and disable filtering for containers in Content Server.
When filtering is disabled, the filter search field does not appear in Content Server
containers.
If the Store item filter information in cookie option is selected, Content Server will
remember the item type on which you are filtering. If this option is cleared, when
the user opens a new tab or window, all Content Server item types will be displayed
again by default.

If the Store name filter information in cookie option is selected, Content Server will
remember the name string on which you were filtering. If this option is cleared,
when the user opens a new tab or window, Content Server will apply no name filter.
Note: Filtering is enabled by default.
The Content Filter sidebar and filtering are mutually exclusive. When both the
sidebar and filtering are enabled, filtering will only be available on those
containers not eligible to display the sidebar.
Drag and Drop

In this section, you can enable or disable Drag and Drop. By default, Drag and Drop
is enabled.
You can also specify a number of Drag and Drop settings, including:
• behavior when an identically named file exists (add a version to the identically
named file or skip the upload)
• the maximum number of files that you can drag and drop in a single operation
• the maximum size of a file that you can upload to Content Server using Drag and
Drop
Note: OpenText recommends that you set this value to the maximum
upload value permitted by your web server. Although you can set it to a
larger value, when you attempt to upload a file that is larger than the
maximum upload value permitted by your web server, the operation will
fail.
To produce detailed logging on Drag and Drop operations, you can Enable Logging
to Browser Console. This can be a useful setting if you need to troubleshoot a
problem with Drag and Drop.
Important
OpenText recommends that you do not enable logging to the browser
console unless OpenText Technical Support has requested that you enable
this setting.
Custom View File Listing

When enabled, the file listing will display when a container has a hidden Custom
View.
Note: The file listing is hidden by default.
This setting does not apply to virtual folders.

To Configure Container Options

To configure container options:
1. On the Content Server administration page, under Server Configuration, click

Configure Presentation.
2. On the Configure Presentation page, click Configure Container Options.
3. On the Configure Container Options page, in the Navigation section:
a. In the Navigation Style field, select either the Hyperlinked Trail radio
button to select the hyperlink view, or the Drop-Down List radio button to
select the drop-down list view.
b. Optional In the Allow user to override field, to prevent users from altering
their personal navigation style, clear the box. It is enabled by default.
c. Optional In the Browse Appearances field, to include Appearances in the
Target Browse dialog box, select the box. It is disabled by default.
d. Optional In the Enable Smart View Link field, select the Enable Smart View
Link check box to allow users to switch to the Smart View from the Classic
View. This option, when enabled, appears on the My Account menu. It is
only available to users when the container is accessible in both views.
4. In the Pagination section:
a. Optional In the Enable Pagination field, to disable pagination, clear the box.
Pagination is enabled by default.
b. Optional In the Number of Items Shown Per Page text field, type a list of
positive integers that will be available to select in the next field.
c. Optional From the Default Number of Items Shown Per Page list, select the
number of items that will appear on each page.
d. Optional Clear the Store page information in cookie box if you do not want
to store pagination settings in a cookie. Pagination settings are stored in a
cookie by default.
5. Optional In the Column Customization section, to permit users to customize the
columns display in the browse list, select the Allow Browse List Column
Customization box. Column customization is disabled by default.
6. Optional In the Featured Items section, if, once an item has been selected as a
featured item, you want that item removed from the list view, select the
Remove Featured Items from Browse List box. Featured items appear in the
browse list by default.
7. In the Filtering section:
a. Optional To disable filtering, clear the Enable Filtering box. Filtering is

enabled by default.
b. Optional If you do not want item filter information stored in a cookie, clear
the Store item filter information in cookie box. Item filter information is
stored in a cookie by default.

c. Optional If you do not want name filter information stored in a cookie, clear
the Store name filter information in cookie box. Name filter information is
stored in a cookie by default.
8. In the Drag and Drop section:
a. Optional If you want to disable Drag and Drop, select the Enable Drag and
Drop box. Drag and Drop is enabled by default.
b. Ensure that the Enable Logging to Browser Console box is cleared, unless
OpenText Technical Support has requested that you enable this setting.
Logging to browser console is disabled by default.
c. In the Add Version field, select one of:
• Add a version if file exists

• Skip file if file already exists
d. In the Maximum Number of Files Allowed In A Drop field, enter a
positive integer. The default is 500.
e. In the Maximum File Size For A Drag and Dropped File (MB) field, enter
a positive integer that should match your webservers maximum value. The
default is 100.
9. Optional If you want to show the file listing if the container has a hidden Custom
View, select the Show File Listing box. The file listing is hidden by default.
10. Click Save Changes to save your changes and return to the previous screen, or
click Reset to reset the page to its previous values.
3.4.2 Enabling or Disabling the Document Overview Page

You can enable or disable an Overview page as the default target for links to a
Document or a version of a Document. (If you disable the Overview page as the
default target for Document and Version links, you can still view it using a a
Document's or Version's Functions menu.)
The Document Overview and Version Overview pages provide information about
a Document or Version, and enable you to perform a number of functions on the
Document or Version. For more information, see OpenText Content Server User Online
Help - Working with Documents and Text Documents (LLESWBD-H-UGD).

To Enable or Disable the Document Overview Page
To enable or disable the Document Overview page:
1. In the Server Configuration section of the Administration page, click the

Configure Presentation link.
2. On the Configure Presentation page, click the Configure Document Overview

Function link.
3. On the Configure Document Overview Function page, click one of the following
radio buttons:
• Enable, which enables the Document and Version Overview pages as the
default targets.
• Disable, which disables the Document and Version Overview pages as the
default targets.
4. Click the Save Changes button to save your changes and return to the
Administration page, or click the Cancel button to reset the page to its previous
values and return to the Configure Presentation page.
3.4.3 Configuring the Login Screen Message

You can create a custom message which will appear at the Login screen. Anytime a
user logs in to Content Server, they will view this message from the Login Screen.
If you have multiple language packs installed, the Configure Login Message page
will display a list in the Language column representing each language pack. From
this list, you need to select the language you want used to display your login
message.
The Configure Login Message page contains the following columns:
1. Language: this column displays the installed language pack(s). If multiple

language packs are installed, this column will display a list which allows you to
select the language pack you want used to display your login message. One
example is “English ( United States )”.
2. Language Code: the language code associated with the language will be
displayed in this column. This field is not editable and it will display the
language code associated with the language you selected in the Language
column. One example is “_en_US”.
3. HTML Login Screen Message: a text box which allows you to type the message
that you want all users logging into Content Server to see at the Login Screen.
You can enter plain text, HTML, or Javascript to this text box.

To Configure the Login Screen Message

To configure the login screen message:
1. On the Content Server Administration page, under Server Configuration, select

Configure Presentation.
2. On the Configure Presentation page, click Configure Login Screen Message.
3. On the Configure Login Message page, under the Language column, if you
have one language pack installed, that language will appear in this column, and
that field will not be editable.
If you have multiple language packs installed, you will see a list. From this list,
select the language pack you want used to display your login message.
4. The Language Code column is not editable. If only one language pack is
installed, the language code for that language will appear in this column.
If you have multiple language packs installed, the language code associated
with the language you selected from the list in the Language column will
appear in this column.
5. In the HTML Login Screen Message column, in the text box, type the message
that you want all users logging into your system to see at the Login Screen.
6. Click Save Changes.
3.4.4 Configuring Promoted Functions

You can make certain document-management functions easier to find in the user
interface by promoting them. Promoted functions are displayed more prominently
for Documents on the Detail View page of containers and Workspaces, and the
View as Web Page and Properties pages for Documents.
The following functions can be promoted:
Function Presentation
Download A link on the Workspace or parent
container's Detail View page and a button
on the View as Web Page and Properties
pages.
Edit A link on the Workspace or parent
pages.
Open A link on the Workspace or parent
pages.

Function Presentation
Add Document An Add Document button on the container's
browse page.
Add Folder An Add Folder button on the container's
browse page.
Note: By default, both Display on Detail List View and Display on Properties
& View as Web Page are enabled.
To Configure Promoted Functions

To configure promoted functions:
1. Click the Configure Presentation link in the Server Configuration section on

the Administration page.
2. Click the Configure Promoted Functions link on the Configure Presentation

page.
3. To display functions links for Documents on the Detail List View of a container,
select the Display on Detail List View check box.
4. To display functions buttons on the Properties and View as Web Page pages of
Documents, select the Display on Properties & View as Web Page check box.
5. Click the Save Changes button to save your changes and return to the previous
screen, or the Cancel button to cancel your changes and return to the main
Administration page.
3.4.5 Configuring the Sidebar

You can enable or disable the Content Filter sidebar and sidebar panels for all users.
By default, both are enabled.
To Configure the Sidebar

To configure the sidebar:
1. On the administration page, select Server Configuration.
2. Select Configure Presentation, then Configure Sidebar.
3. To enable the sidebar for all users, ensure the Enable Sidebar check box is
checked. The sidebar is enabled for all users by default.
4. In order to ensure that the sidebar is enabled for all users, you must also select
at least one sidebar panel. By default, the Content Filter sidebar panel check box
is checked.
5. Click the Save Changes button to save your changes and return to the previous
page, or click the Reset button to cancel your changes.

Notes
• If there is only one sidebar panel available to enable, disabling that
panel will disable the sidebar. In order to ensure that the sidebar is
enabled for users, you must select the Enable Sidebar check box and
one sidebar panel.
• You can also configure the sidebar from the Facets Volume Control
Panel page. Select Tools then Facets Volume from the global menu bar.
From the Facets functions menu, select Control Panel. Select Configure
Sidebar.
3.4.6 Configuring Small and Large Icon Views

You can enable or disable small and large icon views in the user interface. When the
Display Large and Small Icon Views setting is enabled, containers can display
items using the Detail, Large, and Small Icon Views and users can toggle between
view types using the View Type buttons. By default, items marked as Featured will
appear in both the Featured Items section and in the Detail View list. The
administrator can change this default in the Featured Items section.
When this setting is disabled, users cannot toggle between views. The Detail View
displays for all containers, regardless of which view the user had previously selected
in for the container. If you re-enable the Display Large and Small Icon Views
setting, the container will display the view that was originally selected.
Note: The Display Large and Small Icon Views setting is disabled by default.
To Enable or Disable Small or Large Icon Views

To enable or disable small or large icon views:

2. On the Configure Presentation page, click the Configure Small and Large Icon
Views link.
3. On the Configure Small and Large Icon Views page, select or clear the Display
Small and Large Icon Views check box, and then click the Save Changes
button.

3.4.7 Configuring Thumbnail Options

You can enable or disable Thumbnail generation in the user interface when objects
in an Enterprise Data Source are indexed. When the Generate Thumbnails setting is
enabled, the Document Conversion process creates thumbnails of the document or
object. You can generate thumbnail for either the current version of the object or for
all versions, and specify which MIME types to generate thumbnails for. You can also
enable or disable Thumbnails, when available, to be displayed instead of large icons.
Note: The Generate Thumbnails setting is enabled by default.
Supported MIME Types

You can generate Thumbnails during Document Conversion for specific types of
documents, based on analysis of the document. The Configure Thumbnail Options
page defines to the Extractor which Content Server MIME types are candidates for
thumbnail generation. Defining thumbnails on this page will only produce
thumbnails if the file format is supported, and the MIME type is defined in the
[Thumbnail] section of the dcsrules.txt file.
The following file formats can be configured to generate thumbnails in the

Document Conversion server:
• Word 95-2013 • Micro Station (DGN) • WMF

• Excel 95-2013 • RDL • ME10
• PowerPoint 97-2013 • RTF • JPEG
• PDF 1.0 – 1.9 • Calcomp • BMP
• DWG • HPGL
• PNG
• DWF • DXF
• CADRA • Gerber
• GIF
• WordPerfect • CGM • TIF
• Postscript • EMF • CALS
To Configure Thumbnail Options

To configure Thumbnail Options:

the Configure Presentation link, and the Configure Thumbnails link.
2. On the Configure Thumbnail Options page, for Generate Thumbnails, click
the Enable radio button, if needed. It is enabled by default.
3. For Thumbnail Versions, click the Current version only radio button, the
default, to generate thumbnails only for the current version of the object, or the
All versions radio button.
4. For MIME Types, click the edit / review list link to open the Configure
Thumbnail MIME Types page. For details, see “To configure the MIME types

for generating thumbnails:“ on page 45 and “Supported MIME Types”

on page 44.
Note: Thumbnails are generated during indexing. The thumbnail MIME

types act as an indexing white list, and take precedence over the Extractor
MIME type exclusion list in the [ExcludedMimeTypes] section of the
opentext.ini file.
For thumbnail generation to work, the MIME type must be selected on the
Configure Thumbnail MIME Types page, and the MIME type needs to be
defined in the [Thumbnail] section of the dcsrules.txt file.
5. For Display Thumbnails, click the Enable radio button to display thumbnails
instead of large icons. It is enabled by default.
To configure the MIME types for generating thumbnails:

the Configure Thumbnails link.
2. On the Configure Thumbnail Options page, for MIME Types, click the edit /
review list link to open the Configure Thumbnail MIME Types page.
3. On the Configure Thumbnail MIME Types page, select the check boxes for the
MIME Types to extract to the search index. See “Supported MIME Types”
on page 44 for more information.
4. Click Update.
3.4.8 Configuring the DOCTYPE for HTML pages

The DOCTYPE is the document type declaration used by browsers to properly
display web page elements and attributes. OpenText recommends that the
DOCTYPE is always explicitly declared in your HTML or XHTML documents.
Note: The default setting is: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01
Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
To Set the Declared DOCTYPE for HTML Pages

To set the Declared DOCTYPE for HTML pages:

the Configure Presentation link.
2. On the Configure Presentation page, click the Default DOCTYPE for HTML
Pages link.
3. On the Declared DOCTYPE for HTML Pages page, in the Default DOCTYPE
for HTML Pages text box, type your new document type declaration.

3.4.9 Configuring Project Presentation Settings

This page allows you to configure the following default Project appearance and
behavior:
• You can set the default start page for a Project to either the Project's Overview
page or the Project Workspace.
• You can display either a Project menu or a Project Icon Bar in all Project
Workspaces.
• You can enable the Overview.html page, which provides Project participants
with a personalized view of items in a Project. The sections that appear on the
page are configured by the Project Coordinator. When this option is enabled, the
Overview.html page appears when a Project is opened. By default, this option is
disabled, and the Project Workspace page is used as the start page when a
Project is opened.
• You can set the maximum number of items allowable in each section on the
Project Overview page.
• You can change the default Status Indicator values for all Projects.
Note: When you change a Project setting, the change applies to new Projects
and existing Projects. For example, if you clear the My Tasks check box in the
Navigation section, the My Tasks icon will no longer display in the Project
Icon Bar.
To Configure Project Settings

To configure Project settings:

2. Click the Project Settings link on the Configure Presentation page.
3. In the Start Page section, click either the Overview or Workspace radio button.
This determines the first page that appears when a user opens a Project.
4. In the Overview.html section, click the Enable or Disable radio button.
5. In the Navigation section, select the Project Menu check box to display the
Project menu in all Project Workspaces.
6. Do one of the following:
• Select the Project Icon Bar check box, and then select the check boxes of the
items you want displayed in the Icon Bar.
• Clear the Project Icon Bar check box if you do not want the Icon Bar.

3.5. Configuring System Messages
7. In the Overview Settings section, select the check boxes of the sections you
want to allow Project Coordinators to choose from when selecting sections to
appear on the Project Overview page.
8. In the # of items drop-down list, click the maximum number of items allowable
in each section on the Project Overview page.
9. In the Status Indicator section, type a value for each of the status indicators in
the appropriate fields.
Note: If you change the default Status Indicator values and there are
existing Projects, the existing Projects pick up the new values immediately.
You should advise Project Coordinators of any impending changes prior
to submitting the change.
10. Click the Submit button.
3.5 Configuring System Messages

The System Messages feature enables the administrator to broadcast information to
all users on the system using the News Player. News players deliver information to
the Enterprise Workspace, all Personal Workspaces, and some other Content Server
pages.
3.5.1 To Configure System Messages

To configure system messages:
1. Click the Configure System Messages link in the Server Configuration section
on the Administration page.
2. To add a system message, do the following:
• Click the Add Message button.

• Type a name for the message in the Name field.
• Type a headline describing the message in the Headline field. This is the text
that will appear in the News Player.
• Optionally, type a URL in the URL field. Specifying a URL makes the
headline a clickable link that will take the user to another webpage. This can
be any webpage that can be accessed by Content Server, either on the
Internet, on your organization's intranet, or within Content Server itself.
• Click the date on which you want the message to begin appearing to users in
the Effective Date drop-down lists.
• Click the and buttons to move the item either up or down in the
menu order.
• Click the Submit button to save your changes and return to the
administration page. Click the Cancel button to cancel your changes and
return the page to its previous saved values so you can begin again.

3. To edit a system message, do the following:
• Click to highlight the name of the message you want to edit in the dialogue
box on the left hand side of the Configure System Messages page.
• You will note that the fields on the right hand side of the page are now
populated with the message information associated with the message name
you highlighted. Edit the information in the appropriate fields.
• Click the and buttons to move the selected item either up or down in
the display order.
Tip: To delete a message, click to highlight the name of the message you
want to delete in the dialogue box on the left hand side of the Configure
System Messages page. Click the Delete button.
3.6 Customizing the User Interface with

Appearances
An Appearance is a container that stores Documents and HTML code. Appearances
enable you to customize certain locations, much as you would design a webpage.
For information about Appearances, see OpenText Content Server User Online Help -
Working with Custom Views and Appearances (LLESAPP-H-UGD).
Global Appearances, which are intended to be applied to multiple, separate locations,

must be added to the Appearances Volume. To add Global Appearances, you need
the Add Items permission on the Appearances Volume.
The Appearances Volume is accessible from the Administration page.
1. Select Appearances Administration.
2. Next, select Open the Appearances Volume.
3. To create a Global Appearance, click the Add Item button and select Global
Appearance.
4. Type a name for the new global appearance in the Name field. Optionally, type
or select items in the Description, Categories, and Create In fields.
5. Click the Add button.

Chapter 4
Configuring and Customizing Faceted Browsing
If you are a Knowledge Manager or an administrator, you can access the Facets
Volume from the Tools menu on the global menu bar. If you are an administrator,
you can also access the Facets Volume from the administration page. If the link to
access the Facets Volume is not available to you, then you do not have the necessary
privileges. Contact your administrator for access to the Facets Volume.
4.1 Configuring Faceted Browsing

Faceted Browsing is one of the navigational tools available to your users. It allows
users to browse through items in Content Server using groupings of metadata, or
facets, to progressively narrow their search. Faceted Browsing is enabled by default
and is installed with default facets and document classes defined. As the
administrator, you need to assess the usage needs of your users in order to
determine how you will customize faceted browsing. This section describes how to
configure faceted browsing for all users so that the facets available are relevant to
your system's content. It will detail how to configure the sidebar for all users, set up
your knowledge managers, and add document classes, facets, facet trees, and
columns. For information regarding how to use faceted browsing, see OpenText
Content Server User Online Help - Working with Documents and Text Documents
(LLESWBD-H-UGD) in the User help.
Enabling Faceted Browsing

The administrator decides whether faceted browsing is enabled for all users. Faceted
browsing is enabled by default, at install, for your users. It is accessed by users
through the Content Filter sidebar.
For information about enabling and configuring the Content Filter sidebar, see “To
Configure the Sidebar” on page 42.
Configuring Knowledge Managers

The administrator must decide who, in your organization, has sufficient knowledge
of your organization's data content to serve as a Knowledge Manager? Only an
administrator can define a knowledge manager. The system administrator gives the
person designated as a knowledge manager the privileges and permissions
necessary to access the Facets Volume so that they can administer the faceted
browsing setup. Your Knowledge Manager(s) structure how faceted browsing will
function for your organization. A good idea when beginning is to create a
Knowledge Manager group in Content Server and then populate that group with the
users who will be assigned the Knowledge Manager privilege.

Chapter 4 Configuring and Customizing Faceted Browsing
Configuring Document Classes

Document classes are used as facet data sources. No document class can be deleted if
it is being used as a data source for a facet. In the event you attempt to remove a
document class that is being used as a data source for a facet, a dialgue box will
appear informing you that the document class cannot be deleted.
After you have created a document class, you need to configure your document
class. A link to the procedure to create and configure a document class can be found
below. During the configuration process, you are required to select all MIMETypes
that you want to add to your new document class in the Configure MIMEType
alias page. These MIMETypes are categorized as follows:
• MIMETypes in use
This is a list of MIMETypes that have already been added to your Content Server
system. Any document, graphic file, or other item that has been added to a
location in Content Server has a MIMEType. That MIMEType is listed in this
section.
• MIMEType Aliases
This is a list of MIMETypes aliases that have already been defined within all
document classes.
• Known MIMETypes
This is a list of all known MIMETypes that have not previously been listed in the
MIMETypes in use field. If a MIMEType appears in this field then it is not a
MIMEType of an item added to your Content Server system.
Configuring the Date Format

Date facets have an auto-traversal with the following levels: Relative, Century,
Decade, Year, Month, and Day. The relative date might be yesterday or today. The
century, decade, and year dates display as four digit years. The day will display in
the format that is set as the short date format on your Content Server installation.
The way that the sidebar displays the month and year can be configured by the
administrator.
By default, any date facet will display the month in the format Month Year, where
Month is the full name of the month, and Year is the four digit year. You can change
this default date format by modifying the [Lang_en_US] section of the
_home/config/opentext.ini file.
Options available for use are:
• %b
The three-character abbreviated month name. For example: Jan, Feb, Mar.
• %B
The full month name. For example: January, February, March.

4.1. Configuring Faceted Browsing
• %m
The two-digit month. For example: 01, 02, 03.
• %Y
The year, including the century. For example: 1993, 2002, 2010.
• %y
The two-digit year. For example: 93, 02, 10.
For general information about modifying the opentext.ini file, see “Modifying the
opentext.ini File” on page 91.
4.1.1 To Set Up Knowledge Managers

To set up knowledge managers:
1. Under System Administration, select Administer Object and Usage Privileges.

On the Administer Object and Usage Privileges page, scroll down to the Usage
Privileges section.
2. Under the column Usage Type, find Facet Administration. By default, the
Usage Name is Knowledge Manager, the Usage Status is Restricted, and the
action available under the Actions column is Edit Restrictions. Click on the text
Edit Restrictions under Actions. You will now see the Members Info page titled
Edit Group: Knowledge Manager
3. Using the drop-down list box and input boxes on the right, enter the name of
the person or group you want to designate as a knowledge manager. Click the
Find button.
4. The name of the person or group will appear. Select the check box Add to group
then click the Submit button.
5. Your new knowledge manager's name will now appear in the Current Group
Members box on the left. Click the Done button.
6. To edit your knowledge manager group in future, click the text Edit Restrictions
under Actions on the Administer Object and Usage Privileges page.
7. After adding your user to the Knowledge Manager group, you must give your
user permission to edit the Facets Volume. Select Tools then Facets Volume
from the global menu bar.
8. Click the Facets functions button. Select Permissions.
9. Click the Grant Access... button in the Assigned Access field.
10. Type the name of the new Knowledge Manager in the text field then click the
Find button. Click the Grant Access check box next to the new Knowledge
Manager's name.

11. Click the Submit button. Select the check boxes next to the permissions that you
want to assign to your Knowledge Manager. Make sure you grant edit
permission.
12. Click the Update button. Finally, click the Done button.
4.1.2 To Add Document Classes

To add document classes:
1. Go to the administration page, under Server Configuration select Configure

Facets. Select Configure Document Classes.
Note: You can also access the Document Class Definitions page from any
workspace page by selecting Tools then Facets Volume from the global
menu bar. Select the Facets' functions button, then select Control Panel.
Select Configure Document Classes.
2. To add a new document class, in the Document Classes input box, type the
name of the new document class. Click the Add New Document Class button
to the right of the Document Classes input box.
3. If you want to configure your new document class later, click the OK button to
save your new document class and return to the Configure Facets page.
Note: You can remove any document class by clicking the delete button,
, located in the Document Classes field under the Actions column. You
will be prompted to confirm that you want to delete the document class.
Click OK to delete the document class. Once you click OK in the dialog
box, the document class is deleted.
4. If you want to continue and configure your new document class immediately,
click on the new document class name in the Class Name section. You will now
see the MIMEType Alias Definitions page.
Note: You can choose to add a new MIMEType Alias for an existing
document class. If you want to add a new MIMEType Alias for an existing
document class, click on that existing document class name in the Class
Name section. You will now see the MIMEType Alias Definitions page.
5. In the MIMEType Alias Definitions page, in the MIMEType Aliases input

box, type an alias name for your new document class. Click the Add New Alias
button to the right of the MIMEType Aliases input box to add the new alias to
the Alias Name list.
If you want to configure your new alias later, click the OK button to save your
new alias and return to the Document Class Definitions page.
You can remove any MIMEType Alias by clicking the delete button, , located
in the MIMEType Aliases field under the Actions column. You will be

4.2. Working with the Facets Volume
prompted to confirm that you want to delete the document class. Click OK to
delete the MIMEType Alias.
To continue and configure your new alias, click on the new alias name in the
Alias Name section. You will now see the Configure MIMEType alias page.
6. In the Configure MIMEType alias page, select the check boxes next to all the
MIMETypes that you want to add to your new document class. Once you have
finished, scroll to the bottom of the screen and click Update.
4.1.3 To Change the Date Format for Facets

To change the date format for Facets:
1. Open the opentext.ini file for editing and place the following parameter
under [Lang_en_US]: MonthYearFormat=%B %Y. The example given here would
give the default display of full name of the month followed by the four digit
year.
2. After you modify the opentext.ini file, restart Content Server (and your web
application server, if applicable) for the changes to take effect.
4.2 Working with the Facets Volume

The Facets Volume is available to your administrator and Knowledge Managers. If
the link to access the Facets Volume is not available to you, then you do not have the
necessary privileges. Contact your administrator for access to the Facets Volume.
From the Facets Volume, you can add columns, facets, facet folders and facet trees.
OpenText recommends that, prior to creating a column, facet or facet tree, you first
create a facet folder to store your custom items. Creating a facet folder for your
custom items aids in future maintenance for faceted browsing.
Column
In the Browse View of any location, items are viewed in a list. Each item is displayed
in the list according to the columns defined for the Browse View. If a column is
sortable, then clicking a column's name will organize the browse list.
Knowledge Managers can create new columns that can display to users. The only
columns that appear in the Browse View by default are the Fixed System Columns:
Type, Name, Size and Modified.
Creating a custom column requires you to select a data source for your column.
Your administrator is responsible for managing your available data sources. In the
event that you want to create new data sources for your column, for example a
Records Management field, then a solution developer will be required to write the
code to make that available. A data source will not display in the list if it is in use by
another column.
The data sources available for your columns in the list consist of the active and
unused data sources only. Once a data source is in use, it no longer appears in the

list. Your administrator is responsible for managing your available data sources. If
your administrator has created a category in the Categories Volume, that category
can be available as a data source.
After you add a column, you will need to configure that column. A custom column
is configured from the column's functions menu by selecting Properties. The fields
in a column's Properties dialog box are:
• Column data source: a read-only field that lists the data source that was selected
when the column was created.
• Status: a read-only field that lists the current status for the column and provides
a button to rebuild the column, if necessary.
• Sortable: a read-only field that indicates whether the column can be sorted by
users.
• Width: a numeric input box that allows you to set the width of the custom
column in characters. The default setting is 20. Allowable values range from 1 to
250. This field is required.
Note: A custom column displays a maximum of 64 characters of data. If the

length of the data to be displayed in the column exceeds 64 characters, the
text is truncated and suspension points (...) appear to represent the missing
data. Setting the column width to a value greater than 64 characters does
not affect this limitation.
• Alignment: a list box that allows you to select whether the column text will align
left, align center or align right. The default setting is align center.
• Long Text: a list box that allows you to select whether the column text will wrap,
not wrap or truncate. The default setting is wrap.
• Display as link?: a check box that allows you to select whether to allow the
column value to display as a hypertext link.
This box appears checked by default if the column data source is a user-type data
source. If this box is not checked, the next four options will not be selectable. If
this box is checked, the Link URL and Display value fields below are required.
• Link URL: an input box to enter the URL to which the column value will link.
You will only be able to enter information to this field if you have first checked
the Display as link? box. This field is required if you have checked the Display
as link? box.
• Display value: an input box to enter the value to be displayed in the column. The
default value is %value%, which will display the value for the column. Other
options are:
• %objid%: this will display the ID of the object itself.
• %nexturl%: this is the URL the browser will be directed to after the original
action has been completed.
• %value%: this will display the value for the column. This is the default value.

• %rawvalue%: this will display the raw value for the object.
the Display as link? box. This field is required if you have checked the Display
as link? box.
• Alt-text: an input box to enter the alt-text for the link. You can choose to use the
values: %objid%, %nexturl%, %value% or %rawvalue%.
the Display as link? box. This field is optional.
• Link Target: a check box that allows you to select whether the link will open in a
new browser window.
the Display as link? box. This field is optional.
Before your column can be accessed by users, you must make your column available
and give your users permission to see, edit or administer the column.
The availability options for your column are Not available, Available everywhere or
Only available in specific locations. By default, the custom column's availability setting
is Not available.
Allowable permissions are Administer, Read, Write and None. By default, the custom
column is given a Public Access permission of Read. It is advised that you keep this
setting. In order for a column to show up in a user's Browse View, it needs to be
selected in one of:
• global columns,
• at the folder level, or
• on a user's personal settings.
For information about setting permissions for your column, see “Administering
Permissions“ on page 21.
Facet
In the Content Filter sidebar, the facet panel displays the facets and facet values
relevant to the items found in that location. Metadata are values that describe an
item. Facets are groupings of metadata to which values are assigned.
Knowledge Managers create and edit facets in the Facets Volume. The only facets
that appear in the Browse View by default are the System Default Facets: Owner,
Content Type, Document Type, and Modified Date.
A facet will display if all of the following is true:

• The facet's status is Ready.
• The setting for Display in sidebar is set to On.

• The user has permission to access the facet.

• The user has permission to access the facet's data source. Currently, this only
applies to Categories.
• The facet is in a facet tree.
• The user has permission to access the facet tree.
• The facet tree is available for that location.
The data sources available for your facets in the list consist of the active and unused
facet data sources only. Once a data source is in use, it no longer appears in the list.
Your administrator is responsible for managing your available data sources. If your
administrator has created a category in the Categories Volume, that category can be
available as a data source.
In the event that a category, and its associated attributes, are available as a data
source, they will display in the list as: Category: {cat name}:{attr name}, or, if the
attribute is in a set category, they will display as: Category: {cat name}:{set name}:{attr
name}.
The data source field list is alphabetically listed, followed by a separator, and then
all available attributes.
A facet that is used in the definition of a facet tree cannot be deleted. The facet must
first be removed from the definition of a facet tree before it can be deleted.
After you add a facet, you will need to configure that facet. A custom facet is
configured from the facet's functions menu by selecting Properties. The fields in a
facet's Properties dialog box are:
• Facet data source
A read-only field that lists the data source which was selected when the facet was
created.
• Status
A read-only field that lists the current status for the facet and provides a button
to rebuild the facet, if necessary. Possible values include: Building, Ready, or Error.
• Show in sidebar
A check box that allows you to select whether the facet will be displayed in the
sidebar. The box is checked by default. Clearing this check box will remove the
facet from the sidebar even though it is still found in the facet tree definition.
• Minimum unique values
A list box that allows you to specify the minimum number of unique values
required before the facet may appear. The default setting is 2.
• Maximum values to display
A list box that allows you to specify the maximum number of unique values
permitted to appear in the facet. The default setting is 5.

• Display mode
A list box that specifies the order in which facet values are displayed. The default
setting is Ranked list.
The available options depend on the type of the Facet. Generally, the options
available are:
• Ranked list: the default, which will sort by the count for each value.
• Alphabetical list: which will sort by the values themselves.
Date-type facets do not support display mode.

• Display priority
A list box that specifies the presentation format for facet values. The default
setting is Medium.
• Count accuracy
A list box that specifies the level of accuracy for the facet item count. The default
setting is Precise.
• Show lookup in 'More...'
A check box that adds a Type ahead look up box to the More dialog box if there
are more than 50 unique values in the facet. The box is checked by default.
You must now decide on the permissions for your facet. Allowable permissions are
Administer, Read, Write, and None. By default, the custom facet is given a Public
Access permission of Read. It is advised that you keep this setting.
The public access permission value is being cached with the facet and facet tree
definitions. This results in a significantly faster browse time because Content Server
does not have to check user permissions on the facets and facet trees.
For information about setting permissions for your facet, see “Administering
Permissions“ on page 21.
The final step is to include your new facet in a facet tree. Your facet will not be
available until it is included in a facet tree. For information about including your
facet in a facet tree, see “To Configure a Facet Tree” on page 63.
Facet Folders
Creating Facet Folders provides a way to manage and organize your custom
environment. Columns, Facets, and Facet Trees can have their permissions set so
that they are only accessible by certain groups in Content Server. When creating
custom items in the Facets Volume, you should consider first creating a Facet Folder
to store the new custom item. For example, if you are creating custom Facet Volume
items for your Financial Department, you should first create a Facet Folder called
“Financial Dept”. This will help with future maintenance for your custom items.

Facet Tree
The Facet Tree is used to list the facets whose values will be displayed in the
Content Filter sidebar. Facet Trees allow the Knowledge Manager to control who
sees the facets and where they appear.
Before your facet tree can be accessed by users, you must make your facet tree
available and give your users permission to see the facet tree.
You make your facet tree available from your facet tree's Properties dialog box,
Availability tab.
The availability options for your facet tree are Never displayed, Display in all facet
sidebars, or Only available in specific locations. By default, the custom facet tree's
availability setting is Never displayed.
• Never displayed
The facet tree is never displayed in the sidebar.
• Display in all facet sidebars
The facet tree is always displayed in the sidebar, provided the user has sufficient
permission to see the facet tree.
• Only available in specific locations
The facet tree is only displayed in the facet sidebar panel in the locations selected
in the Locations field(s). Users must also have sufficient permissions to see the
facet tree.
The only valid locations you can select in the Locations field in the Availability tab
are the Enterprise Workspace, Folders, and Projects.
Allowable permissions are Administer, Read, Write, and None. By default, the custom
facet tree is given a Public Access permission of Read. It is advised that you keep this
setting. For information about setting permissions for your facet tree, see
“Administering Permissions“ on page 21.
It is possible to select the Facet Tree location from any folder's properties dialog box.
The fields in a folder's Properties dialog box, Presentation tab, are:
• Global Trees
Displays a list of the facet trees that are available globally. The trees are
displayed in ascending alphabetical order by facet tree name. Each tree is
displayed as a link which, when clicked, takes the user to the Availability tab for
the related facet tree in the facet volume.
If there are no trees to display for this field, the text “No global facet trees
found.” is displayed.
• Inherited Trees
Displays a list of the facet trees that are available at the current folder and that
are inherited from a parent object. The facet trees are displayed in ascending

alphabetical order by facet tree name. Each tree is displayed as a link which,
when clicked, takes the user to the Availability tab for the related facet tree in the
facet volume. Additionally, the name of the location from which the tree is
inherited, is displayed in light-gray text to the right of the facet tree link. The
name of the location is not displayed if the user does not have permission to view
the object. If there are no trees to display for this field, the text “No inherited
facet trees found.” is displayed.
• Local Trees
Contains an editable list of facet trees that are specifically made available to the
current folder, displayed in ascending alphabetical order.
Clicking the associated Select... button opens the targeted browse popup and
allows the Knowledge Manager to select facet trees from the Facet Volume to
add to the list of Local Trees. When a facet tree is selected from the popup, it is
added to the list of Local Trees but not saved until the page's changes are saved
in the next step. Facet trees that already appear in the list of Local Trees for the
current folder are not added if they are selected again. The associated Remove
button is disabled until at least one facet tree is selected in the list of Local Trees.
Clicking it removes the selected facet trees from the list of Local Trees, but the
changes are not saved until the page's changes are saved.
4.2.1 To Add a Column

To add a Column:
1. On the Global Menu bar, from the Tools menu, select Facets Volume.
2. Navigate to the custom facet folder in which you want to create your new
column, or create a facet folder in the Facets Volume then navigate to that new
folder.
3. From the Add Item menu, select Column.
4. In the Name field, type a unique name for your new column.
5. Optional In the Description field, type a description for your new column.
6. From the Data Source list, choose a data source for your new column.
7. Optional In the Categories field, click Edit... to either select, or add, a Category to
apply to this column.
8. Optional If you want to place the column in a location other than that which
appears in the Create In field, click Browse Content Server..., navigate to the
container where you want to locate the column, then click its Select link. Only
those areas in Content Server that can store a column will be selectable.
9. Click Add to save your new column and return to the Facets Volume.

4.2.2 To Configure a Column

To configure a Column:
1. Once you have created your custom column, you will find yourself back in the
facet folder in which you created your custom column.
From your new column's Functions menu, select Properties. Next, select
Specific.
2. On the Column Properties: <your_column_name> page, in the Width field, set

the desired width of the column in characters.
Note: A custom column displays a maximum of 64 characters of data. If

the length of the data to be displayed in the column exceeds 64 characters,
the text is truncated and suspension points (...) appear to represent the
missing data. Setting the column width to a value greater than 64
characters does not affect this limitation.
3. In the Alignment field, select the alignment for your column from the list.
4. In the Long Text field, select whether the column text will wrap or not from the
list.
5. Select the Display as link? check box to allow the column value to display as a
hypertext link.
6. In the Link URL text box, enter the URL to which the column value will link.
7. In the Display value field, enter the value that will display in the column.
8. In the Alt-text input box, enter the alt-text for the link.
9. Select the Link Target check box to select whether the link will open in a new
browser window.
10. Click Update to save your new column settings and return to the facet folder.
To make a Column available to users:
1. You must now select your new column's availability and permissions settings.
Click the functions button for your column and select Properties. Next, select
Availability.
2. In the field Column availability, select one of Not available, Available everywhere,
or Only available in specific locations.
3. If you selected one of Not available or Available everywhere, click Update to save
your changes and return to the facet folder.
If you selected Only available in specific locations, click Browse Content Server
next to the Locations text box to select those locations in Content Server that
will display your custom column. Once you have selected your locations, click
Update to save your changes and return to the facet folder.

4. Click the functions button for your column and select Properties. Next, select
Permissions.
5. On the Permissions page for your column, select the user or user group whose
permission you want to edit. In the Edit User Permissions dialog box, select the
radio button next to the permission you want assigned.
6. Click Update to save your changes.
7. Click Done to return to the facet folder.
4.2.3 To Add a Facet

To add a Facet:
2. Navigate to the custom facet folder in which you want to create your new facet,
or create a facet folder in the Facets Volume then navigate to that new folder.
3. From the Add Item menu, select Facet.
4. In the Name field, type a unique name for your new facet.
5. Optional In the Description field, type a description for your new facet.
6. From the Data Source list, choose a data source for your new facet.
apply to this facet.
8. Optional If you want to place the facet in a location other than that which appears
in the Create In field, click Browse Content Server..., navigate to the container
where you want to locate the facet, then click its Select link. Only those areas in
Content Server that can store a facet will be selectable.
9. Click Add to save your new facet and return to the Facets Volume.
4.2.4 To Configure a Facet

To Configure a Facet:
1. Once you have created your custom facet, you will find yourself back in the
facet folder in which you created your facet. Select the new facet's Functions
menu. Select Properties, then select Specific.
2. On the Facet Properties: <your_facet_name> page, select the Show in sidebar

check box to ensure that the facet will be displayed in the sidebar.
3. From the Minimum unique values list, select the minimum number of unique
values required before the facet may appear.
4. From the Maximum values to display list, select the maximum number of
unique values permitted to appear in the facet.

5. From the Display mode list, select the order in which facet values are
displayed.
Note: The available options depend on the type of the Facet.

Date-type facets do not support display mode.
6. From the Display priority list, select the priority presentation format for facet
values.
7. From the Count accuracy list, select the level of accuracy for the facet item
count.
8. Select the Show lookup in 'More...' check box to add a Type ahead look up box
to the More dialog box, if there are more than 50 unique values in the facet.
9. Click Update to save your new facet settings and return to the facet folder.
To make a Facet available to users:
1. Click the functions button for your new facet and select Properties. Select
Permissions.
2. On the Permissions page for your facet, select the user or user group whose
permission you want to edit. In the Edit User Permissions dialog box, select the
radio button next to the permission you want assigned.
4.2.5 To Add a Facet Folder

To add a Facet Folder:
2. From the Add Item menu, select Facet Folder.
Tip: Your administrator may have enabled an Add Facet Folder button to
the left of the Add Item menu.
3. In the Name field, type a unique name for your new facet folder.
4. Optional In the Description field, type a description for your facet folder.
apply to this facet folder.
6. Optional If you want to place the facet folder in a location other than that which
container where you want to locate the facet folder, then click its Select link.
Only those areas in Content Server that can store a facet folder will be
selectable.

7. Click Add to save your new facet folder and return to the Facets Volume.
4.2.6 To Add a Facet Tree

To add a Facet Tree:
2. Navigate to the custom facet folder in which you want to create your new facet
tree, or create a facet folder in the Facets Volume then navigate to that new
folder.
3. From the Add Item menu, select Facet Tree.
4. In the Name field, type a unique name for your new facet tree.
5. Optional In the Description field, type a description for your new facet tree.
apply to this facet tree.
7. Optional If you want to place the facet tree in a location other than that which
container where you want to locate the facet tree, then click its Select link. Only
those areas in Content Server that can store a facet will be selectable.
8. Click Add to validate and create your new facet tree and return to the Facets
Volume.
4.2.7 To Configure a Facet Tree

To Configure a Facet Tree:
1. Select the new facet tree's Functions menu. Select Properties then select
Specific.
2. On the Facet Tree Properties: <your_facet_tree_name> page, in the Facet Tree

definition box you will see the name of your new facet tree. To the right of your
facet tree name you will see an Add Child Facet icon, . To begin creating the
tree, click Add Child Facet.
3. A new level to your tree appears, along with a list box to allow you to select a
facet to add to your tree. Select the facet that will become your new level 1 for
your facet tree.
4. To the right of the level 1 facet you have just added to your facet tree, you will
see an Add button, , and a Remove button, . If you wish to add a second
level to your facet tree, click the Add Child Facet button. If you wish to remove
the level 1 facet you have just added, click Remove.

Note: Creating a child facet from your facet tree name creates a level 1
facet in your tree. Creating child facets on each subsequent level will add a
new level to your tree.
5. Click Update to update your selection and return to the previous page.
To make a Facet Tree available to users:
1. From the facet folder, click on the functions icon for your facet tree and select
Properties. Next, select Availability.
2. In the Facet Tree availability field, select one of the radio button options.
3. If you selected Only available in specific locations, choose the Browse Content
Server button next to the Locations input box in order to select those locations
in Content Server that will display your custom facet tree.
4. Optional Sfter you have selected one location, if you want to make your facet tree
available in an additional location, click Add Location, , to create a new
location field. Choose the Browse Content Server button to select your next
location. If, after entering a location, you want to remove that location, click
Remove Location, , next to the location you want removed.
5. Once you have selected your locations, click Update to save your changes and
return to the facet folder. Any location fields that have no value, or that have no
valid value, are not saved.
6. Click the functions icon for your column and select Properties. Select
Permissions.
7. On the Permissions page for your custom facet tree, select the user or user
group whose permission you want to edit. In the Edit User Permissions dialog
box, select the radio button next to the permission you want assigned.
4.2.8 To Select the Facet Tree Location from a Folder

To select the Facet Tree location from a folder:
1. Navigate to any folder in Content Server to which you want to apply facet tree
configuration. Click the functions button for that folder and select Properties.
Next, select Presentation.
2. If there are trees to display, in the Global Trees field, click on one tree in the list
of the facet trees that are available globally.
You will be taken to the Availability tab for the related facet tree in the facet
volume.

3. If there are trees to display, in the Inherited Trees field, click on one tree in the
list of facet trees that are inherited from a parent object.
You will be taken to the Availability tab for the related facet tree in the facet
volume.
4. Click Select... to open the targeted browse popup and select facet trees from the
Facet Volume to add to the list of Local Trees.
5. The associated Remove button is disabled until at least one facet tree is selected
in the list of Local Trees. Clicking the Remove button removes the selected facet
trees from the list of Local Trees.
6. Click Update to save your changes and return to the previous page.
4.2.9 Examples Adding Facets

Example 4-1: To make the Creation Date system attribute available as a
content filter throughout Content Server:
2. Open the System Default Facets folder.
4. In the Name field, type “Creation Date”.
5. In the Description field, type “This facet will filter content by Creation
Date.”
6. From the Data Source list, choose “Date Created”.
7. Click Add.
8. In the System Default Facets folder, select the Default System Facets
facet tree.
9. On the Default System Facets page, click the plus sign next to Default
System Facets.
10. From the list box that appears, select Creation Date from the list.
11. Click Update.
12. Navigate to the System Default Facets page, open the Creation Date
facet.
13. On the Creation Date properties page, select the Specific tab.
14. On the Specific tab, in the Minimum unique values field, increase the
value to “4”.
15. Click Update.
Example 4-2: To create a facet based on a category's attribute, and

make that facet available as a content filter to one folder only:
Note: This example assumes that you have previously created a

category called “Office Locations”, with a Text: Popup category

attribute called “Office Location”. The “Office Location” category

attribute contains a list of city names. For example: Chicago, London,
New York, Paris, Seattle, Toronto.
This example also assumes that you have previously created a folder in
the Enterprise workspace called “Offices”.
2. Open the System Default Facets folder.
3. From the Add Item menu, select Facet Folder.
4. In the Name field, type “Office Locations”.
5. In the Description field, type “Holds the Facets and the Facet Tree for
the Office Locations content filter, displayed on the Enterprise:Offices
page.”.
6. Click Add.
7. Open the Office Locations Facet Folder.
9. In the Name field, type “Office Location”.
10. In the Description field, type “This facet will filter content by the Office
Location category attribute.”
11. From the Data Source list, choose “Category:Office Locations:Office
Location”.
12. Click Add.
13. Navigate to the System Default Facets folder. From the Add Item menu,
select Facet Tree.
14. In the Name field, type “Office Locations”.
15. Click Add.
16. Open the Office Locations Facet Tree.
17. Click the plus sign next to Office Locations.
18. From the list box that appears, select Office Location from the list.
19. Click Update.
20. Open the Office Locations Facet Tree.
21. Select the Availability tab.
22. Select the Only display in specific locations button.
23. Click Browse Content Server.... Browse to the Offices folder, that you
previously created in the Enterprise workspace.
24. Click Update.

4.3. Working With the Facets Volume Control Panel
4.3 Working With the Facets Volume Control Panel

The Facets Volume Control Panel is only available to your administrator and to
Knowledge Managers. If you are not able to view the Facets Volume Control Panel,
contact your administrator to request the appropriate permissions.
The Knowledge Manager has permission to access the Configure Facet Count
Indicators and Configure Global Columns pages only. An administrator can
configure document classes and the sidebar in addition to the configuration options
available to the Knowledge Manager.
The facet count can be displayed by either numbers or graphic bar charts. If you take
a look at the Content Filter sidebar in any workspace, you will note that all facets'
values show numbers next to them. This is the default setting for Content Server.
You can change this setting by displaying the count as graphic bar charts for all
users.
The global columns page displays two dialog boxes called Displayed Columns and
Available Columns. The Displayed Columns dialog box contains the columns that
are currently displayed for all users who have permission to view the columns when
in Browse View. The Available Columns dialog box contains the available columns
that can be added to the Browse View for all users.
4.3.1 To View the Facet Volume

To view the facet volume:
1. If you are an administrator or a Knowledge Manager, from the Global Menu

Bar, select Tools then Facets Volume.
Note: If you are an administrator, you can also access the Facets Volume
from the administration home page. Select Server Configuration then
Configure Facets. Next select View Facet Volume.
2. From the Facet Volume you can also access the Facet Volume Control Panel by
selecting the Facet Volume's functions button then selecting Control Panel.
4.3.2 To Configure Facet Count Indicators

To Configure Facet Count Indicators
1. From the Global Menu Bar, select Tools then Facets Volume.
2. Click the Facets functions icon.
3. Select Control Panel from the Functions menu.
4. Select Configure Facet Count Indicators.
5. Select the radio button next to the display option you want to set.

6. Click Save Changes to save your changes and return you to the Facets Volume
Control Panel page.
4.3.3 To Configure Global Columns

1. From the Global Menu Bar, select Tools then Facets Volume.
2. Click the Facets functions icon.
3. Select Control Panel from the Functions menu.

4. Select Configure Global Columns.
5. To the right of the Available Columns box are left and right arrows, and .
Click on any column name to highlight it. Clicking the right arrow will move
the highlighted column from the Available Columns box to the Displayed
Columns box, thereby displaying that highlighted column to all users. Clicking
the left arrow will move the highlighted column from the Displayed Columns
box to the Available Columns box, thereby removing that column from view
by all users.
6. To the right of the Displayed Columns box are up and down arrows, and
, which can be used to move items up and down in display order. The order
in which the columns appear, from left to right, in Content Server Browse View
depends on the order in which they appear in the Displayed Columns box. The
first column listed in the Displayed Columns box appears at the far left of the
Browse View. Click on any column name to highlight it. Clicking the up arrow
will move the highlighted column name higher in the list in the Displayed
Columns box. Clicking the down arrow will move the highlighted column
name lower in the list in the Displayed Columns box.
7. Click Save Changes to save your changes and return to the Facets Volume
Control Panel page.

Chapter 5
Configuring Virtual Folders
Only the administrator can assign permissions to users or groups which allow them
to create Virtual Folders. For information about Virtual Folders, see OpenText
Content Server User Online Help - Working with Documents and Text Documents
(LLESWBD-H-UGD).
5.1 To Assign Users Permissions to Create Virtual

Folders
To assign users permissions to create Virtual Folders:
1. On the administration page, under the System Administration section, click

Administer Object and Usage Privileges.
2. On the Administer Object and Usage Privileges page, under the Object
Privileges section, scroll down until you find Virtual Folder under the Object
Type heading.
By default, the Create Object Status is Restricted, and the actions available
under the Actions column are Edit Restrictions and Delete All Restrictions.
3. Click the Edit Restrictions link. You will now see the Content Server Group
Members Info page titled Edit Group: Virtual Folder.
4. Using the list box and input box on the right, find the person or group to whom
you want to assign the permission to create a Virtual Folder.
5. The name of the person or group will appear on the right hand side of the page.
Under the Actions column, select the Add to group check box, then click
Submit.
6. The individual or group name will now appear in the Current Group Members
box on the left hand side of the page. Click Done.
Tip: When you want to edit the persons or groups allowed to create
Virtual Folders in the future, click the Edit Restrictions link under Actions
on the Administer Object and Usage Privileges page.

Chapter 6
Configuring Server Parameters and Settings
On the Configure Server Parameters page, you can modify performance settings,
security parameters, basic server parameters, and the Content Server port number.
You can also limit access to the Admin account by specifying specific IP addresses,
and generate a system report.
6.1 Configuring Basic Server Parameters

You can modify the following settings for the Content Server on the Configure
Server Parameters page:
• URL Prefix for /support Directory
The URL prefix, also known as the virtual directory alias, is mapped to the support
directory during the installation of Content Server. By default, the support
directory is located at the root installation level: /installation_path/support.
It is normally not necessary to change URL prefix; however, if you modify it, you
must make the change in Content Server and the web server.
The default value for the URL prefix is /img/.
Note: You must type a forward slash (/) before and after the URL prefix.
• Content Server Administrator Password

The Administrator password is one that you use to access the Administration
pages. Do not confuse this password with the password for the Admin user.
After the initial Content Server installation, you should change the default
Admin password. You can set a new Administrator password on the Configure
Server Parameters page by selecting the Change Administrator Password check
box. The new password takes effect the next time you log in as the administrator.
• Site Name
The Site Name is the name that is displayed throughout Content Server. The site
name should be a simple, user friendly name. The default Site Name is Content
Server.
• Administrator E-mail Address
If you provide an email address for the Administrator, a link to the address
appears on the User Log-in page.
• Categories Upgrade Batch Processing
This parameter enables you to set the refresh rate of the progress window during
batch Category upgrade operations. The default refresh rate is 200 items, which
means the progress window will refresh every time 200 Categories are processed.
• Configure Edit/Organize

Chapter 6 Configuring Server Parameters and Settings
This parameter allows you to specify a maximum number of items that users can
put on one page. The default is a maximum of 100 items per page.
Note: This limitation applies only to Edit/Organize pages. Pages that have
an associated Edit/Organize page include the My Favorites and My Projects
pages. When the Maximum Items Per Page limit is exceeded, Content
Server splits the Edit/Organize page into multiple pages. The limit then
applies to each split page individually.
• Default User Start Page
This parameter allows you to select one of the following pages, which is where
users are brought to when they first log in:
• Enterprise Workspace, which displays your organization's home page when

users sign in.
• My Workspace, which displays each user's Personal Workspace when users
sign in.
• About Content Server, which displays the About Content Server page when
users sign in.
Note: If you select About Content Server, you need to decide if you
want to require that your users login in order to view the page. If you
want to require that your users login, select the "About Content Server"
Requires Login check box. This option is disabled by default.
• Administer Icons for Folders
When enabled, this parameter allows users to select additional icons for Content
Server folders. This parameter is disabled by default.
• Duration of New and Modified Indicators
You can specify the number of days items have the New or Modified icons
next to them when items are added or changed. By default, the New icon
appears for 2 days after an item is added; the Modified icon appears for 7 days
after an item is changed.
• Multiple Address Separator for “mailto:” URL
You can change the character that is inserted between multiple recipient
addresses in message composition windows. If your organization predominately
uses Microsoft email applications, you should choose a semi-colon ";" for the
address separator; if your organization predominately uses other email
applications, such as Netscape, you should choose comma “,”.
• Server Logging Options
You can modify the logging options for the Admin server on the Configure
Server Parameters page or the Configure Debug Settings page. For more
information, see “Configuring Server Logging” on page 572. The following
logging options are available:

6.1. Configuring Basic Server Parameters
• No logging, which disables logging for the Content Server server. This is the
default setting.
• Thread logging, which generates the following log files in the
<Content_Server_home>/logs directory: llserver.out, sockserv1.out,
thread<c>.out (one per thread).
• Detailed thread logging, which generates the same log files as Thread
logging, but in verbose mode. Verbose mode includes information about the
relevant environment variables in the thread logs.
• Thread & CGI logging, which generates the following log files in the
<Content_Server_home>/logs directory: llserver.out, sockserv1.out,
thread<n>.out (one per thread), receiver<n>.out (one each per thread),
llclient<nnn>.out (one per request to the CGI program from an end-user
web browser), llindexupdate<nnn>.out (one per start of the Enterprise
Extractor), and indexupdateOut<nnn>.out (one per stop of the Enterprise
Extractor).
Note: When using LLServlet instead of the CGI, llclient<nnn>.out is

replaced by servletclient<nnn>.out. One file is generated for each
thread number as determined by your servlet container's Java Virtual
Machine. Each time a client browser sends LLServlet a request, a new
servletclient<nnn>.out file is created. If a file name with that
number, <nnn>, already exists, the request's information is appended to
the end of the existing file.
• In addition to configuring a Content Server logging setting, you can enable
SQL logging when you want to record the communication, in
connect<n>.log files, that occurs between the Server and the Content Server
database.
The number of connect<n>.log files is equal to the number of threads that
Content Server is running. If you are diagnosing a problem, you can
temporarily set the Content Server to run on a single thread. This allows you
to find diagnostic information in a single file. Because running on a single
thread severely impairs the performance of the Server, OpenText
recommends that you run in single thread mode during periods of low usage
only and that you return the Server to its original thread setting after you
complete your diagnosis.
Note: Database connection logs can increase in size quickly. OpenText

recommends that you enable connection logging if it is required to
diagnose a problem, but that you disable it as soon as you have acquired
the diagnostic information that you need.
• Enhanced Keyboard Accessibility Mode
Enhanced Keyboard Accessibility Mode permits the user interface to be
manipulated using keyboard commands. However, certain features that depend
on Java, such as the Text Editor, are disabled when Enhanced Keyboard
Accessibility Mode is used. This option is disabled by default. When you enable
this option, all users are required to use this mode.

• Character Set
You can specify the character set web browsers use when displaying the user
interface. For more information, see HTMLcharset in the [general] section of
the Opentext.ini File Reference.
• Upload Directory
The Upload Directory parameter is used to restrict the location from which
Content Server accepts Documents for upload. The directory specified in this
field must be accessible to both the web server and the Admin server. OpenText
recommends that you specify the full path to the directory in this field.
Note: OpenText strongly recommends that you specify an upload

directory. Leaving this field blank poses a security risk. It can also prevent
you from applying a license file. See “License Management” on page 236.
• Receive Before Send
This setting reduces the amount of time the Server must dedicate to
downloading and opening documents. The default setting for Receive Before
Send is set to TRUE. When ReceiveBeforeSend=TRUE, the Server's responses are
buffered to the web server, which then assumes control of sending the contents
to the browser. This allows the available server threads to move on to other
requests more quickly. From an end-user perspective, fetching and downloading
documents will still take the same amount of time.
• Server Threads
This setting defines the number of threads used by Content Server. The default
Number of Threads is 8. You may want to increase or decrease the number of
threads, depending on:
• the speed of individual request execution times

• the amount of capacity needed
• your usage profile
• the availability of CPU and RAM resources on your Content Server hardware
The optimum number of threads depends on the characteristics of your Content

Server environment. Items that can be considered include:
• the number, speed, and architecture (for example, NUMA) of the CPUs
• the amount of physical memory in your servers
• the speed of network connections
• whether storage is local or accessed over the network
It also depends on the usage profile for your Content Server instance (the
frequency and variety of the types of user requests).
To determine the number of threads that your server can support, OpenText
recommends that you experiment with different thread values. You can measure
your results by using Content Server logs and utilities that are available from the

6.2. Configuring Performance Settings
operating system. For more information, see “Configuring Server Logging”

on page 572.
Note: Do not set the number of threads higher than the number of
connections supported by your RDBMS.
• Number of Sessions
This setting defines the maximum number of user log-in sessions cached on a
server thread. The default value of the Number of Sessions is set to 100. When
the maximum number of sessions is reached, the oldest user log-in session is
dropped. User log-in sessions are cached independently on each thread. When a
user returns to a thread after their log-in information has been dropped from the
cache, it will take slightly longer to execute their next request. The lower the
maximum number of sessions, the less memory the server must dedicate to
tracking user log-in sessions on each thread. The larger the number, however, the
less often the server will drop user log-in information from the cache. A Server's
memory consumption can be large for a system running many threads. You may
want to try different values for the maximum number of sessions, depending on
how many users are accessing your Content Server system.
6.1.1 To Configure Basic Server Parameters

To configure basic server parameters:
1. In the Server Configuration section of the Content Server Administration page,

click the Configure Server Parameters link.
2. On the Configure Server Parameters page, modify any of the server

parameters, and then click the Save Changes button.
Note: For detailed information about the parameters on this page, see
“Configuring Basic Server Parameters” on page 71.
6.2 Configuring Performance Settings

You can modify the following Content Server performance settings on the
Configure Performance Settings page:
• “Web Caching” on page 76
• “Cache Expiration” on page 76
• “File Buffer Size” on page 76
The Configure Performance Settings page is accessible from the Administration

page. Click Server Configuration, and then click Configure Performance Settings.
Tip: In a clustered Content Server environment, the changes that you make on
the Configure Performance Settings page apply to the Content Server instance
that you are accessing, not to the entire Content Server cluster.

Web Caching
Web caching allows items served by Content Server to be cached by the web server.
By default, web caching is not enabled. OpenText recommends that you enable web
caching to improve performance.
When web caching is enabled, Content Server validates items in the web server
cache. If Content Server confirms that the cache contains the current copy of an item,
the item is delivered from the web server cache instead of from Content Server.
Cache Expiration
This setting allows you to set the time, in minutes, to keep cache data that does not
have a specified expiration. The default is 4320 minutes, which is equal to 72 hours
or 3 days.
File Buffer Size

This setting allows you to configure the file buffer size when copying items to and
from the External File Store. The file buffer size is specified in bytes. The value must
be between 16384 (16 KB) and 2097152 (2 MB). By default, the file buffer size is
524288 bytes (512 KB).
6.2.1 To Configure Performance Settings

To configure performance settings:
1. On the Content Server Administration page, in the Server Configuration

section, click Configure Performance Settings.
2. On the Configure Performance Settings page, do any of the following:
• Enable or disable web caching.

• Accept the default cache expiration setting or type a new value, in minutes,
in the Cache Keep Minutes field.
• Type the size (in bytes) used for file copy operations in the File Copy Buffer
Size field.

6.3. Configuring Security Parameters
6.3 Configuring Security Parameters

You can set options designed to help make Content Server more secure. To access
the Configure Security Parameters page, from the Content Server Administration
page select Server Configuration. Click Configure Security Parameters.
Note: For additional Content Server security features, see “Limiting Admin
Account Log-ins by IP Address” on page 85 and “Clearing Outstanding
Events” on page 832.
HTTP-only Cookies
The HTTP-only Cookies section allows you to specify whether the httpOnly
attribute is added to all Content Server cookies. If enabled, all cookies will be
marked with the httpOnly attribute. To browsers that support it, this attribute
indicates that a cookie should not be made available to scripting. By default, this
option is disabled.
Note: Enabling HTTP-only Cookies disables Cluster Management.
Cookie Encryption Key

Content Server creates an authentication cookie using the user's numeric ID and
other values that you can specify. The values that you select are necessary to
authenticate requests after logging in. The Cookie Encryption Key lets you provide
a text string for use as the key that encrypts a Content Server authentication cookie.
If a key is not specified in this field, Content Server uses a default key. However,
OpenText strongly recommends that you change this value to a unique key.
Data Encryption Key

Content Server also uses a Data Encryption Key, which lets you provide a text
string for use as the key that encrypts the database administrator's password when it
is included in a Content Server request. If a key is not specified in this field, Content
Server uses a default key. However, OpenText strongly recommends that you
change this value to a unique key.
Cookie Authentication Information

When configuring the authentication cookie, you can include the client's IP address
as a value. The Client IP address list lets you apply a bit mask when comparing the
IP addresses of different requests. The bit mask indicates which portion of the IP
address is to be compared; the nonzero elements of the IP address are compared to
the IP address placed in the cookie at log-in. For instance, if 255.255.0.0 is selected,
only the first two elements will be compared. This makes it possible to verify that
requests are coming from the same network, without requiring identical IP
addresses. By default, this field is set to 255.255.255.255 (Compare Entire IP
Address).

If selected, Enable X-Forwarded-For for Client IP mapping tells Content Server to

read the client IP address from the X-Forwarded-For HTTP header. Otherwise,
Content Server reads the IP address from the request. Trusted Proxy Server List tells
Content Server which X-Forwarded-For proxy IPs to trust.
You can optionally choose to include the Owner ID in the authentication cookie.
This is the ID of the user who created the user.
You can also set authentication cookies to expire. After the specified interval,
Content Server requires a user to log in again. Since Cookie Expiration involves
additional interaction with the database, it may have an impact on performance. By
default, cookies are set to expire 30 minutes after the last action is performed.
Log-in Cookie Expiration Date

You can set the cookie expiration date to manage cookies for the Content Server log-
in page. This parameter controls the language display when users have multiple
language packs installed. A cookie on the Content Server log-in page remembers a
user’s language selection until they are authenticated, after which it uses their
preferred language.
The cookie expiration date is calculated based on the date and time value of a user's
computer, not the date and time of Content Server. The number of days must be a
positive integer between 1 and 999. By default, the log-in cookies are set to expire
after 8 days.
Log-in Connection Policies

This section helps secure Content Server against repeated failed user logon attempts,
multiple concurrent sessions being opened by the same user, and cross-site forgery
requests..
• Enabling Disable simultaneous sessions from multiple machines prevents
users from simultaneously accessing Content Server from more than one
computer. If you enable this feature, users can sign in to Content Server from one
computer, but if they sign in a second time from another computer, the first
Content Server session is terminated.
In the except for hosts field, you can provide a comma-delimited list of IP
addresses for any computers to which this feature does not apply. Also, you can
specify a single * wildcard character to indicate multiple computers. For
example, a valid entry is: 123.45.*,192.*,123.99.2.51. By default, this option
is disabled.
• The Allow log-in via HTTP GET request setting specifies the default logon
behavior. When this option is enabled, users are allowed to sign in to Content
Server using an HTTP Get request, which stores their sign in credentials in a
bookmark. When this option is disabled, users are required to sign in again when
that session’s cookies expire. This option is disabled by default.
• The Require secure request token setting, if enabled, helps to prevent cross-site
request forgery: an attack whereby a user unknowingly initiates an action that

takes place in software to which the user has already logged on. The secure
request token is a value that is shared from the server to the browser when the
user performs certain actions. This value must accompany requests for other
actions. If the value is not present, the requested action is invalid. This option is
disabled by default.
Password Retries
This section defines the numbers of times an incorrect password can entered by a
Content Server Web Administrator and Admin before the log-in is disabled, and
whether to send an e-mail to the Administrator. By default, these options are
enabled.
Password policy for users can be set in OTDS. For more information, see OpenText
Directory Services - Installation and Administration Guide (OTDS-IWC).
The login policies include options to alert administrators of policy exceptions by e-

mail, as specified on the Configure Server Parameters page. If the Administrator e-
mail address is not specified, the notification message is not sent. For more
information about specifying the Administrator e-mail address, see “Configuring
Basic Server Parameters” on page 71.
• Web Administrator
If too many incorrect password attempts are made to enter the Web
Administrator password, the Web Administrator password entry can be disabled
for a period of time to reduce exposure to possible brute-force password
guessing.
• Disable log-in when password incorrect, which enables you to specify
actions when a Web Administrator’s log-in fails.
• Number of allowable log-in attempts before the account is disabled. By
default, this setting is enabled, and the number of allowed failed log-in
attempts is set to 5.
• Number of minutes log-in is disabled, which allows you to specify how long
the Web Administrator must wait before attempting to log-in again. By
default, this setting is enabled, and the number of minutes is set to 5.
• Send e-mail to the Administrator when log-in is disabled, which allows you
to specify the Content Server Administrator should receive an email
whenever the specified number of log-in attempts is exceeded.
• Admin
The Admin account is essential, and cannot be disabled without impacting the
system. This policy allows you to alert Admins to the possibility that someone is
trying to guess the password.
• Send e-mail to Administrator on too many password failures, which allows
you to specify whether the Content Server Administrator should receive an
email whenever the specified number of log-in attempts is exceeded.

• Password failure threshold, which allows you to specify the number of times
an Admin can attempt to log in to Content Server before an email is sent. By
default, this setting is enabled, and the number of allowed failed log-in
attempts is set to 5.
Note: The disable log-in feature does not apply to the Content Server
Admin account. You can protect the Content Server Admin account by
allowing only certain client IP addresses access. For more information
about limiting Content Server Admin account log-in attempts by IP
address, see “Limiting Admin Account Log-ins by IP Address”
on page 85.
Frame Embedding
You can optionally choose to prevent request handlers from being embedded in
external frames by selecting the Prevent request option. By default, this option is
selected.
Request Argument Filtering

When Request Argument Filtering is enabled, all client requests to Content Server
are compared with the values in the Filter String field. By default, these fields are
blank. If any matches are found, the request is rejected.
The filter list is delimited by a separator that you specify. For example, if you use a
comma (,) as the separator, type three filters as:
<Filter_A>,<Filter_B>,<Filter_C>
The separator is configurable to prevent conflicts with desired filters. For example, if
you want to use a backslash as the separator, type:
<Filter_A>\<Filter_B>\<Filter_C>
Container Size Display

The Hide Number of Items check box in the Container Size Display field prevents
users from displaying how many items are in a container.
Note: This setting applies to Prospectors as well. Prospector nodes display an

empty size value when this parameter is set.
Secure Request Token Expiration

The Secure Request Token Expiration field is part of an enhanced security
framework that allows requests to access authentication token (cookie) generation
and verification functionality. A token can be passed between sequential requests
and ensure that appropriate security checks occur. The default setting is set to
timeout after 300 seconds.

Content Server Client Hosts

The Content Server Client Hosts field contains the IP addresses of servers from
which requests are to be accepted. By default, the field is blank, and all client
connections are accepted.
Trusted Referring Websites

The Trusted Referring Websites parameter is a security measure used to prevent
other users from exploiting your website. The sites contained in this list appear in an
HTTP Referrer header, which validates HTTP requests coming from another
website. If a request comes from an unauthorized website, the action will not be
permitted, and an error message is displayed.
Note: For Enterprise Process Services Integration, you must enter the Trusted
Referring Websites parameter in the following format: http://<PW
Server>, where <PW Server> is the computer where Process Workplace (the
web server part of Enterprise Process Services) is running.
Document Functions
The Document Functions area contains radio buttons to enable and disable the
Open and View as Web Page functions in Content Server. When these functions are
enabled, users can open a document in its native application, or view them as
webpages, by clicking the document’s link. When disabled, the Open option does
not appear on a document’s Functions menu or on the Overview page. The Open
Document function is disabled by default.
Trusted Cross Domains

The Trusted Cross Domains field allows you to manage Content Server and third
party web application integrations. You register the <key> ; <target> pair where
<key> is a value to be passed in as a URL parameter and will perform the
registration lookup and <target> is a registered URL path to the target resource
(third party web application).
Note: For Enterprise Process Services Integration, you must enter the Trusted
Cross Domains parameter in the following format: pw;http://<PW
server>/pw/client/csbrowse.htm, where <PW Server> is the computer
where Process Workplace (the web server part of Enterprise Process Services)
is running.

6.3.1 To Configure Security Parameters

To configure security parameters:

click the Configure Security Parameters link.
2. On the Configure Security Parameters page, in the HTTP-only Cookies field,
click one of the following buttons:
• Enable, to include the httpOnly attribute when setting authentication

cookies.
• Disable, to exclude the httpOnly attribute from authentication cookies.
3. In the Cookie Encryption Key field, type an encryption key, as a text string
more than one character in length.
4. In the Data Encryption Key field, type an encryption key, as a text string more
than one character in length.
Warning
Although Content Server uses a default key for encryption if the Cookie
Encryption and Data Encryption fields are left blank, OpenText strongly
recommends that you enter unique keys.
5. In the Cookie Authentication Information area, do the following:
• To use the client IP address as part of the authentication cookie, click a value
in the Client IP address list that represents the portion of the client IP
address to be compared.
• To enable X-Forwarded-For for client IP mapping, select the associated
Enable box.
• In the Trusted Proxy Server List field, type the proxy server addresses that
you want to register as trusted.
• Select the Owner ID check box to choose user attributes for inclusion in the
authentication cookie.
• Click one of the following radio buttons, and, if applicable, type an integer
for the number of minutes, to manage the cookie expiration interval:
• Never Expire
• Expire <number_of_minutes> minutes after last request
• Expire <number_of_minutes> minutes after last login
6. In the Log-in Cookie Expiration Date field, select one of the following radio
buttons, and, if applicable, type an integer for the number of days, to specify
how long the current cookie authentication is valid:
• Never Expire

• Expires in <number_of_days> day(s)
7. In the Log-in Connection Policies area:
• Select the Disable simultaneous sessions from multiple machines check

box to disable a user session if the user logs in to Content Server on more
than one computer.
Specify the list of computers to which this feature does not apply in the
except for hosts field.
• Select the Allow log-in via HTTP GET request check box to enable users to
sign in through the HTTP Get request. This option is disabled by default.
8. In the Password Retries area:
• For Web Administrator:
• Select the Disable log-in when password incorrect check box to specify
actions when a user’s log-in fails.
• Specify the Number of allowable log-in attempts before the account is
disabled.
• Specify the Number of minutes log-in is disabled before the Web
Administrator can attempt to log-in again.
• Select the Send e-mail to the Administrator when log-in is disabled
check box so the Content Server Administrator will receive an email
• For Admin:
• Select the Send e-mail to the Administrator when log-in is disabled

check box so the Content Server Administrator will receive an email
• Specify the Password failure threshold for the number of times an
Admin can attempt to log in to Content Server before an email is sent.
9. In the Frame Embedding field, clear the checkbox to allow request handlers to
be embedded in external frames.
10. In the Request Argument Filtering area, do the following to enable request-
argument filtering:
• In the Filter String field, type the strings that you want to exclude from a
Content Server request. For example, to prevent a script from being saved to
Content Server as part of a Text Document, type: <Script>
Note: Avoid using a common URL character, such as a period (.) or

slash (/), as a filter.
• In the Separator Character field, type the character that is to be treated as a
separator between elements in the filter list, not part of the element itself.

11. In the Container Size Display field, select the Hide Number of Items check box
to prevent the number of items in a container from being displayed.
12. In the Secure Request Token Expiration field, click one of the following
buttons:
• Never Timeout
• Timeout <number_of_seconds> seconds after preceding request, then type an
integer for the number of seconds before a timeout occurs.
13. In the Content Server Client Hosts field, specify the servers from which client
requests are to be accepted. Multiple IP addresses must be separated by
commas. Requests originating from servers not on this list are rejected.
Note: The list of client hosts may also be used by the other Content Server
modules. Do not delete or change any existing IP addresses that may
appear in this field. Doing so could adversely affect your system.
14. In the Trusted Referring Websites field, type the HTTP web addresses that you
want to be authorized. If you are adding multiple HTTP web addresses, ensure
each address appears on a separate line.
15. Do the following in the Document Functions area:
• Click the Open function's Enabled button to allow users to open documents.
• Click the View as Web Page function's Enabled button to allow users to
view documents as web pages.
16. In the Trusted Cross Domains field, enter the following <key>;<target> pair
where <key> is a unique case-sensitive alpha-numeric tag used to register the
third party web application and <target> is a registered URL path to the target
resource.

18. The Restart Content Server page appears. Click Restart to restart automatically
(or click Continue if you prefer to restart Content Server using the operating
system). Restart your web application server, if applicable. When the Restart
Successful message appears, click Continue to return to the Content Server

6.4. Specifying the Server Port Number
6.4 Specifying the Server Port Number

The port on which the Server listens is specified during the installation process. Do
not modify it, unless a port conflict arises that cannot be resolved in any other way.
6.4.1 To Specify the Server Port Number

To specify the Server port number:
1. Click Specify Server Port in the Server Configuration section on the

2. Type an unused port number between 1,025 and 65,535, on which you want
Content Server to listen in the Port Number field.
On Linux and Solaris, only the root user has the privileges necessary to run
processes on port numbers 1 to 1,024. For this reason, OpenText recommends
that you do not use this range of port numbers for Content Server.
3. In the Family Hint field, select the address family on which Content Server
should listen for requests.
4. Click Save Changes. An error message appears, indicating that the Server did
not respond.
5. Restart Content Server and then refresh your browser. The Restart Content
Server page appears.
6. On the Restart Content Server page, click Continue (because you have already
used the operating system to restart Content Server).
6.5 Limiting Admin Account Log-ins by IP Address

By default, you can log onto Content Server as the Admin user from any IP address
that has access to your organization's computer network. However, as a security
measure, you can restrict Admin’s ability to log on to Content Server. You can
configure Content Server to prevent the Admin user from logging on unless the
logon attempt originates from an approved IP address.
The values that you add to the Allowed IP Addresses field can include an explicit IP
address or an IP address that contains an asterisk (*) that acts as a wildcard to
replace portions of the address. Using asterisks lets you include a group of
computers that have portions of their IP address in common.
Important
If you have installed OpenText™ Directory Services, the settings you make
on this page also prevent the otadmin@otds.admin user from logging on
from an unapproved IP address.

6.5.1 To Limit Admin Account Log-ins by IP Address

To limit the Admin account log-in by IP address:
1. In the Server Configuration section of the Administration page, click Limit the
Admin Account Log-in.
2. On the Limit the Admin Account Log-in page, do one of the following:
• To add an IP address, type it in the provided field, and then click Add IP
Address.
• To delete an IP address, click the address in the associated list, and then click
Delete.
Note: To allow Admin to log on locally on the Content Server computer,

you must permit logon from the IP address 127.0.0.1.
3. Click OK.
4. Restart Content Server and, if applicable, the web application server.
6.6 Configuring SLD Registration

System Landscape Directory (SLD) is a central repository of information about all of
the products or modules installed on NetWeaver. You can use the SLD Registration
page in Content Server to generate a SLD file with Content Server’s information.
Once the SLD file is generated, NetWeaver uses the information to add Content
Server to its SLD.
6.6.1 To Configure SLD Registration

To configure SLD Registration:

click the SLD Registration link.
2. On the SLD Registration page, select the type of file you want to generate in the
Type of file drop-down list, and then click the Generate button.

6.7. Generating a System Report
6.7 Generating a System Report

A System Report contains extensive details about your Content Server system. There
are two types of System Reports: the Lite System Report and the Full System Report.
Each report contains information about the following:
• System
• Licensing
• Current database
• Database server
• Application (number of Workflows, Categories, and Additional Node Attributes)
• Users and Groups
• Node types
• External storage
• Outdated date attributes
• OSpaces
• Patches
• Request handlers
• Custom modules
• Custom OSpaces
• AgentSchedule table
• LLSystemdata table information
• KIni table
• opentext.ini
• Install directory (full listing of all application files, including Modified Date and
size)
• Additional customized reports
The Full System Report also contains information about the following:
• Node versions
• Additional database properties
• Content Server database tables
• Content Server database table columns
• Content Server database indexes
• Content Server database triggers
• Content Server database stored procedures

• Content Server Tablespace Information (Oracle only)

• Document MIME Types
The generated report is a text document, called sysreport.txt, that resides in the
logs folder of your Content Server installation. When you finish generating a
System Report, its location appears as a link beside File Path on the Content Server
System Report page. Click the link to open the report.
If a System Report has previously been generated, a link to the most recent system
report appears at the top of the Content Server System Report page. To obtain an
up-to-date System Report, click Generate to create a new one.
6.7.1 To Generate a System Report

To generate a System Report:
1. In the Server Configuration section on the Administration page, click System

Report.
2. On the Content Server System Report page, enable Lite System Report or Full
System Report.
3. Click Generate.
6.8 Modifying System Configuration Files

Some system configuration settings cannot be made from the Administration pages
and instead require you to edit a configuration file. In most cases, the file that you
must edit is the opentext.ini file, which is located in the
<Content_Server_home>/config/ folder. The mime.types and mime.gif files,
located in the same folder, are other files that you may need to modify to implement
desired behaviors in Content Server. If you need to modify search settings in a
configuration file, it is likely that you will edit the otadmin.ini file.
Important
Always stop Content Server before you edit a Content Server configuration
file. Editing a configuration file while Content Server is running can result in
corruption of the configuration file and prevent Content Server from running
properly. If you are editing a configuration file that affects the Admin server
or Cluster Management, stop the Admin Server or the Cluster Agent.
After you edit a Content Server configuration file, restart Content Server and, if
applicable, the Admin server or the Cluster Agent, and your application server, so
that your changes to take effect.

6.8. Modifying System Configuration Files
6.8.1 To Modify System Configuration Files

To modify a system configuration file:
1. Log on to the primary Content Server host as the operating-system user that the
servers run as.
2. Stop Content Server. If applicable, stop the Admin server or the Cluster Agent.
3. Open the appropriate file in a text editor.

4. Edit the file as needed to implement the change.
5. Save and close the file.
6. Restart Content Server and, if applicable, the Admin server, the Cluster Agent,
and your web application server.

Chapter 7
Understanding the opentext.ini File
The opentext.ini file is the main Content Server configuration file for both
primary and secondary Content Server installations. It contains such settings as
database connection options, paths to files, date formats, debugging options, and
logging options.
The opentext.ini file is created during the Content Server installation process. At
that time, the default options are set and many settings are configured dynamically.
Some settings, such as the encoded Administrator's password and Notification
settings, are changed by Content Server as necessary.
Most of the settings that appear in the opentext.ini file can be changed on the
Content Server Administration page, but some settings must be changed by
manually editing the opentext.ini file in a text editor. For more information, see
“Modifying the opentext.ini File” on page 91.
7.1 Modifying the opentext.ini File

Although most Content Server configurations can be performed on the Content
Server Administration pages, some Content Server configurations must be
implemented by editing the opentext.ini file.
Note: If you can modify Content Server parameters either on the

Administration pages or in the opentext.ini file, it is preferable to use the
Administration pages. You should manually edit the opentext.ini file only if
you are instructed to do so by:
• an instruction in a Content Server document, such as this Help or the
OpenText Content Server - Installation Guide (LLESCOR-IGD)
• OpenText Customer Support
The opentext.ini file is located in the <Content_Server_home>/config/ folder,

where <Content_Server_home> is the root of your Content Server installation. It is
organized according to the standard Windows INI-file structure. It is composed of
sections, each of which is headed by a section name in square brackets. Each section
contains zero or more properties. These properties are in the form <name>=<value>.
The order of the sections is not important. Section titles and name strings are not
case-sensitive, but value strings are.

Chapter 7 Understanding the opentext.ini File
Settings in the opentext.ini file normally affect only a single instance of Content
Server. In a Content Server cluster, any changes that you make to the opentext.ini
file must typically be made on the opentext.ini file of every node in your cluster.
In contrast, the settings that appear on the Content Server Administration pages
typically affect every Content Server instance in your cluster, so you only need to
change a setting there once.
Important
You must stop Content Server before you edit the opentext.ini file. Make
any changes that are required, and then restart Content Server (and, if
applicable, your web application server) to put the changes into effect. In
some cases, you must also restart the Admin server.
For information about modifying other system configuration files, see “Modifying
System Configuration Files” on page 88.
7.2 Node Type Number to Name Mappings

Each node type that is defined in Content Server is identified by its subtype. A
subtype is a unique, identifying integer that is stored in the node type's LLNode and
WebNode objects.
To see the complete node type number to name mappings, run a system report and
view the “Node Types” section.
The following table shows some of the common node types for a standard Content
Server installation. If you install optional modules, your system may have additional
node types that are not listed here. Also, customizations to Content Server can create
custom node types that are not listed.
Node Type ID Node Type Description

0 Folder
1 Alias
2 Generation
128 WFMap
130 Topic
131 Category
132 Category Folder
133 VolCategories
134 Reply
136 CompoundDoc
137 VolRelease
138 Release

7.2. Node Type Number to Name Mappings

139 Revision
140 URL
141 VolLibrary
142 VolWorkbin
143 VolDiscussion
144 Document
146 CustomView
148 VolSystem
154 WorkflowAttachments
161 VolWorkflow
162 VolEditWorkflow
180 VolDomainWorkspace
190 WFStatusNode
201 ProjectVol
202 Project
204 TaskList
205 TaskGroup
206 Task
207 Channel
208 News
209 ChannelVol
210 TaskListVol
211 VolReports
212 TaskMilestone
215 Discussion
218 Poll
257 OTCIndexObj
258 SearchBroker
259 LibraryExtractor
260 Proxy
268 TemplateFolder
269 SearchManager
270 Data Flow Manager


271 Process
272 LibraryObj
273 Merge
275 Slice Folder
276 DataSourceFolder
277 DirWalker
278 SearchReport
281 IndexUpdate
282 HTMLConversion
285 XMLActivatorProd
286 XMLActivatorCon
290 BackupManager
291 BackupProcess
292 SearchTemplate
293 Importer
294 2WayTee
299 Report
335 DTDLLNode
336 VolDTD
368 IndexEngine
369 SearchEngine
370 PartitionMap
371 Partition
380 ProspectorQueries
384 Prospector
387 ProspectorSnapshot
402 VolDeletedDoc
480 Appearance
481 AppearancesVolume
482 GlobalAppearance
483 AppearanceFolder
484 VolumeFolder
541 ItemTemplateVol

7.3. Opentext.ini File Settings Reference

542 ItemTemplateVolFolder
543 ProjectTemplate
903 FacetTree
904 Facet
905 FacetFolder
7.3 Opentext.ini File Settings Reference

This section of the Admin Help describes opentext.ini file settings. The settings
are listed under the section name that they occur under, and the section names are
sorted alphabetically. Only the settings that are present in a default installation of
Content Server are covered in this section. For opentext.ini file settings that
govern the behavior of optional, custom, and third-party modules, see the
documentation that accompanies these products.
7.3.1 [AFORM]
The [AFORM] section allows you to add a setting to troubleshoot PDF forms in
Content Server. Add this section, with the setting below, to set Content Server to
create form debugging files.
wantDebug
• Description:
Instructs Content Server to create form debug files that describe the form data
retrieval from PDF forms.
• Syntax:
wantDebug=MORE
• Values:
MORE
7.3.2 [AdminHelpMap]
The [AdminHelpMap] section contains mappings that enable context-sensitive online
help for items available only to the Administrator or users with system
administration rights. Help mappings for user functionality are found in the
[HelpMap] section of opentext.ini. For more information, see “[HelpMap]”
on page 157.
A help mapping creates a link between a keyword that identifies a page of the
Content Server interface, for example, the Administration page, and the name of an
HTML online help page.

Important
OpenText recommends that you do not change the default mappings for
[AdminHelpMap] in the opentext.ini file.
7.3.3 [agents]
This section contains proprietary OpenText information.
Important
OpenText recommends that you do not change any of the options in this
section.
7.3.4 [Attributes]
The [Attributes] section controls options for implementing complex attributes.
AttributeMaxRows
• Description:
Sets the maximum number of repeating values allowed in the user interface.
• Syntax:
AttributeMaxRows=50
• Values:
An integer between 1 and 100. The default value is 50.
7.3.5 [BaseHref]
The [BaseHref] section controls options for setting the BASE HREF value in an
HTML page that includes a custom view.
Protocol
• Description:
One of either http or https.
• Syntax:
Protocol=http
Host
• Description:
The hostname of the server to include in the BASE HREF URL.
• Syntax:
Host=myhostname

Port
• Description:
The port of the web server used in the BASE HREF URL.
• Syntax:
Port=3000
• Values:
A positive integer.
7.3.6 [Catalog]
The [Catalog] section controls the default behavior of the Catalog display view for
workspaces.
NGrandChildren
• Description:
Defines the number of children to display in catalog view.
• Syntax:
NGrandChildren=6
• Values:
An integer greater than, or equal to, zero. The default value is 6.
7.3.7 [chicklet]
The [chicklet] section contains the image file that appears in the masthead in the
upper, right-hand corner. You can replace the default image, , with your
own organization's image file.
For optimum viewing, your image file should have the following properties:
Property Value
Decoded size in bytes 7064
Image dimensions in pixels 83 x 30
Color 24-bit RGB true color
Colormap none
Transparency no
The image file resides in the <Content_Server_home>/support directory, where

<Content_Server_home> is the root of your Content Server installation. If you change
the image file, restart Content Server and, if applicable, the web application server.

7.3.8 [Client]
The [Client] section of the opentext.ini file contains options specific to the
configuration of Content Server clients. The following Content Server
Administration page describes changes you can make to the [Client] section:
• “Configuring Performance Settings” on page 75
This page contains information about the following parameters:
• “ErrorRedirectURL” on page 98 • “ReceiveBeforeSend” on page 99

• “ErrorStatus” on page 98 • “StrictClientParse” on page 99
• “MaxHeaderBytes” on page 98
ErrorRedirectURL
• Description:
A URL to which users are redirected when attempting to log in to Content Server
while the server is not running, passing the information displayed on the default
page in a CGI variable called errid. Servlet client connections are not redirected.
By default, this entry is not displayed in the opentext.ini file until it is set,
which is equivalent to ErrorRedirectURL=.
• Syntax:
ErrorRedirectURL=http://www.opentext.com
• Values:
Any valid URL.
ErrorStatus
• Description:
When the server is not running, this code is sent in the HTTP header.
which is equivalent to ErrorStatus=.
• Syntax:
ErrorStatus=503
• Values:
A valid HTTP code.
MaxHeaderBytes
• Description:
Sets the maximum size of HTTP headers in bytes. Content Server uses this
setting to limit the size of the HTTP header. If the actual size of HTTP header
sent by Content Server is larger than this limit (if the HTTP header contains a

large cookie, for example), the browser might be unable to render Content Server
webpages.
which is equivalent to MaxHeaderBytes=2000.
• Syntax:
MaxHeaderBytes=2000
• Values:
A positive integer representing the maximum size of headers in bytes. The
default value is 2000.
ReceiveBeforeSend
• Description:
When set to TRUE, it hands responsibility for the downloading of files to the web
server. This frees up Content Server threads more quickly to perform other
functions.
OpenText recommends that you only modify this value using the Configure
Performance Settings page, rather than edit the opentext.ini file directly. For
more information, see “Receive before Send” in “Configuring Performance
Settings” on page 75.
• Syntax:
ReceiveBeforeSend=FALSE
• Values:
TRUE or FALSE. The default value is FALSE.
Setting this parameter to TRUE hands responsibility for the downloading of files
to the web server.
StrictClientParse
• Description:
Requires clients to be strict when parsing an input web request. It will produce
errors instead of passing on incomplete requests to the server.
• Syntax:
StrictClientParse=TRUE
• Values:
TRUE or FALSE. The default value is TRUE.
Setting this parameter to FALSE does not require the client to be strict when
parsing an input web request.

7.3.9 [dateformats]
The [dateformats] section controls how Content Server deals with dates and times.
To modify these parameters, OpenText recommends that you use the Administer
Date/Time page, rather than edit the opentext.ini file directly. For more
information, see “Setting Date and Time Formats” on page 32.
• “InputDateMinYear” • “TwoDigitYears” • “SeparateCentury”

on page 100 on page 100 on page 101
• “InputDateMaxYear” • “WantTimeZone”
on page 100 on page 101
InputDateMinYear
• Description:
Limits how many years in the past users can choose from, in the lists provided to
users.
• Syntax:
InputDateMinYear=1990
• Values:
A positive integer. The default value is 1990.
You can set this value as low as you like; there is no numeric limit. However, it is
best to set it to something that makes sense in the display.
InputDateMaxYear
• Description:
Limits how many years in the future users can choose from, in the lists provided
to users.
• Syntax:
InputDateMaxYear=2027
• Values:
A positive integer whose limit is 400,000. The default value is 2027.
It is best to set the value of this parameter to something that makes sense in the
display. A very large setting causes pages to render more slowly and can have a
noticeable effect on your performance.
TwoDigitYears
• Description:
Indicates whether Content Server displays years as two-digit numbers or four-
digit numbers.

• Syntax:
TwoDigitYears=FALSE
• Values:
Setting this parameter to TRUE displays the year 2002 as 02. If you leave the
default value, FALSE, the year 2002 is displayed as 2002.
WantTimeZone
• Description:
Indicates whether the Time Zone Offset feature is enabled.
• Syntax:
WantTimeZone=FALSE
• Values:
Setting this parameter to TRUE enables the Time Zone Offset feature.
SeparateCentury
• Description:
Indicates whether Content Server supplies one or two lists to users for year
inputs.
• Syntax:
SeparateCentury=FALSE
• Values:
Setting this parameter to TRUE supplies two lists to users for year inputs: one list
for the century, 19 and 20, and one list for the decade, 00 through 99. If you leave
the default value, FALSE, one list for year inputs is supplied.
7.3.10 [dbconnection:connection_name]
The [dbconnection:<connection_name>] section defines database connection
information and options. Each of the parameters in this section is set by the
Administrator during the installation of Content Server. The values are managed
through the Administration pages.
For more information, see “Maintaining an Existing Database“ on page 283.

7.3.11 [DCS]
The settings in the [DCS] section control the behavior of the indexing function of the
Document Conversion Service, DCS. The DCS uses different conversion filters to
convert native data to HTML or raw text within an intermediate data flow process.
After converting the documents, the DCS makes the data available to the Update
Distributor process for indexing. For more information about conversion filters, see
Livelink Search Administration - websbroker Module (LLESWBB-H-AGD).
The [DCS] section of the opentext.ini file contains the following parameters:
• “LogFileSizeInMB” • “maxuptime” • “NumRollingLogFiles”

• “LogMode” on page 103 • “mod” on page 105 • “QueueSize” on page 106
• “logLevel” on page 102
• “modreq” on page 105 • “rulesfile” on page 107
• “maxcontentrefsize”
on page 104 • “NumThreads” • “Securedelete”
• “maxoctetsize” on page 106 on page 107
on page 104
Some of the parameters in the [DCS] section of the opentext.ini file are also in the
[FilterEngine] section. The [DCS] parameters perform the same function as the
corresponding [FilterEngine] parameters; however, setting the values for the
parameters in the [DCS] section overrides the settings in the [FilterEngine]
section. If no value is specified in the [DCS] section, the value is inherited from the
[FilterEngine] section. This page contains information about the following
parameters shared by the [DCS] and [FilterEngine] sections:
• “dllpath” on page 108
• “logfile” on page 108
LogFileSizeInMB
• Description:
Specifies a limit, in MB, on the maximum size of a log file.
• Syntax:
LogFileSizeInMB=100
• Values:
An integer greater than, or equal to, 1. The default value is 100.
logLevel
• Description:
Specifies the events and information that should be written to the log file.
• Syntax:
logLevel=1

• Values:
Integer values 0, 1, 2, 3, or 4. The default value is 1.
The following table contains descriptions of the valid values for the logLevel
parameter.
Value Description
0 Disables logging
1 Only errors and documents that could not
be indexed are logged. This is the default
value.
2 Logs everything from logLevel=1, and
also logs DCS events. Examples of these
events include loading a conversion filter
and shutting down the conversion process.
also logs document conversion statistics
and document information. This
information includes the conversion time,
size of the input file, document MIME type,
OTURN, and which conversion filter was
used to convert the document.
also logs iPool processing events, and log
messages generated by the conversion
filters. This level should only be used to
help identify problems in the data flow.
LogMode
• Description:
Specifies how the DCS processes are recorded in one or more log files.
• Syntax:
LogMode = Rolling
• Values:
Valid values are:
• Rolling – saves and closes the existing log file and creates a new file, which
is the default.
• Single – adds any new information to the end of the current log file, which is
the traditional logging mode. The parameters “LogFileSizeInMB” on page 102
and “NumRollingLogFiles” on page 106 are ignored.
• Segmented – rolls over to new files when an existing log file is full, as defined
by the size specified in “LogFileSizeInMB” on page 102. The parameter
“NumRollingLogFiles” on page 106 is ignored.

maxcontentrefsize
• Description:
Specifies the maximum size, in kilobytes, of EFS (External File Storage) files the
DCS can pre-load. This setting avoids multiple disk hits to the EFS, and in some
situations, this can result in dramatic performance improvement. This setting has
no effect on non-EFS files.
• Syntax:
maxcontentrefsize=8192
• Values:
An integer greater than, or equal to, zero. The default value is 8192. A value of
zero disables this parameter.
maxoctetsize
• Description:
Specifies the maximum size, in kilobytes, of program files that can be converted
by the DCS. Some unusual text documents are occasionally identified as
application octet-stream files. Rather than discard such a document, the DCS
attempts to convert it to the UTF-8, or Unicode, character set. If this is successful,
the document is indexed.
Files larger than the specified size will be discarded without the UTF-8
conversion. Smaller values may prevent more text documents from being
indexed. Larger values may increase the amount of bad tokens indexed by the
search engine, which will impact search performance.
• Syntax:
maxoctetsize=256
• Values:
An integer. The default value is 256.
maxuptime
• Description:
Specifies the maximum time period, in minutes, before the DCS is restarted.
When your Content Server is running normally, the DCS will exit without an
error and the Admin Server will immediately restart a new instance. For a
dataflow instance of the DCS, it is preferable to define “maxtransactions”
on page 113 instead of the maxuptime parameter.
Important
Do not modify the value of this parameter unless directed to do so by
OpenText Customer Support.
• Syntax:

maxuptime=1440
• Values:
An integer greater than, or equal to, zero. The default value is 0, which is
disabled.
mod
• Description:
Specifies the section of the opentext.ini file that contains the configuration for
a conversion filter. The [DCS] section may contain several mod parameters that
correspond to different conversion filters.
Caution
Modifying the value of this parameter may prevent the DCS from
functioning, or from functioning correctly. Do not modify the values of
these parameters unless directed to do so by OpenText Customer
Support.
• Values:
The following table contains the default values for the mod parameter.
Name Value
modx01 QDF
mod03 Summarizer
modx04 DCSxpdf
modx05 Languageid
modx06 DCSmail
Note: The character x specifies that the conversion filter process will be
carried out within a worker process.
The Summarizer filter process should be carried out within the DCS, and
not a worker process.
modreq
• Description:
Specifies the request handler used by the DCS. The request handler accepts input
documents from a specific source type, such as an iPool, socket, or pipe, and
delivers the documents to the DCS to perform the conversion. After the
conversion is finished, the converted documents are returned to the request
handler and delivered to their appropriate destination, such as a client or an
iPool.

Caution
functioning, or from functioning correctly. Do not modify the value of
this parameter unless directed to do so by OpenText Customer Support.
• Values:
The default value is DCSipool.
modx10
• Description:
This parameter is required in order to use the OTDF Filter with Content Server
on the Linux® platform.
• Syntax:
modx10=DCSIm
• Values:
The only allowed value is DCSIm.
NumRollingLogFiles
• Description:
Specifies the maximum number of DCS log files. After the number of log files
you specify is created, the oldest is deleted.
• Syntax:
NumRollingLogFiles=10
• Values:
An integer greater than 0. The default value is 10.
NumThreads
• Description:
Specifies the maximum number of concurrent document conversion operations
that the DCS can perform. Changing the default value affects document
conversion performance.
• Syntax:
NumThreads=2
• Values:
QueueSize
• Description:

Specifies the maximum number of documents that the DCS queues when the
maximum number of concurrent document conversions is reached.
Important
OpenText strongly recommends that you do not modify the value of this
parameter.
• Values:
rulesfile
• Description:
Specifies the file name that defines the rules for document conversion processing
of various MIME types.
Important
parameter.
• Values:
An absolute path. The default value is <Content Server_home>\config
\dcsrules.txt, where <Content Server_home> is the root of your Content Server
installation.
Securedelete
• Description:
Specifies whether the temporary files generated by the DCS are scrubbed with
secure delete patterns to make them non-recoverable.
During index creation, the DCS generates temporary files that may contain text
or other content extracted from the files being indexed. When a temporary file is
no longer needed, the data flow uses normal system calls to delete it. In most
cases, this removes the file entry but allows an image of the file to remain on
disk.
Security-conscious sites may want to set a secure delete level, which determines
how the system overwrites the image left on the disk. The Securedelete
parameter sets the secure delete level for the DCS.
Note: If you set the Securedelete parameter to anything other than the
default, OpenText recommends that you set the secure delete level for
iPools to the same value. For more information about the secure delete
level, see “Setting Up Secure Deletion of Temporary Files” on page 747.
• Syntax:
Securedelete=0
• Values:

An integer between 0 and 4, zero and four. By default, this parameter does not
appear in the opentext.ini file, which is equivalent to Securedelete=0.
Setting this parameter to 0 turns off the secure delete functionality for DCS.
Setting this parameter to any larger value represents increasingly complex file
scrubs.
dllpath
• Description:
Specifies the location of the directory containing Content Server's conversion
filters. A document created by a word processor, such as Microsoft Word,
contains formatting information that is not necessary or required for searching.
Conversion filters extract text content that is suitable for reading and indexing
from word processor files.
• Syntax:
dllpath=C:\OPENTEXT\filters
• Values:
An absolute path. The default value is <Content Server_home>\filters, where
<Content Server_home> is the root of your Content Server installation.
logfile
• Description:
Specifies the location and prefix for the Document Conversion log file. The
admin port number assigned to this process is appended to the log file, followed
by the .log suffix. This prevents multiple processes from writing to the same file.
Note: This is a required parameter. To disable logging, set “logLevel”

on page 102=0.
• Syntax:
logfile=C:\OPENTEXT\logs\dcs
• Values:
An absolute path. The default value is <Content Server_home>\logs\dcs,
where <Content Server_home> is the root of your Content Server installation.

7.3.12 [DCSIm]
The settings in the [DCSIm] section control the configuration of the OpenText
Document Filters (IM Filter), that the Document Conversion Service (DCS) uses. The
OpenText Document Filters is an installable set of Document Conversion Service
components and associated files that extend the MIME type detection, text-
extraction, and document-conversion capabilities of Content Server.
For more information about the IM Filter, see “OpenText Document Filters”
on page 523
The [DCSIm] section of the opentext.ini file contains information about the
following parameters:
• “dllpath” on page 109 • “outputoleinfo” • “WordExcel2010HtmlVie

• “lib” on page 109 on page 109 wOn” on page 110
• “viewpagerange” • “x-timeout” on page 110
on page 110
dllpath
• Description:
Specifies the path to the directory where the DCSIm filter resources are installed.
• Syntax:
dllpath=<Content_Server_home>/filters/image
• Values:
An absolute path. The default value is <Content_Server_home>/
filters/image.
lib
• Description:
Specifies the name of the library to be loaded by the DCS. A library is a list of
operations associated with a conversion filter that the DCS reads to perform the
conversion.
• Syntax:
lib=DCSIm
• Values:
The default value is DCSIm. Modifying the value of this parameter may prevent
the DCS from functioning or functioning properly. Do not modify the value of
outputoleinfo
• Description:

Specifies whether DCSIm should extract OLE properties from the document and
retrieve only the OLE metadata tags listed in the metadataTags.txt file. OLE is
a program-integration technology that is supported by all Microsoft Office
programs. OLE allows information to be shared among different programs.
If this parameter is enabled, DCSIm extracts the standard OLE properties as well
as any custom OLE properties associated with a document.
Note: This setting applies to the Custom Regions in Office 2007 and 2010
documents such as Word, Excel, and PowerPoint.
• Syntax:
outputoleinfo=TRUE
• Values:
When outputoleinfo=TRUE only OLE metadata tags (listed in the
metadataTags.txt file) are retrieved. When outputoleinfo=FALSE, or is not
defined, then all metadata tags are retrieved.
viewpagerange
• Description:
Specifies which pages of a document DCSIm will convert to HTML for View as
Web Page.
• Syntax:
viewpagerange=all
• Values:
A range of integers from 1 to X, or all. For example, to convert only the first 10
pages to HTML, set viewpagerange=1-10. The default value is all.
WordExcel2010HtmlViewOn
• Description:
Specifies whether View as Web Page for Office 2010 formats Word and Excel is
enabled in DCSIm.
• Syntax:
WordExcel2010HtmlViewOn=TRUE
• Values:
TRUE or FALSE. When WordExcel2010HtmlViewOn=FALSE, or is not defined, View
as Web Page for Office 2010 formats Word and Excel is not enabled.
x-timeout
• Description:
Specifies the maximum number of seconds to wait before terminating a
document conversion worker process. You configure this parameter when the

default value specified in the timeout parameter is inappropriate. You configure

the timeout parameter for each conversion filter. For example, some conversion
filters convert documents slower than other conversion filters. In this case, the
timeout default value of 30 seconds may not be applicable, as the average
conversion time is longer than this value. In this case, you can modify the x-
timeout value to a higher and more appropriate value.
Warning
parameter.
• Syntax:
x-timeout=30
• Values:
The default value is inherited from the timeout parameter of the [DCSworker]
section of the opentext.ini file. The default value is 30 seconds.
Note: When both the x-timeout value and the timeout value in the
“[DCSworker]” on page 121 section of the opentext.ini file are specified, the
lower value takes effect first, and the document conversion worker process
is terminated.
The x-timeout parameter is only functional when the conversion filter it
modifies is managed by a worker process. For more information about
configuring a worker process, see “[DCS]” on page 102.
7.3.13 [DCSipool]
The [DCSipool] section controls options specific to the configuration of data
interchange pools, IPools, for the Document Conversion Service, DCS. The DCS
converts documents from their native formats to HTML or raw text for viewing and
indexing purposes. IPools are temporary storage areas that connect the processes in
a data flow. As data passes through a data flow, it is deposited in IPools. The DCS
reads data from IPools so that it can process data and convert it to HTML.
This page contains information about the following parameters shared by the
[DCSipool] and “[FilterEngine]” on page 128 sections:
• “lib” on page 112 • “MaxMetaSize” • “maxrequests”

Some of the parameters in the [DCSipool] section of the opentext.ini file are also
in the [FilterEngine] section. The [DCSipool] parameters perform the same
function as the corresponding [FilterEngine] parameters; however, setting the
values for the parameters in the [DCSipool] section overrides the settings in the
[FilterEngine] section. If no value is specified in the [DCSipool] section, the
value is inherited from the [FilterEngine] section.
The [DCSipool] section of the opentext.ini file contains information about the

• “MaxFileSize” • “maxtime” on page 113 • “window” on page 114

on page 113 • “maxtransactions”
• “minwindow” on page 113
on page 114
lib
• Description:
operations associated with a conversion filter that the DCS reads to perform
conversion.
Caution
Modifying the value of this parameter will prevent DCS from
initializing. Do not modify the value of this parameter.
• Values:
The default value is dcsipool.
MaxMetaSize
• Description:
Specifies the maximum size, in MB, of metadata that can be stored in memory
while the corresponding document is being converted. If any metadata exceeds
this value, it will be stored in a temporary file until the associated document has
been converted.
Important
parameter.
• Values:
An integer greater than one. The default value is 8.
Note: Specifying a value larger than the default may cause the DCS to
consume more memory.
maxrequests
• Description:
Specifies the number of documents that the DCS reads from the IPool.
Important
parameter.
• Values:

The value should correspond to the NumThreads parameter in the [DCS] section
of the opentext.ini reference section so that the indexing process can
synchronize effectively. For further information, see “[DCS]” on page 102
Note: This parameter is not set in the default opentext.ini file. When no
value is specified, the default value matches the setting specified for the
NumThreads parameter in the [DCS] section.
MaxFileSize
• Description:
Specifies the maximum size, in MB, of a file that can be converted in memory.
• Syntax:
MaxFileSize=8
• Values:
maxtime
• Description:
Specifies the maximum amount of time, in milliseconds, to allow for processing
of an IPool transaction. When a transaction exceeds this time limit, the
transaction is committed after the current IPool message has been fully
processed, regardless of whether the window or minwindow criteria have been
satisfied.
This parameter is the last of three throughput-limiting mechanisms in the
[FilterEngine] section of the opentext.ini file, after the window and
minwindow parameters.
• Syntax:
maxtime=120000
• Values:
An integer greater than, or equal to, one. The default value is 120000, or two
minutes.
maxtransactions
• Description:
Specifies the maximum number of iPool messages to process before the DCS is
restarted. When your Content Server is running normally, the DCS will exit
without an error and the Admin Server will immediately restart a new instance.
The “maxuptime” on page 104 parameter can also be used to restart the DCS, but
OpenText recommends you use the maxtransactions parameter.

Important
• Syntax:
maxtransactions=5000
• Values:
An integer greater than, or equal to, zero. The default value is 0, which is
disabled.
minwindow
• Description:
Specifies the minimum number of IPool messages to process from the read IPool
area before the DCS commits an IPool transaction. If the number of available
messages in the read area is less than the value specified for the minwindow
parameter, the transaction will be committed after the DCS processes the last
IPool message.
This parameter is the second of three throughput-limiting mechanisms in the
[FilterEngine] section of the opentext.ini file, after the window parameter
and before the maxtime parameter.
• Syntax:
minwindow=5
• Values:
An integer greater than, or equal to, one. The default value is 5.
window
• Description:
Specifies the maximum number of IPool messages to be processed from the IPool
read area before the DCS commits an IPool transaction.
This parameter is the first of three throughput-limiting mechanisms in the
[FilterEngine] section of the opentext.ini file, followed by the minwindow
and maxtime parameters.
• Syntax:
window=10
• Values:
Note: Setting this value higher than the default improves conversion filter
throughput but also increases the amount of disk space used by the DCS.

7.3.14 [DCSpipe]
The settings in the [DCSpipe] section control the inter-process communication
between a Document Conversion Service, DCS, client process and the DCS. The DCS
converts documents from their native formats to HTML or raw text for viewing and
indexing purposes. DCSs are managed by Admin servers. The parameters in the
[DCSpipe] section are only used when the Admin server that manages a DCS is not
running, or the DCS is disabled. In these cases, a new DCS service that reads from
the parameters specified in the [DCSpipe] section of the opentext.ini file is
launched.
Lib
• Description:
conversion.
Modifying the value of this parameter may prevent the DCS from functioning or
from functioning properly.
Important
• Values:
The default value is dcspipe.
7.3.15 [DCSservers]
The [DCSservers] section is a compilation of running Document Conversion
Service (DCS) servers in Content Server. The DCS converts documents from their
native formats to HTML or raw text for viewing and indexing purposes. DCSs are
managed by Admin servers. Clients of DCS, such as LLView and hit highlight, use
this section to discover available DCS servers. This list is refreshed each time
Content Server is required to load an Admin server.
Server1
• Description:
Specifies an enumeration of available DCS servers.
The value of this parameter is set automatically and updated periodically by the
Admin server.
Important
• Values:

An integer. The value of this parameter is generated dynamically.
SpawnExe
• Description:
Specifies the name of the DCS binary that Content Server uses to perform
document conversion operations. The value of this parameter is set automatically
and updated periodically by the Admin server.
Important
• Values:
The default value is dcs.exe on Windows. On other platforms, the default
setting is dcs.
SpawnIni
• Description:
Specifies the ini file to be used when DCS is not persistent. The value of this
parameter is set automatically and updated periodically by the Admin server.
Important
• Values:
An absolute path. The default value is <Content_Server_home>/
config/opentext.ini, where <Content_Server_home> is the root of your Content
Server installation.
7.3.16 [DCSview]
The settings in the [DCSview] section control the operation of the Document
Conversion Service, DCS, for viewing and hit highlighting documents inside
Content Server. The DCS converts documents from their native formats to HTML or
raw text. DCSs are managed by the Admin servers. The parameters in the
[DCSview] section are only used when the Admin server is not running or the DCS
managed by the Admin server is not enabled. You can also configure this service
when you configure an Admin server. The parameters you specify when you
configure an Admin server override the values in the [DCSview] section of the
opentext.ini file. For more information about the parameters you can configure
when you configure an Admin server, see “Configuring Server Parameters and
Settings“ on page 71.
The [DCSview] section of the opentext.ini file contains information about the

• “logLevel” on page 117 • “modreq” on page 118 • “QueueSize” on page 119

• “mod” on page 118 • “NumThreads” • “rulesfile” on page 120
on page 119
Some of the parameters in the [DCSview] section of the opentext.ini file are also
in the [FilterEngine] section. The [DCSview] parameters perform the same
values for the parameters in the [DCSview] section overrides the settings in the
[FilterEngine] section. If no value is specified in the [DCSview] section, the value
is inherited from the [FilterEngine] section.
This page contains information about the following parameters shared by the
[DCSview] and [FilterEngine] sections:
• “dllpath” on page 120 • “logfile” on page 120
logLevel
• Description:
Specifies the events and information that should be written to the log file.
• Syntax:
logLevel=1
• Values:
Integer values 0, 1, 2, 3, or 4. The default value is 1.
The following table contains descriptions of the valid values for the logLevel
parameter.
Value Description
0 Disables logging
1 Only errors and documents that could not
be indexed are logged. This is the default
value.
also logs DCS events. Examples of these
events include loading a conversion filter
and shutting down the conversion process.
also logs document conversion statistics
and document information. This
information includes the conversion time,
size of the input file, document MIME type,
OTURN, and which conversion filter was
used to convert the document.

Value Description
also logs iPool processing events, and log
messages generated by the conversion
filters. This level should only be used to
help identify problems in the data flow.
mod
• Description:
Specifies the section of the opentext.ini file that contains the configuration for
a conversion filter. The [DCSview] section may contain several mod parameters
that correspond to different conversion filters.
Caution
functioning, or from functioning properly. Do not modify the values of
these parameters unless directed to do so by OpenText Customer
Support.
• Values:
The following table contains default values for the mod parameter.
Name Value
modx02 QDF
modx03 DCStext
modx04 DCSxpdf
modx06 DCSmail
Note: The character x specifies that the conversion filter process will be
carried out within a worker process.
modreq
• Description:
Specifies the request handler used by the DCS. The request handler accepts input
documents from a specific source type, such as an IPool, socket, or pipe, and
delivers the documents to the DCS to perform the conversion. After the
conversion is finished, the converted documents are returned to the request
handler and delivered to their appropriate destination, such as a client or an
IPool.

Caution
functioning, or from functioning properly. Do not modify the value of
• Values:
The default value is DCSpipe.
modx10
• Description:
This parameter is required in order to use the OTDF Filter with Content Server
on the Linux® platform.
• Syntax:
modx10=DCSIm
• Values:
The only allowed value is DCSIm.
NumThreads
• Description:
Specifies the maximum number of concurrent document conversion operations
that the DCS can perform. Changing the default value affects document
conversion performance.
• Syntax:
NumThreads=1
• Values:
QueueSize
• Description:
Specifies the maximum number of documents that the DCS queues when the
maximum number of concurrent document conversions is reached.
Important
parameter.
• Values:

rulesfile
• Description:
Specifies the file name that defines the rules for document conversion processing
of various MIME types.
Important
parameter.
• Values:
An absolute path. The default value is <Content_Server_home>\config
\dcsrest.txt, where <Content_Server_home> is the root of your Content Server
installation.
dllpath
• Description:
• Syntax:
• Values:
An absolute path. The default value is <Content_Server_home>\filters,
where <Content_Server_home> is the root of your Content Server installation.
logfile
• Description:
• Syntax:
logfile=C:\OPENTEXT\logs\dcsview
• Values:
An absolute path. The default value is <Content_Server_home>\logs\dcsview,
Note: This is a required parameter. To disable logging, set “logLevel”

on page 117 to 0.

7.3.17 [DCSworker]
The settings in the [DCSworker] section control the behavior of the worker processes
managed by the Document Conversion Service (DCS). The DCS converts documents
from their native formats to HTML or raw text for viewing and indexing purposes.
The DCS sends documents to a worker process named dcsworker.exe. This worker
process delegates conversion operations to the appropriate conversion filters after
receiving requests from the DCS. It loads the requested conversion filter and
performs the conversion in an isolated environment. This prevents damaging
processes from terminating the DCS.
The [DCSworker] section of the opentext.ini file contains information about the
• “fastinit” on page 121 • “maxcalls” on page 122 • “workerexe” on page 123

• “lib” on page 121 • “timeout” on page 122 • “x-maxmemory”
on page 123
fastinit
• Description:
Specifies whether external conversion filters should be loaded when the DCS
starts.
• Syntax:
fastinit=FALSE
• Values:
TRUE or FALSE. The default setting is FALSE.
Setting this parameter to TRUE instructs the DCS to wait until the conversion
filter is required for the conversion process before loading it. Setting this
parameter to TRUE results in a quicker performance time.
lib
• Description:
conversion.
Caution
• Values:
The default value is dcsworker.

maxcalls
• Description:
Specifies the maximum number of conversion operations that a worker process
should perform before it is stopped. A worker process will stop once its
document conversion quota reaches the value specified in the maxcalls
parameter. This mechanism is provided to prevent conversion filters that may
have memory leaks from using too much memory.
• Syntax:
maxcalls=200
• Values:
The default value is 200.
Note: This setting can be customized for each conversion filter by

configuring the x-maxcalls parameter in the opentext.ini file section for
the appropriate conversion filter.
timeout
• Description:
document conversion worker process.
The DCS monitors the time that worker processes spend converting documents
and terminates the worker processes that exceed this limit. This timeout
threshold is defined by the timeout parameter.
When the worker process tries to convert a corrupt or otherwise badly formed
document, it fails and returns an error code to the worker process. Some
documents, however, can cause the filtering system to remain in an infinite
processing loop. On rare occasions, the conversion filter progressively uses up
system resources while in this infinite loop.
The worker process has a default timeout value of 30 seconds, after which it
stops the worker process. However, if the worker process is using up memory
quickly, it could consume all the available memory before the 30 seconds have
elapsed. In this case, you can lower the timeout value so that the conversion
filter will not consume all the memory before it times out.
The value of the timeout parameter should be as low as possible, without
causing the conversion process to end before a valid document can be converted.
You can estimate an appropriate timeout value by enabling logging for a
reasonable period of time, for example 24 hours, and examining the maximum
amount of time the process spends converting a valid document. The length of
the maximum valid conversion time is usually a small number of seconds. Once
you have determined this value, you can change the timeout value to one and a
half or two times the maximum valid conversion time. The additional time
allows for documents that are larger than those that were converted during the
test period.

• Syntax:
timeout=30
• Values:
Note: This parameter also appears in the [FilterEngine] section of the

opentext.ini file. This parameter performs the same function as the
corresponding [FilterEngine] parameter; however, setting the value for
this parameter in the [DCSworker] section overrides the setting in the
[FilterEngine] section. If no value is specified in the [DCSworker]
section, the value is inherited from the [FilterEngine] section.
This setting can be customized for each conversion filter by configuring the
x-timeout parameter in the opentext.ini file section for the appropriate
conversion filter.
workerexe
• Description:
Specifies the name of the worker process program used by Content Server to
perform document conversion operations.
Important
parameter.
• Values:
The default value is dcsworker.exe on Windows. On other platforms, the
default value is dcsworker.
x-maxmemory
• Description:
Specifies the maximum memory, in MB, that a worker process will use to
perform document conversion operations.
• Syntax:
x-maxmemory=2048
• Values:
An integer greater than, or equal to, 128. Using a lower value is possible, but this
will cause the worker process to end before the filters are even loaded into
memory. The default value is 2048 (2GB). Setting to 0 will disable the memory
limit.

7.3.18 [DCSxpdf]
The [DCSxpdf] section controls the settings of the XPDF filter. The XPDF filter is
used by the Document Conversion Service, DCS, to convert PDF files into plain text
for indexing purposes.
The [DCSxpdf] section of the opentext.ini file contains information about the
• “dllpath” on page 124 • “startdir” on page 124 • “x-timeout” on page 125

• “lib” on page 124 • “x-maxcalls” on page 125
dllpath
• Description:
Specifies the path to the directory where the XPDF filter resources are installed.
• Syntax:
dllpath=C:\OPENTEXT\filters\xpdf
• Values:
An absolute path. The default value is <Content_Server_home>\filters\xpdf,
lib
• Description:
conversion.
Caution
• Values:
The default value is dcsxpdf.
startdir
• Description:
Specifies the path to the directory from which the XPDF filter executes.
• Syntax:
startdir=C:\OPENTEXT\filters\xpdf
• Values:

An absolute path. The default value is <Content_Server_home>\filters\xpdf,

x-maxcalls
• Description:
Specifies the number of times a worker process is reused for processing
documents. During document conversion, the DCS loads a worker process. The
worker process loads the appropriate conversion filter and uses it to convert the
document. To increase performance, the DCS reuses the worker process for
multiple conversions. If the worker process encounters an error, the process is
stopped before reaching the value specified in the opentext.ini file.
Important
parameter.
• Values:
The default value is inherited from the maxcalls parameter of the [DCSworker]
section of the opentext.ini file.
Note: The x-maxcalls parameter is only functional when the conversion

filter it modifies is managed by a worker process. For more information
about configuring a worker process, see “[DCS]” on page 102.
Specifying a value for x-maxcalls will override the value of maxcalls in
the [DCSworker] section of the opentext.ini file.
x-timeout
• Description:
filters convert documents slower than other conversion filters. In this case, the
timeout default value of 30 seconds may not be applicable, as the average
Important
parameter.
• Values:

Note: The x-timeout parameter is only functional when the conversion

about configuring a worker process, see “[DCS]” on page 102.
Specifying a value for x-timeout will override the value of timeout in the
[DCSworker] section of the opentext.ini file.
7.3.19 [EditableMimeTypes]
• Description:
The [EditableMimeTypes] section is a list of MIME types that can be edited in
Content Server using the Text Edit feature. For more information about the Text
Edit feature, see OpenText Content Server User Online Help - Working with
Documents and Text Documents (LLESWBD-H-UGD).
• Values:
The following is an example of the [EditableMimeTypes] section in the
opentext.ini file:
[EditableMimeTypes]
text/html=TRUE
text/plain=TRUE
text/tab-separated-values=TRUE
text/xml=TRUE
text/xsl=TRUE
text/x-setext=TRUE
text/x-sgml=TRUE
7.3.20 [ExcludedMimeTypes]
• Description:
The [ExcludedMimeTypes] section controls the behavior of the Enterprise
Extractor process. By including a MIME type in this section, you instruct the
Enterprise Extractor to ignore the content of documents of that MIME type,
extracting only the metadata from documents of that MIME type in the Content
Server database. Examples of metadata include the name of the document and
the date the document was created.
There are many file types whose content you may not want to index, such as
audio and image files, whose content is not textual. When the content of such file
types passes through the Enterprise Index data flow, it takes time and resources
to process, even though it yields no useful result. Therefore, adding the MIME
types of these and similar file types to the [ExcludedMimeTypes] section
improves the efficiency of the Enterprise Index data flow by preventing data that
you do not want to index from passing through it.
Note: When a user adds a document to the Content Server database,

Content Server records the MIME type that is reported by the user's web
browser. Make certain that all web browsers used to connect to Content
Server are configured properly. If a user's web browser is misconfigured, it

may in some cases report an incorrect MIME type. If a web browser

incorrectly reports a MIME type that appears in the [ExcludedMimeTypes]
section, the content of the document is not extracted and indexed, even
though its actual MIME type may be one for which you want to index
content.
• Values:
The following is an example of the [ExcludedMimeTypes] section in the
opentext.ini file:
[ExcludedMimeTypes]
audio/basic=TRUE
audio/mpeg=TRUE
audio/x-aiff=TRUE
audio/x-wav=TRUE
image/gif=TRUE
image/ief=TRUE
image/jpeg=TRUE
image/tiff=TRUE
image/x-bmp=TRUE
image/x-cmu-raster=TRUE
image/x-pcx=TRUE
image/x-pic=TRUE
image/x-pict=TRUE
image/x-portable-anymap=TRUE
image/x-portable-graymap=TRUE
image/x-portable-pixmap=TRUE
image/x-rgb=TRUE
image/x-xbitmap=TRUE
image/x-xpixmap=TRUE
image/x-xwindowdump=TRUE
video/mpeg=TRUE
video/quicktime=TRUE
video/x-msvideo=TRUE
video/x-sgi-movie=TRUE
Note: Although the entries in the [ExcludedMimeTypes] section appear in

the form <MIME_type>=TRUE, Content Server ignores the value after the equals
sign. Setting a MIME type to FALSE has no effect. To include a particular
MIME type for indexing, place a pound sign, #, in front of the MIME type
entry or remove it altogether.
For more information about the Enterprise Extractor process and the Enterprise
Index, see “Creating the Enterprise Index” on page 407 and “Configuring the
Enterprise Extractor Process” on page 481.

7.3.21 [FetchMimeTypes]
• Description:
The [FetchMimeTypes] section includes MIME types of files that Content Server
should always download rather than attempt to open or fetch.
Important
section.
• Values:
The following is an example of the [FetchMimeTypes] section in the
opentext.ini file:
[FetchMimeTypes]
type1=application/x-msdownload
type2=application/octet-stream
7.3.22 [FilterEngine]
The settings in the [FilterEngine] section control the central behavior of the
Document Conversion Service, DCS. The DCS converts documents from their native
formats to HTML or raw text for viewing and indexing purposes. To do so, the DCS
uses document conversion filters. For information about document conversion
filters, see Livelink Search Administration - websbroker Module (LLESWBB-H-AGD).
There are three ways to configure the DCS.
• You can globally configure all DCSs at your site by setting the parameters in the
[FilterEngine] section of the opentext.ini file.
• You can globally configure the specific settings for a conversion filter in one of
the following opentext.ini file sections: [DCS], [DCSworker], [DCSxpdf],
[DCSservers], [DCSview], [DCSpipe], [DCSipool], [QDF], [DCSIm], and
[Summarizer].
• You can locally configure an individual DCS by setting command line arguments
for the DCS.
Some of the parameters in the DCS sections of the opentext.ini file and some of
the DCS command line arguments are also parameters in the [FilterEngine]
section. The DCS parameters and command line arguments perform the same
values for parameters in the DCS sections of the opentext.ini file or in the DCS
command line arguments overrides the settings in the [FilterEngine] section.
The [FilterEngine] section of the opentext.ini file contains the following

parameters:

• “conntenttruncsize” • “summary” on page 130 • “tmpdir” on page 132

on page 129 • “window” on page 133
• “summaryhotwords”
• “dllpath” on page 129 • “minwindow”
on page 131
• “encoding<n>” on page 133
on page 129 • “summarysentences” • “maxtime” on page 134
on page 131
• “logfile” on page 130
• “maxfilesize” • “timeout” on page 131
on page 130
conntenttruncsize
• Description:
Specifies the maximum truncated size, in MB, DCS will use when converting
documents from their native formats. When the document exceeds this limit, it
will be truncated.
• Syntax:
conntenttruncsize=8
• Values:
An integer equal to or greater than 1. The default value is 10.
dllpath
• Description:
• Syntax:
• Values:
An absolute path. The default value is <Content_Server_home>\filters,
encoding<n>
• Description:
The encoding<n> parameter allows you to specify multiple character encoding
values, which can enable successful character encoding conversion for indexed
documents. The DCS will attempt to detect the character encoding of text
documents that are being indexed. If the DCS is not able to detect the encoding, it
will attempt UTF-8 character encoding using the encoding values specified for
this parameter. The DCS attempts to use the encoding values in the order that
they are listed in the [FilterEngine] section. The DCS continues to attempt

character encoding until it either is successful or runs out of valid encoding

values to try. The first encoding value for which the data can be successfully
converted is considered to be the correct encoding. Each encoding<n> entry in
the [FilterEngine] section must have the following format:
encoding<n>=<encodingvalue>, where <n> is a unique number.
In the example shown in the Syntax section below, the DCS would attempt to
convert documents using the Shift JIS encoding. If the Shift JIS encoding
fails, the DCS would then attempt to use the EUC-JP encoding.
• Syntax:
encoding1=Shift JIS
encoding2=EUC-JP
• Values:
A character encoding specification name. If no value is specified for this
parameter, ISO-8859-1 is used. If you do not include the encoding<n>
parameter in the opentext.ini file at all, the DCS uses Latin-1 encoding by
default. For more information, contact OpenText Customer Support.
logfile
• Description:
• Syntax:
logfile=C:\OPENTEXT\logs\dcs
• Values:
An absolute path. The default value is <Content_Server_home>\logs\dcs,
Note: This is a required parameter. To disable logging, set logLevel to 0.
maxfilesize
• Description:
Specifies the maximum size, in MB, of a file that can be converted in memory.
• Syntax:
maxfilesize=8
• Values:
summary
• Description:

Specifies whether the DCS generates summaries of the documents that it

converts to HTML. If the user sets their search display options to show
summaries, Content Server displays these summaries with search results on the
Search Result page.
By default, the summary parameter is set to TRUE on the command line of each
DCS. To set the summary parameter to FALSE, you must modify the command
line of each DCS rather than change the parameter in the opentext.ini file,
since arguments set on the command line override the global parameters set in
the opentext.ini file. For more information, see “Command Line Arguments”
on page 585.
• Values:
A value of TRUE means that the DCS generates summaries. A value of FALSE
means that the DCS does not generate summaries.
summaryhotwords
• Description:
Specifies the number of hotwords that the summarizer uses to generate a
document summary. Reducing this value may speed up summarization, but
there are many other variables that also affect the speed of this process.
Important
OpenText strongly recommends that you not modify the value of this
parameter.
• Values:
summarysentences
• Description:
Specifies the number of sentences to generate in summaries.
• Syntax:
summarysentences=5
• Values:
An integer greater than, or equal to, one. By default, this parameter does not
appear in the [FilterEngine] section of the opentext.ini file, which is
equivalent to summarysentences=5.
timeout
• Description:
Specifies the maximum number of seconds to wait before terminating a worker
process.

The DCS monitors the time that worker processes spend converting documents
and terminates the worker processes that exceed this limit. This timeout
threshold is defined by the timeout parameter.
When the worker process tries to convert a corrupt or otherwise badly formed
document, it fails and returns an error code to the DCS. Some documents,
however, can cause the filtering system to remain in an infinite processing loop.
On rare occasions, the conversion filter progressively uses up system resources
while in this infinite loop.
The DCS has a default timeout value of 30 seconds, after which it stops the
worker process. However, if the worker process is using up memory quickly, it
could consume all the available memory before the 30 seconds have elapsed. In
this case, you can lower the timeout value so that the conversion filter will not
consume all the memory before it times out.
The value of the timeout parameter should be as low as possible, without
causing the conversion process to end before a valid document can be converted.
You can estimate an appropriate timeout value by enabling logging for a
reasonable period of time, for 24 hours for example, and examining the
maximum amount of time the process spends converting a valid document. The
length of the maximum valid conversion time is usually a small number of
seconds. Once you have determined this value, you can change the timeout
value to one and a half or two times the maximum valid conversion time. The
additional time allows for documents that are larger than those that were
converted during the test period.
The value of the timeout parameter can also be customized for each conversion
filter. This is done by specifying the parameter x-timeout in the INI section of
each conversion filter.
• Syntax:
timeout=30
• Values:
tmpdir
• Description:
Note: In the Windows version of Content Server, this value has no effect.
All temporary files are written to the directory specified by the TMP
environment variable.
This parameter specifies the directory that DCSs use to store temporary
conversion files. Temporary conversion files are files with .in and .out
extensions, and the temporary files created by the filtering system. The value of
this parameter can be no larger than 256 bytes.

In Linux and Solaris operating systems, OpenText recommends that you use
the /tmp directory as the temporary directory for DCSs. Specifying a temporary
file system, such as /tmp for Linux and Solaris, significantly improves the
performance of DCSs. In Linux and Solaris versions of Content Server, the
tmpdir parameter is set by default to /tmp during the installation of Content
Server.
Sometimes, temporary files are discarded by abnormally terminated worker
processes in Linux or Solaris. OpenText recommends that you clean up the
temporary directory on a regular basis.
• Syntax:
tmpdir=/tmp
• Values:
An absolute path.
window
• Description:
Specifies the maximum number of IPool messages to be processed from the IPool
read area before the DCS commits an IPool transaction.
This parameter is the first of three throughput-limiting mechanisms in the
[FilterEngine] section of the opentext.ini file, followed by the minwindow
and maxtime parameters.
• Syntax:
window=10
• Values:
Note: Setting this value higher than the default improves conversion filter
throughput but also increases the amount of disk space used by the DCS.
minwindow
• Description:
Specifies the minimum number of IPool messages to process from the read IPool
area before the DCS commits an IPool transaction. If the number of available
messages in the read area is less than the value specified for the minwindow
parameter, the transaction will be committed after the DCS processes the last
IPool message.
This parameter is the second of three throughput-limiting mechanisms in the
[FilterEngine] section of the opentext.ini file, after the window parameter
and before the maxtime parameter.
• Syntax:
minwindow=5

• Values:
maxtime
• Description:
Specifies the maximum amount of time, in milliseconds, to allow for processing
of an IPool transaction. When a transaction exceeds this time limit, the
transaction is committed after the current IPool message has been fully
processed, regardless of whether the window or minwindow criteria have been
satisfied.
This parameter is the last of three throughput-limiting mechanisms in the
[FilterEngine] section of the opentext.ini file, after the window and
minwindow parameters.
• Syntax:
maxtime=120000
• Values:
An integer greater than, or equal to, one. The default value is 120000, or two
minutes.
7.3.23 [filters]
The [filters] section controls the behavior of the document-viewing program,
llview.
• “autoRecMimeTypes” • “logfile” on page 135 • “TypeSense” on page 135

on page 134 • “relativeLinkMimeTypes”
• “filterPath” on page 134 on page 135
autoRecMimeTypes
• Description:
Instructs Content Server to perform autorecognition of files of the specified
MIME types.
• Syntax:
autoRecMimeTypes=application/octet-stream
• Values:
A comma-separated list of valid MIME types. The default value is
application/octet-stream.
filterPath
• Description:

Location of the directory containing the document viewing filters.

• Syntax:
filterPath=C:\OPENTEXT\filters\
• Values:
An absolute path. The default value is <Content_Server_home>\filters\,
logfile
• Description:
To instruct Content Server to log filter activity, add a logfile entry to the
[filters] section. This activates filter logging and places the log entries in the
file you specify.
• Syntax:
logfile=C:\filters\<logfile_name>
• Values:
An absolute path and file name. OpenText recommends:
<Content_Server_home>\filters\<logfile_name>, where
<Content_Server_home> is the root of your Content Server installation and
<logfile_name> is the name of your log file.
relativeLinkMimeTypes
• Description:
When opening documents of a MIME type contained in this parameter, Content
Server translates relative links within the document to other files so that clicking
a relative link will fetch the proper item, provided the referenced item is also
stored in Content Server.
• Syntax:
relativeLinkMimeTypes=text/html,application/pdf
• Values:
A comma-separated list of MIME types. The default value is:
relativeLinkMimeTypes=text/html,application/pdf
TypeSense
• Description:
Governs document view and fetch behavior.
• Syntax:
TypeSense=BROWSER
• Values:

BROWSER or SERVER. The default value is BROWSER.

If this parameter is set to BROWSER, attempting to open a document causes
Content Server to refer to the ViewableMimeTypes section. If the document's
MIME type appears there, Content Server executes a fetch rather than attempting
to open the document. If this parameter is set to SERVER, attempting to open a
document causes Content Server to search the INSOViewableMIMETypes list in
the [filters] section. If the document's MIME type appears there, Content
Server opens the document rather than executing a fetch.
7.3.24 [general]
Many of the parameters in the [general] section are set during the installation
process.
OpenText recommends that you use the Content Server Administration pages to
make changes to INI parameters. You should only modify the opentext.ini file
when a parameter is not available on the administration page. The following
Content Server Administration pages describe changes you can make to the
[general] section:
• “Understanding the Administration Page” on page 17

• “Configuring Basic Server Parameters” on page 71
• “Clearing Outstanding Events” on page 832

• “AdminIndexStyle” • “HaveSeenSetupPage” • “MaxUsersInGroup”

• “AdminMailAddress” • “HaveValidatedDBAdmi • “MaxUsersToListPerPage
on page 138 nServers” on page 145 ” on page 151
• “adminpwd” on page 138 • “HaveValidatedEnterpris
eDataSource” • “MessageClearInterval”
• “CaseInsensitiveQueries” on page 146 on page 152
on page 138
• “HaveValidatedFacetsVol • “NavigationOption”
• “dbconnretries” ume” on page 146 on page 152
on page 139 • “HaveValidatedReSyncPa
• “Debug” on page 139 ge” on page 147
• “NewsDftExpiration”
on page 152
• “DefaultContentRH” • “HaveValidatedSearchCo
on page 140 mponents” on page 147 • “NTPATH” on page 153
• “DefaultRH” on page 141 • “HaveValidatedWarehou • “NTSERVICENAME”
seVolume” on page 147
• “DFTAutoLoginStr” on page 153
on page 141 • “HTMLCharset”
on page 148 • “NumOldLogs”
• “dftConnection” on page 153
on page 142
• “htmlImagePrefix”
on page 148 • “OTHOME” on page 154
• “DisableSelectReservedBy
• “INDEXHOME”
” on page 142 • “PauseSleep”
on page 148
• “DisplayServerName” on page 154
• “InstallAdminPort”
on page 143
on page 149 • “Port” on page 154
• “DocModTimeInDays” • “integrity” on page 149
on page 143 • “Profile” on page 155
• “LLIndexHTMLFile”
• “DocNewTimeInDays” on page 149 • “ProfileFormat”
• “LLIndexRequiresLogin”
• “EnableAutoRestarts” on page 150 • “ScheduleHandlerClearIn
on page 144 • “Logpath” on page 150 terval” on page 156
• “ExplorerServerName” • “MacBinaryDefault”
• “Server” on page 156
• “HaveSeenLicenseSetupP • “MailtoAddressSeparator • “UploadDirectory”
age” on page 144 ” on page 150 on page 156
• “HaveSeenModuleInstall • “MaxListingOnGroupExp • “version” on page 157
Page” on page 145 n” on page 151
AdminIndexStyle
• Description:
Determines if the Content Server Administration page displays all sections and
links at once, or if it displays the sections as tabs, with only the links under the
selected tab displaying.
OpenText recommends that you modify this value using the Content Server
Administration page, rather than edit the opentext.ini file directly. For more
information, see “Understanding the Administration Page” on page 17.
• Syntax:
AdminIndexStyle=all

• Values:
Valid values are all or tabs. The default value is all.
Value Description
all Displays all sections and links at once. This is the default value,
and corresponds to clicking “Show All Sections” on the
Content Server administration page.
tabs Displays sections as tabs. Only the links in the selected tab
display. This corresponds to clicking “Show As Tabs” on the
Content Server administration page.
AdminMailAddress
• Description:
E-mail address of the Administrator. If you provide an e-mail address here, a
link to e-mail the Administrator is created on the User Log-in page.
OpenText recommends that you modify this value using the Configure Server
Parameters page, rather than edit the opentext.ini file directly. For more
information, see “Administrator E-mail Address” in “Configuring Basic Server
Parameters” on page 71.
• Syntax:
AdminMailAddress=<user_name>@<domain_name>.com
• Values:
A valid e-mail address. The default value is null, AdminMailAddress=, which
means no administrator email address is specified.
adminpwd
• Description:
Encoded Content Server Administrator password.
information, see “Content Server Administrator Password” in “Configuring
• Syntax:
adminpwd=<encoded_admin_password>
• Values:
An alphanumeric string. This parameter does not have a default value and is not
displayed in the opentext.ini file until you enter a value in the Content Server
Administrator Password field.
CaseInsensitiveQueries
• Description:

Used for Microsoft SQL Server LiveReport queries. This parameter is not used in
Content Server, and has not been used since before Livelink Version 9.
Important
OpenText recommends that you do not manually change the value of
CaseInsensitiveQueries.
• Syntax:
CaseInsensitiveQueries=FALSE
• Values:
dbconnretries
• Description:
Sets the number of times that Content Server tries to reconnect to the database if
the database connection is lost. By default, this setting does not appear in the
opentext.ini file, and its value defaults to dbconnretries=15.
Content Server waits 1 millisecond between the first and second attempt to
reconnect to the database. It then doubles the waiting period for each subsequent
connection attempt (to 2 ms, then 4 ms, and so on).
Tip: OpenText recommends that you do not set this value much higher
than 15. If the value is set to 15, Content Server spends a little over a minute
attempting to reconnect to the database. If the value is twenty, the total time
spent is over fifteen minutes.
• Syntax:
dbconnretries=15
• Values:
Debug
• Description:
Controls the level of debugging in Content Server. For more information, see
“Configuring Server Logging” on page 572.
Logging adversely affects server performance. You should only enable logging
for as long as is necessary to gather information on a particular problem.
information, see “Server Logging Options” in “Configuring Basic Server
• Syntax:
Debug=0

• Values:
Valid values are 0, 1, 2, and 11. The default value is 0, zero.
Value Description
0 No logging. This is the default value.
1 Performs minimal server logging. Produces server thread and other log files in
the <Content_Server_home>/logs directory. Log files produced include:
• llserver.out
• sockserv1.out
• thread<n>.out (one per thread)
2 Performs all logging from Debug=1, as well as more detailed thread request
logging, including information about the relevant environment variables in the
thread logs.
11 Performs all logging from Debug=2, as well as enabling logging for CGI client
process and Index Update engine, the Enterprise Extractor. Log files produced
include:
• llclient<nnn>.out (one per request to the CGI program from an end-
user web browser)
• llindexupdate<nnn>.out (one per start of the Enterprise Extractor)
• indexupdateOut<nnn>.out (one per stop of the Enterprise Extractor)
• receiver<n>.out (one each per thread)
Note: When using LLServlet instead of the Content Server CGI,

llclient<nnn>.out is replaced by servletclient<nnn>.out. One file is
generated for each thread number, as determined by your servlet
container's Java Virtual Machine. Each time a client browser sends an
LLservlet a request, a new servletclient<nnn>.out file is created. If a file
name with that number <nnn> already exists, the request's information is
appended to the end of the existing file.
DefaultContentRH
• Description:
Sets the default content request handler. If the frames view of Content Server is
displayed when users log in, when “DefaultRH” on page 141 is set to
LL.FrameHome, this parameter controls which Content Server page is displayed
in the right frame. If the no-frames view of Content Server is displayed when
users log in, this parameter controls which Content Server page is displayed in
the web browser window.
information, see “Default User Start Page” in “Configuring Basic Server
• Syntax:
DefaultContentRH=Enterprise.Home

• Values:
The name of a valid request handler is required. Valid values are:
Enterprise.Home, Personal.Home, and LL.Index. The default value is
Enterprise.Home.
Value Description
Enterprise.Home This is the default value. It indicates that the Enterprise
Workspace page is displayed when the user logs in.
Personal.Home Indicates that the user's Personal Workspace page is displayed
when the user logs in.
LL.Index Indicates that the About Content Server page is displayed
when the user logs in.
DefaultRH
• Description:
Sets the default request handler. This parameter controls which view of Content
Server is displayed when users log in using their web browsers.
• Syntax:
DefaultRH=Enterprise.Home
• Values:
The name of a valid request handler is required. Valid values are:
Enterprise.Home, Personal.Home, LL.Index, and LL.FrameHome. The default
value is Enterprise.Home.
This value can only be set in the opentext.ini file.
Value Description
Enterprise.Home This is the default value. It indicates that the Enterprise
Workspace page is displayed in a no-frames view of Content
Server when users log in.
Personal.Home Indicates that the user's Personal Workspace page is displayed
in a no-frames view of Content Server when users log in.
LL.Index Indicates that the About Content Server page is displayed in a
no-frames view of Content Server when users log in.
LL.FrameHome Indicates that the frames view of Content Server is displayed
when users log in. When DefaultRH is set to LL.FrameHome,
the Menubar is displayed in the left frame and the content of
the right frame is controlled by “DefaultContentRH”
on page 140.
DFTAutoLoginStr
• Description:
This is OpenText proprietary information.

dftConnection
• Description:
Default database connection.
• Syntax:
dftConnection=<default_database_connection>
• Values:
This parameter does not have a default value and is not displayed in the
opentext.ini file until you enter a value. You set this value when you install
Content Server and configure its database.
The value must match the connection specified in the
“[dbconnection:connection_name]” on page 101 section title. If there are multiple
dbconnection sections, specify the connection that you want to use.
DisableSelectReservedBy
• Description:
In Content Server, users can reserve a document to a group. The
DisableSelectReservedBy parameter allows one group member to reserve a
document, but have other members of the group work on it, and subsequently
have a different member of the group check the document back in. The intended
behavior is for Content Server to display a page that prompts the user to specify
the user or group to which to reserve the document at the same time that the
document is being downloaded to the web browser.
If the user's web browser is configured to open the document's MIME type, the
document is displayed directly in the web browser window and the user does
not have the opportunity to specify the user or group to which they want to
reserve the document. In particular, this problem has been reported with HTML
documents in Microsoft Internet Explorer browsers. The user is thus unable to
reserve documents of this MIME type using the Check-out method.
Users experiencing this problem have two options:
1. Reserve and then Fetch the document, rather than using Check-out.
2. Add DisableSelectReservedBy=TRUE to the [general] section of the
opentext.ini file. This disables the group check-out feature for all users.
You must manually enter this parameter and value to the [general] section of
the opentext.ini file.
• Syntax:
DisableSelectReservedBy=FALSE
• Values:
TRUE or FALSE. Setting this parameter to FALSE enables the group check-out
feature for all users.
By default, this parameter is not displayed in the opentext.ini file, which is the
equivalent of setting the parameter to FALSE.

DisplayServerName
• Description:
The user-friendly name given to the server.
information, see “Site Name” in “Configuring Basic Server Parameters”
on page 71.
• Syntax:
DisplayServerName=<my_server_name>
• Values:
A string of up to 64 alphanumeric characters. By default, this parameter is not
displayed in the opentext.ini file until you enter a value in the Site Name
field.
DocModTimeInDays
• Description:
Number of days for which the Modified icon appears beside Content Server
items that are modified.
information, see “Duration of New and Modified Indicators” in “Configuring
• Syntax:
DocModTimeInDays=7
• Values:
If you set this value to 0, zero, modified objects are not marked with the
Modified icon.
DocNewTimeInDays
• Description:
Number of days for which the New icon appears beside newly added Content
Server items.
information, see “Duration of New and Modified Indicators” in “Configuring
• Syntax:
DocNewTimeInDays=2

• Values:
If you set this value to 0, zero, new objects are not marked with the New icon.
EnableAutoRestarts
• Description:
If EnableAutoRestarts is set to FALSE, Content Server does not automatically
restart. When the Restart Content Server page appears (after installation of a
module, for example), you must restart Content Server using the operating
system.
If EnableAutoRestarts is set to TRUE, you are offered a choice when the Restart
Content Server page appears. You can let Content Server restart automatically,
or you can bypass the automatic restart and restart Content Server using the
operating system.
• Syntax:
EnableAutoRestarts=TRUE
• Values:
TRUE or FALSE. By default, this parameter does not appear in the opentext.ini
file, which is equivalent to EnableAutoRestarts=TRUE.
ExplorerServerName
• Description:
This value is only set if you install the Explorer module; it stores the display
name for the Explorer server.
Warning
Do not manually change the value of ExplorerServerName.
• Syntax:
ExplorerServerName=<Explorer_server_display_name>
• Values:
By default, this parameter is displayed in the opentext.ini file with a null
value, ExplorerServerName=, until you install the Explorer module.
HaveSeenLicenseSetupPage
• Description:
Indicates that the License Setup page was displayed during the initial setup of
Content Server.

Important
HaveSeenLicenseSetupPage.
• Syntax:
HaveSeenLicenseSetupPage=TRUE
• Values:
TRUE or FALSE. This value is set during installation. If you completed the
installation and setup of Content Server, this parameter will be TRUE.
HaveSeenModuleInstallPage
• Description:
Indicates that the Install Modules page was displayed during the initial setup of
Content Server.
Important
HaveSeenModuleInstallPage.
• Syntax:
HaveSeenModuleInstallPage=TRUE
• Values:
HaveSeenSetupPage
• Description:
Indicates that the Setup page was displayed during the initial setup of Content
Server.
Important
HaveSeenSetupPage.
• Syntax:
HaveSeenSetupPage=TRUE
• Values:
HaveValidatedDBAdminServers
• Description:

Indicates that the database administration servers have been validated during
the initial setup of Content Server.
Important
HaveValidatedDBAdminServers.
• Syntax:
HaveValidatedDBAdminServers=TRUE
• Values:
HaveValidatedEnterpriseDataSource
• Description:
Indicates that the Enterprise data source has been validated during the initial
setup of Content Server.
Important
HaveValidatedEnterpriseDataSource.
• Syntax:
HaveValidatedEnterpriseDataSource=TRUE
• Values:
HaveValidatedFacetsVolume
• Description:
Indicates that the Facets Volume has been validated during the initial setup of
Content Server.
Important
HaveValidatedFacetsVolume.
• Syntax:
HaveValidatedFacetsVolume=TRUE
• Values:

HaveValidatedReSyncPage
• Description:
Indicates that the resynchronize page has been validated during the initial setup
of Content Server.
Important
HaveValidatedReSyncPage.
• Syntax:
HaveValidatedReSyncPage=TRUE
• Values:
HaveValidatedSearchComponents
• Description:
Indicates that the search components have been validated during the initial setup
of Content Server.
Important
HaveValidatedSearchComponents.
• Syntax:
HaveValidatedSearchComponents=TRUE
• Values:
HaveValidatedWarehouseVolume
• Description:
Indicates that the Warehouse Volume has been validated during the initial setup
of Content Server.
Important
HaveValidatedWarehouseVolume.
• Syntax:
HaveValidatedWarehouseVolume=TRUE
• Values:

HTMLCharset
• Description:
By default, Content Server does not specify a character set encoding; the
character set used depends on the configuration of each user's web browser. You
can set Content Server to override the web browser's setting with a different
character set.
information, see “Character Set” in “Configuring Basic Server Parameters”
on page 71.
• Syntax:
HTMLCharset=<character_set>
• Values:
Any character encoding that is recognized by Content Server-supported web
browsers. This parameter does not have a default value and is not displayed in
the opentext.ini file until you enter a value in the Character Set field.
htmlImagePrefix
• Description:
The URL prefix, or alias, in your HTTP server that is mapped to the directory
containing image files and other support files, such as Java applets and Content
Server's online help files.
information, see “URL Prefix for /support Directory” in “Configuring Basic
Server Parameters” on page 71.
• Syntax:
htmlImagePrefix=/img/
• Values:
A URL prefix defined in your HTTP server. The default value is /
<cgi_URL_prefix>/support/, where <cgi_URL_prefix> is the URL prefix of the
<Content_Server_home>/cgi directory, and <Content_Server_home> is the root
of your Content Server installation.
INDEXHOME
• Description:
The directory in which the index resides. This parameter is not used in Content
Server, and has not been used since before Livelink Version 9.

• Syntax:
INDEXHOME=index\
• Values:
The default value is index\. This value is set during installation.
InstallAdminPort
• Description:
The TCP/IP port on which the Admin server accepts connections during
installation. This value is set by the Content Server installation program, based
on the Admin server port number entered when Content Server was installed.
• Syntax:
InstallAdminPort=5858
• Values:
Any open TCP/IP port. The default value is 5858. This value is set during
installation, and is not used once the installation is finished.
integrity
• Description:
An parameter used by the database verification process. The database
verification process sets integrity=TRUE when it starts and sets
integrity=FALSE when it completes.
Warning
Do not manually change the value of integrity.
• Syntax:
integrity=TRUE
• Values:
TRUE or FALSE. The default value is TRUE. This value is set during installation.
LLIndexHTMLFile
• Description:
Specifies the name of the HTML file used to generate the About Content Server
page. A path is not required.
• Syntax:
LLIndexHTMLFile=llindex.html
• Values:
The name of a valid WebLingo HTML file. The default value is llindex.html.

LLIndexRequiresLogin
• Description:
Specifies whether you need to log in to Content Server to view the About
Content Server page.
If LLIndexRequiresLogin is set to FALSE, users do not need to log in to view the
About Content Server page. All other log-in security remains in place.
• Syntax:
LLIndexRequiresLogin=FALSE
• Values:
TRUE or FALSE. The default value is FALSE. This value is set during installation.
Logpath
• Description:
The directory to which log files are written.
• Syntax:
Logpath=.\logs\
• Values:
A directory path relative to the root of the Content Server installation. The
default value is .\logs\
MacBinaryDefault
• Description:
This parameter applies to Macintosh workstations using Netscape browsers only.
Specifies the default state of the MacBinary (set before selecting a file) check
box on certain document upload pages.
Setting this value to TRUE instructs Netscape browsers to encode the file to be
uploaded in MacBinary format.
• Syntax:
MacBinaryDefault=FALSE
• Values:
TRUE or FALSE. The default value is FALSE, the check box is not selected. Also by
default, the MacBinaryDefault parameter does not appear in the opentext.ini
file, which is equivalent to MacBinaryDefault=FALSE.
MailtoAddressSeparator
• Description:

The character that Content Server inserts between multiple recipient addresses in
message composition windows.
information, see “Multiple Address Separator for ‘mailto:’ URL” in “Configuring
• Syntax:
MailtoAddressSeparator=,
• Values:
A semi-colon ( ; ) or a comma ( , ). The default value is a comma.
MaxListingOnGroupExpn
• Description:
Maximum number of users to display when opening the members of a group. If
you search for groups and then click a group to display its members, the
maximum number of members displayed on the page is defined by the value of
the MaxListingOnGroupExpn parameter.
• Syntax:
MaxListingOnGroupExpn=100
• Values:
MaxUsersInGroup
• Description:
The maximum number of users permitted in a group.
• Syntax:
MaxUsersInGroup=1000
• Values:
MaxUsersToListPerPage
• Description:
Maximum number of users or groups to be displayed on the results page when
searching for users or groups.
• Syntax:
MaxUsersToListPerPage=30
• Values:

MessageClearInterval
• Description:
The MessageClearInterval parameter sets the maximum number of days that
Content Server stores Content Server Notification messages.
If a user enables e-mail delivery of a Notification report, the messages associated
with the report are cleared from the database when the e-mail message is sent.
However, if a user does not enable e-mail delivery of a given Notification report,
events corresponding to the interests of the report are stored in the database until
the user opens and deletes them on the Notification tab of the Personal
Workspace. If users are negligent in checking their Notification tabs, a lot of
messages can accumulate in the database. To prevent an excessive amount of
messages from accumulating, Content Server deletes all stored Notification
reports that are older than the number of days set by the MessageClearInterval
parameter.
• Syntax:
MessageClearInterval=30
• Values:
Any whole number of days. The default value is 30.
NavigationOption
• Description:
Governs whether navigation menus and icons in the Content Server user
interface are Java-enabled.
• Syntax:
NavigationOption=0
• Values:
Valid values are: 0, 1, or 2. The default value is 0.
Value Description
0 This is the default value. Sets Java-enabled
navigation as the default condition but
allows individual users to choose non-Java
navigation.
1 Sets non-Java navigation only for all users.
2 Sets non-Java navigation as the default
condition but allows individual users to
choose Java-enabled navigation.
NewsDftExpiration
• Description:

Number of days before a News item expires. If you set this value to 0, zero,
News items do not expire.
• Syntax:
NewsDftExpiration=2
• Values:
NTPATH
• Description:
Path to the directory containing the document-viewing filters. This path is
appended to the host's path environment variable. The path is set during
installation.
• Syntax:
NTPATH=C:\OPENTEXT\filters\
• Values:
An absolute path, including trailing slash. The default value is
<Content_Server_home>\filters\, where <Content_Server_home> is the root of
your Content Server installation.
NTSERVICENAME
• Description:
This parameter applies to Windows workstations only. This parameter indicates
the service name of this particular Content Server instance in the Windows
Services dialog box. This value is set during installation.
• Syntax:
NTSERVICENAME=OTCS
• Values:
Any unique service name. The default value is OTCS.
NumOldLogs
• Description:
This parameter, when added to the [general] section, determines the number of
log files you want saved. When you restart the server, this parameter deletes all
old threads. This parameter does not impact connect logs.
• Syntax:
NumOldLogs=1
• Values:

Value Description
0 Sets Content Server to display only the
current set of thread logs.
1 Displays the current set of thread logs, and
saves the next oldest set. This is the default
value.
<n> Any number that represents the number of
log files, in addition to the one displayed,
that you want saved.
OTHOME
• Description:
The full path to the root of the Content Server installation. The placeholder,
<Content_Server_home>, is used to refer to this root directory.
• Syntax:
OTHOME=C:\OPENTEXT\
• Values:
An absolute path is required. On Windows systems, C:\OPENTEXT\ is an
example of the value of OTHOME. On Linux and Solaris systems, /usr/local/ is
an example of the value of OTHOME. This value is set during installation.
PauseSleep
• Description:
The length of time, in microseconds, each item in a News player remains on
screen.
• Syntax:
PauseSleep=2000
• Values:
Any integer greater than, or equal to, zero. The default value is 2000, or 0.002
seconds.
Port
• Description:
The port that clients use to connect to the server.
• Syntax:
Port=2099
• Values:
Any open TCP/IP port. The default value is 2099.

Profile
• Description:
Enables the OScript profiler, which can be used by software developers to
analyze the behavior of Content Server software.
The OScript profiler creates a profile data file in the <Content_Server_home>
\logs\ folder for each running Content Server thread.
Profile data files follow a naming convention of profile-<process_id>-
<thread_id>.<extension>, where <extension> could be csv, out, csv.zip, or
out.zip. (See “ProfileFormat” on page 155.) For example, a profile data file
could have the name profile-2620-7003.csv.zip.
Note: If the Profile parameter is enabled under the [general] section

name, the profiler generates a profile data file for every Content Server
OScript thread.
You can also enable Profile under different section names to restrict its
effects. If Profile is enabled under [llserver], Content Server worker
threads are profiled. If Profile is enabled in one or more agent sections
(for example, [wfagent] or [daagent]), only the agent functions are
profiled.
• Syntax:
Profile=0
• Values:
Valid values are 0, 1, or 2. The default value is 0.
Value Description
0 Disabled. If the Profile parameter does
not appear in the opentext.ini file, it is
equivalent to Profile=0. This is the
default value.
1 Only OScript function calls are profiled.
2 OScript function calls and built-in function
calls are profiled.
ProfileFormat
• Description:
Specifies the file format of profiler output. Applies only if “Profile” on page 155
is enabled (set to 1 or 2).
• Syntax:
ProfileFormat=out.zip
• Values:

Valid values are out, csv, out.zip, or csv.zip. The default value is out.zip.
out
Callgrind format. Callgrind (http://valgrind.org/docs/manual/cl-format.html)
is an open-source format that can be viewed using kcachegrind (http://
kcachegrind.sourceforge.net/html/Home.html) and other tools.
csv
Comma-separated values.
out.zip
Compressed (gzip) Callgrind format.
csv.zip
Compressed (gzip) comma-separated values.
ScheduleHandlerClearInterval
• Description:
The number of days after which all unprocessed events will be cleared.
OpenText recommends that you modify this value using the Clear Outstanding
Events page, rather than edit the opentext.ini file directly.
You access the Clear Outstanding Events page from the Content Server
Administration page. In the Notification Administration section, click
Configure Clear Outstanding Events. For more information, see “Clearing
Outstanding Events” on page 832.
• Syntax:
ScheduleHandlerClearInterval=30
• Values:
Any integer greater than, or equal to, zero. The default value is 30.
Server
• Description:
The name of the host on which the server resides. This parameter is used in
conjunction with the “Port” on page 154 parameter to enable clients to connect to
the server.
• Syntax:
Server=localhost
• Values:
A fully-qualified hostname or an IP address. The default value is localhost.
UploadDirectory
• Description:

The UploadDirectory parameter is used to restrict the location from which

Content Server accepts Documents for upload. If specified, Content Server will
only upload Documents found in this directory.
information, see “Upload Directory” in “Configuring Basic Server Parameters”
on page 71.
• Syntax:
UploadDirectory=C:\upload\
• Values:
This parameter does not have a default value and is not displayed in the
opentext.ini file until you enter a value in the Upload Directory field.
version
• Description:
File version identifier.
Important
version.
• Syntax:
version=22
• Values:
This entry does not have a default value.
7.3.25 [HelpMap]
• Description:
The [HelpMap] section contains mappings for Content Server's context-sensitive
online help for users. A help mapping creates a link between a keyword that
identifies a page of the Content Server interface, for example, the Personal
Workspace or Search page, and the name of an HTML online help page.
Help mappings for functions available only to the Administrator, or users with
system administration rights, are found in the “[AdminHelpMap]” on page 95
section.
Important
OpenText recommends that you do not change the default mappings in

7.3.26 [HHExcludedMimeTypes]
• Description:
The entries in the [HHExcludedMimeTypes] section determine which types of
items are excluded from being hit highlighted in Content Server. If you add a
MIME type to this section, the Hit Highlight command will not be available in
the Functions menu for the corresponding item type.
The entries in the [HHIncludedMimeTypes] section, which determines the types
of items that can be hit highlighted in Content Server, takes precedence over the
entries in the [HHExcludedMimeTypes] section. However, if the
[HHIncludedMimeTypes] section is not included or is empty in the
opentext.ini file, Content Server uses the [HHExcludedMimeTypes] section to
determine which items can be hit highlighted. For information about the
[HHIncludedMimeTypes] section, see “[HHIncludedMimeTypes]” on page 160.
• Syntax:
mime1=image/jpeg
• Values:
Each entry in the [HHExcludedMimeTypes] section has the following format:
mime<n>=<mimetype>, where <n> is a unique number.
You must specify MIME types using the correct format. The following table lists
some common MIME types:

• application/ • application/x-latex • image/gif

activemessage • application/x-macbinary • image/ief
• application/andrew- • application/x-mif
inset • image/jpeg
• application/x-netcdf
• application/applefile • image/tiff
• application/x-outlook
• application/atomicmail • image/x-cmu-raster
• application/x-quattro
• application/dca-rft • application/x-quattropro • image/x-portable-
• application/dec-dx anymap
• application/x-
• application/mac- quattroproj • image/x-portable-bitmap
binhex40 • application/x-sh
• application/macwriteii
• image/x-portable-
• application/x-shar graymap
• application/msword • application/x-sv4cpio
• application/news-
• image/x-portable-
• application/x-sv4crc pixmap
message-id
• application/x-tar
• application/news- • image/x-rgb
transmission • application/x-tcl
• image/x-xbitmap
• application/octet-stream • application/x-tex
• application/x-texinfo
• image/x-xpixmap
• application/oda
• application/pdf • application/x-troff • image/x-xwindowdump
• application/postscript • application/x-troff-man • message/external-body
• application/powerpoint • application/x-troff-me • message/news
• application/remote- • application/x-troff-ms
• message/partial
printing • application/x-ustar
• application/rtf • application/x-wais-
• message/rfc822
• application/slate source • message/alternative
• application/ • application/x- • multipart/
vnd.lotus-1-2-3 wordperfect
• application/x-
• multipart/appledouble
• application/vnd.lotus-
freelance wordperfectmac • multipart/digest
• application/vnd.ms- • application/x- • multipart/mixed
excel wordperfect4.2
• multipart/parallel
• application/vnd.ms- • application/x-
powerpoint wordperfect5e • text/html
• application/vnd.ms- • application/x- • text/plain
project wordperfect5.1j
• text/richtext
• application/vnd.ms-tnef • application/x-
wordperfect6.0 • text/tab-separated-
• application/wita
• application/x- values
• application/
wordperfect6e • text/xml
wordperfect5.1
• application/x-
• application/x-ami • text/x-setext
wordperfect6.1
• application/x-amipro • text/x-sgml
• application/x-
• application/x-bcpio wordperfect7 • video/mpeg
• application/x-cpio • application/x-zip- • video/quicktime
• application/x-csh compressed
• application/x-dvi • application/zip • video/x-msvideo
• application/x-gtar • audio/basic • video/x-sgi-movie

• application/x-hdf • audio/x-aiff
• application/x-js-taro • audio/x-wav
7.3.27 [HHIncludedMimeTypes]
• Description:
The entries in the [HHIncludedMimeTypes] section determine which types of
items can be hit highlighted in Content Server. Only items that match the MIME
types in this section have the Hit Highlight command available in their
Functions menu in Content Server. The [HHIncludedMimeTypes] section takes
precedence over the [HHExcludedMimeTypes] section, which determines which
types of items are excluded from being hit highlighted in Content Server.
However, if the [HHIncludedMimeTypes] section is not included or is empty in
the opentext.ini file, Content Server uses the [HHExcludedMimeTypes] section
to determine which items can be hit highlighted. For information about the
[HHExcludedMimeTypes] section, see “[HHExcludedMimeTypes]” on page 158.
• Syntax:
mime1=image/jpeg
• Values:
Each entry in the [HHIncludedMimeTypes] section has the following format:
mime<n>=<mimetype>, where <n> is a unique number.
You must specify MIME types using the correct format. To view some common
MIME types, see the table located in “[HHExcludedMimeTypes]” on page 158.
7.3.28 [hithighlight]
The [HitHighlight] section contains the configuration settings for hit highlighting
in Content Server. Hit highlighting allows users to highlight the instances of their
search terms within a particular search result item. For more information, see
OpenText Content Server User Online Help - Searching Content Server (LLESWBB-H-
UGD).
Before Content Server can hit highlight a search result item, it converts the item to
HTML using a process named wfwcnv. You can configure the environment in which
the wfwcnv process runs in this section of the opentext.ini file.
The [HitHighlight] section contains the following parameters:
Important
OpenText strongly recommends that you do not modify the values of these
parameters:
• “cachePath” on page 161 • “HHStyle” on page 161 • “sectionName”

• “hhAdminServer” • “MaxNumberOfCacheIte on page 163
on page 161 ms” on page 162

cachePath
• Description:
Specifies the directory in which the converted files that the wfwcnv process
generates are cached.
• Values:
An absolute path. The default is <Content_Server_home>\cache\hh\, where
<Content_Server_home> is the root of your Content Server installation.
hhAdminServer
• Description:
Specifies the shortcut of the Admin server that manages the wfwcnv process. An
Admin server's shortcut is the same as the name that appears in the Name
column of the Admin Servers table on the System Object Volume page. For
more information, see“Using the System Object Volume” on page 427.
• Values:
The shortcut of an Admin server that is registered with the primary Content
Server host. By default, the hhAdminServer parameter does not appear in the
opentext.ini file, which is equivalent to hhAdminServer=default.
HHStyle
• Description:
Specifies the background color, font color, font size, font style, and font weight
used when hit highlighting a key word or phrase. An example of font style is
italic. An example of font weight is bold.
• Syntax:
HHStyle={background:red; color:blue}
• Values:
The values that you specify for this parameter must be contained in braces, {}.
Each entry takes the form <option>:<value>. Entries are separated by
semicolons.
The HHStyle parameter can contain five display options: background, color,
font-size, font-style or font-weight. The values of each element are
described in the following table:
Option Value
background Any valid HTML color. A color is a either a
color name or a numerical RGB
specification. For more information,
consult an HTML color reference chart or
website.

Option Value
color Any valid HTML color. A color is a either a
color name or a numerical RGB
specification. For more information,
consult an HTML color reference chart or
website.
font-size An integer representing the absolute font
size
font-style One of three possible values: normal,
italic, or oblique, depending on the
font family used.
font-weight One of the following values:
• normal
• bold
• bolder
• lighter
• 100
• 200
• 300
• 400
• 500
• 600
• 700
• 800
• 900
The values 100-900 represent an ordered
sequence, where each number indicates a
weight that is at least as dark as the
previous value. The value normal is equal
to 400, and bold is equal to 700.
MaxNumberOfCacheItems
• Description:
Specifies the maximum number of conversion files that can be stored in the
cache. When the number of cache items exceeds the maximum, the items that
have not been accessed for the greatest amount of time are deleted.
A cache item is a set of converted files that are associated with a given source
document. For example, if a non-HTML source document contains both text and
images, its conversion to HTML results in an HTML file and one or more image
files. This set of files is the cache item for that source document.
• Values:
An integer greater than, or equal to, zero. By default, the
MaxNumberOfCacheItems parameter does not appear in the opentext.ini file,
which is equivalent to MaxNumberOfCacheItems=30.

sectionName
• Description:
Specifies the opentext.ini section from which the wfwcnv process reads its filter
settings.
• Values:
A valid opentext.ini section name. Do not include the square brackets, [] , in
the section name. By default, the sectionName parameter does not appear in the
opentext.ini file, which is equivalent to sectionName=HHFilterSettings.
7.3.29 [Home]
By default, the [Home] section does not appear in the opentext.ini file. You only
need to add it if you want to change the default value of the EditOrganizeMaxItems
parameter, which is described below.
EditOrganizeMaxItems
• Description:
Sets the maximum number of items that Content Server displays per page when
a user is editing/organizing items, such as favorites or Projects on tabs.
For example, if a user is a member of 150 Projects, and clicks the Edit/Organize
link when opening the All Projects tab in their Personal Workspace, Content
Server only displays the first 100 Project names on the first page. To see the
remaining 50 Project names, the user must click 2 of 2 in the Page list at the
bottom of the page.
• Syntax:
EditOrganizeMaxItems=100
• Values:
An integer greater than, or equal to, 0. The default is 100.
7.3.30 [IndexObject]
The [IndexObject] section contains OpenText proprietar information.
Important
section.

7.3.31 [InterestsProfile]
The [InterestsProfile] section controls the configuration parameter for Report
Settings in Notification Administration. To set this parameter, OpenText
recommends that you use the Configure Notification page, rather than edit the
opentext.ini file directly.
EventNo
• Description:
Limits Content Server to processing only this number of events per cycle.
• Syntax:
EventNo=1000
• Values:
An integer greater than, or equal to, zero.
7.3.32 [ipmove]
The [ipmove] section is used to control whether an item is sent to a particular iPool.
Note: There is a separate configuration file to set all arguments, for example,
\bin\ipmove -inifile opentext.ini -config myconfig, where myconfig is
a file in the same format as a standard initialization file. To set [ipmove]
parameters, OpenText recommends that you use the myconfig file, rather than
edit the opentext.ini file directly. For details, see “Sending an Item to an
iPool Using ipmove” on page 563.
readfields
• Description:
The readfields parameter works, when there is more than one write iPool, with
the location specified in the File Path field, in the Non-EFS Object Content
section of the Setting Extractor General Settings page. For details, see “Setting
Extractor General Settings” on page 485.
If a directory path location is specified for the File Path field, the original path
name is passed to the first iPool. Any other iPools which get this item also get a
copy of the temporary file specified in the File Path field. It is the consumer
iPool's responsibility to delete the temporary file when it has consumed the
content and committed the transaction.
If an output iPool is not selected, and readfields is not set, then copying of the
temporary file specified in the File Path location will not occur. This is because
iPool messages are fast copied and there is no entry parsing. The potential failure
to delete the temporary file could happen with a Two Way Tee process, or with a
Merge.

• Syntax:
readfields=TRUE
• Values:
Setting readfields=TRUE is only required if there are no patterns, and more than
one output is specified. If you specify a pattern, readfields=TRUE is set
automatically.
7.3.33 [javaserver]
The [javaserver] section allows you to modify the settings of the Virtual Machine,
VM, running in Content Server. You can optimize performance of the Java web
application server by typing more VM arguments. For example:
JavaVMOption_4=-Xms256M
JavaVMOption_5=-Xmx256M
Note: On a multi-processor 64 bit server, the Java process uses more memory
for each additional cpu in use. To limit the amount of memory used by the
javaserver upon a Content Server startup, add the following to the [javaserver]
section of the opentext.ini file: JavaVMOption_5=Xmx256M.
For information about more arguments you can use, locate your Java SDK
installation, then navigate to <Java_SDK_installation_path>\jre\bin\client
\Xusage.txt. The text file lists and explains each argument.
7.3.34 [Lang_xx_XX]
The [Lang_<xx>_<XX>] section, where <xx>_<XX> indicates the locale of your
Content Server version, controls how Content Server deals with dates, times, and
user names that are subject to locale settings. The following Content Server
Administration pages describe changes you can make to the [Lang_<xx_XX>]
section:
• “Setting Date and Time Formats” on page 32

• “To Configure User Name Display” on page 392
• “ENV_NLS_COMP” • “InputTimeFormat” • “ShortDateFormat”

• “ENV_NLS_SORT” • “LongDateFormat” • “ShortDateSeqFormat”
• “InputDateFormat” • “LongDateSeqFormat” • “ShortTimeFormat”
• “InputDateSeqFormat” • “LongTimeFormat” • “UserNameDisplayForma
on page 167 on page 168 t” on page 169

ENV_NLS_COMP
• Description:
Sets the Oracle National Language Support (NLS) collation setting (which
specifies how Oracle performs comparisons) used by an Oracle Content Server
database. If this setting does not appear in the opentext.ini file, an Oracle
Content Server database uses the existing settings of your Oracle server.
• Syntax:
ENV_NLS_COMP=LINGUISTIC
• Values:
One of BINARY, LINGUISTIC, or ANSI. The Oracle default value is LINGUISTIC.
ENV_NLS_SORT
• Description:
Sets the Oracle National Language Support (NLS) sort setting (which specifies
how Oracle sorts the results of ORDERBY queries) used by an Oracle Content
Server database. If this value is not set, an Oracle Content Server database uses
the existing settings of your Oracle server.
By default, Oracle performs case-sensitive sorting and comparisons, if you want
Content Server to behave in a case-insensitive manner, set the ENV_NLS_SORT
setting to a case-insensitive setting, such as GENERIC_M_CI. With this setting in
place, Content Server would treat MyDocument and mydocument as the same
name and would not permit items with these names to be added to the same
container.
• Syntax:
ENV_NLS_SORT=GENERIC_M_CI
• Values:
BINARY, or any linguistic definition name allowed by Oracle
InputDateFormat
• Description:
Specifies how input fields appear for the day, month, and year. Other
characteristics are governed by the InputDateSeqFormat parameter. For more
information, see “Input Date” in “Setting Date and Time Formats” on page 32.
• Syntax:
InputDateFormat=%m/%d/%Y
• Values:
The default setting is a two-digit month, the day, and the year: %m/%d/%Y.

InputDateSeqFormat
• Description:
Specifies the order in which input fields appear for the day, month, and year, and
what characters separate the elements of the date. Other characteristics are
governed by the TwoDigitYears parameter. For more information, see “Input
Date” in “Setting Date and Time Formats” on page 32.
• Syntax:
InputDateSeqFormat={1,1,2,1,'/','/'}
• Values:
The default setting is month, day, and year, all separated by a slash: {1,1,2,1,
'/','/'}.
InputTimeFormat
• Description:
Specifies whether Content Server accepts time inputs in 12-hour format, for
example 02:41 PM, or 24-hour format, for example 14:41. For more information,
see “Time Zone” in “Setting Date and Time Formats” on page 32.
• Syntax:
InputTimeFormat=%I:%M %p
• Values:
The default setting is a 12-hour format: %I:%M %p.
LongDateFormat
• Description:
Specifies how Content Server displays the day, month, and year. Other
characteristics are governed by the LongDateSeqFormat parameter. For more
• Syntax:
LongDateFormat=%m/%d/%Y
• Values:
LongDateSeqFormat
• Description:
Specifies the order in which input fields appear for the day, month, and year, and
what characters separate the elements of the date. Other characteristics are
governed by the TwoDigitYears parameter. For more information, see “Setting
Date and Time Formats” on page 32.

• Syntax:
LongDateSeqFormat={1,1,2,1,'/','/'}
• Values:
'/','/'}.
LongTimeFormat
• Description:
Specifies whether Content Server displays times in 12-hour format, for example
02:41 PM, or 24-hour format, for example 14:41. For more information, see
“Setting Date and Time Formats” on page 32.
• Syntax:
LongTimeFormat=%I:%M %p
• Values:
ShortDateFormat
• Description:
Specifies how Content Server displays the day, month, and year. Other
characteristics are governed by the ShortDateSeqFormat parameter. For more
• Syntax:
ShortDateFormat=%m/%d/%Y
• Values:
ShortDateSeqFormat
• Description:
Specifies the order in which Content Server displays the day, month, and year,
and what characters separate the elements of the date. Other characteristics are
governed by the TwoDigitYears parameter. For more information, see “Setting
Date and Time Formats” on page 32.
• Syntax:
ShortDateSeqFormat={1,1,2,1,'/','/'}
• Values:
'/','/'}.

ShortTimeFormat
• Description:
Specifies whether Content Server displays times in 12-hour format, for example
02:41 PM, or 24-hour format, for example 14:41. For more information, see
“Setting Date and Time Formats” on page 32.
• Syntax:
ShortTimeFormat=%I:%M %p
• Values:
UserNameDisplayFormat
• Description:
A format in which a Content Server user's name displays throughout Content
Server, in fields such as Created by, Owned by, and User.
User Name Display page, rather than edit the opentext.ini file directly. For
more information, see “Display Name Format” in “To Configure User Name
Display” on page 392.
• Syntax:
UserNameDisplayFormat=1
• Values:
Valid values are:
• 1, which displays the Log-in ID. This is the default value.
• 2, which displays FirstName LastName.
• 3, which displays FirstName MiddleInitial. LastName.
• 4, which displays LastName, FirstName.
• 5, which displays LastName, FirstName MiddleInitial.
• 6, which displays LastName FirstName.

7.3.35 [LivelinkExtractor]
This setting controls the order in which the Extractor processes information in the
DTreeNotify table. An Enterprise Extractor process is a data flow process that
extracts data from the Content Server database and writes it to a data flow, where it
is indexed. Most Extractor settings are accessible in Content Server on the Extractor
General Settings administration page. For details, see “Setting Extractor General
Important
Because only one process is required to extract data from the Content Server
database, OpenText strongly recommends that each Content Server system
have only one Enterprise Extractor process.
wantDescendingExtractor
• Description:
Specifies the order in which the Extractor processes information in the
DTreeNotify table. You can process information from either newest to oldest
updates, or from oldest to newest updates.
Note: To set a date-based partition creation control rule, the descending

extraction order must be set to false.
• Syntax:
wantDescendingExtractor=TRUE
• Values:
file, which is equivalent to wantDescendingExtractor=TRUE.
To process information from oldest to newest, you must specify that the
wantDescendingExtractor=FALSE.
7.3.36 [llserver]
The [llserver] section contains settings that determine the number of threads that
Content Server uses in its operation. Although you can edit these settings directly,
OpenText recommends that you change the number of threads on the Configure
Performance Settings administration page. For more information, see “Configuring
Performance Settings” on page 75
Increasing the number of threads allows Content Server to serve a greater number of
users, until the capacity of the Content Server host computer is reached. The more
threads you allow, the more system resources Content Server consumes.
Note: The opentext.ini file installed by Content Server 10.5 SP1 and later
contains the number setting instead of the min and max settings.

• If you perform a new installation of Content Server 10.5 SP1 and later, the
number setting appears in this section, but the min and max settings do not.
• If you perform a new installation of Content Server 10.5 Update 2014–09 or
earlier, the min and max settings appear in this section but the number setting
does not.
id
• Description:
max
• Description:
This setting is used if the number setting does not appear in the [llserver]
section. Content Server sets the number of threads to the value of min or max. It
uses whichever value is greater.
• Syntax:
max=8
• Values:
An integer greater than or equal to 1.
min
• Description:
This setting is used if the number setting does not appear in the [llserver]
section. Content Server sets the number of threads to the value of min or max. It
uses whichever value is greater.
• Syntax:
min=8
• Values:
An integer greater than, or equal to, 1.
number
• Description:
The number of threads that Content Server uses. If this setting does not appear in
the [llserver] section, Content Server uses the min and max settings to
determine the number of threads to use.
• Syntax:
number=8
• Values:

An integer greater than, or equal to, 1. The default value is 8.
path
• Description:
Profile
• Description:
Enables the OScript profiler, which can be used by software developers to
analyze the behavior of Content Server software. For more information, see
“Profile” on page 155
7.3.37 [llview]
In the [llview] section, you can correct problems of excess resource consumption
by llview processes. These processes are created every time a user opens a
document in Content Server.
CancelTimeOut
• Description:
Instructs Content Server to end any llview process that exceeds the stated
number of seconds.
• Syntax:
CancelTimeOut=10
• Values:
Any integer greater than, or equal to, 0.
7.3.38 [loader]
The [loader] section contains proprietary OpenText information.
Important
section.

7.3.39 [Modules]
• Description:
The [Modules] section contains module information. The values in this section
are set by Content Server and by the modules themselves.
Important
OpenText recommends that you do not modify any of the settings in this
section.
• Values:
There are three lines for each module. For example, the following is the module
definition for the Discussions module:
• ospaces_discussion={'discussion'}. . .
• module_11=discussion. . .
• discussion=_3_0_0
The first line lists the OSpaces which make up the module. This is a comma-
separated list of one or more OSpace names. Each name must be delimted by
apostrophes, and the entire list must be contained in braces: {'<value>',
'<value>'}.
The second line is used to help iterate through the list of installed modules.
The third line defines the module's version number.
7.3.40 [nlqsearch]
Content Server's Natural Language Query system uses the functionality provided by
the Content Server Summarizer to parse the text that users enter when submitting
natural language queries. The [nlqsearch] section contains most of the same
parameters that appear in the [Summarizer] section; however, the default values of
these parameters may differ.
The [nlqsearch] section of the opentext.ini file contains the following

parameters:
• “SumAbbrevFile” • “SumDocFreqFile” • “SumTagFile”

• “SumDefFile” • “SumStopWordFile”
SumAbbrevFile
• Description:
Specifies the abbreviation file that the Content Server Summarizer uses to define
common abbreviations and all three-letter combinations that are not words.
• Syntax:

SumAbbrevFile=../config/abbrev.eng
• Values:
A relative path and file name. By default, the abbreviation file is named
abbrev.eng and is stored in the config directory of your Content Server
installation. For example, <Content_Server_home>/config, where
SumDefFile
• Description:
Specifies the definition file that the Content Server Summarizer uses to define its
operation. The definition file contains five numbers, one number per line, each
representing the following:
• A score multiplier for sentences that are in the first 20 percent of a document.
These sentences are probably introductory sentences and are likely to be good
summary sentences.
• A maximum number of word tokens allowed in a summary sentence. A word
token is a combination of letters, numbers, dashes, and entity references. The
Summarizer marks sentences containing more word tokens than the
maximum number as unreadable and does not use them as summary
sentences.
• A minimum number of word tokens allowed in a summary sentence. The
Summarizer marks sentences containing fewer word tokens than the
minimum number as unreadable and does not use them as summary
sentences.
• A maximum ratio of non-word tokens to word tokens. If the actual ratio of
non-word tokens to word tokens exceeds this number, the Summarizer marks
the sentence as unreadable and does not use it as a summary sentence.
• The number of documents used to form the data for the statistical significance
of words in the word frequency file.
• Syntax:
SumDefFile=../config/natlang.eng
• Values:
A path, relative to the value of the otpath parameter in the [OTCommon] section
of the opentext.ini file. By default, the definition file is named natlang.eng
and is stored in the config directory of your Content Server installation. For
example, <Content_Server_home>/config, where <Content_Server_home> is the
root of your Content Server installation.
SumDocFreqFile
• Description:
Specifies the word frequency file that contains the data necessary for the Content
Server Summarizer to calculate the statistical significance of words in documents.

This file contains a list of words that occurred in more than 1,000 of the 1,371,876
documents that OpenText used to build the statistical background for the
Summarizer's default settings.
• Syntax:
SumDocFreqFile=../config/docfreq.eng
• Values:
A relative path and file name. By default, the word frequency file is named
docfreq.eng and is stored in the config directory of your Content Server
SumStopWordFile
• Description:
Specifies the stopword file that the Content Server Summarizer uses to define a
list of common stopwords. Stopwords are words that add no semantic value to a
sentence. These words are typically functional words such as a, and, and the. By
distinguishing stopwords from semantically important words, the Content
Server Summarizer identifies which words are more likely to contribute to the
document's distinct meaning, increasing the accuracy of its summaries and key
phrases.
• Syntax:
SumStopWordFile=../config/nlstopword.eng
• Values:
A relative path and file name. By default, the stopword file is named
nlstopword.eng and is stored in the config directory of your Content Server
SumTagFile
• Description:
Specifies the tag file that contains a list of markup tags that appear in documents.
Examples of markup tags include HTML, XML, and SGML. Next to each tag is a
number that specifies the tag's importance to the Content Server Summarizer.
Range of Tag Significance Settings table:

Number Label Description

0 IGNORE_TAG The Summarizer ignores these
tags, but does not ignore the data
enclosed in them. If a sentence
begins before this tag, and has this
tag within it, the Summarizer
does not break the sentence into
two sentences. By default,
unknown tags are marked with
this number.
1 SENTENCE_BREAKING_IGNOR The Summarizer ignores these
E_TAG tags, but does not ignore the data
enclosed in them. If a sentence
begins before this tag, and has this
tag within it, the Summarizer
breaks the sentence into two
sentences.
2 IGNORE_BETWEEN_TAGS The Summarizer ignores these
tags and the data enclosed in
them.
3 ABSTRACT This value marks the data
enclosed in these tags as abstract,
or overview, sentences. The
Summarizer uses sentences in the
title, abstract, and conclusion, in
that order, before any other
sentences to create the summary.
4 CONCLUSION This value marks the data
enclosed in these tags as
concluding sentences. The
Summarizer uses sentences in the
title, abstract, and conclusion, in
that order, before any other
sentences to create the summary.
5 TITLE_MAJOR This value marks the data
enclosed in these tags as title
sentences. The Summarizer uses
sentences in the title, abstract, and
conclusion, in that order, before
any other sentences to create the
summary.
• Syntax:
SumTagFile=../config/tags.eng
• Values:
A relative path and file name. By default, the tag file is named tags.eng and is
stored in the config directory of your Content Server installation. For example,
<Content_Server_home>/config, where <Content_Server_home> is the root of

7.3.41 [notify]
The [notify] section contains proprietary OpenText information.
Important
section.
7.3.42 [options]
You can set several logging options in the [options] section, and enable or disable
some key functionality, such as the search engine and Content Server Notification.
The following Content Server Administration pages describe changes you can make
to the [options] section:
• “Configuring Performance Settings” on page 75
• “Enabling and Disabling Notifications” on page 831
• “Configuring Server Logging” on page 572
• “EFSCopyBufferSize” • “maxRightsString” • “wantSearchLogs”

• “EnableAgents” • “processAllNodeIds” • “wantSecureCookies”
• “EnableAgentsTestAll” • “wantByteServing”
• “wantTimings”
• “EnableAgentsTrace” • “wantVerbose”
• “wantLAPILogs”
on page 180
• “EnableNotification” • “wantWeb” on page 182
on page 179
• “wantLogs” on page 181
• “excludeNodeIDs” • “wantNotification”
• “MaxOpenSessions” • “wantSearch”
EFSCopyBufferSize
• Description:
Sets the file buffer size for files that are copied to and from the External File
Storage.
more information, see “File Buffer Size” in “Configuring Performance Settings”
on page 75.
• Syntax:
EFSCopyBufferSize=<value_in_bytes>

• Values:
A value in bytes, between 16384 and 2097152. The default value is 524288 (500
KB).
EnableAgents
• Description:
Important
EnableAgents.
• Syntax:
EnableAgents=TRUE
• Values:
EnableAgentsTestAll
• Description:
Important
EnableAgentsTestAll.
• Syntax:
EnableAgentsTestAll=FALSE
• Values:
EnableAgentsTrace
• Description:
Important
EnableAgentsTestAll.
• Syntax:
EnableAgentsTestAll=FALSE
• Values:

EnableNotification
• Description:
Enables or disables Content Server Notification.
Notification page, rather than edit the opentext.ini file directly. For more
information, see “Enable Notifications” in “Enabling and Disabling
Notifications” on page 831.
• Syntax:
EnableNotification=FALSE
• Values:
TRUE or FALSE. The default value is FALSE until Content Server Notification is
enabled by the Administrator.
excludeNodeIDs
• Description:
Allows you to specify node IDs so that they are excluded from processing when
adding documents to Content Server.
• Syntax:
excludeNodeIDs=<nodeID1>,<nodeId2>
• Values:
A comma separated list of <NodeID>'s.
You can force the system to ignore the excludeNodeIDs parameter by setting the
“processAllNodeIds” on page 180 parameter to TRUE.
MaxOpenSessions
• Description:
This setting defines the maximum number of user log-in sessions cached on a
server thread.
more information, see “Number of Sessions” in “Configuring Performance
• Syntax:
MaxOpenSessions=100
• Values:

maxRightsString
• Description:
This parameter specifies which of two methods Content Server should use to
calculate a user's permissions for a particular item being requested. The choice is
based on the number of user rights that the user has. If a user who is attempting
to access an item in Content Server has a number of rights lists greater than, or
equal to, the specified number, the threshold, Content Server calculates the user's
permissions set for that item in a different way. The alternative method is
intended to improve performance in cases where individual Content Server users
have a large number of individual rights.
• Syntax:
maxRightsString=250
• Values:
processAllNodeIds
• Description:
Set processAllNodeIds to TRUE if you want the system to ignore the
“excludeNodeIDs” on page 179 parameter.
which is equivalent to processAllNodeIds=FALSE.
• Syntax:
processAllNodeIds=FALSE
• Values:
wantByteServing
• Description:
Enables or disables byte serving of PDF files.
• Syntax:
wantByteServing=FALSE
• Values:
wantLAPILogs
• Description:
Sets whether or not Content Server records the LAPI inArgs and outArgs
values, which are received and sent by the server, to the thread logs. For more
information, see “Clearing Outstanding Events” on page 832.

To enable this feature, you must manually add wantLAPILogs=TRUE to the

opentext.ini file in the [options] section.
• Syntax:
wantLAPILogs=FALSE
• Values:
TRUE or FALSE. By default, the wantLAPILogs parameter does not appear in the
opentext.ini file, which is equivalent to wantLAPILogs=FALSE.
wantLogs
• Description:
Turns detailed connection logging on or off. Log output is written to files called
connect<n>.log, where <n> is the thread number. For more information, see
• Syntax:
wantLogs=FALSE
• Values:
wantNotification
• Description:
Enables or disables e-mail notification. This setting is not used in Content Server.
It has not been used since Livelink 9.0.
wantSearch
• Description:
Allows or prevents searches performed by users. This setting is not used in
Content Server. It has not been used since Livelink 9.0.
wantSearchLogs
• Description:
Enables or disables search transaction logging. Input, or queries, and output, or
results, from the search engine, otsearch, are logged. Transactions are logged to
the file search.log in the <Content_Server_home>/logs directory, where
<Content_Server_home> is the root of your Content Server installation. For more
information, see “Enabling SQL Connection Logging” on page 575.
• Syntax:
wantSearchLogs=FALSE
• Values:

wantSecureCookies
• Description:
If Content Server is running on an HTTPS server, SSL, the secure flag will be set
for the user's login cookie.
• Syntax:
wantSecureCookies=TRUE
• Values:
wantTimings
• Description:
Records transaction timings in the thread logs. For more information, see
• Syntax:
wantTimings=TRUE
• Values:
wantVerbose
• Description:
Records all arguments passed from the web browser to the server in the thread
logs. For more information, see “Configuring Server Logging” on page 572.
• Syntax:
wantVerbose=TRUE
• Values:
wantWeb
• Description:
Enables Content Server to run on the web. If you plan to use Content Server only
through LAPI, you can set wantWeb to FALSE.
• Syntax:
wantWeb=TRUE
• Values:

7.3.43 [OTAdmin]
The [OTAdmin] section defines a port number for connection requests.
port
• Description:
Specifies the port on which the admin server accepts connection requests.
You must modify the value of this parameter in the opentext.ini file. For more
information, see “Understanding the opentext.ini File“ on page 91.
• Syntax:
port=5858
• Values:
Any open TCP/IP port. The default value is 5858.
7.3.44 [OTCommon]
InstallType
• Description:
This is OpenText proprietary information
otpath
• Description:
The path to the directory containing the configuration files for indexing and
searching.
• Syntax:
otpath=C:\OPENTEXT\config
• Values:
An absolute path.
7.3.45 [Passwords]
• “MaxPasswordLength” • “ExpirationDays” • “MustBeDifferent”

• “MinimumLength” • “ChangePWAtFirstLogin • “preventPwdReuse”
on page 184 ” on page 185 on page 185
• “MustContainDigits”
on page 184

These parameters appear in the [Passwords] section by default. To set them,

OpenText recommends that you use the Configure Password Settings page, rather
than edit the opentext.ini file directly. For more information, see “Configuring
User Settings” on page 391.
Notes
• The default settings listed below are applicable to new Content Server
installations; if Content Server is upgraded from a previous version and the
password values have been saved, the values will be retained in the
upgraded version.
Depending on other password settings, additional parameters may appear in
the [Passwords] section. For more information about these additional
settings, see “Configuring User Settings” on page 391.
• The password settings are now deprecated, and are controlled in OpenText
Directory Services.
MaxPasswordLength
• Description:
The maximum number of characters allowed for a user password is set to 16 by
default. To change the default number of characters allowed for user passwords,
you must manually add the MaxPasswordLength setting to the [Passwords]
• Syntax:
MaxPasswordLength=<integer for the maximum number of characters
allowed in user passwords>
MinimumLength
• Description:
Minimum number of characters required for a user's password.
• Syntax:
MinimumLength=6
• Values:
An integer between 0 and 16. The default value is 6. If 0 is selected, a blank
password is acceptable. The maximum value is 16.
MustContainDigits
• Description:
Governs whether or not passwords must contain at least one numeric character.
• Syntax:
MustContainDigits=TRUE

• Values:
TRUE or FALSE. The default value is TRUE, which means that a numeric character
is required.
ExpirationDays
• Description:
The number of days after which user passwords expire.
• Syntax:
ExpirationDays=30
• Values:
An integer greater than or equal to -1. The default value is 30. A value of -1
indicates that passwords never expire.
ChangePWAtFirstLogin
• Description:
Governs whether or not users must change their passwords after logging in to
Content Server the first time.
• Syntax:
ChangePWAtFirstLogin=TRUE
• Values:
TRUE or FALSE. The default value is TRUE, which means that users must change
their passwords after they first log-in to Content Server.
MustBeDifferent
• Description:
Governs whether or not users must specify a new password when they change
their password.
• Syntax:
MustBeDifferent=TRUE
• Values:
TRUE or FALSE. The default value is TRUE, which means that the changed
password cannot be the same as the previous password.
preventPwdReuse
• Description:
Determines how many days must pass before a previously used password can be
reused.
• Syntax:

preventPwdReuse=60
• Values:
An integer 0 or greater. The default value is 60. A value set to 0 indicates that the
same password can be used immediately.
7.3.46 [Project]
By default, the [Project] section does not appear in the opentext.ini file. You
only need to add it if you want to change the default value of the
ProjectOutlineSubtypes parameter, which is described below.
ProjectOutlineSubtypes
• Description:
By default, Content Server Projects contain seven subtypes of WebNode objects.
The subtype values translate to a node type name, or a label, which gets included
in the Include Item Types field on the Project Outline page of a Project.
By adding such a [Project] section to the opentext.ini file, the Administrator
can change subtype values based on your organization's project needs.
• Syntax:
ProjectOutlineSubtypes={204,215,207,144,140,136,400,0}
• Values:
The default values are:
Node Subtype Value Node Type

204 Task List
215 Discussion
207 Channel
144 Document
140 URL
136 Compound Document
0 Folder
For a complete list of node type number to name mappings, see “Node Type
Number to Name Mappings” on page 92.

7.3.47 [QDF]
The settings in the [QDF] section control the configuration of the Quality Document
Filters, QDFs, that the Document Conversion Service, DCS, uses. The QDFs convert
documents from their native formats to HTML or plain text for viewing and
indexing purposes. The details of this conversion process vary, depending on the
native file format. For example, the QDFs convert Microsoft Outlook files to HTML
or plain text for indexing. If available, the QDFs use the Unicode version of a
Microsoft Outlook file by default; however, if the Unicode format is not available,
the QDFs use the RTF version. If neither the Unicode nor the RTF versions are
available, the QDFs use the HTML version. If neither the Unicode, nor the RTF, nor
the HTML versions are available, the QDFs use a plain-text version. In cases where
the QDFs use the RTF or HTML version of a Microsoft Outlook file for indexing, the
content is extracted and returned to the DCS as if it were an attachment. The QDFs
RTF filtering mechanism then converts the RTF content to HTML or plain text for
indexing. For more information about QDFs, see Livelink Search Administration -
websbroker Module (LLESWBB-H-AGD).
The [QDF] section also configures the extraction of custom OLE document
properties from supported Microsoft Office documents. The exported metadata
region names are identical to the OLE document property names, with two
exceptions: they have the prefix OTDoc and discard all whitespace and slash
characters.
The [QDF] section of the opentext.ini file contains information about the
• “DefaultLatinEncoding” • “MinAsianAvgLength” • “MinHighLowRatioForSJI

on page 187 on page 189 S” on page 191
“lib” on page 188
• “MinAsianTextRatio”
• • “outputoleinfo”
• “showcdata” on page 188 • “MinAsianTokens”
on page 190 • “x-maxcalls” on page 192
• “maxfilesunzip”
on page 188 • “MinHighLowRatioForE • “x-timeout” on page 193
UC” on page 190
DefaultLatinEncoding
• Description:
Specifies the default Latin character set to detect.
A character set can have multiple mappings. For example, the ISO-8859-* and
EUC character sets each have several regional variations. Because these
variations overlap significantly, you can specify the default character set that the
QDFs will detect.
• Syntax:
DefaultLatinEncoding=ISO-8859-1
• Values:

ISO-8859-1 ~ ISO-8859-15, WinANSI. By default, this parameter does not appear

in the opentext.ini file, which is equivalent to
DefaultLatinEncoding=ISO-8859-1.
lib
• Description:
conversion. This parameter is a required setting for the DCS.
Modifying the value of this parameter may prevent the DCS from functioning, or
Important
Do not modify the value of this parameter unless directed to do by
• Values:
The default value is dcsqdf.
showcdata
• Description:
Specifies whether CDATA sections in Extensible Markup Language, XML,
documents should be extracted so that they can be indexed by the DCS.
• Syntax:
showcdata=FALSE
• Values:
TRUE or FALSE, where FALSE instructs the DCS to omit CDATA sections when
extracting data from XML documents so that they can be indexed. The default
value is FALSE.
Note: Setting this parameter to TRUE may affect search performance.
maxfilesunzip
• Description:
Specifies the maximum number of files that the QDFs extract from a compressed
file during conversion. The files that are extracted are determined by the order in
which the file creator originally added them.
Note: Recursive processing of compressed files is supported by the DCS

rules file configuration. That is, an LZH file within an LZH file, or a ZIP file
within an LZH file.
• Syntax:

maxfilesunzip=250
• Values:
MinAsianAvgLength
• Description:
Specifies the minimum average run length of adjacent multibyte tokens.
Once the QDFs have determined that a file does not contain only 7-bit characters,
Asian character set detection typically occurs. If the value of the
MinHighLowRatioForSJIS or MinHighLowRatioForEUC parameters is satisfied,
the QDFs will scan some text to determine the character set in use.
When scanning multibyte text, the QDFs perform some additional text
evaluations. For example, the QDFs determine the average run length of adjacent
multibyte tokens to determine whether the scanned text contains actual Asian
text or just instances of some tokens. In order to be evaluated, the average run
length of adjacent tokens must be longer than the minimum value set for the
MinAsianAvgLength parameter.
Note: When determining the average run length of adjacent multibyte

tokens, the QDFs ignore all white space in the scanned text.
For more information about the additional conditions that must be satisfied
for mulitbyte text evaluation to occur, see the MinAsianTextRatio and
MinAsianTokens parameters.
• Syntax:
MinAsianAvgLength=6
• Values:
MinAsianTextRatio
• Description:
Specifies the percentage of bytes of Asian text that must be exceeded during
Asian text detection.
evaluations. First, the QDFs determine the average run length of adjacent
multibyte tokens. For more information, see the MinAsianAvgLength parameter.
Then, one or both of the following conditions must be satisfied:

• The percentage of bytes of Asian tokens in the text exceeds the value specified
by the MinAsianTextRatio parameter.
• The number of identified tokens exceeds the value specified by the
MinAsianTokens parameter. For more information, see the MinAsianTokens
parameter.
• Syntax:
MinAsianTextRatio=50
• Values:
MinAsianTokens
• Description:
Specifies the number of multibyte tokens that must be identified during Asian
text detection.
evaluations. First, the QDFs determine the average run length of adjacent
multibyte tokens. For more information, see the MinAsianAvgLength parameter.
Then, one or both of the following conditions must be satisfied:
• The percentage of bytes of Asian tokens in the text exceeds the value specified
by the MinAsianTextRatio parameter. For more information, see the
MinAsianTextRatio parameter.
• The number of identified tokens exceeds the value specified by the
MinAsianTokens parameter.
• Syntax:
MinAsianTokens=5000
• Values:
MinHighLowRatioForEUC
• Description:
Specifies the ratio of high to low bytes that must be exceeded in order for Asian
character set detection to occur in EUC files.
Asian character set detection typically occurs. This level of character set detection
can be time consuming and may delay the MIME type detection operations. So,
depending on the content of the documents at your Content Server site, you may

not want this level of detection to occur or may only want it to occur when a
certain ratio of high to low byte characters is exceeded within a document. You
can manipulate this ratio by changing the value of the MinHighLowRatioForEUC
parameter.
• Syntax:
MinHighLowRatioForEUC=60
• Values:
MinHighLowRatioForSJIS
• Description:
Specifies the ratio of high to low bytes that must be exceeded in order for Asian
character set detection to occur in Shift-JIS files.
Asian character set detection typically occurs. This level of character set detection
can be time consuming and may delay the MIME type detection operations. So,
depending on the content of the documents at your Content Server site, you may
not want this level of detection to occur or may want it to occur only when a
certain ratio of high to low byte characters is exceeded within a document. You
can manipulate this ratio by changing the value of the MinHighLowRatioForSJIS
parameter.
• Syntax:
MinHighLowRatioForSJIS=50
• Values:
outputoleinfo
• Description:
Specifies whether the QDFs should extract OLE properties from the document
and export these properties as Content Server metadata regions. OLE is a
program-integration technology that is supported by all Microsoft Office
programs. OLE allows information to be shared among different programs.
If this parameter is enabled, the QDFs extract the standard OLE properties as
well as any custom OLE properties associated with a document. The standard
OLE properties are extracted and exported as the following metadata regions in
Content Server:

• OTDocTitle • OTDocSecurity
• OTDocSubject • OTDocCategory
• OTDocAuthor • OTDocPresentationTarget
• OTDocKeywords • OTDocBytes
• OTDocComments • OTDocLines
• OTDocTemplate • OTDocParagraphs
• OTDocLastSavedBy • OTDocSlides
• OTDocRevisionNumber
• OTDocNotes
• OTDocTotalEditingTime
• OTDocHiddenSlides
• OTDocLastPrinted
• OTDocMMClips
• OTDocCreateTimeDate
• OTDocLastSavedTimeDate
• OTDocScaleCrop
• OTDocNumberofPages
• OTDocHeadingPairs
• OTDocNumberofWords • OTDocTitlesofParts
• OTDocNumberofCharacters • OTDocManager
• OTDocThumbnail • OTDocCompany
• OTDocNameofCreatingApplication • OTDocLinksUpToDate
The following is an example of exported metadata regions displayed in a search

result:
• Syntax:
outputoleinfo=TRUE
• Values:
TRUE or FALSE, where TRUE instructs a QDF to extract the OLE-embedded
metadata from the file. The default opentext.ini configuration file shipped
with Content Server has a value of TRUE. The assumed default value, if not
specified in the configuration file, is FALSE.
x-maxcalls
• Description:


Important
parameter.
• Values:

about configuring a worker process, see “Configuring Server Logging”
on page 572.
x-timeout
• Description:
filters convert documents more slowly than other conversion filters. In this case,
the timeout default value of 30 seconds may not be applicable, as the average
Important
parameter.
• Values:

on page 572.

7.3.48 [relagent]
The [relagent] section contains proprietary OpenText information.
Important
section.
7.3.49 [report]
The [report] section contains LiveReport options. In versions of Livelink prior to
8.1, this section was called [reports].
objectSubTypes
• Description:
The objectSubTypes parameter controls the Content Server object types that
appear in Object input type lists in LiveReports. To modify the Content Server
object types displayed in these lists, modify the list of node type numbers, also
known as object type numbers. For more information about how object types are
used in LiveReports, see “Understanding Privileges and Permissions for
LiveReports” on page 975.
See “Node Type Number to Name Mappings” on page 92 if you need a reference
for each object type.
For more information about object subtypes, see the Content Server Module
Development Guide, or inspect the LLNode and WebNode objects in the Content
Server Builder.
• Syntax:
objectSubTypes={ 299, 215, 202, 206, 204, 144, 0, 140, 207, 130, 1, 131,
136, 400, 223, 230, 208, 128, 335 }
• Values:
The default value for this parameter is:
objectSubTypes={ 299, 215, 202, 206, 204, 144, 0, 140, 207, 130, 1, 131,
136, 400, 223, 230, 208, 128, 335 }
As shown in the example, the list of valid Content Server node type, or object
type, numbers must be separated by commas and the entire list must be
delimited by braces.
InsertStrEnabled
• Description:
Enables and disables the InsertStr input type.
• Syntax:
InsertStrEnabled=false

• Values:
true or false. The default value is false.
• Example:
[report]
InsertStrEnabled=true
blockedSQLterms
• Description:
Specifies all terms that should be blocked from usage in SQL. These terms are
checked whenever InsertStr has been used and the Secure mode enabled. For
more information, see OpenText Content Server User Online Help - Working with
LiveReports (LLESREP-H-UGD).
• Syntax:
blockedSQLterms=;,UPDATE,UPDATETEXT,WRITETEXT,REMOVE,DROP,CREATE,
ALTER,INSERT,COMMIT,EXECUTE,FETCH,REVOKE,ROLLBACK,SAVE,TRUNCATE,UN
ION
• Values:
A comma separated list of terms. The default value is ;,
UPDATE,UPDATETEXT,WRITETEXT,REMOVE,DROP,CREATE,
ALTER,INSERT,COMMIT,EXECUTE,FETCH,REVOKE,ROLLBACK,SAVE,TRUNCATE,UN
ION.
ModificationSQLTerms
• Description:
Specifies a list of terms that, if used in the SQL or in an SQL template, would
require the user to set the Allow Database Modification option. For more
information, see OpenText Content Server User Online Help - Working with
• Syntax:
ModificationSQLTerms=UPDATE,UPDATETEXT,WRITETEXT,REMOVE,DROP,CREAT
E,ALTER, INSERT,COMMIT,EXECUTE,FETCH,REVOKE,ROLLBACK,SAVE,TRUNCATE
• Values:
A comma separated list of terms. The default value is
UPDATE,UPDATETEXT,WRITETEXT,REMOVE,DROP,CREATE,ALTER,
INSERT,COMMIT,EXECUTE,FETCH,REVOKE,ROLLBACK,SAVE,TRUNCATE.
AllowDBModification
• Description:
Enables or disables the Allow Database Modification feature in LiveReports. For

• Syntax:
AllowDBModification=false
• Values:
true or false. The default value is false.
Note: This setting replaces a previous setting called lockDBModification.

If you had previously set lockDBModification=true, that is now
equivalent to the current AllowDBModification=false.
• Example:
[report]
AllowDBModification=true
QueryVisibleWithSeeContents
• Description:
Determines whether the View Query option is available to users with only See
Contents permission for the LiveReport. If the administrator sets this option to
true, users with See and See Contents permissions on a LiveReport will be able to
use the View Query option. For more information, see OpenText Content Server
User Online Help - Working with LiveReports (LLESREP-H-UGD).
• Syntax:
QueryVisibleWithSeeContents=true
• Values:
true or false. The default value is true.
• Example:
[report]
QueryVisibleWithSeeContents=false
7.3.50 [scheduleactivity]
This section contains proprietary OpenText information.
Warning
Do not manually change the values in the scheduleactivity section.

7.3.51 [SearchOptions]
The [SearchOptions] section contains the following Content Server Search
parameters:
• “brokerObjectCacheExpir • “hitHighlight” • “objectTypes and

e” on page 197 on page 199 objectTypesName”
• “masterCacheDisable” on page 200
• “dateTypesAdditions”
on page 197 on page 199 • “redirectPost”
• “MaxImportAgentObjects on page 201
• “defaultWebSearchDetail
PerTransaction”
” on page 198 • “resultCountLookAhead”
on page 199
• “findSimilar” on page 202
• “needValidHTTPSCertica
on page 198 te” on page 200 • “wantMultipleEnterprise”
• “functionMenu” • “NoHiddenItemForResult on page 202
on page 198 ” on page 200
brokerObjectCacheExpire
• Description:
Specifies the number of minutes that slice data on the Content Server search bar
is cached before it is refreshed.
For example, if you add or delete a slice, the brokerObjectCacheExpire
parameter specifies the number of minutes that will elapse before the slice
appears on, or is removed from, the Content Server search bar.
• Syntax:
brokerObjectCacheExpire=5
• Values:
An integer greater than, or equal to, zero. By default, this parameter is not
included in the opentext.ini file, which is equivalent to
brokerObjectCacheExpire=5. Setting the brokerObjectCacheExpire
parameter to 0 specifies that slice data is not cached.
dateTypesAdditions
• Description:
Specifies the list of non-default regions, additional ones discovered by the Search
Index, that will be treated as dates by the System Attributes advanced search
component. The date handling allows users to enter dates with a calendar widget
instead of the special text syntax.
• Syntax:
dateTypesAdditions={'region1name', 'region2name'}
• Values:

A comma separated list of any valid non-default regions. By default, this

parameter does not appear in the opentext.ini file, which is equivalent to no
regions specified.
An example of a valid entry is: dateTypesAdditions={'OTEmailSentDate',
'OTEmailReceivedDate'}
defaultWebSearchDetail
• Description:
Specifies the initial state of the Less Detail and More Detail links for the Web
Search and Web Search —Themes Right Search Result page styles. Users can
change the initial state by specifying the other detail setting.
• Syntax:
defaultWebSearchDetail=FALSE
• Values:
file, which is equivalent to defaultWebSearchDetail=FALSE, which sets the
initial state to the Less Detail link. To set the initial state to the More Detail link,
specify defaultWebSearchDetail=TRUE.
findSimilar
• Description:
Specifies if the Find Similar option is disabled for search result items when using
the search API with outputformat=xml (Extensible Markup Language). A
temporary value for this parameter can also be set using search API parameters.
• Syntax:
findSimilar=FALSE
• Values:
TRUE or FALSE. Default is TRUE.
Note: The values in the opentext.ini file are the defaults and if you set a
value in the API parameters it will override the opentext.ini value. If no
value is specified in either opentext.ini or the API parameter, the default
value is TRUE.
functionMenu
• Description:
Specifies if the Function menu is disabled for search result items when using the
search API with outputformat=xml (Extensible Markup Language). A
• Syntax:
functionMenu=false

• Values:
value is TRUE.
hitHighlight
• Description:
Specifies if the hit highlighting option is disabled for search result items when
using the search API with outputformat=xml (Extensible Markup Language). A
• Syntax:
hitHighlight=FALSE
• Values:
value is TRUE.
masterCacheDisable
• Description:
Specifies whether memory caching is prevented of search object data such as
Search Manager region maps and slice definitions.
• Syntax:
masterCacheDisable=TRUE
• Values:
file, which is equivalent to masterCacheDisable=FALSE.
MaxImportAgentObjectsPerTransaction
• Description:
Specifies the maximum number of objects from the DStagingImport table to
process per database transaction. This parameter can be used if there is a very
large amount of data in the table, which may cause memory issues.
• Syntax:
MaxImportAgentObjectsPerTransaction=25

• Values:
An integer greater than or equal to 1, or -1 for unlimited. The default is -1. By
default, this parameter does not appear in the opentext.ini file, which is
equivalent to MaxImportAgentObjectsPerTransaction=-1.
needValidHTTPSCerticate
• Description:
Specifies if a valid HTTPS (Hypertext Transfer Protocol Secure) certificate must
be present for the URL to local file conversion to be able to retrieve a document
over HTTPS.
• Syntax:
needValidHTTPSCerticate=FALSE
• Values:
TRUE or FALSE. Defaults to FALSE.
NoHiddenItemForResult
• Description:
Specifies whether Hidden items appear in a search results list or not.
• Syntax:
NoHiddenItemForResult=FALSE
• Values:
file, which is equivalent to NoHiddenItemForResult=FALSE, which includes
items designated as Hidden in a search results list. To exclude Hidden items,
specify NoHiddenItemForResult=TRUE.
objectTypes and objectTypesName

• Description:
Determines which types of Content Server items appear in the Object Type list
in the System Attributes section of the Content Server Search page. There are
two parameters that control the Object Type list: objectTypes and
objectTypesName.
Together, these parameters allow you to map object subtype values to the
display names that you want to appear in the System Attributes section's Object
Type list. Arrange both objectTypes and objectTypesName in the order in
which you want the options to appear in the Object Type list. If you want to add
or remove an option from the Object Type list, you must add or remove the
subtype value in the objectTypes parameter, and you must add or remove the
corresponding display name from the objectTypesName parameter.
For single known subtype values in the Object Type list, the corresponding
objectTypes parameter is ignored in favour of the official object type name in

Content Server. This is done to ensure the type name is available in every user
interface language.
Use the objectTypes parameter to list the subtype values of the Content Server
item types that you want to appear in the Object Type list in the System
Attributes section of the Content Server Search page. For example, in the default
configuration, the node type 144, (Content Server documents), corresponds to
Documents in the Object Type list. You can also combine several subtype values
by a Boolean OR operator to map them to the same option in the Object Type
list. You must enclose such expressions in quotation marks within the
objectTypes parameter. For example, in the default configuration, the entry
"130 OR 134", (Content Server topics and replies), corresponds to Discussions in
the Object Type list. For a complete list of subtype values in your Content
Server system, use the Content Server SDK Builder to run a script that lists all
subtype values, or refer to “[llview]” on page 172.
Use the objectTypesName parameter to list the strings, enclosed in single

quotation marks, that you want Content Server to display in the Object Type list
for each entry in the objectTypes parameter. List the display names in the
objectTypesName parameter in the same order as the objectTypes entries that
they represent. By default, the 'All Types' parameter is applied.
Tip: You can change the language used for the objectTypes by entering an
Xlate value instead of a numeric value.
• Syntax:
objectTypes={144,0,"206|212|204|205","130|134|215",202,128,189}
objectTypesName={'Documents','Folders','Tasks','Discussions',
'Projects','Workflow Map','Workflow Status'}
• Values:
By default, these parameters are not included in the opentext.ini file. This is
the equivalent of the settings listed in the Syntax section above.
redirectPost
• Description:
Specifies if search pages needing to “POST” search requests will redirect to a
“GET” request so that the Back button in an internet browser will function as
users expect it to. Also, the Content Server search bar will submit with a “GET”
request when possible.
• Syntax:
redirectPost=TRUE
• Values:
file, which is equivalent to redirectPost=TRUE.

resultCountLookAhead
• Description:
Specifies the number of extra search results to permission check, and if the end of
the “unpermissioned” result set can be reached in that range it will display the
exact count.
• Syntax:
resultCountLookAhead=225
• Values:
An integer between 0 and 225. By default, users can see 225 search results, which
is equivalent to resultCountLookAhead=225. For more information about search
results, see “Administering Searching Processes” on page 690.
Note: Specifying a value for this parameter does not guarantee an exact
count of search results will be available.
wantMultipleEnterprise
• Description:
Specifies whether to allow Administrators to create more than one Enterprise
Data Source.
• Syntax:
wantMultipleEnterprise=FALSE
• Values:
TRUE or FALSE. By default, this parameter does not appear in the opentext.ini file,
which is equivalent to wantMultipleEnterprise=FALSE. To enable the creation
of more than one Enterprise Data Source, specify
wantMultipleEnterprise=TRUE.
7.3.52 [Security]
The [Security] section sets Content Server security options.
allowedNextURLPrefixes
• Description:
This parameter is evaluated only if checkNextURL=TRUE. Its value is the name of
any URL prefix that Content Server accepts as a valid value for the prefix
portion of a NextURL value. (For the meaning of prefix, see “checkNextURL”
on page 204.)
• Syntax:
allowedNextURLPrefixes={'/prefix/','/another/prefix/'}

allowedNextURLSites
• Description:
This parameter is evaluated only if checkNextURL=TRUE. Its values are the names
of any binaries that are not specified by the “cgiDirectory” on page 203
parameter and that Content Server accepts as values for the CGI-file portion of
a NextURL value. (For the meaning of CGI-file, see “checkNextURL”
on page 204.)
• Syntax:
allowedNextURLSites={'<binary1.exe>', '<binary2.exe>'}
Authentication
• Description:
cgiDirectory
• Description:
This parameter is evaluated only if checkNextURL=TRUE. Its value is the name of
the folder that contains the Content Server CGI and ISAPI binaries (by default
the <Content_Server_home>\cgi\ folder). The names of the files contained in
the cgiDirectory are accepted as values for the CGI-file portion of a NextURL
value. (For the meaning of CGI-file, see “checkNextURL” on page 204.)
• Syntax:
cgiDirectory=cgi
• Values:
The name of the folder that contains the CGI and ISAPI binaries (by default the
<Content_Server_home>\cgi\ folder). The default value is cgi.
CGIHosts
• Description:
A list of hosts from which the server accepts client connections. These
connections are made from the CGI program, which is called cs on Linux and
Solaris systems and cs.exe on Windows systems. Since the CGI program and
the server must be on the same host, the default value is the IP address
127.0.0.1, which is a special IP address used for the localhost.
If the list is empty, the server will accept CGI connections from any IP address.
• Syntax:
CGIHosts=127.0.0.1
• Values:
The default value is 127.0.0.1, which is a special IP address used for the
localhost. In rare circumstances, some systems may not recognize that this special

IP address refers to the localhost. If this occurs, replace this special IP address
with the unique IP address or host name of the localhost.
checkNextURL
• Description:
This parameter enables NextURL validation.
Setting checkNextURL=TRUE protects the nextURL value from attackers who want
to direct Content Server users to other sites. If this parameter is enabled, Content
Server evaluates the “cgiDirectory” on page 203, “allowedNextURLPrefixes”
on page 202, and “allowedNextURLSites” on page 203 parameters to determine
whether the value of the nextURL URL extension is permitted.
Tip: The NextURL value is delivered to your browser as part of a response

to certain requests.
Example: If you submit a request to add a Task List, the server responds with the
URL for a page that allows you to name the Task List. The URL includes a NextURL
value. The NextURL value is the next logical request (expressed as a URL) to
complete the addition of a Task List to Content Server.
For the purposes of NextURL validation, a Content Server URL has the following
components:
<protocol>://<server>/<prefix>/<CGI-file>?func=...
Example: In the following URL, the server is my-server, the prefix is

contentmgmt, and the CGI-file is cs.exe:
http://my-server/contentmgmt/cs.exe?func=...
If checkNextURL=TRUE, the values of the components are compared to the values

of the following parameters to determine whether the nextURL value is
permitted.
<protocol>
Not evaluated by NextURL validation
<server>
Not evaluated by NextURL validation
<prefix>
“allowedNextURLPrefixes” on page 202
<CGI-file>
“cgiDirectory” on page 203, “allowedNextURLSites” on page 203
Note: Anything after the CGI-file portion of the URL is not evaluated by
NextURL validation.
• Syntax:
checkNextURL=TRUE

• Values:
directoryList
• Description:
hideContainerSize
• Description:
Setting this parameter to TRUE prevents Content Server from displaying how
many items are in a container.
Note: This parameter also applies to Prospectors. Prospector nodes display

an empty size value when this parameter is set to TRUE.
To set this parameter, OpenText recommends that you use the Configure
Security Parameters page, rather than edit the opentext.ini file directly. For
more information, see “Configuring Security Parameters” on page 77.
• Syntax:
hideContainerSize=FALSE
• Values:
TRUE or FALSE. By default, this entry is not displayed in the opentext.ini file,
which is equivalent to hideContainerSize=FALSE.
7.3.53 [Servers]
The [Servers] section pertains to Content Server Explorer module use only. In this
section, the Administrator provides a directory path mapping where a primary
server connects to one or more secondary servers for the purpose of allowing users
to perform actions on items between servers. Examples of these actions include:
open, copy, and delete.
Content Server Explorer provides a view similar to that of the Windows Explorer
familiar to users of Windows operating systems. If a secondary server name is
mapped in the opentext.ini file, all users can see the name of the secondary server
in the tree view, and make subsequent entries open folders, sub-folders and items.
In the following example, remote_0 is the name of the Content Server secondary
server. It is followed by the URL that links the primary server to the secondary
server.
#server_0=remote_0|http://myNT/support/cs.exe"

7.3.54 [sockserv]
The [sockserv] section contains proprietary OpenText information.
Important
section.
7.3.55 [Summarizer]
The [Summarizer] section of the opentext.ini file controls one aspect of the
Document Conversion Service, DCS. This service converts documents from their
native formats to HTML, or raw text, for viewing and indexing purposes. DCSs are
managed by Admin servers. The conversion services managed by the DCS share the
parameters in the opentext.ini file. These parameters control the behavior of the
conversion services. The [Summarizer] section, as a part of the DCS, is enabled by
default.
Content Server Summarizer works with Content Server's search features to provide
automatically generated summaries for documents. If Summarizer is turned on, and
your display options in Content Server are set to display summaries, Content Server
displays document summaries on the Search Result page after you perform a
search. Summarizer generates summaries by compiling sentences based on their
location in the document, the surrounding structures in the document, and the
statistical significance of the words in the sentences. These sentences are identified in
conjunction with the word frequency file, which is a configuration file that identifies
the statistical frequency of words drawn from a large body of documents.
Summarizer also generates the key phrases associated with a document. Key
phrases are phrases from the document that are likely to be indicative of the content.
By default, Summarizer designates five phrases as key phrases, based on several
factors, including the repetition of the phrases within the document and the location.
If the document does not contain five suitable key phrases, Summarizer generates as
many as it can. Key phrases are also displayed on the Search Result page after you
perform a search, provided your display options in Content Server are set to display
key phrases and Summarizer is enabled.
Summarizer begins by tokenizing source files to determine which elements are

words, abbreviations, and so on. After defining the elements in the source file,
Summarizer determines which series of tokens are readable sentences. It also
analyzes the structure of the source file to determine which regions are most likely
to contain good summary data. Summarizer then scores sentences according to the
importance of words in both the document and the word frequency file, and then
generates the summary. If Summarizer cannot summarize a source file, because of
its structure or the readability of its sentences, its summary consists of the first 10
words in the file. If the source file does not have any word tokens, Summarizer does
not generate a summary or key phrases.

OpenText has designed and configured Summarizer for English documents, but you
can adjust its configuration to summarize documents in other languages. If you
want to customize Summarizer, consider the following implications:
• Summarizer has the ability to summarize Japanese, French, and German, but has
not been tested with languages other than English.
• Summarizer accommodates most sentence-ending punctuation from languages
other than English.
• Multibyte languages can be summarized. Tokenization is Unicode-based.
• Summaries for languages requiring dictionary-based tokenization may not be
complete.
The [Summarizer] section of the opentext.ini file contains the following

parameters:
Important
OpenText strongly recommends that you do not modify the values of these
parameters.
• “SumAbbrevFile” • “SumDocFreqFile” • “SumTagFile”

• “SumDefFile” • “SumStopWordFile”
In addition to these parameters, this page also contains information about the
following DCS parameters. These parameters are required settings that are only
used by DCS.
• “lib” on page 210 • “summarysentences” • “x-maxcalls” on page 212

• “summary” on page 210 on page 211 • “x-timeout” on page 212
• “summaryhotwords” • “summarysize”
• “summarytitlesize”
on page 211
SumAbbrevFile
• Description:
Specifies the relative path and name of the abbreviation file that Summarizer
uses to define common abbreviations and all three-letter combinations that are
not words.
• Values:
A path and file name, relative to the location of the DCS in your Content Server
installation. By default, the abbreviation file is named abbrev.eng and is stored
in the config directory of your Content Server installation.

SumDefFile
• Description:
Specifies the relative path and name of the definition file that Summarizer uses to
define its operation. The definition file contains five numbers, one number per
line, each representing the following:
• A score multiplier for sentences that are in the first 20 percent of a document.
These sentences are probably introductory sentences and are likely to be good
summary sentences.
• A maximum number of word tokens allowed in a summary sentence. A word
token is a combination of letters, numbers, dashes, and entity references.
Summarizer marks sentences containing more word tokens than the
maximum number as unreadable and does not use them as summary
sentences.
• A minimum number of word tokens allowed in a summary sentence.
Summarizer marks sentences containing fewer word tokens than the
minimum number as unreadable and does not use them as summary
sentences.
• A maximum ratio of non-word tokens to word tokens. If the actual ratio of
non-word tokens to word tokens exceeds this number, Summarizer marks the
sentence as unreadable and does not use it as a summary sentence.
• The number of documents used to form the data for the statistical significance
of words in the word frequency file.
• Values:
installation. By default, the definition file is named summdef.eng and is stored in
the config directory of your Content Server installation.
SumDocFreqFile
• Description:
Specifies the relative path and name of the word frequency file that contains the
data necessary for Summarizer to calculate the statistical significance of words in
documents. This file contains a list of words that occurred in more than 1,000 of
the 1,371,876 documents that OpenText used to build the statistical background
for Summarizer's default settings.
• Values:
installation. By default, the word frequency file is named docfreq.eng and is
stored in the config directory of your Content Server installation.
SumStopWordFile
• Description:

Specifies the relative path and name of the stopword file that Summarizer uses to
define a list of common stopwords. Stopwords are words that add no semantic
value to a sentence. These words are typically functional words such as “a”,
“and”, and “the”. By distinguishing stopwords from semantically important
words, Summarizer identifies which words are more likely to contribute to the
document's distinct meaning, increasing the accuracy of its summaries and key
phrases.
• Values:
installation. By default, the stopword file is named stopword.eng and is stored
in the config directory of your Content Server installation.
SumTagFile
• Description:
Specifies the relative path and name of the tag file that contains a list of markup
tags that appear in documents. Examples of markup tags include HTML, XML,
and SGML. Next to each tag is a number that specifies the tag's importance to
Summarizer. The following table describes the meaning of each number.
Table describing the range of tag significance settings:
Number Description
0 Summarizer ignores these tags, but does
not ignore the data enclosed in them. If a
sentence begins before this tag, and has this
tag within it, Summarizer does not break
the sentence into two sentences. By default,
unknown tags are marked with this
number.
1 Summarizer ignores these tags, but does
not ignore the data enclosed in them. If a
sentence begins before this tag, and has this
tag within it, Summarizer breaks the
sentence into two sentences.
2 Summarizer ignores these tags and the
data enclosed in them.
3 This value marks the data enclosed in these
tags as abstract, or overview, sentences.
Summarizer creates the summary by using
sentences in the title, abstract, and
conclusion, in that order, before any other
sentence.
tags as concluding sentences. Summarizer
creates the summary by using sentences in
the title, abstract, and conclusion, in that
order, before any other sentence.

Number Description
tags as title sentences. Summarizer creates
the summary by using sentences in the
title, abstract, and conclusion, in that order,
before any other sentence.
• Values:
installation. By default, the tag file is named tags.eng and is stored in the config
directory of your Content Server installation.
lib
• Description:
conversion.
Modifying the value of this parameter may prevent the DCS from functioning, or
Important
• Values:
The default value is dcssum.
summary
• Description:
Specifies whether the DCS generates summaries of the documents that it
converts to HTML. If the user sets the search display options to show summaries,
Content Server displays these summaries with search results on the Search
Result page.
• Values:
TRUE or FALSE, where TRUE instructs the DCS to generate summaries. By default,
the summary parameter is set to TRUE on the command line of each DCS.
To set the summary parameter to FALSE, you must use “Command Line
Arguments” on page 585 rather than change the parameter in the opentext.ini
file, since arguments set on the command line override the global parameters set
in the opentext.ini file.
summaryhotwords
• Description:

Specifies the number of hotwords that Summarizer uses to generate a document

summary. Reducing this value may speed up summarization, but there are many
other variables that also affect the speed of this process.
Important
OpenText strongly recommends that you not modify the value of this
parameter.
• Values:
summarysentences
• Description:
Specifies the number of sentences to generate in summaries.
• Syntax:
summarysentences=5
• Values:
An integer greater than, or equal to, one. By default, this parameter does not
appear in the [Summarizer] section of the opentext.ini file, which is
equivalent to summarysentences=5.
summarysize
• Description:
Specifies the portion of the converted document, in bytes, used by Content
Server to generate a summary. A lower value restricts the summary to the first
<n> bytes of the document. Changing this value may also affect document
conversion performance of larger documents.
Important
parameter.
• Values:
Any integer greater than one. The default value is 256000 bytes.
summarytitlesize
• Description:
Specifies the number of characters to display in search result titles for specific
documents. These documents originate from data sources other than the Content
Server Enterprise data source, such as Directory Walker or Spider data sources.
• Syntax:
summarytitlesize=30

• Values:
x-maxcalls
• Description:
Important
parameter.
• Values:

on page 572.
x-timeout
• Description:
the timeout parameter on the opentext.ini page for each conversion filter. For
example, some conversion filters convert documents slower than other
conversion filters. In this case, the timeout default value of 30 seconds may not
be applicable, as the average conversion time is longer than this value. In this
case, you can modify the x-timeout value to a higher and more appropriate
value.
Important
parameter.
• Values:


on page 572.
7.3.56 [Tabs]
The [Tabs] section contains OpenText proprietary information.
Important
section.
7.3.57 [unix_lang]
The [unix_lang] section, which is applicable to Linux and Solaris only, contains
system-specific information about the Content Server host's locale. For more
information on locale functions and attributes, ask your system administrator.
LL_LC_ALL
• Description:
Default language that the system uses for input and output. This corresponds to
the LANG argument of the locale command. Leave this value set to the default.
• Syntax:
LL_LC_ALL=C
• Values:
Values are platform dependent. The default value, C, works on all platforms. This
corresponds to the ANSI C 7-bit standard.
NLS_LANG
• Description:
Specifies Oracle's internal NLS_LANG setting.
• Values:
Operating-system dependent. As an example, a US-English Solaris machine uses
american_america.us7ascii by default. Consult your Oracle documentation to
determine an appropriate value for your installation.
NLS_SORT
• Description:

Oracle client environment variable that determines how search results returned
from the database are ordered.
• Syntax:
NLS_SORT=binary
• Values:
Any valid Oracle sort method. The default value is binary.
7.3.58 [UserSetting]
The [UserSetting] section controls the color settings of the Content Server user
interface and Content Server user name display throughout the interface.
Color settings pertain to the color scheme seen on most Content Server pages. In
general, most pages present data in rows and columns. Content Server users modify
their default colors for column headers and rows by accessing the Tools menu.
User name displays are formats that identify how names appear in Content Server.
The Administrator modifies name formats by making changes on the Configure
User Name Display page of the administration page.
• “RowColorOptions” • “Row1Color” • “ColumnHeaderColor”

• “ColumnHeaderColorOpt • “Row2Color” • “UserNameAppendID”
ions” on page 214 on page 215 on page 215
RowColorOptions
• Description:
Provides the six hexadecimal color value options available for users to select for
Row 1 and Row 2. Users can change the default row color by modifying Settings
on the Tools menu.
• Syntax:
RowColorOptions=#FFFFFF,#EEEEEE,#FFFFCC,#CCFFFF,#CCFFCC,#DDDDFF
• Values:
A comma separated list of any valid Hexadecimal color values.
ColumnHeaderColorOptions
• Description:
Provides the four hexadecimal color value options for users to select for the
column headers that appear on most Content Server pages. Users can change the
default header column color by modifying Settings on the Tools menu.
• Syntax:

ColumnHeaderColorOptions=#CCCCCC,#A0B8C8,#83D8A4,#CCCC99
• Values:
A comma separated list of any valid Hexadecimal color values.
Row1Color
• Description:
Identifies a hexadecimal color value for Row 1. Any changes made to this field
impacts only the local computer's INI settings, it does not impact any other user
on the Content Server system.
• Syntax:
Row1Color=#EEEEEE
• Values:
Any valid Hexadecimal color value. The default color value is #EEEEEE.
Row2Color
• Description:
Identifies a hexadecimal color value for Row 2. Any changes made to this field
impacts only the local computer's INI settings, it does not impact any other user
on the Content Server system.
• Syntax:
Row2Color=#FFFFFF
• Values:
Any valid Hexadecimal color value. The default color value is #FFFFFF.
ColumnHeaderColor
• Description:
Identifies a hexadecimal color value for the column headers. Any changes made
to this field impacts only the local computer's INI settings, it does not impact any
other user on the Content Server system.
• Syntax:
ColumnHeaderColor=#CCCCCC
• Values:
Any valid Hexadecimal color value. The default color value is #CCCCCC.
UserNameAppendID
• Description:
A format that allows the Content Server Log-in ID to append to the name display
throughout Content Server. The UserNameAppendID setting can be changed only

by the Administrator on the Configure User Name Display page of the

administration interface.
• Syntax:
UserNameAppendID=0
• Values:
0 or 1. The default value is 0, or false, which means the Content Server Log-in ID
will not append to the display name. The other valid value is 1, or true, which
means the Content Server Log-in ID will append to the display name.
An example of each would be:
• If UserNameAppendID=0, the name display format is: John Q Public.
• If UserNameAppendID=1, the name display format is: John Q Public
(JQPublic).
7.3.59 [ViewableMimeTypes]
• Description:
The [ViewableMimeTypes] section lists the MIME types of documents for which
the Open operation should be treated like a Fetch. Content Server passes the
document directly to the web browser without first trying to convert it to HTML
for display.
• Values:
The following is an example of the [ViewableMimeTypes] section in the
opentext.ini file:
MimeType_1=image/gif
MimeType_2=image/jpeg
MimeType_3=text/html
MimeType_4=text/plain
MimeType_5=application/pdf
MimeType_6=application/x-zip-compressed
MimeType_7=text/xml
MimeType_8=message/rfc822
MimeType_9=application/x-macbinary
MimeType_10=image/pjpeg

7.3.60 [Workflow]
The [Workflow] section includes settings that control Workflow behavior.
ExcludedNodeSubTypes
• Description:
Controls which items are excluded from the item reference attribute.
• Syntax:
ExcludedNodeSubTypes={731,732,900,901,902,903,904,905,906,919,920}
• Values:
The node type ID of the items you want to exclude from the item reference
attribute. The node type IDs that you specify for this parameter must be
contained in braces, and each node type ID must be separated by a comma.
For example, the setting ExcludedNodeSubTypes={141,142} excludes the
Enterprise Workspace, which is node type ID 141, and the Personal Workspace,
which is node type ID 142, from the list of items that can be stored in an item
reference attribute.
IHLogging
• Description:
Controls Item Handler step logging.
• Syntax:
IHLogging={1}
• Values:
• 0
Disables Item Handler logging with time stamps.
• 1
Enables Item Handler logging.
• 11
Enables Item Handler logging with time stamps.

7.3.61 [XML]
The [XML] section contains the configuration settings for XML Export. By default,
this section appears in the opentext.ini file when Content Server is installed.
Please consult with OpenText Customer Support before making modifications to
this section.
• “Encoding” on page 218 • “MaxNodesToExport” • “UnencodedMimetype”

• “StyleSheetMimeType” on page 219 on page 219
on page 218 • “FetchSize” on page 219
Note: An additional parameter, LogPath, can be added to the [XML] section to

route the logging of XML import and export activity to its own directory. By
default, XML log files are stored alongside other Content Server log files. For
more information, see “Logpath” on page 150. If your Content Server system
uses XML import and export extensively, you can add the line
LogPath=<full_directory_path> to the [XML] section, where
<full_directory_path> is the directory path that you specify.
Please consult with OpenText Customer Support before making this or any
other modification to this section.
Encoding
• Description:
Sets the encoding attribute of the XML declaration. An example of an XML
declaration is: <?xml version="1.0" encoding="ISO-8859-1"?>.
• Syntax:
encoding=ISO-8859-1
• Values:
The default value is ISO-8859-1.
StyleSheetMimeType
• Description:
Sets the value of the type attribute on the link to the stylesheet that is embedded
in the XML export. An example of a stylesheet declaration is: <?xml-stylesheet
type="text/xsl" href=".."?>. Microsoft IE5 requires the value text/xsl,
which is not a formally recognized MIME type.
• Syntax:
StyleSheetMimeType=text/xsl
• Values:
The default value is text/xsl.

MaxNodesToExport
• Description:
Sets the upper limit on how many nodes can be exported in a single export
request. Zero, or a negative number, specifies an unlimited number of nodes.
• Syntax:
MaxNodesToExport=1000
• Values:
FetchSize
• Description:
Sets the chunk size at which nodes are exported and written to the browser.
• Syntax:
FetchSize=20
• Values:
UnencodedMimetype
• Description:
Specifies the MIME types that can be exported unencoded when the content
input parameter of the XMLExport request contains the value cdata or plain. If
you do not specify the MIME type, the cdata and plain values are ignored.
• Syntax:
UnencodedMimetype_1=text/xml
• Values:
Valid MIME types.

Chapter 8
Administering MIME Types and Icons
By default, Content Server recognizes approximately 100 MIME types. MIME stands
for Multipurpose Internet Mail Extensions, which is a standard used to identify the
formats of files. You can modify the list of MIME types that Content Server
recognizes by editing the <Content_Server_home>/config/mime.types file. The
MIME types in this file are the ones that appear in the MIME Type list on the
Specific tab of a Document's Properties page.
Similarly, you can modify the list of icon-to-MIME-type mappings by editing the
Content_Server_home/config/mime.gif file.
For information about modifying other system-configuration files, see “Modifying

System Configuration Files” on page 88.
8.1 Modifying the MIME Types List

When a file is uploaded to the Content Server database, the following list shows the
actions performed by Content Server to determine the document’s MIME type. If the
first action fails to determine the MIME type, the next action occurs.
1. Content Server looks for information about the file's MIME type from the user's
web browser.
2. Content Server looks up the file's extension in the mime.types file to see if it is
mapped to a MIME type in that file.
3. Content Server attempts to identify the MIME type using an autorecognition
program.
4. Content Server assigns the file the first MIME type listed in the mime.types file.
By default, this is application/octet-stream.
Note: The default actions, and the order in which they occur, can be changed
on the System Administration page.
In addition to assigning MIME types to uploaded documents, the mime.types file

controls the MIME types displayed in the MIME Type list on the Specific Info page
of Documents in Content Server. By default, the mime.types file contains
approximately 100 MIME types.
Using a text editor, you can easily modify the mime.types file to add a MIME type,
remove a MIME type, or map a new file extension to an existing MIME type.
The Mime Types list

The Mime Types can be found in the Content_Server_home/config/mime.types
file, and it can be modified using a text editor.

Chapter 8 Administering MIME Types and Icons
Example 8-1: An Example of a Mime Types List
# MIME type to file extension mapping file.

#
# This is a whitespace-separated values file where blank lines and
text
# following "#" is ignored.
#
# Each line is a separate entry with the following format:
# <mime type> <file extension> ...
application/activemessage
application/andrew-inset
application/applefile
application/atomicmail
application/dca-rft
application/dec-dx
application/mac-binhex40
application/macwriteii
application/msword doc W6BN
application/vnd.ms-excel xls xlb XLS5
application/powerpoint ppt SLD3
A MIME type is added to the list in the following format:
<mime_type> <file_extension1> <file_extension2> ...
Taking one example of a <mime_type> from the MIME Types list above:
application/msword, the two associated <file_extensions> are: doc and W6BN.
However, when adding a new MIME type, it is not necessary to map a file extension
to the MIME type.
You can use the # character to append a comment to any entry. Everything after the
# character is considered to be a comment and is ignored by Content Server.
8.1.1 To Configure MIME Type Detection Rules

To configure MIME type detection rules:
1. In the System Administration section of the Content Server Administration

page, click the Configure MIME Type Detection link.
2. On the Configure MIME Type Detection page, highlight any of the available
MIME type detection methods and use the right arrow to move them to the
Selected Methods field.
3. Once the methods you want used appear in the Selected Methods field, use the
up and down arrows to place the methods in the order they should be used.

8.2. Modifying Icon-to-MIME type Mappings
8.1.2 To Modify the MIME Types List

To modify the MIME types list:
1. Open the <Content_Server_home>/config/mime.types file in a text editor.
2. To add a new MIME type to the mime.types file, add the MIME type on its own
line in the format:
<mime_type> <file_extension1> <file_extension2> ...
Note: It is not necessary to map a file extension to the MIME type.
3. To map a new file extension to an existing MIME type, append the extension to
the MIME type's row, separating it from any other file extensions with a space.
4. To remove a MIME type entry, delete its line from the mime.types file.
Tip: If you are not sure whether or not to permanently remove the MIME
type, comment out the MIME type's line by inserting a # character at the
beginning of the line instead of deleting it. This way, if you do need to use
this MIME type in the future, you can remove the # character.
5. Save and close the mime.types file.

If the updated list of MIME types does not immediately appear in the MIME
Types list on the Specific Info page of a document, you may need to reload
your web browser.
8.2 Modifying Icon-to-MIME type Mappings

The icons used to identify certain MIME types are controlled by the icon-to-MIME
type mappings in the <Content_Server_home>/config/mime.gif file. When a
Content Server user adds a Document to the system, Content Server notes its MIME
type and checks the mime.gif file to see if a specific icon has been defined for the
new file's MIME type. For example, if a user adds a Microsoft Word document to
Content Server, a Microsoft Word icon appears next to it in Content Server,
because the icon's GIF file has been mapped to the application/msword MIME type
in the mime.gif file.
If a document's MIME type is not specified in the mime.gif file, Content Server uses
a default document icon, .
You can edit the mime.gif file to do any of the following:
• Associate a new or different icon file with an existing MIME type or types.
• Associate a new MIME type with an existing icon file.
• Associate a new MIME type with a new icon file.

Tip: You can use an image editor to create custom icons for use with the
Documents you add to Content Server.
Creating a Custom Icon

If you want to create a custom icon for use by MIME types in Content Server, you
should consider creating three different sizes of each custom icon:
•
The default requirement is for a 16 × 16 pixel icon, , which you create in your
<Content_Server_home>/support/webdoc directory.
• If a user chooses to make an item a Featured Item, Content Server displays a 32 ×
32 pixel icon, which you create in your <Content_Server_home>/
support/webdoc directory and your <Content_Server_home>/
support/mimetypeimages directory.
• Content Server uses a 145 × 145 pixel icon on an item's Overview page. You
create this icon in your <Content_Server_home>/support/mimetypeimages
directory.
8.2.1 To Add a New Icon File

To add a new icon file:
1. Create an icon file in the General Internet Format image format, with the .gif
file extension.
2. Create four copies of the new icon file, as follows
• Create a 16 × 16 pixel icon in the <Content_Server_home>/support/webdoc

directory.
• Create a 32 × 32 pixel icon in the <Content_Server_home>/support/webdoc
directory.
• Create a 32 × 32 pixel icon in the <Content_Server_home>/
• Create a 145 × 145 pixel icon in the <Content_Server_home>/

3. Map the new icon file to the desired MIME type(s). For more information, see
“To Modify Icon-to-MIME Type Mappings” on page 225.

8.3. Associating MIME Types and Categories
8.2.2 To Modify Icon-to-MIME Type Mappings

To modify icon-to-MIME type mappings:
1. Open the <Content_Server_home>/config/mime.gif file in a text editor.
2. To associate a new MIME type with an existing icon file, type the new MIME
type after the existing MIME types, separating them with spaces.
3. To associate a new icon file with new or existing MIME types, add an entry to
the mime.gif file in the following format:
<gif_name> <file_name> <mime_type1> <mime_type2> ...
4. You can use the # character to append a comment to an icon mapping entry.
Everything after the # character is considered to be a comment and is ignored
by Content Server.
5. Make sure that any MIME type that you reference in the mime.gif file is listed
in the <Content_Server_home>/config/mime.types file. For more
information, see “Modifying the MIME Types List” on page 221.
6. Do not associate a MIME type with more than one icon file.
7. Save and close the mime.gif file.
Tip: If a new icon does not immediately appear in Content Server, you may
need to reload your web browser.
8.3 Associating MIME Types and Categories

You can associate any available MIME type with an existing Category. When a
MIME type is associated with more than one Category, and users add objects of that
MIME type, they are directed to a second page during the Add Item process where
they can choose which Category they want applied to that item.
In order to allow users to choose a Category when they add an item, if the item they
are adding is of a MIME type that has more than one Category associated with it,
you must select the Display categories on second Add Item page check box on the
Administer Item Control page. For more information about item control
parameters, see “Administering Item Control“ on page 323.

8.3.1 To Associate a MIME Type with a Category

To associate a MIME type with a Category:
1. In the System Administration section of the Content Server administration

page, click the Administer MIME Types and Categories link.
2. On the Administer MIME Types and Categories page, click the Add Category
icon, , to add existing Categories in Content Server to the Categories list.

3. In the MIME Types list, highlight each MIME Type that you want to associate,
highlight each Category with which you want the MIME Type associated, and
then click the Associate Category icon, .
4. Click Submit.

Chapter 9
Managing the Servers in Content Server
Managing the servers in Content Server includes the following tasks:
• “Stopping and Starting the Servers” on page 227

• “Backing Up and Restoring Content Server” on page 230
9.1 Stopping and Starting the Servers

When you perform certain system administration tasks, you must restart Content
Server for the changes to take effect.
In most cases, when a restart is necessary, Content Server displays the Restart
Content Server page. This page includes a Restart button that allows you to restart
Content Server automatically (and a Continue button that allows you to bypass the
automatic restart). However, there may be times when you prefer to restart Content
Server manually, and occasionally you may need to restart Content Server in the
absence of the Restart Content Server page. You may also need to restart the
Content Server Admin server or the Content Server Cluster Agent, which are not
restarted automatically. At such times, you can follow the instructions in this section
to restart any of the Content Server servers.
There are three servers referred to in this section: Content Server , the Admin server,
and the Cluster Agent. If you keep the default settings during the Microsoft
Windows installation of Content Server, your servers are given the following default
names:
• Content Server (OTCS): referred to in the help as Content Server.

• Content Server Admin (OTCS): referred to in the help as the Admin server.
• Content Server Cluster Agent (OTCS): referred to in the help as the Cluster
Agent
9.1.1 Stopping and Starting the Servers under Windows

Stopping the servers under Windows
To stop a server under Windows:
1. Open Windows Services.
2. Stop one or more of the Content Server services:
a. To stop the Content Server (OTCS) service, right-click its name, and then
click Stop.

Chapter 9 Managing the Servers in Content Server
b. To stop the Content Server Admin (OTCS) service, right-click its name,
and then click Stop.
c. To stop the Content Server Cluster Agent (OTCS) service, right-click its
name, and then click Stop.
Starting the servers under Windows
To start the servers under Windows:
2. Start one or more of the Content Server services:
a. To start the Content Server (OTCS) service, right-click its name, and then
click Start.
b. To start the Content Server Admin (OTCS) service, right-click the name of
the Admin server, and then click Start.
c. To start the Content Server Cluster Agent (OTCS) service, right-click its
name, and then click Start.
9.1.2 Stopping and Starting the Servers under Linux or

Solaris
Stopping the Servers under Linux or Solaris
Stopping or starting the Content Server process under Linux or Solaris also shuts
down or starts the Admin server process.
To stop Content Server and the Admin server under Linux or Solaris:
1. Log on to the Linux or Solaris host with the user name that Content Server uses.
2. At the command prompt, change to the directory where Content Server is

installed.
3. Type the following command, and then press ENTER:

./stop_llserver
Tip: To start only the Content Server Admin server process, run ./
stop_lladmin
To stop the Cluster Agent under Linux or Solaris:

installed.

./stop_otclusteragent

9.1. Stopping and Starting the Servers
Starting the Servers under Linux or Solaris
To start Content Server and the Admin server under Linux and Solaris:
installed, and then do one of the following:
• To start Content Server and the Admin server, type the following command,
and then press ENTER:
./start_llserver
• To start only the Admin server, (on a secondary Content Server host, for
example), type the following command, and then press ENTER:
./start_lladmin
To start the Cluster Agent under Linux or Solaris:
installed.
./start_otclusteragent
9.1.3 Setting the Servers to Start Automatically

By default, the Content Server setup program configures Content Server, the Admin
server, and the Cluster Agent to start automatically. (If you have multiple instances
of Content Server installed on a host machine, the setup program only starts one
instance of the Cluster Agent.) OpenText recommends that you do not alter this
setting because Content Server requires these servers to function correctly. However,
there may be times, such as when you are troubleshooting a problem, that you do
not want the servers to start automatically when the primary Content Server host
machine is restarted. In such cases, you can temporarily set one or more of the
servers to manual startup, but make sure that you reset them to automatic startup
when you are done.
Note: Whenever you restart Content Server, remember to restart your web
application server, if you use one in your Content Server environment.
The procedures for setting Content Server, the Admin server, and the Cluster Agent
to start automatically or manually differ on Windows and on Linux or Solaris.
To modify the startup settings of a server under Windows:

2. Right-click the name of the server whose startup setting you want to modify,
and then click Properties.

Chapter 9 Managing the Servers in Content Server
3. On the Startup type menu:
• To set the server to manual startup, choose Manual, and then click OK.
• To set the server to automatic startup, choose Automatic, and then click OK.
To modify the startup settings of a server under Linux or Solaris:
1. Log on to Linux or Solaris as root.

2. Add the full path of start_llserver, start_lladmin or
start_otclusteragent to the boot script of the Linux or Solaris computer
running the servers. Each of these scripts is located in the
<Content_Server_home> directory.
Note: If you do not have root privileges or are unsure about modifying the
boot script, consult your Linux or Solaris system administrator.
There are several other ways to set up the servers to start automatically on
Linux and Solaris operating systems.
9.2 Backing Up and Restoring Content Server

You should back up Content Server periodically to protect the data that resides in
your Content Server deployment. In addition, OpenText recommends that you back
up Content Server whenever you apply an Update, install, uninstall, or upgrade a
module, or make any other significant changes to your Content Server deployment.
A Content Server backup set consists of the following items:

• the <Content_Server_home> folder
• the Content Server database
• the External File Store
• one or more Search Indexes
• any Content Server folders that exist outside of the <Content_Server_home> folder,
for example, an Upload folder.
Note: If your Content Server deployment includes optional modules or

integrated applications, you may need to include additional items in the
backup set.
Stop the Content Server services before you take a backup, so that all of the Content
Server components are in sync with each other. Backing up Content Server while the
Content Server services are running can result in data inconsistencies. For example,
the Content Server database could contain references to Content Server items that do
not exist in the backup of the External File Store.
To back up Content Server:
1. Stop Content Server, the Admin server, and the Cluster Agent.

9.3. Renaming a Content Server Host Computer
2. Back up the Content Server database using tools that are appropriate for your
relational database management system.
3. Back up the Content Server Search Indexes by making a copy of the ...\index
\<index_name> folder and its subfolders.
Example: To back up the Enterprise Search Index, copy the ...\index\Enterprise\

folder and all of its subfolders.
Note: See “Backing Up and Restoring Indexes” on page 647 for

information on automating index backups.
4. Back up the <Content_Server_home> folder by copying the folder and its

subfolders.
5. Back up any Content Server folders that exist outside of the

<Content_Server_home> folder, such as the Content Server Upload folder.
To restore a Content Server backup set:
1. Stop Content Server, the Admin server, and the Cluster Agent.
2. Restore your Content Server database.
3. Restore the Content Server Search Indexes.
4. Restore the <Content_Server_home> folder.
5. Restore any Content Server folders that exist outside of the

<Content_Server_home> folder.
6. Start Content Server, the Admin server, and the Cluster Agent.
9.3 Renaming a Content Server Host Computer

After you have installed and configured Content Server, OpenText recommends that
you do not change the host name of a computer that runs Content Server. Renaming
a Content Server computer is a complex operation that affects multiple Content
Server components. If you must rename a Content Server computer , OpenText
recommends that you obtain assistance from OpenText Professional Services before
you proceed.

Chapter 10
Managing Licenses in Content Server
10.1 Licenses in Content Server

Content Server must be licensed before users without the System administration
rights privilege can log on. You can apply a production, non-production, or
temporary license to Content Server.
To license Content Server, you acquire a license file from OpenText, and then apply
it in Content Server. Content Server licenses are tied to a system fingerprint that is
generated from information in your Content Server database. (The information is
encrypted and hashed so that it not human-readable.) A single license file is
sufficient to license numerous Content Server instances that connect to the same
database.
Certain Content Server modules also require licenses. Modules that require licenses
appear on the Manage Licenses page, in the Module License(s) Overview section.
10.1.1 Obtaining a Content Server License

When you purchase Content Server or a Content Server optional module that
requires licensing, you are provided with a link to download the installation
software and a logon for the product activation site (http://
productactivation.opentext.com/ContentServer). You use this logon to obtain your
license file. For detailed steps, see “License Management” on page 236.
Types of License
The type of license that you have can be viewed in the License Type field on the
Manage Licenses administrative page. Three types of license are available:
Production License
A Content Server production license enables full functionality for a specified
number of licensed users. A production license is associated with a specific
version of Content Server.
Temporary License
A temporary Content Server license enables all of the same functionality that a
production license enables, but has an expiration date. The expiration date is
always a specific date; it does not vary according to when you apply the
temporary license.
Non-production License
A non-production license enables all of the same functionality that a production
license enables, but is issued for use in any Content Server environment that is
used to support a production environment. For example, you could apply a non-

Chapter 10 Managing Licenses in Content Server
production license to a development environment or a User Acceptance Testing

environment.
10.1.2 License Statuses

You can view the status of your Content Server license on the Manage Licenses
administrative page. A Content Server license status can be:
Valid
A valid license status indicates that Content Server is licensed for use by a
specified number of users.
Invalid
An invalid license status indicates an irregularity in your Content Server license:
Invalid Version
Your license applies to a different version of Content Server than the one
that you are running
Invalid Fingerprint
Changes in your Content Server environment have caused your system
fingerprint to change, so that it does not match the fingerprint in your
Content Server license file.
Expired
The current date is after the Expiration Date specified in your temporary
Content Server license. When its temporary license expires, Content Server
operates in “Administrative Mode” on page 235.
Exceeded Users
The number of users in your Content Server environment is higher than the
value of Licensed Users in your Content Server license.
Tip: If your license status is Exceeded Users, Content Server

functionality is not affected and no users are locked out.
Invalid
Your Content Server license is invalid for a reason other than the ones listed
above.
Unlicensed
You have not applied a Content Server license to your Content Server
installation. When Content Server is unlicensed, it operates in “Administrative
Mode” on page 235.

10.2. Managing Content Server Licenses
10.1.3 Administrative Mode

Content Server operates in administrative mode when:
• its temporary license has expired
• it is unlicensed
When Content Server is in administrative mode, only users with the System
administration rights privilege can log on. Regular users cannot log on to
Content Server. If a user without System administration rights attempts to log onto
Content Server when it is in administrative mode, the following message appears:
To make Content Server exit administrative mode, apply a valid license.
10.2 Managing Content Server Licenses

The Manage Licenses administration page allows you to apply a license file, view
details about your license file and system fingerprint, and generate a license file
report.

10.2.1 Content Server License Overview

The Content Server License Overview summarizes the features of your Content
Server license:
Status
For information on license statuses, see “License Statuses” on page 234.
Product Name
The product licensed by this OpenText license: OpenText Content Server.
Licensed Version
The version of the product licensed by this OpenText license.
License Type
For information on License Types, see “Types of License” on page 233.
Company Name
The name of the company that the license is issued to.
Expiration Date
If your license type is Temporary License, an expiration date appears.
Licensed Users
Maximum number of users supported by this OpenText license.
Active Users
Number of users that currently exist in Content Server.
The Module License(s) Overview summarizes the modules that are licensed by
your Content Server license.
Tip: Not all modules require licenses.
10.2.2 License Management

On the License Management page, you can acquire a license or apply a license file.
To obtain a license file:
1. On the License Setup page, a System Fingerprint appears that uniquely

identifies your Content Server installation. Copy the System Fingerprint so that
you can use it to generate a license file for Content Server or for a Content
Server optional module.
2. Log on to http://productactivation.opentext.com/ContentServer using the logon
and password provided to you when you purchased Content Server.
3. If you have more than one Content Server environment, select the environment
that the license applies to.
Tip: Only one license is required for multiple instances of Content Server
that connect to the same database.

10.2. Managing Content Server Licenses
4. Select the appropriate product and license file type, and use your System
Fingerprint to generate a license file.
To apply a license file:
1. Beside License Location, click Choose File.
2. Browse to the location of your license file and select it.

The page refreshes and a New License File Details section appears with
information on the license file that you are going to apply.
3. To apply the license, click Apply License File.

When the license file is successfully applied, the Manage Licenses page
appears, and Valid appears in the Status field of the Content Server License
Overview.
Note: If a Failed to get license or Could not read license content

error message appears when you attempt to apply the license file, verify
that you have configured an upload directory and that the Content Server
user has full control of it. See “Configuring Basic Server Parameters”
on page 71
4. If you have applied a module license, restart Content Server. (If you have
applied an overall Content Server license, it is not necessary to restart Content
Server,)
10.2.3 System Fingerprint

A system fingerprint uniquely identifies your Content Server deployment, using
pieces of information from your Content Server database. The information is
encrypted and hashed so that it is not readable, even by OpenText. The system
fingerprint is the same for every instance of Content Server in your deployment,
provided each instance connects to the same Content Server database.
Invalid System Fingerprint

In the unlikely event that changes in your database cause your system fingerprint to
become invalid, your license status appears as Invalid Fingerprint on your
Content Server License Overview.
Having an invalid system fingerprint has no effect on your deployment. Your users
can continue to access Content Server normally. The system does not enter
administrative mode. However, if you see that your license status is Invalid
Fingerprint, OpenText recommends that you contact Technical Support for
assistance.

10.2.4 License Report

The License Report page displays detailed information on your Content Server
license, including your End User Code, System Unique Identifier (SUID) and System
Fingerprint. To generate an XML copy of this report, click Generate Report.

Part 3
System Administration
Chapter 11
Managing UI Languages
The multilingual feature allows you to translate all user interface elements – dialog
boxes, status bars, toolbars, hyperlinks, menus, tabs, labels of drop-down menus,
text fields, and online help – into a localized language on one Content Server
instance.
11.1 Creating, Installing and Upgrading Language

Packs
A Localization Kit is available on the OpenText Knowledge Center (https://
knowledge.opentext.com). Before you can configure languages, you must create a
new language pack and install it on the computer where Content Server is installed.
When a new instance of Content Server is installed, English is always the default
language. French, German, Japanese and Dutch language packs are included in the
Content Server installation. If you intend using one of these five languages, it is not
necessary to create a new Localization Kit.
Important
OpenText strongly recommends that you delete and recreate the User Help
Data Source Folder and the Admin Help Data Source Folder whenever you
add or remove language packs, or when the system default locale is
modified. For more information, see “Creating the User or Admin Help
Index” on page 411.
Installing Language Packs

Once you have the language pack you want to install, and depending on whether
this is a Content Server system language pack or a Content Server module language
pack, you need to do one of two things:
1. If you are installing a Content Server system language pack, you need to unzip
the language pack to the root Content Server installation directory.
For example, if you installed Content Server to the C:\OPENTEXT directory,
unzip the language pack you have downloaded, or created, to the C:\OPENTEXT
directory. The language pack will be unzipped to C:\OPENTEXT
\langpkgstaging.
2. If you are installing a Content Server module language pack, you need to unzip
the language pack to the C:\<Content_Server_home>\langpkgstaging
\module directory, where C:\<Content_Server_home> is the location of your
Content Server installation.

Chapter 11 Managing UI Languages
Note: When you install a language pack, if settings already exist in the
opentext.ini file, and the value of the setting is not empty, the values will be
overwritten with the settings in the language pack you install.
Once a language is installed, the language code will appear in alphabetical order
under the Languages section on the Installed Language Packs page. Content Server,
and each Content Server module, will show all available languages; if a language is
not installed for a particular module, a “No languages installed” message is listed.
For more information about language names and codes, see “Configuring
Languages” on page 245.
You can specify a different user display name format for each language. The display
name for users can be their Log-in ID, or their first name, last name, and middle
initial. You can also choose to append the users' Log-in IDs to the format you
choose. For more information, see “Configuring User Settings” on page 391.
When you install a language, it may be necessary to update the way dates and times
appear to match the standard of that language. For example, the default date format
is set to appear as month/day/year, but you may want to set it to a year/month/day
format. You can specify the format for each installed language. For more
Upgrading Language Packs

Content Server language packs can be upgraded. OpenText releases updated
language packs, for each of the languages shipped with Content Server, with each
Content Server update.
There are two ways that you can upgrade your language packs:
1. When you upgrade Content Server to the latest patch or service pack, you can
also download the latest language packs.
2. You can also download the latest language packs from the OpenText Knowledge
Center (https://knowledge.opentext.com) and install those updated language
packs on your Content Server system.
Once you have the updated language pack you want to install, you need to unzip it
to the proper directory:
1. If you are installing an updated language pack to the Content Server system,
unzip the updated language pack to the root Content Server installation
directory.
For example, if you installed Content Server to the C:\OPENTEXT directory,
unzip the updated language pack you have downloaded to the C:\OPENTEXT
directory. The updated language pack will be unzipped to C:\OPENTEXT
\langpkgstaging.
2. If you are installing an updated language pack to a Content Server module,
unzip the updated language pack to the C:\<Content_Server_home>
\langpkgstaging\module directory, where C:\<Content_Server_home> is the
location of your Content Server installation.

11.1. Creating, Installing and Upgrading Language Packs
Important
Because customers can download and install full language packs with each
Content Server update, each full language pack will overwrite the
corresponding, existing language pack, provided the version of the language
pack you are installing is equal to or greater than the currently installed
language pack.
Content Server will generate an error message if the updated language pack
you are attempting to install is an older version than the currently installed
language pack.
For more information, see “To Update a Language Pack for Content Server”
on page 244.
Disabling Language Packs

Language packs cannot be uninstalled, but they can be disabled. For more
information on how to disable a language pack, see “Configuring Languages”
on page 245.
11.1.1 To Install a Language Pack for Content Server

To install a language pack for Content Server:
1. Download the language pack that you want to install and extract it to the
<Content_Server_home> folder, so that it adds files to the C:
\<Content_Server_home>\langpkgstaging\module location (where C:
\<Content_Server_home> is the location of your Content Server installation).
Note: Do not change the default name of the language pack.
2. On the Content Server Administration page, in the Languages section, click

Install Language Packs.
3. On the Install Language Packs page, in the Installable Content Server

Language Packs section, enable each language pack that you want to install,
and then click Install.
4. When the Installation Summary page appears, restart Content Server.
5. Click Continue.
Note: After you install a language pack, you must enable it in the Configure
Languages section in order to apply the new language to the entire system. For
information about enabling language packs, see “Configuring Languages”
on page 245.

11.1.2 To Install a Language Pack for a Content Server Module

To install a language pack for a Content Server module:
1. Download the module language pack that you want to install and extract it to
the <Content_Server_home> folder, so that it adds files to the C:
Note: Do not change the default name of the module language pack.

3. On the Install Language Packs page, in the Installable Module Language

Packs section, enable each module language pack that you want to install, and
then click Install.
5. Click Continue.
11.1.3 To Update a Language Pack for Content Server

To update a language pack for Content Server:
1. Download the updated language pack that you want to install, and extract it to
the <Content_Server_home> folder.
Note: Do not change the default name of the updated language pack.

3. On the Install Language Packs page, in the Installable Content Server

Language Packs section, enable each language pack update that you want to
update, and then click the Install button.
5. Click Continue.

11.2. Configuring Languages
11.1.4 To Update a Language Pack for a Content Server

Module
To update a language pack for a Content Server module:
1. Download the updated language pack that you want to install, then and extract
it to the <Content_Server_home> folder, so that it adds files to theC:
Note: Do not change the default name of the updated language pack.

3. On the Install Language Packs page, in the Installable Module Language

Packs section, enable each language pack that you want to upgrade, and then
click Install.
5. Click Continue.
11.1.5 To View Installed Language Packs

To view installed language packs:
• Click the View Installed Language Packs link in the Languages section on the
Content Server Administration page.
11.2 Configuring Languages

Once you install a language pack, you can use the Administration page to enable,
disable, and change the default system language. Users can see all languages that are
enabled, and select which language they want Content Server to use when they log
in. Users cannot see or select languages that are installed but not enabled.
Note: The current system default language cannot be disabled or removed. If

you want to disable a language, you must first enable and specify a different
language as the system default language.
Each language has a default language name, local language name, and associated
language code. For example, the English language is listed as “English (United
States)” for both language and local language, but it either name can be changed if
necessary. The language code is a default value, and cannot be changed.

11.2.1 To Enable, Disable, and Change the Default System

Language
To enable, disable, and change the default system language:
1. In the Languages section of the Content Server Administration page, click the
Configure Languages link.
2. On the Configure Languages page, do any of the following:
• To enable or disable a language, select or clear the Enabled check box beside
the language.
• To change the system default language, click the System Default radio
button beside the language you want to specify as the default.
• To edit the language name, click the Edit button, type a name for the
language and the local language in the Language and Language (Local)
fields, and then click the Save button.
3. Click the OK button.

Chapter 12
Working with Multilingual Metadata
The Multilingual Metadata functionality enables users to modify the names and
descriptions of objects in Content Server using languages that you enable. The
metadata is captured in audit trails and is searchable.
12.1 Configuring Multilingual Metadata

In order to allow users to add metadata tags in other languages, you must first add
the language, then enable it. Once languages, other than the default, are enabled, the
Edit Multilingual Values icon appears next to an object's Name and Description
fields. Once a language is enabled, you can modify the default language name or
specify it as the system default, which means when a user clicks the Edit
Multilingual Values icon, the default metadata language appears first in the list if
that user has not selected a preferred language.
Note: Even though the system default language can be specified, it is not
recommended that you modify the system default. The system default
language is normally assigned during the installation or upgrade process.
OpenText strongly recommends you delete and recreate the Help Data Source
Folder and the Admin Help Data Source Folder whenever you add or remove
language packs, or when the system default language is modified.
12.1.1 To Add a Metadata Language

To add a metadata language:
1. In the Metadata section of the Content Server administration page, click the
Configure Multilingual Metadata link.
2. On the Configure Multilingual Metadata page, select a language to add in the

Add New Metadata Language list, and then click the Add button.
Note: After a metadata language is added, you must enable it.
language packs, or when the system default language is modified.

Chapter 12 Working with Multilingual Metadata
12.1.2 To Configure Multilingual Metadata Parameters

To Configure Multilingual Metadata Parameters:
1. In the Metadata section of the Content Server administration page, click the
Configure Multilingual Metadata link.
2. Do any of the following:
• To enable a language, select the Enabled check box for any language you
want to enable.
• To specify the language as the default language for Content Server, click the
System Default button for the language.
• To edit the language name, click the language's Edit icon, type a new
language in the Language or Language (Local) fields, and then click Save.
• To delete a language that has been added, click the language's Delete icon,
and then click Yes in the confirmation window.
3. Click OK.

Chapter 13
Working with Memcache
Memcached proceses are managed in the same manner as Content Server search
processes. The memcached processes are registered with the admin servers through
the System Object Volume page. Content Server will install three default
memcached nodes.
13.1 To View the Memcached Processes

To view the memcached processes:
1. On the administration page, under the Search Administration section, click the
Open the System Object Volume link.
2. On the Open the System Object Volume page, click Memcached Processes.
13.2 To View the Memcached Statistics

To view the memcached statistics:

Memcached Statistics.
2. On the Memcached Statistics page you will see:
• Status: displays the status for each cached process. Possible values include
Idle and Running.
• Name: displays the name of the cached process as a link. Click this link to
see the details page for that process.
13.3 To View or Change the Properties of a

Memcached Process
To view or change the properties of a memcached process:

2. On the Memcached Statistics page, under the Name column, click the name of
the memcached process you want to view.
3. On the <memcache_process_name> properties page, click the General tab. Next,
do any of the following:
a. Optional If you want to change the name of the process, in the Name field,
type the new name for the process.

Chapter 13 Working with Memcache
b. Optional In the Description field, type a description of the process.

4. Click Update.
13.4 To Start or Stop a Memcached Process

To start or stop a memcached process:

2. On the Memcached Statistics page, under the Name column, select the name of
a memcached process you want to start or stop.
3. On the <memcache_process_name> properties page, click the Specific tab.
4. Optional Under the Actions section, if the process has been stopped, click the
Start button. If the process is running, click the Stop button.
5. Click Update.
13.5 To Add a Memcached Process

To add a memcached process:
1. On the administration page, under the Search Administration section, click the
2. On the Open the System Object Volume page, click Memcached Processes.
3. From the Add Item menu, select Memcached Process.
4. In the Name field, enter a name for your new process.
5. In the Port Number field, enter an available port number for your new process.
Once you have entered the port number, click the Check port link to be certain
that this port number is available.
6. Optional In the Description field, enter a description for your new process.
7. Optional In the Host field, change the default host using the associated list.
8. Optional In the Memory Usage field, change the default memory usage setting
using the associated list.
9. Optional In the Additional Command Line field, enter additional command line
options to run with your new process.

Chapter 14
Configuring Rendering Settings
From the Configure Rendering Settings page, you can enable the Use Versioned
Resources setting to minimize the need for users to refresh their browser caches
after Content Server upgrades.
You can also set the BASE HREF value in an HTML page that includes a custom
view. If no values are present in this page, default values in the HTTP request are
used. The settings you can update are:
• If you want to add comments to every generated HTML page in Content Server
to describe which WebLingo template file generated that page, you can select the
Generate WebLingo Filename Comments check box. Mainly for debugging
purposes.
• Protocol: a list from which you can select either http or https.
• Host: a text field which allows you to enter the hostname of the server to include
in the BASE HREF URL.
• Port: a text field which allows you to enter the port of the web server used in the
BASE HREF URL.
For information about how these settings appear in the opentext.ini file, see
“[BaseHref]” on page 96.
14.1 To Configure Rendering Settings

To configure rendering settings
1. Click the Configure Rendering Settings link in the System Administration

section on the Content Server administration page.
2. Optional To minimize the need for browser refreshes after Content Server
upgrades, select the Use Versioned Resources check box. This should help
ensure that new updates can deploy without your users needing to refresh their
browser caches.
Note: Not all proxy servers support caching of versioned resources.
3. Optional To add comments to describe which WebLingo template file generated a

particular Content Server HTML page, select the Generate WebLingo Filename
Comments check box.
4. Optional In the Base Href Settings section:
a. In the Protocol field, select either http or https from the list.

Chapter 14 Configuring Rendering Settings
b. In the Host field, type the name of the host.

c. In the Port field, type the port number.

Chapter 15
Working with the Distributed Agent
The Distributed Agent system manages ongoing Content Server jobs, such as those
related to Facets, Columns, Workflow steps, Records Management, and the purging
of deleted items. It uses Workers to process job tasks in the background, allowing for
scaling and performance, without interfering with users’ system interactions. It can
be configured to run these tasks outside of peak usage times.
15.1 Managing the Distributed Agent and Workers

On the Distributed Agent Dashboard, you can configure the operations of the
Distributed Agent system and view information on its activities. The dashboard
provides a graphic summary of Distributed Agent task execution, and displays the
status (Idle, Standing By, Paused, Stopped, or Running) of each Distributed Agent
system and Distributed Agent Worker. On the Distributed Agent Dashboard , you
can:
• view a graph that shows:
• the number of queued tasks and processed tasks for each hour of the past 12
hours
• a running total of unprocessed tasks
• pause one, several, or all of the Distributed Agent Workers
• schedule an outage of the Distributed Agent system or of any of its Workers
• designate a Distributed Agent as the Primary Distributetd Agent (if you have
more than one Distributed Agent system running in your Content Server
environment)
• assign Workers to prioritize specific tasks, such as processing Workflow Item
Handler steps or generating Facets data
• enable Fairness settings (settings that govern how much time Distributed Agent
Workers devote to tasks that have not been processed after a set period of time)
By default, the Distributed Agent Dashboard displays information that is accurate

for the moment when you open it. You can use the Refresh Interval menu to
configure it to periodically update the information that it displays.

Chapter 15 Working with the Distributed Agent
15.1.1 Viewing the Task Summary

The Task Summary graph reports on the overall progress and performance of the
Distributed Agent system. For each hour of the day, it displays:
Queued
A bar that shows the number of tasks that were added to the queue by
Distributed Agent Workers.
Processed
A bar that shows the number of tasks that were completed or cancelled by
Distributed Agent Workers.
Backlog
A line that shows the accumulated total number of queued tasks. It includes
unprocessed tasks from earlier periods.
The Queued and Processed task counts and the backlog for the current hour are
updated frequently. Over the course of an hour, the same task may move from the
backlog to Queued and then to Processed. The values that appear for previous
hours are the last calculated values for that hour.
To obtain more detailed information on Distributed Agent activities, click Details

(beside Task Summary) to open the Task Group Summary.
The Task Group Summary

The graphs on the Task Group Summary page present information on various types
of tasks performed by the Distributed Agent system, grouped by the Content Server
operation that the tasks support. For example, you can see how many tasks related
to Columns or Facets were queued or processed during a given hour.
You can drill further into these operations by clicking Details beside any of the
graphs on the Task Group Summary page to open the Task Type Summary page
for a given task group.
The Task Type Summary

The Task Type Summary page provides information that is similar to that presented
on the Task Summary and Task Group Summary pages, broken out into the
component tasks for a given task group.
For example, to learn more about the Facets-related tasks that are performed by
Distributed Agent Workers, click Details beside Facets on the Task Group
Summary page. The Task Type Summary page opens, and you can view graphs for
specific Facets-related task types, including Calculate Facet, Clear Facet Cache,
Populate Facet, and so on.

15.1. Managing the Distributed Agent and Workers
15.1.2 Ensuring Low-Priority Tasks are Processed (Fairness)

Distributed Agent Fairness settings regulate the amount of time that Distributed
Agent Workers spend on processing tasks that have not been executed within a
specified period of time.
If you enable Fairness, you must specify:

• Percentage: the percentage of its processing time that a Distributed Agent
Worker spends on Fairness tasks. The percentage is a number from 5 through 50.
• Task Age: the period of time in hours that must elapse before tasks are eligible
for Fairness processing.
To enable Distributed Agent Fairness:
1. Open the Distributed Agent Dashboard administrative page. (On the Content
Server Administration page, in the System Administration section, click
Distributed Agent Dashboard.)
2. Open the Configure the Distributed Agent System page. (On the Distributed
Agent Dashboard, click Configure the Distributed Agent System.)
3. Enable Fairness.
a. In the Fairness section of the Configure the Distributed Agent System

page, check the Enable Fairness check box.
b. Select a number from the Percentage box.
c. Enter a number in the Task Age box.
15.1.3 Setting a Primary Distributed Agent

Only one Distributed Agent can run at a time. If you have Content Server running
on multiple computers, you will typically see more than one Distributed Agent
listed in the Distributed Agent Status section of the Distributed Agent Dashboard.
By default, Content Server selects the first Distributed Agent in the alphabetical
listing as the active (or Primary) one, but you can change this. You can designate a
Distributed Agent of your choice to be your Primary Distributed Agent.
The Primary Distributed Agent runs in preference to any other Distributed Agents
that you have in your Content Server environment. A Distributed Agent other than
the Primary will run only if the Primary Distributed Agent becomes unavailable.
OpenText recommends that you select the Distributed Agent with the greatest
capacity to be your Primary Distributed Agent. Typically, the Distributed Agent
with the greatest capacity resides on your most powerful or your least busy
computer.
The Primary Distributed Agent appears in the Distributed Agent Status with a blue
check mark indicator ( )in the Primary column.

To set a Primary Distributed Agent:
3. In the Primary Agent section, click the name of the Distributed Agent that you
wish to designate as the Primary Distributed Agent, and the click Save
Changes.
15.1.4 Pausing Distributed Agent Workers

If you need to relieve strain on Content Server, you can pause one or more Workers.
Note: The system may resume a stopped worker, or pause a resumed worker,
as it requires.
Pausing all of the Distributed Agent Workers

You can temporarily pause every Distributed Agent Worker if you need to
immediately stop all Worker activities. If, for example, your Content Server database
is overloaded, you could pause all of the Distributed Agent Workers while you
troubleshoot your database issue.
To pause all of the Distributed Agent Workers:
2. In the Worker Status section, click Pause All Workers.
Note: To restart the Distributed Agent system, click Resume All Workers to
restart the Distributed Agent system at once, or click Resume beside each
Worker to restart the Distributed Agent system one Worker at a time.
Pausing Individual Workers

Rather than pause every Distributed Agent Worker, you can pause an individual
worker. You might do this to reduce the work load of a single Content Server host
machine.
To pause a Worker:

15.1. Managing the Distributed Agent and Workers
2. In the Worker Status section, click Pause beside the Worker that you want to
stop.
Note: To restart the Worker, click Resume.
15.1.5 Scheduling Outages of the Distributed Agent and its

Workers
If you have a requirement for the Distributed Agent system to be idle at a specific
time, you can schedule a Distributed Agent system outage. You can set your outage
to affect the entire system, or configure it for one or more Workers. Outages can be
scheduled to happen once or on a recurring basis.
Scheduling System Outages

You can schedule a Distributed Agent system outage so that the system is not
operating during important system events. If, for example, you take a weekly
database backup that runs for three hours on a Sunday, you can configure a
recurring Distribution Agent system outage to occur during the database backup
period.
To schedule a Distributed Agent system outage:
3. In the System Outages section, click Add ( ).

4. Configure the Distributed Agent system outage.
a. Optional For a recurring weekly outage, enable Recurring, and then enable
the day of the outage. You can enable more than one day, if you want.
b. Using the calendar icon and the time menus, set a Start and End date and
time for the outage. (If you enable All day outage, the time is automatically
set to 12 Midnight.)
c. Optional Enter a reason for the outage.
d. Click Apply.
Note: To modify an existing outage, click Edit ( ). To remove an existing

outage, click Delete ( ).
Scheduling Worker Outages

Rather than schedule an outage of the entire Distributed Agent system, you can
schedule outages for individual workers. For example, if you want to have

additional Workers performing work during off-peak hours, you could configure
additional Workers with an outage that occurs during your system’s busy times.
To schedule a Worker outage:
1. Open the Configure Worker administrative page.
a. On the Content Server Administration page, in the System Administration

section, click Distributed Agent Dashboard.
b. In the Worker Status section of the Distributed Agent Dashboard, click the
Worker ID of the Worker that you wish to configure.
2. In the Worker Outages section, click Add ( ).

3. Configure the Worker outage.
a. Optional For a recurring weekly outage, enable Recurring, and then enable
the day of the outage. You can enable more than one day, if you want.
b. Using the calendar icon and the time menus, set a Start and End date and
time for the outage. (If you enable All day outage, the time is automatically
set to 12 Midnight.)
c. Optional Enter a reason for the outage.
d. Click Apply.
Note: To modify an existing outage, click Edit ( ). To remove an existing

outage, click Delete ( ).
15.2 Managing Distributed Agent Workers

The Configure Worker page allows you to assign one or more Priority Tasks to a
Worker and to schedule Worker outages.
Tip: If you need to pause a Worker rather than schedule an outage, you can do
this on the Distributed Agent Dashboard administrative page. See “Pausing
Individual Workers” on page 256.
You can also give the Worker a description. The description could, for example,
indicate that the Worker has an outage or a Priority Task assigned to it.
Assigning a Priority Task to a Worker

You can configure a Worker to give priority to certain kinds of tasks by assigning it a
Priority Task. When the worker runs, it will attempt to run its Priority Task before it
selects any other tasks to process. It will only perform other tasks if no Priority Task
is available to perform. You can assign multiple Priority Tasks to a Worker.
To assign a Priority Task to a Worker:
1. Open the Configure Worker administrative page.

15.2. Managing Distributed Agent Workers
a. On the Content Server Administration page, in the System Administration

section, click Distributed Agent Dashboard.
b. In the Worker Status section of the Distributed Agent Dashboard, click the
Worker ID of the Worker that you wish to configure.
2. In the Priority Tasks section, enable each Priority Task that you wish to assign
to the Worker.
Scheduling a Worker Outage

For information on scheduling a Worker outage, see “Scheduling Worker Outages”
on page 257.
Setting the Number of Workers

By default, the Distributed Agent runs three Workers on each instance of Content
Server. You can increase or decrease the number of Workers on an instance of
Content Server by editing the opentext.ini file. Increasing the number of Workers
can allow Content Server to perform Worker tasks more quickly if your Content
Server environment has sufficient system resources available.
Bear in mind that adding a Worker to a Content Server instance increases the overall
load on that instance, and that each additional Worker in your Content Server
environment increases the load on your database server. If you do increase the
number of Workers, you should monitor your Content Server environment for
increased usage of processor, memory, disk, and other resources.
Tip: To create a new worker that performs a specific task only during times of
low Content Server utilization, edit the opentext.ini file to create the new
worker, and then use the Content Server Admin pages to assign the new
Worker to a priority task, and to schedule an outage for the Worker during
times of high Content Server utilization.
To set the number of Workers used by the Distributed Agent:
1. Stop Content Server.
2. Open the opentext.ini file in a text editor.
3. In the [distributedagent] section of the opentext.ini file, set the value of

number to the number of Workers that you would like to run on this instance of
Content Server.
Important
Do not make any changes to the [daagent] section of the opentext.ini
file.
Save your changes and close the text editor.


Part 4
Database Administration
Chapter 16
Changing Your Content Server Database
A Content Server database is created as part of the Content Server installation. If you
have a working Content Server database, you do not normally need to create a new
one or switch to a different one. However, on occasion, you may wish to change
your Content Server database.
For example, if you have been using Content Server with a test database and you
now wish to move Content Server to production, or if you are restoring a database
backup and you do not wish to overwrite your current database, you could create a
new database. And if you are upgrading Content Server, part of the upgrade process
is to disconnect from a staging database created for your new Content Server
version, connect to your existing production database and upgrade it.
Overall, the procedure of changing your Content Server database consists of:
“Deselecting Your Current Database” on page 264

You disconnect from your current Content Server database and, optionally, drop
the data source folder that contains your Search index.
Tip: After you deselect your current Content Server database, you can no
longer access this online help. To retain access to these instructions, keep
this window open, print a copy of this section before you disconnect, or
view the Content Server Admin Help on the OpenText Knowledge Center.
“Adding and Connecting to a new Content Server Database” on page 265 or

“Connecting to an Existing Database” on page 275
If you are creating a new database, you log onto your RDBMS, create a Content
Server database and database user, and then create your Content Server
database tables. The exact procedure depends on your RDBMS.
If the Content Server database already exists, you can connect to it by logging on
as the Content Server database user. If the database contains the Content Server
tables, it is ready to use. If it does not, you can create the Content Server
database tables when you connect.
“Configuring Content Server After Changing Your Database” on page 282

After you switch to a different Content Server database, you will need to
perform some or all of the following additional steps:
• Upgrade the database

• Configure Content Server to use OpenText Directory Services
• Install additional Content Server modules
• Configure one or more Admin servers

Chapter 16 Changing Your Content Server Database
• License Content Server
Each of these tasks is looked at in greater detail in this section.
16.1 Deselecting Your Current Database

Before you can create a new Content Server database or connect to an existing one,
you must disconnect from your current Content Server database.
When you deselect your current Content Server database, you are offered the choice
of deleting or keeping the data sources that are associated with your current
database. The default option is to delete the data sources, but if you think you might
have any reason for keeping them, clear the Delete option. You can always delete
the data sources later.
To deselect your current Content Server database:
1. On the Content Server Administration page, in the Database Administration

section, click Change Current Database.
2. The Deselect Content Server Database page appears. It displays information

on your current Content Server database, and lists each data source that is
associated with this database.
By default, Delete is enabled beside each data source, meaning the folder at the
path in the Index Location column will be deleted when the new Content
Server database is created. If you wish to retain the data source folder, clear the
Delete check box.
Click Continue to deselect your current Content Server database.
3. The Restart Content Server page appears. Click Restart to restart Content
Server automatically, or click Continue, if you prefer to use operating system
tools to restart Content Server.
Important
Before you connect to a different database:
1. Stop every Admin server.
2. Remove the search.ini and otadmin.cfg files from the

<Content_Server_home>/config folder of each Admin server to
prevent orphaned processes from being carried to another database.
3. Start each Admin server.
After you connect to the new database, resynchronize each Admin

server to create new search.ini and otadmin.cfg files.
After you deselect your current database, the Database Administration page
appears, and you can proceed with one of the following options:

16.2. Adding and Connecting to a new Content Server Database
Create New Database

Choose this option to create a new Content Server database, Content Server
database user, and Content Server database tables. For more information, see
“Adding and Connecting to a new Content Server Database” on page 265
Select Existing Database

Choose this option to connect to an existing Content Server database (that has
Content Server database tables in it) as an existing Content Server database user.
For more information, see “To Connect to an Existing Content Server Database”
on page 279.
Create Tables in Existing Database

Choose this option to connect to a Content Server database that has no tables in
it as an existing Content Server database user. For more information, see “To
Connect to an Existing Empty Database” on page 276.
16.2 Adding and Connecting to a new Content Server

Database
After you deselect your current database (see “Deselecting Your Current Database”
on page 264), the Database Administration page appears, and you can create a new
Content Server database.
Tips
• For recommendations on configuring your Content Server database, see
OpenText Content Server - Installation Guide (LLESCOR-IGD).
• When you create a Content Server database, you specify whether Content
Server uses External Document Storage (file system storage) for its
documents and other items. If you do not enable External Document
Storage, Content Server stores all of its item in its database. For more
information on storage options, see “Storage Providers and Storage
Management“ on page 351.
To begin creating a new Content Server database, click Create New Database. On
the Select RDBMS page, enable the type of database that you wish to create, and
then click Continue.
SAP HANA
To create a HANA database, see “Adding and Connecting to a New SAP HANA
Database” on page 266.
Oracle Server
To create an Oracle database, see “Adding and Connecting to a New Oracle
Tip: If the option to create an Oracle database does not appear on the
Select RDBMS Type page, ensure that you have installed Oracle client
software on the Content Server computer.

PostgreSQL
To create a PostgreSQL database, see “Adding and Connecting to a New
PostgreSQL Database” on page 270.
Microsoft SQL Server

To create a SQL Server database, see “Adding and Connecting to a New SQL
Server Database” on page 272.
16.2.1 Adding and Connecting to a New SAP HANA Database

To create a new Content Server SAP HANA database, you use the utility functions
on the HANA Maintenance page.
Creating a new Content Server SAP HANA database requires the following steps:
• “Logging onto HANA” on page 266 as a user with system access privileges
• “Creating a HANA Database User for Content Server” on page 267
• “Creating a HANA Schema” on page 267
• “Creating the Tables in the HANA Database” on page 267
Important
You must install the HANA database client on your Content Server
computer before you connect to the HANA server to create a new Content
Server HANA database.
Logging onto HANA

To open the HANA Maintenance page, where you can create your Content Server
database and database user, and perform other database maintenance, log onto SAP
HANA as a user with system administration privileges.
To log onto HANA:
1. On the HANA Server Administrator Log-in page, enter the host name and
port, or IP address and port, of an SAP HANA server in the HANA Server
(IP:Port) box. For example, enter HANAserver.domain.com:30115 or
192.168.10.20:30115.
2. Enter the name of an SAP HANA user with administrator privileges (for
example, SYSTEM) in the System User box.
3. Type the password of the system user in the System Password box.
4. Click Log-in. After you successfully log on, the HANA Maintenance page
appears.

Creating a HANA Database User for Content Server

Perform the following steps on the HANA Maintenance page, in the Create A New
User section.
To create a HANA database user for Content Server:
1. Type the name of the new HANA user in the User Name box.
2. Type a password for the new HANA user in the Password box.
3. Type the password again in the Verify Password box.
4. Click Create User.
Creating a HANA Schema

Perform the following steps on the HANA Maintenance page, in the Create A
HANA schema section.
To create a HANA schema:
1. In the User Name box, select the name of the user that you created in “Creating
a HANA Database User for Content Server” on page 267.
2. In the Schema box, enter the name of the new HANA schema.
3. Click Create Schema.
After the tablespace is created, it is listed in the Schema menu in the Delete a
HANA schema section of the HANA Maintenance page.
Creating the Tables in the HANA Database

To complete the creation of a new Content Server database, connect to the new
Content Server database as the Content Server database user and create the Content
Server database tables. Do this on the Create Content Server Tables page.
To return to the Create Content Server Tables page, click Return to previous page
at the top of the HANA Maintenance page.
To create Content Server tables in a HANA database:
1. In the HANA Schema box, select the name of a HANA schema.
2. In the HANA User Name box, select the name of the HANA user that is
associated with the HANA schema that you selected in step 1.
3. Enter the password of the HANA user in the Password box.
4. Optional Enable External Document Storage if you want Content Server to store
documents and other items outside the database, and enter the absolute path of
the folder where you want Content Server to store items in the adjacent box.

5. Click Create Tables.
You have now created a new Content Server HANA database. You must now
perform some configuration tasks to make Content Server ready to use. For
information on these tasks, see “Configuring Content Server After Changing Your
16.2.2 Adding and Connecting to a New Oracle Database

To create a new Content Server Oracle database, you use the utility functions on the
Oracle Server Maintenance page.
Creating a new Content Server Oracle database requires the following steps:
• “Logging onto Oracle Server” on page 268 as a user with system access
privileges
• “Creating an Oracle Tablespace” on page 269
• “Creating an Oracle Database User for Content Server” on page 269
• “Creating the Tables in the Oracle Database” on page 270
Tip: If the option to create an Oracle database does not appear on the Select
RDBMS Type page, ensure that you have installed Oracle client software on
the Content Server computer.
Logging onto Oracle Server

To open the Oracle Server Maintenance page, where you can create your Content
Server database and database user, and perform other database maintenance, log
onto Oracle Server as a user with system administration privileges.
To log onto Oracle Server:
1. On the Oracle Server Administrator Log-in page, enter the name of an Oracle
user with administrator privileges (for example, system) in the System User
Name box.
2. Type the password of the system user in the Password box.
3. Type the service name (database alias) of Oracle Server in the Service Name
box.
Tip: The service name is typically the same as the host name of the
computer on which Oracle Server is installed. You can find the service
name (database alias) in the tnsnames.ora file. You may need to consult
your Oracle administrator to obtain this information.
4. Click Log-in. After you successfully log on, the Create Content Server Tables
page appears.

Creating an Oracle Tablespace

After you successfully log onto Oracle, the Create Content Server Tables page
appears. Before you can create the Content Server tables, however, you must create a
Content Server database and Content Server database user. You perform these tasks
on the Oracle Server Maintenance page.
To open the Oracle Server Maintenance page, click the Oracle Server Maintenance
link that appears in the Note near the top of the Create Content Server Tables page.
To create an Oracle tablespace:
1. On the Oracle Server Maintenance page, click Create New Tablespace.

2. Specify the characteristics of the tablespace.
a. In the Tablespace Name box, type a unique name for the tablespace.
Tip: You can find out which tablespace names are already in use by
looking at the Default Tablespace menu in the Create New User
section of this page.
b. In the File Specification box, type the absolute path of the tablespace data
file that you want to create. For example, C:\oracle\database
\filename.ora or /usr/oracle/database/filename.dbf.
The directory that you specify must already exist, and the Windows,
Solaris, or Linux user that runs Oracle Server must have permission to
write to it.
c. In the Size box, type a size in megabytes for the tablespace data file.
d. Optional Enable Automatically extend tablespace, if you desire.
3. Click Create Tablespace.
After the tablespace is created, it is listed in the Default Tablespace menu in the
Create A New User section of the Oracle Server Maintenance page.
Creating an Oracle Database User for Content Server

To create an Oracle database user for Content Server:
1. On the Oracle Server Maintenance page, click Create A New User.

2. Specify the characteristics of the Content Server Oracle database user.
a. Type the name of the new Oracle user in the User Name box.
b. Type a password for the new Oracle user in the Password box.
c. Type the password again in the Verify Password box.
d. In the Default Tablespace menu, select the Oracle tablespace that you
created in “Creating an Oracle Tablespace” on page 269

Creating the Tables in the Oracle Database

at the top of the Oracle Server Maintenance page.
To create Content Server tables in an Oracle database:
1. In the User Name menu, select the Oracle user that you created in “Creating an
Oracle Database User for Content Server” on page 269.
2. Enter the password of the Oracle user in the Password box.
You have now created a new Content Server Oracle database, but you must perform
some configuration tasks to make Content Server ready to use. For information on
these tasks, see “Configuring Content Server After Changing Your Database”
on page 282.
16.2.3 Adding and Connecting to a New PostgreSQL Database

To create a new Content Server PostgreSQL database, you use the utility functions
on the PostgreSQL Maintenance page.
Creating a new Content Server PostgreSQL database requires the following steps:
• “Logging onto PostgreSQL” on page 271 as a user with system access privileges
• “Creating a PostgreSQL Database User for Content Server” on page 271
• “Creating a PostgreSQL Database” on page 271
• “Creating the Tables in the PostgreSQL Database” on page 272

Logging onto PostgreSQL

To open the PostgreSQL Maintenance page, where you can create your Content
Server database and database user, and perform other database maintenance, log
onto PostgreSQL as a user with system administration privileges.
To log onto PostgreSQL:
1. On the PostgreSQL Server Administrator Log-in page, enter the host name or
IP address of a PostgreSQL server in the PostgreSQL Server Name box. For
example, enter PostgreSQLserver.domain.com or 192.168.10.20.
2. Enter the name of an PostgreSQL user with administrator privileges in the

System User box.
3. Type the password of the system user in the System Password box.
4. Click Log-in. After you successfully log on, the PostgreSQL Maintenance page
appears.
Creating a PostgreSQL Database

Perform the following steps on the PostgreSQL Maintenance page, in the Create A
New PostgreSQL Database section.
To create a PostgreSQL database:
1. In the Database Name box, enter a name for your Content Server database.
2. Click Create Database.
After the database is created, it is listed in the Delete a PostgreSQL Database menu
on the PostgreSQL Maintenance page.
Creating a PostgreSQL Database User for Content Server

Perform the following steps on the PostgreSQL Maintenance page, in the Create A
New User section.
To create a PostgreSQL database user for Content Server:
1. Type the name of the new PostgreSQL user in the User Name box.
2. Type a password for the new PostgreSQL user in the Password box.
3. Type the password again in the Verify Password box.
4. Select the name of the database that you created in “Creating a PostgreSQL

Creating the Tables in the PostgreSQL Database

at the top of the PostgreSQL Maintenance page.
To create Content Server tables in a PostgreSQL database:
1. In the PostgreSQL Database box, select the name of a PostgreSQL database.
2. In the PostgreSQL User Name box, select the name of the PostgreSQL user that
is associated with the PostgreSQL database that you selected in step 1.
3. Enter the password of the PostgreSQL user in the Password box.
You have now created a new Content Server PostgreSQL database. You must now
16.2.4 Adding and Connecting to a New SQL Server Database

To create a new Content Server SQL Server database, you use the utility functions on
the Microsoft SQL Server Maintenance page.
Creating a new Content Server SQL Server database requires the following steps:
• “Logging onto SQL Server” on page 273 as a user with system access privileges
• “Creating an Empty Microsoft SQL Server Database” on page 273
• “Creating a Content Server SQL Server Database User” on page 274
• “Creating the Tables in the SQL Server Database” on page 274

Logging onto SQL Server

To open the Microsoft SQL Server Maintenance page, where you can create your
Content Server database and database user, and perform other database
maintenance, log on to Microsoft SQL Server as a user with system administration
privileges.
To log on to Microsoft SQL Server:
1. Type the Microsoft SQL Server alias in the SQL Server Name box.
Tip: If your installation of Microsoft SQL Server does not run on the
default port (1433), enter the SQL Server port after the server alias,
separated by a comma, with no space.
Example: For a SQL Server installation with an alias of MySQLsrv running on

port 1456, enter the following in the SQL Server Name box:
MySQLsrv,1456
2. Type the Microsoft SQL Server system administrator user name (the default is
sa) in the System User box.
3. Type the password for the system user in the System Password box.
4. Type the name of the master database (the default is master) in the Master
Database Name box.
5. Click Log-in. After you successfully log on, the Create Content Server Tables
page appears.
Creating an Empty Microsoft SQL Server Database

After you successfully log on to Microsoft SQL Server, the Create Content Server
Tables page appears. Before you can create the Content Server tables, however, you
must create a Content Server database and Content Server database user. You
perform these tasks on the Microsoft SQL Server Maintenance page.
To open the Microsoft SQL Server Maintenance page, click the Microsoft SQL
Server Maintenance link that appears in the Note near the top of the Create Content
Server Tables page.
To create a Microsoft SQL Server database:
1. On the Microsoft SQL Server Maintenance page, click Create a New Microsoft
SQL Server Database.
2. Specify the characteristics of the database.
a. In the Database Name box, type the name that you want to assign to the
database, for example, csdb.

Tip: You can find out which database names are already in use by
looking at the Database Name menu in the Create New User section
of this page.
b. In the Data File Specification box, type a path and file name, for example,
C:\Store\csdb.mdf.
c. In the Data File Size box, type a size in megabytes for the Data File.
d. Optional Enable Automatically extend data file, if you desire.
e. In the Log File Specification box, type a path and file name, for example,
C:\Store\csdb.ldf..
f. In the Log File Size box, type a size in megabytes for the file.
g. Optional Enable Automatically extend log file, if you desire.
3. Click Create Database.
After the database is created, it can be viewed in the Database Name menu in the
Create A New User section of the Microsoft SQL Server Maintenance page.
Creating a Content Server SQL Server Database User

To create a Content Server SQL Server database user:
1. On the Microsoft SQL Server Maintenance page, click Create A New User.
2. Specify the characteristics of the Content Server SQL Server database user.
a. Type the name of the new SQL Server user in the User Name box.
b. Type a password for the new SQL Server user in the Password box.
c. Type the password again in the Verify Password box.
d. In the Database Name menu, select the SQL Server database that you
created in “Creating an Empty Microsoft SQL Server Database”
on page 273
Creating the Tables in the SQL Server Database

To return to the Create Content Server Tables page, click the Return to previous
page link that appears at the top of the Microsoft SQL Server Maintenance page.
To create the tables in the Content Server SQL Server database:
1. In the SQL Server Database menu, select the Microsoft SQL Server database
that you created in “Creating an Empty Microsoft SQL Server Database”
on page 273.

16.3. Connecting to an Existing Database
2. In the Microsoft SQL User Name menu, select the Microsoft SQL Server user
that you created in “Creating a Content Server SQL Server Database User”
on page 274.
3. Enter the password of the Microsoft SQL Server user in the Password box.
You have now created a new Content Server SQL Server database. You must
16.3 Connecting to an Existing Database

To connect to an existing database, you require a Content Server database and a
Content Server database user.
Tip: You can create an empty database and database user in advance, by using
the <RDBMS> Maintenance page. The procedure is the same as described in
“Adding and Connecting to a new Content Server Database” on page 265,
except that you open the <RDBMS> Maintenance page directly from the
If you connect to an empty database, you create the Content Server tables as part of
the procedure of switching to an existing database. See “To Connect to an Existing
Empty Database” on page 276
You can also connect to an existing database that already has Content Server tables.
This is an important step in upgrading Content Server to a new version, but you
might do it for other reasons too. For example, you might need to switch Content
Server databases in a test environment. For instructions on switching from one
Content Server to another, see “To Connect to an Existing Content Server Database”
on page 279.

16.3.1 To Connect to an Existing Empty Database

During the process of changing your database, after you deselect your current
database (see “Deselecting Your Current Database” on page 264), the Database
Administration page appears, and you can connect to an existing empty database
and create the Content Server tables in it.
To connect to an existing empty Content Server database, click Create Tables in

Existing Database. On the Select RDBMS Type page, enable the type of database
that you wish to connect to, and then click Continue.
SAP HANA
To connect to an SAP HANA database, see “Connecting to an Empty SAP
HANA Database” on page 276.
Oracle
To connect to an Oracle database, see “Connecting to an Empty Oracle
PostgreSQL
To connect to a PostgreSQL database, see “Connecting to an Empty PostgreSQL
To connect to a SQL Server database, see “Connecting to an Empty SQL Server
Connecting to an Empty SAP HANA Database

To connect to an empty SAP HANA database:
1. On the Specify Content Server Database Owner page, enter the host name and
port, or IP address and port, of an SAP HANA server in the HANA Server
(IP:Port) box. For example, enter HANAserver.domain.com:30115 or
192.168.10.20:30115.
2. Enter the name of the HANA user that owns the database that you wish to
connect to in the HANA User Name box.
4. Enter the name of the HANA schema of the database that you wish to connect
to in the HANA Schema box.
5. Click Connect. After you connect to the HANA server, the page refreshes and
additional options appear, allowing you to create the tables for the Content
Server database.

You have now connected to an existing Content Server HANA database and created
the Content Server tables in it. You must now perform some configuration tasks to
make Content Server ready to use. For information on these tasks, see “Configuring
Content Server After Changing Your Database” on page 282.
Connecting to an Empty Oracle Database

To connect to an empty Oracle database:
1. On the Specify Content Server Database Owner page, enter the name of the
Oracle user that owns the database that you wish to connect to.
2. Type the password of the user in the Password box.
box.
4. Click Connect.
5. Optional The External Document Storage box appears. Enable External

Document Storage if you want Content Server to store documents and other
items outside the database, and enter the absolute path of the folder where you
want Content Server to store items in the adjacent box.
You have now connected to an existing Content Server Oracle database and created
the Content Server tables in it. You must now perform some configuration tasks to
make Content Server ready to use. For information on these tasks, see “Configuring
Content Server After Changing Your Database” on page 282.
Connecting to an Empty PostgreSQL Database

To connect to an empty PostgreSQL database:
1. On the PostgreSQL Server Administrator Log-in page, enter the host name or
2. Enter the name of the PostgreSQL user that owns the database that you wish to
connect to in the PostgreSQL User Name box.
4. Enter the name of the PostgreSQL database that you wish to connect to in the
PostgreSQL Database box.

5. Click Connect. After you connect to the PostgreSQL server, the page refreshes
and additional options appear, allowing you to create the tables for the Content
Server database.
You have now connected to an existing Content Server PostgreSQL database and
created the Content Server tables in it. You must now perform some configuration
tasks to make Content Server ready to use. For information on these tasks, see
“Configuring Content Server After Changing Your Database” on page 282.
Connecting to an Empty SQL Server Database

To connect to an empty SQL Server database:
1. On the Specify Content Server Database Owner page, type the Microsoft SQL
Server alias in the SQL Server Name box.

MySQLsrv,1456
2. In the MSSql User Name box, enter the name of the SQL Server user that owns
the database that you wish to connect to.
4. In the SQL Server Database box, type the name of the SQL Server database that
you want to connect to.
5. Click Connect.
6. Optional The External Document Storage box appears. Enable External

Document Storage if you want Content Server to store documents and other
items outside the database, and enter the absolute path of the folder where you
want Content Server to store items in the adjacent box.
You have now connected to an existing Content Server SQL Server database and
created the Content Server tables in it. You must now perform some configuration
tasks to make Content Server ready to use. For information on these tasks, see
“Configuring Content Server After Changing Your Database” on page 282.

16.3.2 To Connect to an Existing Content Server Database

During the process of changing your database, after you deselect your current
database (see “Deselecting Your Current Database” on page 264), the Database
Administration page appears, and you can connect to an existing Content Server
database that has Content Server tables in it.
To connect to an existing Content Server database, click Select Existing Database.

On the Select RDBMS Type page, enable the database platform that you wish to
connect to, and then click Continue.
Important
The database that you connect to should be from a Content Server
environment that has the same modules installed as your current Content
Server environment. If it is not, you will have to add or remove Content
Server modules to match the database before you can use it in your current
environment.
SAP HANA
To connect to an SAP HANA database, see “Connecting to a Content Server
HANA Database” on page 279.
Oracle Server
To connect to an Oracle database, see “Connecting to a Content Server Oracle
PostgreSQL
To connect to a PostgreSQL database, see “Connecting to a Content Server
PostgreSQL Database” on page 280.

To connect to a SQL Server database, see “Connecting to a Content Server SQL
Server Database” on page 281.
Connecting to a Content Server HANA Database

To connect to a Content Server HANA database:
1. On the Specify Content Server Database Owner page, enter the host name or
IP address of a PostgreSQL server in the HANA Server Name box. For example,
enter HANAserver.domain.com:30115 or 192.168.10.20:30115.
2. Enter the name of the HANA user that owns the database that you wish to
4. Enter the name of the HANA database that you wish to connect to in the
HANA Database box.
5. Click Continue.

6. On the Content Server Administrator User Log-in page, enter the password of
the Content Server Admin user, and then click Log-in.
You have now connected to an existing Content Server HANA database. You must
now perform some configuration tasks to make Content Server ready to use. For
Connecting to a Content Server Oracle Database

To connect to a Content Server Oracle database:
1. On the Specify Content Server Database Owner page, enter the name of the
Oracle user that owns the database that you wish to connect to.
box.
4. Click Continue.
You have now connected to an existing Content Server Oracle database. You must
now perform some configuration tasks to make Content Server ready to use. For
Connecting to a Content Server PostgreSQL Database

To connect to a Content Server PostgreSQL database:
1. On the Specify Content Server Database Owner page, enter the host name or
2. Enter the name of the PostgreSQL user that owns the database that you wish to
4. Enter the name of the PostgreSQL database that you wish to connect to in the
PostgreSQL Database box.
5. Click Connect.

You have now connected to an existing Content Server PostgreSQL database. You
must now perform some configuration tasks to make Content Server ready to use.
For information on these tasks, see “Configuring Content Server After Changing
Your Database” on page 282.
Connecting to a Content Server SQL Server Database

To connect to a Content Server SQL Server database:
1. On the Specify Content Server Database Owner page, type the Microsoft SQL
Server alias in the SQL Server Name box.

MySQLsrv,1456
2. In the MSSql User Name box, enter the name of the SQL Server user that owns
the database that you wish to connect to.
4. In the SQL Server Database box, type the name of the Microsoft SQL Server
database that you want to connect to.
5. Click Continue.
You have now connected to an existing Content Server SQL Server database. You
must now perform some configuration tasks to make Content Server ready to use.
For information on these tasks, see “Configuring Content Server After Changing
Your Database” on page 282.

16.4 Configuring Content Server After Changing Your

Database
After you change your Content Server database, Content Server displays a series of
pages that direct you to perform configuration changes to ensure that Content
Server is ready to use. Depending on the database operation that you have
performed, you will see one, some or all of the following pages.
Database Upgrade
The Content Server Database Upgrade Confirmation page appears if the
database that you connected to in “To Connect to an Existing Content Server
Database” on page 279 needs to be upgraded. For information on upgrading the
database, see “Upgrading the Content Server Database” on page 292 and
OpenText Content Server - Upgrade Guide (LLESCOR-IUP).
Select OTDS Server Type

Content Server uses OpenText Directory Services for user management and
authentication. The Select OTDS Server Type page allows you to connect to an
external OTDS server or use an OTDS server that is internal to Content Server.
Install Modules
The Install Modules page appears after you have successfully switched your
Content Server database. It offers you the chance to install any available
modules. For information on installing modules, see “Installing Modules”
on page 379 and OpenText Content Server - Module Installation and Upgrade Guide
(LLESCOR-IMO)
Admin Server Configuration

If you have connected to an existing Content Server database, after you click
Continue on the Install Modules page, you are prompted to connect to a
Content Server Admin server. After you log on to an Admin server, the
Configure and Migrate the Search System page appears, which allows you to
migrate an existing search index as part of a Content Server upgrade. For
information on this page, see OpenText Content Server - Upgrade Guide
(LLESCOR-IUP).
If you have created a new Content Server database, after you click Continue on
the Install Modules page, you are prompted to create a new Enterprise Data
Source. For information, see “Creating the Enterprise Index” on page 407.
License Setup
After you complete the Admin server configuration, you are presented with the
License Setup page. For information on licensing Content Server and Content
Server modules, see OpenText Content Server - Installation Guide (LLESCOR-IGD).
Congratulations!
After you finish licensing Content Server (and Content Server modules, if
applicable), theCongratulations! page appears, indicating that you have
successfully changed your Content Server database and completed basic
configuration of Content Server for the new database.

Chapter 17
Maintaining an Existing Database
The Maintain Current Database page displays information about the current
Content Server database and provides links to a number of database-related
administration pages.
17.1 Viewing Content Server Tables

A Content Server database stores data in a set of RDBMS tables. To view a list of
these tables and the number of rows in them, click View Content Server Tables on
the Maintain Current Database page. Additional information may be available
depending on your database platform.
The View Content Server Tables page displays the following information:
Table 17-1: Information available on the View Content Server Tables page
SAP HANA Oracle SQL Server PostgreSQL

Table Name
Number of rows
Tablespace
Object Type
Table or Object
Owner
17.2 Viewing Tablespace Usage (Oracle)

Oracle Database uses an entity called a tablespace to store the tables of one or more
relational databases. A tablespace can have multiple database users, each owning a
set of tables. In general, the set of tables corresponding to a Content Server database
resides within a single tablespace, which it may share with other sets of tables
owned by different database users.
If you use Oracle Database as your RDBMS, you can view the amount of space that
is being used by Content Server tables in the Oracle tablespace.
To view Content Server tablespace usage, on the Maintain Current Database page,
click View Tablespace Usage.

Chapter 17 Maintaining an Existing Database
17.3 Performing Database Maintenance Tasks

To perform Content Server database maintenance tasks that are specific to your
database platform, click <RDBMS> Maintenance Tasks. This opens the database
maintenance for your database platform, where you can perform tasks that are
related to the creation and maintenance of Content Server databases, such as
creating a Content Server database and user, or deleting the tables within an existing
Content Server database. The specific tasks that you can perform on the database
maintenance page depend on your database platform.
After you click <RDBMS> Maintenance Tasks, you are prompted to log onto your
database server as a user with database administrator privileges.
17.3.1 Performing HANA Maintenance Tasks

You can perform the following tasks on the HANA Server Maintenance page:
• Create a new HANA user

• Create a new HANA schema
• Delete a HANA schema
Typically, you create a HANA database and user as part of the procedure of creating
a new Content Server database either during the initial setup of Content Server or
afterwards.
For more information, see “Changing Your Content Server Database“ on page 263.
17.3.2 Performing Oracle Maintenance Tasks

You use the Oracle Server Maintenance page to perform the following tasks:
• Create a New Tablespace

• Create an Oracle User Account
• Extend a Tablespace
• Delete an Oracle User Account and/or its Tables
You use the Oracle Server Maintenance page under the following two
circumstances:
• When you are administering an existing Content Server database. In this case
you access the Oracle Server Maintenance page by clicking the Oracle Server
Maintenance Tasks link on the Maintain Current Database page.
• When you are creating a new Content Server database to connect to a new or
existing Content Server installation. In this case, you access the Oracle Server
Maintenance page by clicking the Oracle Server Maintenance link on the Create
Content Server Tables page.

17.3. Performing Database Maintenance Tasks
Under either of the preceding circumstances, you click the Return to previous page
link on the Oracle Server Maintenance page to return to the page (Maintain
Current Database or Create Content Server Tables) from which you accessed the
If you access the Oracle Server Maintenance page as part of the process of creating a
new Content Server database, perform the following two tasks in the order shown
before clicking the Return to previous page link:
• “Creating a New Tablespace” on page 285.
• “Creating a New Oracle User” on page 285.
Creating a New Tablespace

Content Server uses an Oracle tablespace to contain the tables of the Content Server
database. Since a tablespace can contain tables owned by multiple Oracle users, it is
not necessary to create a new tablespace if one with sufficient available space
already exists.
Since a tablespace is created as part of the Content Server database creation

procedure, it is normally not necessary to create one apart from that procedure.
Creating a New Oracle User

All of the tables in a tablespace are owned by Oracle users. A particular Oracle user
owns the tables of the Content Server database. Content Server uses this Oracle user
name and the corresponding password to connect to the Content Server database,
which the Oracle Server manages.
An Oracle user is created as part of the Content Server database creation procedure,
so it is normally not necessary to create a user apart from that procedure.
Extending a Tablespace
A tablespace consists of one or more datafiles. As the amount of data in your
Content Server database grows, these datafiles may become full. You can increase
the size of a tablespace by adding a new datafile to it.
Some versions of Oracle Database can be configured to extend tablespaces

automatically when they run low on free space. For more information, consult the
documentation that accompanied your Oracle Database software.
Deleting an Oracle User and the Tables It Owns

If a Content Server database becomes corrupt, the only way to recover it may be to
delete its tables (and perhaps even the database user) and then restore the database
from backup.
If you delete the tables only, tables created for custom categories are not removed.
Therefore, you may want to delete both the user and its tables, which will remove
the custom tables.

The Oracle Server Administrator Log-in page appears under the following two
circumstances:
• You are creating a new Content Server database. The page appears after you click
the Continue button on the Select RDBMS Type page.
• You clicked the Oracle Server Maintenance Task link on the Maintain Current
Database page.
The purpose of this page is to prompt you to specify the user name and password of
an RDBMS account that has administrator privileges.
To Create a New Tablespace

To create a new tablespace:
1. On the Oracle Server Maintenance page, click the Create New Tablespace link.
2. Type a unique name for the tablespace (for example, _TS) in the Tablespace
Name field.
You can find out what tablespace names are already in use in the Default
Tablespace drop-down list in the Create New User section of the Oracle Server
Maintenance page.
3. In the File Specification field, type the absolute path of the tablespace datafile
that you want to create (for example, C:\orant\database\filename.ora or /
usr/oracle/database/filename.dbf). The directory that you specify must
already exist and the operating system user created for Oracle Database must
have permission to write to it.
4. In the Size field, type a size in MB for the tablespace datafile (the minimum is
5MB), following the guidelines in the Create New Tablespace section on the
5. Click the Create Tablespace button.
• If you are creating a new Content Server database and have not yet created
the Oracle user, go to “To Create an Oracle User” on page 287.
• If you have completed all tasks on the Oracle Server Maintenance page,
click the Return to previous page link.

To Create an Oracle User
To create an Oracle user:
1. On the Oracle Server Maintenance page, click Create New User.
2. In the Create New User section, type a unique name for the Oracle user in the
User Name field.
3. In the Password field, type a password for this user and type it again in the
Verify Password field
4. In the Default Tablespace list, click the name of the tablespace in which you
want to create the tables of the new Content Server database.
5. Click the Create User button.
• If you are creating a new Content Server database, click the Return to
previous page link to return to the Create Content Server Tables page.
• Otherwise, if you have completed all tasks on the Oracle Server
Maintenance page, click Return to previous page to return to the Maintain
Current Database page.
To Extend an Oracle Tablespace
To extend an existing tablespace:
1. On the Oracle Server Maintenance page, click Extend Tablespace.
2. In the Tablespace To Extend list, click the name of the tablespace that you want
to extend.
3. In the File Specification field, type the absolute path of the file that you want to
use for the tablespace datafile extension (for example, C:\orant\database
\filename.ora or Oracle Server Maintenance/
usr/oracle/database/filename.dbf). The directory that you specify must
already exist and the operating system user created for Oracle Database must
have permission to write to it.
4. In the Size field, type a size in MB for the new tablespace datafile. Based on the
size of previous datafiles that have been created for this tablespace and the time
that it took to fill them, you can estimate an appropriate size for the new
tablespace datafile.
5. Click the Extend Tablespace button.
6. If you have completed all tasks on the Oracle Server Maintenance page, click
Return to previous page.

To Delete Oracle Users and Tables

To delete an Oracle user or tables:
1. On the Oracle Server Maintenance page, click Delete Users and Tables.
2. In the User Name list, click the name of the Oracle user that you want to delete
or whose tables you want to delete.
• To delete the selected Oracle user and all the tables that it owns, click the
Delete user and tables radio button.
• If you want to delete only the Content Server tables owned by the selected
Oracle user, click the Delete tables only radio button.
4. Click the Delete button.
5. Click the OK button in the dialog box that opens.
6. If you have completed all tasks on the Oracle Server Maintenance page, click
Return to previous page.
17.3.3 Performing SQL Server Maintenance Tasks

The Microsoft SQL Server Administrator Log-in page appears under the following
circumstances:
• You are creating a new Content Server database. The page appears after you click
the Continue button on the Select RDBMS Type page.
• You clicked the Microsoft SQL Server Maintenance Tasks link on the Maintain
Current Database page.
The purpose of this page is to prompt you to specify the user name and password of
an RDBMS account that has administrator privileges.
Use the Microsoft SQL Server Maintenance page to perform the following tasks:
• Create a new Microsoft SQL Server database
• Create a new user
• Extend a Microsoft SQL Server database
• Delete Microsoft SQL Server Content Server tables
• Delete a Microsoft SQL Server database
Use the Microsoft SQL Server Maintenance page under the following two
circumstances:
• When you are administering an existing Content Server database. In this case,
you access the Microsoft SQL Server Maintenance page by clicking the

Microsoft SQL Server Maintenance Tasks link on the Maintain Current

Database page.
Under either of the preceding circumstances, you click the Return to previous page
link on the Microsoft SQL Server Maintenance page to return to the page
(Maintain Current Database or Create Content Server Tables) from which you
accessed the Microsoft SQL Server Maintenance page.
Deleting Content Server Tables or a SQL Server Database

If your Content Server database becomes corrupt for some reason, the only way to
recover it may be to delete its tables or even the SQL Server database in which they
reside and then restore them from backup.
Extending a SQL Server Database

As the amount of data in a SQL Server database approaches the maximum space
allotted to the database in data file, you will need to increase the amount of space
allotted in the data file to extend the database. You can allot space in more than one
data file to a SQL Server database.
To Extend a SQL Server Database
To extend a SQL Server database:
1. On the Administration page, select Database Administration.
2. On the Database Administration page, select Maintain Current Database.
3. On the Maintain Current Database page, select Microsoft SQL Server

Maintenance Tasks. You may need to enter your SQL Server administrator
password.
4. On the Microsoft SQL Server Maintenance page, click Extend a Microsoft SQL
Server Database.
5. In the Database to Extend list, click the name of the SQL Server database that
you want to extend.
6. In the Data File list, click the name of the data file in which you want to allot
more space to this SQL Serverdatabase.
7. In the Data File Allotment field, type the amount of additional data file space
(in MB) that you want to allot to this SQL Server database.
8. Click the Extend Database button.
9. If you have completed all desired tasks on the Microsoft SQL Server
Maintenance page, click Return to previous page.

To Delete Content Server Tables

To delete Content Server tables:
1. On the Administration page, select Database Administration.
2. On the Database Administration page, select Maintain Current Database.
3. On the Maintain Current Database page, select Microsoft SQL Server

Maintenance Tasks. You may need to enter your SQL Server administrator
password.
4. On the Microsoft SQL Server Maintenance Tasks page, click Delete Microsoft
SQL Server Content Server Tables link.
5. In the Database Name drop-down list, click the name of the SQL Server
database that contains the Content Server tables that you want to delete.
6. In the User Name drop-down list, click the name of the SQL Server user that the
Server uses to log into this SQL Server database.
7. Type the password of the SQL Server user in the Password field.
8. Click the Delete Tables button.
Maintenance Tasks page, click the Return to previous page link.
To Delete a SQL Server Database

To delete a SQL Server database:
1. On the Microsoft SQL Server Maintenance Tasks page, click Delete a

Microsoft SQL Server Database.
2. In the Database Name drop-down list, click the name of the SQL Server
database that you want to delete.
3. Click the Delete Database button.
Maintenance Tasks page, click Return to previous page.

17.4. Purging Deleted Data (Oracle)
17.3.4 Performing PostgreSQL Maintenance Tasks

You can perform the following tasks on the PostgreSQL Maintenance page:
• Create a PostgreSQL database for use with Content Server
• Create a PostgreSQL user for use with Content Server
• Delete the Content Server tables from a PostgreSQL database
• Delete a PostgreSQL database
Typically, you create a PostgreSQL database and user as part of the procedure of
creating a new Content Server database either during the initial setup of Content
Server or afterwards.
For more information, see “Changing Your Content Server Database“ on page 263.
17.4 Purging Deleted Data (Oracle)

The Maintain Current Database page displays the Purge Delete Data link if you are
using Oracle Database as your RDBMS and the Content Server database uses
internal document storage.
When users delete documents form the Content Server database, Oracle marks the
data as deleted, but it is still taking up disk space. OpenText recommends that you
purge this deleted data periodically to recover disk space.
The Purge Deleted Data link opens the Purge Deleted Data page, on which you
perform the purge operation.
If you are using Oracle Database as your RDBMS and your Content Server database
stores documents internally, you can use the Purge Deleted Data page to remove
data marked as deleted from the BLOB data table. You access the Purge Deleted Data
page by clicking Purge Deleted Data on the Maintain Current Database page.
When a Content Server user deletes a document stored internally in a Content

Server database, Oracle does not delete the document from the storage media, but
rather marks the document as deleted. Thus, the document continues to use up disk
space, even though Content Server users can no longer access it. For this reason,
OpenText recommends that you purge your Content Server database of deleted data
periodically to free disk space.
Purging deleted data requires that you have enough rollback segments to purge the
BLOB data table. For more information about rollback segments, consult your Oracle
documentation.

17.5 Upgrading the Database

The Content Server Database Upgrade Confirmation page provides information on
your Content Server database schema and indicates whether any database upgrades
are available. If your database is up to date, the Content Server Database Upgrade
Confirmation page displays the current schema version of the Content Server
database and of the modules that use tables in the Content Server database.
You access the Content Server Database Upgrade Confirmation page by clicking
Upgrade this Database on the Maintain Current Database page. It may also appear
automatically during an upgrade or module installation.
If the Content Server Database Upgrade Confirmation page indicates that there are
database upgrades available, you should upgrade the Content Server database.
17.5.1 Upgrading the Content Server Database

To upgrade the Content Server Database:
1. On the Content Server Database Upgrade Confirmation page, enable Upgrade

the <DB_name> Content Server database, and then click Continue.
2. On the Admin Server Configuration page, change the Host Name, Port
Number and Password of the listed Admin servers, if necessary, so that these
values are correct for the Admin servers in your environment, and then select
the Accept check box.
Note: If an Admin server Status is Unavailable, make sure that it is

running before you proceed. You must select the Accept check box for
every Admin server before you can start the upgrade process.
Click Continue when you have made the necessary changes.
3. When the Restart Content Server page appears, click Restart to restart Content
Server automatically (or click Continue if you prefer to restart Content Server
using the operating system.)
4. When the Restart Successful message appears, click Continue. The Database
Upgrade Status page appears. It displays the progress of the upgrade and
refreshes its display every few seconds.
5. On the Database Upgrade Status page, a series of messages appear that indicate
the progression of your database upgrade.
Important
If Content Server indicates that a recoverable error has occurred in the
upgrade process, correct the issue and then click Continue.

17.6. Verifying the Database
On the bottom of the Database Upgrade Status page, verify that the message
The database upgrade completed with no errors appears. If the database
upgrade completes successfully, and no errors are present, click Continue.
Important
Review the text on the page carefully. Occasionally the Database
Upgrade Status page may display the message "The database upgrade
has completed successfully when the page also displays messages
indicating the occurrence of errors that were not sufficient to halt the
database upgrade.
If any errors appear, do not attempt to continue the upgrade or restart
the upgrade where it left off. Contact OpenText Customer Support.
17.6 Verifying the Database

If you are experiencing difficulty with your Content Server database, you can use
the diagnostic tests on the Verify Content Server Database page to verify various
aspects of the database. You access the Verify Content Server Database page by
clicking the Verify This Database link on the Maintain Current Database page.
You can run both predefined and custom diagnostic test sets.
17.6.1 Managing Custom Verification Options

Running Predefined Diagnostic Test Sets
The Verify Content Server Database page displays five radio buttons (Level 1
Diagnostic to Level 5 Diagnostic) that you click to select the desired test set. The
tests performed at each level are listed below each radio button.
Running a Custom Set of Diagnostic Tests

If none of the predefined diagnostic test sets meet your needs, you can go to the
Custom Verification Options page to select a custom set of diagnostic tests to
perform.
You can access the Custom Verification Options page by clicking the Go To
Custom Verification Options link on the Verify Content Server Database page.

Depending on whether your database uses internal or external document storage,

Content Server displays a different set of test options.
The Initial Content Server Database Verification Report page appears after you
click the Perform Diagnostic button on either the Verify Content Server Database
page or the Custom Verification Options page (internal or external storage version).
The Initial Content Server Database Verification Report page informs you that the
verification is in progress and displays a link that you can click to view the status/
results of the verification.
The second Content Server Database Verification Report page appears after you
click the click here link on the initial Content Server Database Verification Report
page.
If the verification is in progress, the second Content Server Database Verification

Report page displays the status of the verification. If the verification is complete, the
page displays the results of the verification. If no errors are found, the page displays
the message, “Congratulations! No errors were found in this database.”
Custom Verification Options

You access the Custom Verification Options page by clicking the Go To Custom
Verifications Options link on the Verify Content Server Database page.
The set of tests that appear depends on whether your Content Server database is set
to store documents internally or externally. This help topic lists the tests available for
an internal-storage database. The tests available for an external-storage database are
also available.
If none of the predefined diagnostic test sets on the Verify Content Server Database
page meet your needs, select a custom set of diagnostic tests to perform on the
Custom Verification Options page.
To Run Custom Diagnostic Tests on the Database (Internal)

To run a custom set of diagnostic tests on your Content Server database:
On the Custom Verification Options page, select any of the following check boxes:
1. Verify the ACL count of a node

2. Verify the child count of a container
3. Verify that a DataID exists for each DocID
4. Verify that a ProviderData providerID exists for each providerID on DVersData
5. Verify the existence of members and leaders of groups
6. Verify that each group recorded on KUAFChildren exists
7. Search for nodes without ParentIDs

17.6. Verifying the Database
8. Verify the parentID of each node
9. Verify that a DVersData providerID exists for each providerID on ProviderData
10. Click the Perform Diagnostic button.
To Run Custom Diagnostic Tests on the Database (External)
To run a custom set of diagnostic tests on your Content Server database:
1. On the Custom Verification Options page, select any of the following check
boxes:
• Verify the ACL count of a node
• Verify the child count of a container
• Verify that a DataID exists for each DocID
• Verify that a ProviderData providerID exists for each providerID on

DVersData
• Verify the file size of the external document store
• Verify that each file represented on the ProviderData table exists in the
external document store
• Verify the name of each file in the external document store
• Verify the existence of members and leaders of groups
• Verify that each group recorded on KUAFChildren exists
• Search for nodes without ParentIDs
• Verify the parentID of each node
• Verify that a DVersData providerID exists for each providerID on

ProviderData
2. Click the Perform Diagnostic button. The Initial Content Server Database
Verification Report page appears.
To Run Predefined Diagnostic Tests on the Database
To run predefined diagnostic tests on the database:
1. On the Verify Content Server Database page, click the radio button of the
diagnostic test set that you want to perform.
2. Click the Perform Diagnostic button to display the initial Content Server
Database Verification Report page.

17.6.2 Rebuilding Ancestor Tables

Important
OpenText recommends that you do not access these URLs unless specifically
directed to by OpenText technical support.
The Content Server administration pages described in this section are used to
rebuild the ancestor database tables in Content Server. Rebuilding the ancestor
tables is accomplished by typing the following URLs in your browser:
1. http://<Content Server_IP_address>/OTCS/cs.exe?
func=admin.AskRebuildAncestors
The admin.AskRebuildAncestors URL will display the Enable the Ancestor
Agent Content Server administration page. The Enable the Ancestor Agent
page allows you to optionally trigger http://<Content Server_IP_address>/
OTCS/cs.exe?func=admin.RebuildAncestors.
Click OK to rebuild the tables.
The Enable the Ancestor Agent page will update during the rebuild, and the
URL will change to http://<Content Server_IP_address>/OTCS/cs.exe?
func=admin.RebuildAncestorLog. Wait until you see the message “The rebuild
of the Ancestor tables has completed successfully.”.
2. http://<Content Server_IP_address>/OTCS/cs.exe?func=admin.RebuildAncestors
The admin.RebuildAncestors URL is used to rebuild the DTreeAncestors and /
or the DBrowseAncestors table. It takes an optional, target parameter:
• DTA will rebuild DTreeAncestors
• DBA will rebuild DBrowseAncestors
• If no target is specified, both tables will be rebuilt.
The Enable the Ancestor Agent page will appear and will update during the
rebuild. The URL will change to http://<Content Server_IP_address>/
OTCS/cs.exe?func=admin.RebuildAncestorLog. Wait until you see the
message “The rebuild of the Ancestor tables has completed successfully.”.
3. http://<Content Server_IP_address>/OTCS/cs.exe?
func=admin.RebuildAncestorLog
The admin.RebuildAncestorLog URL will monitor the status of the rebuilding
of the ancestors table(s). The two URLs above will redirect to this URL after
triggering a rebuild.

17.7. Testing or Repairing Known Database Issues
17.7 Testing or Repairing Known Database Issues

The Test or Repair Known Database Issues page contains Content Server database
test and repair utilities. New utilities may be added by Content Server Updates. Be
careful with these correction utilities! Use them only if you are confident that they
resolve specific error conditions that were detected by a Database Verification.
Relocate Orphaned Items

Orphaned items are items that do not have a reference to a valid parent container in
the database. For example, if the database does not contain a valid reference to a
document’s parent folder, the document is an orphaned item. The Relocate
Orphaned Items utility identifies orphaned items and gives you the option of
moving them to a special volume, the Orphaned Items Volume.
Once items are in the Orphaned Items Volume, you can do whatever you want with
them. You can move, copy, or delete them, or perform any other operation
permitted by their item types.
Insert Missing Reflexive Rows for Volume Objects

This utility uses the results from a Level 5 Database verification to identify and
insert missing reflexive rows into the DTreeAncestors table for volume objects.
Regenerate ChildCounts
This utility regenerates corrected ChildCount column values in the DTreeCore table.
Regenerate ACLCounts
This utility regenerates corrected ACLCount column values in the DTreeCore table.
Delete references to nonexistent Users and Groups

This utility uses the User & Group verification queries from the Database
Verification functionality to present a possibly truncated list of references in the
KUAFChildren table to delete users or groups that do not exist in the KUAF table, and
provides you with the ability to delete these entries. For details, see “Managing
Custom Verification Options” on page 293.
Directly deleting a user or group that do not exist in the KUAF table also causes a
change to other referentially stored database information in a number of associated
tables. Users or groups should not be deleted directly in Content Server because this
can lead to unexpected consequences.
Delete orphaned rows in DVersData

This utility uses the DocIDs and ProviderIDs verification queries from the Database
Verification functionality to present a list of orphaned rows in the DVersData table,
and allows you to delete the DocID and ProviderID entries that do not exist.

Delete references to nonexistent Objects

This utility uses the Database Verification functionality to present a list entries in the
DTreeAncestors table which reference nonexistent Objects, and allows you to delete
these Objects.
Identify Document Class Cycles

Dependency cycles can be created, accidentally, in the Document Class definitions
that are used to build Facets. These cycles can cause recursion problems when
building Document Class facets, and can cause an error indicating that the
maximum recursion limit has been exceeded.
The Identify Document Class Cycles option has been included on the Test or
Repair Known Database Issues page to check for these dependency cycles.
To view or run installed database test and repair utilities:
1. On the Content Server admin page, under Database Administration, click

Maintain Current Database.
2. On the Maintain Current Database page, click Test or Repair Known Database
Issues.
3. On the Test or Repair Known Database Issues page, click the utility you want
to view or run.
To check for dependency cycles in document class definitions:
1. On the Content Server admin page, under Database Administration, click

Maintain Current Database.
2. On the Maintain Current Database page, click Test or Repair Known Database
Issues.
3. On the Test or Repair Known Database Issues page, click Identify Document
Class Cycles.
4. The Content Server Database Verification Report page appears. It will either
confirm that the diagnostic test found no document class cycles, or it will inform
you of the number of document class cycles found in your database.
5. If document class cycles have been found, select the links provided in the report
to fix the records in the database:
a. Identify which relationship should be removed for each loop. Each link will
take you to the page where the relationship is defined. You will only need
to remove one.
b. Next to the relationship you need to remove, either clear the associated box,
or click '-'.
c. Click Update.

17.8. Changing the Password of the Content Server Database User
6. Re-run the Identify Document Class Cycles diagnostic tool.
17.8 Changing the Password of the Content Server

Database User
During the setup of Content Server, you create a Content Server database and a
Content Server database user. Typically, you perform both of these steps on the
Database Maintenance page. (See “Changing Your Content Server Database“
on page 263.)
When you create a Content Server database user, you give it a name and password,
and make it the owner of the Content Server database. Content Server stores the
Content Server database user name and password and uses it to establish a database
connection. If the password of the database user does not change, the stored
credentials allow Content Server to connect to the Content Server database
whenever necessary.
Over time, however, the password of the Content Server database user might be
updated. The database user’s password might be changed, for example, by a
database administrator who is following your organization’s security procedures, or
through some other mechanism. However the change occurs, once the database
user’s password is changed, the information stored in Content Server is no longer
valid and Content Server cannot connect to its database. To allow Content Server to
connect to the database, you must update the Content Server database user’s
password on the Update Database Connection Password page.
Note: Changing the password on the Update Database Connection Password

page changes the password that Content Server stores to enable its database
user to connect. It does not change the password of the database user on the
RDBMS.
17.8.1 To Change the Password Used to Connect to the

Database
To change the password used to connect to the database:
1. In the Database Administration section of the Content Server Administration

page, click Maintain Current Database.
2. On the Maintain Current Database page, click Update Database Connection

Password.
3. On the Update Database Connection Password page, enter the current

(changed) password of the Content Server database user.
4. Click Update Password.

5. On the Restart Content Server page, click Restart to restart Content Server
automatically, or click Continue if you prefer to use the operating system to
restart Content Server.

Chapter 18
Administering Blob Deletion Failures
The Flexible Storage Management module enables tracking of blob deletion errors.
You can monitor blob deletion errors and attempt to delete the blobs that failed to
delete on previous deletion attempts. If a deletion failure is detected, the Administer
Blob Deletion Failures page lists information about the blob deletion, such as its
Logical Provider name, the class of the error, and the error string associated with the
deletion failure, if one exists. This page provides you with the date and time the next
automated attempt to delete the blob will occur, and gives you the date that the
failure was queued.
If you want to manually retry to delete blobs, you can do so on the Administer Blob
Deletion Failures page. However, it is possible that manual blob deletion attempts
can fail, just as automated attempts can fail.
Note: Blobs that are not deleted because the physical storage retention period
is not yet expired are not available for manual deletion retries.
Administrators can view the scheduled activity for retrying blob deletion failures,
and set the schedule to a specific day and time when they want to the Provider Blob
Deletion Failure Retry Agent to run. When the retry agent runs, it processes log file
entries, inserting those entries into the ProviderRetry database table. The log files
contain blob deletion failure entries that the system attempted to insert into the
ProviderRetry database table, but failed. The retry agent then searches for blob
deletion records more than 24 hours old. The retry agent then attempts to delete
each blob deletion failure entry listed in the ProviderRetry database table.
Note: By default, the Provider Blob Deletion Failure Retry Agent schedule is
set to run every night at 12:00 a.m.
Blob deletion failures are events that can be audited by Content Server. The
following events can be audited:
• Provider Retry Deleted, which is created when a blob that could not initially be
deleted is successfully deleted.
• Provider Retry Queued, which is created when a blob deletion fails and a row in
the ProviderRetry database table is either inserted or updated.
• Provider Queuing Error, which is created when a blob deletion fails and the
system is unable to either insert a row into the ProviderRetry table or add a row
to the log file indicating that the blob deletion failed.
• Provider Retry Retried, which is created whenever the system attempts to delete
a blob that previously could not be deleted.

Chapter 18 Administering Blob Deletion Failures
For more information about event auditing, see “Administering Event Auditing“
on page 303.
18.1 To Monitor Blob Deletion Failures

To monitor Blob Deletion Failures:
1. In the System Administration section on the Administration page, click the

Administer Blob Deletion Failures link.
2. On the Administer Blob Deletion Failures page, click the Monitor Blob
Deletion Failures link.
Optionally, select the check box for each blob you want to reattempt to delete,
and then click the Retry Now button.
18.2 To Configure the Provider Blob Deletion Failure

Retry Agent
To configure the Provider Blob Deletion Failure Retry Agent:

Configure the Provider Blob Deletion Failure Retry Agent link.
2. In the Provider Blob Deletion Failure Retry section on the Configure Scheduled
Activities page, do the following:
• Click the Enable radio button.

• In the Activity Schedule section, select the days and times you want the
Provider Blob Deletion Failure Retry agent to run.

Chapter 19
Administering Event Auditing
Content Server allows you to track events that occur in the Content Server database.
An event is any action that users perform on a Content Server item, such as a
document or folder. Auditing events lets you monitor how Content Server users are
using the system and determine who has performed certain operations. For
example, you can identify which users have deleted or moved items.
From the Administer Auditing Events page, you can perform the following tasks:
• “To View All Currently Set Auditing Interests” on page 315
• “To Set Auditing Interests” on page 315
• “To Manage Audit Records Created in Prior Releases” on page 317
• “To Query the Audit Log” on page 317
• “To Purge the Audit Log” on page 318
• “To Configure Audit Security Settings” on page 320
19.1 Managing Audit Interests

On the Set Auditing Interests page, you can specify the events that Content Server
audits. “Auditable Events” on page 304 lists the events that are available to audit
when Content Server is installed. Optional modules often add new events that
Content Server can audit.
Note: When an audit event is not registered with the registry subsystem, it is
logged as Deprecated. A deprecated audit event has an ID of zero (0).
You can also enable settings that affect the functioning of the Audit system.
Force auditing of all events performed by System Administrators

When you enable this option, you ensure that any auditable actions performed
by a System Administrator (users that have the System Administration
privilege) are recorded, regardless of which events you have enabled on the Set
Auditing Interests page.
Audit an "Attributes Changed" event for Category Attributes modified during
item creation
This option affects how Content Server records Attributes Changed events. It
has no effect if the Attributes Changed auditing interest is not enabled.
Enabled (default setting)
If the option is enabled, an Attributes Changed event is recorded when an
item (or item version) that is created or copied has a Category Attribute
applied to it, and the default value of the Category Attribute is changed.

Chapter 19 Administering Event Auditing
It does not matter whether the Category Attribute is inherited from a parent
container or explicitly applied by a user. An Attributes Changed event is
recorded only if a user changes the Category Attribute from its default
value. If the user does not change the default value of the Category
Attribute, an Attributes Changed event is not recorded.
Disabled
When the option is not enabled, an Attributes Changed event is not
recorded when an item that is created or copied has a Category Attribute
applied to it, regardless of whether a user modifies the default value of the
Category Attribute. An Attributes Changed event is recorded, however, if
a user changes a Category Attribute value that is currently applied to an
item from its existing value to a different one.
Table 19-1: Auditable Events
Event Audit ID Description

ActiveView Browse 2000210 Logged against a container object whenever an ActiveView
template is used to render the browse view. This needs to
be enabled in the Audit Interests Admin page and on the
Specific tab of the ActiveView template itself.
Added to Package 302 An item was added to a Transport Package.
Added to Warehouse 300 An item was added to the Transport Warehouse.
Apply License 355 A license file was applied to Content Server or to a Content
Server module.
Attachment Added 383 An attachment was added to a comment or to a reply.
Attachment Removed 384 An existing attachment was removed from a comment or
from a reply.
Attributes Changed 10 One or more attributes of an item were changed.
Category Added 35 A category was added to an item.
Category Removed 34 A category was removed from an item.
CD Ordered 22 A compound document was ordered or created.
Classification – Classification 264 Classification was added to a managed item.
Applied
Classification – Classification 265 Classification was removed from a managed item.
Removed
Classify Existing Content 199 Intelligent Classifications were assigned to all eligible
managed objects.
Comment Created 373 A comment was added to a content message or to a content
item.
Comment Deleted 375 An existing comment was deleted from a content message
or from a content item.
Comment Edited 374 An existing comment was modified.

19.1. Managing Audit Interests

Configuration Changed 28 A Content Server configuration setting changed.
Content Moved 336 An item or item version was moved to a different Storage
Provider.
Copy 4 An item was copied from one location to another.
Create 1 An item was created.
Create Node Split Transaction 343 Content Server failed to roll back a split transaction. A split
Rollback Error transaction is a transaction that creates an item, and then
adds a version to the item. If the second operation (adding
a version) fails, Content Server rolls back the split
transaction.
Custom Audit Event 2000586 A WebReports custom audit event was recorded. Enabling
this interest enables the use of the WebReports
AUDITACTION tag, which can be used by a WebReports
developer to generate custom audit events. For more
information on the AUDITACTION tag, see OpenText
WebReports - OpenText Content Server User Guide
(LLESWEBR-UGD)
Data Source Purged 211 A data source was purged.
Database Maintenance 356
Delete 2 An item was deleted.
Deployed from Warehouse 301 An item was deployed from the Transport Warehouse.
Edit 25 An item was edited.
eLink AutoSubscriptions Changed 169 An eLink item and its auto-subscription changed.
eLink Disabled 166 eLink was systematically disabled.
eLink Enabled 165 eLink was systematically enabled.
eLink Option Changed 188 The eLink attachment option changed.
eLink Sent Document Copy 220 eLink sent a copy of a document.
eLink Sent Document Link 221 eLink sent a link to a document.
eLink Subscribed 167 An item was eLink-subscribed.
eLink Unsubscribed 168 An item was eLink-unsubscribed.
Enterprise Connect – Added from 256
eDOCS
Enterprise Connect – Log-in
Enterprise Connect – Version 255
Supersede
Enterprise Database Re-Extracted 210 The database was re-extracted.
Failed Log-In Attempt 29 A logon attempt failed.
Function Executed 31 A Content Server function was executed.


Generation Created 15 A generation of an item was created.
Hit Highlight 254 A user applied Hit Highlighting to an item within a Search
Results list.
Invalid Session Blocked 6543 The session of an externally-authenticated user became
invalid.
LiveReport Executed 234 A LiveReport was executed.
Log-in 23 A user logged in to Content Server.
Log-in Disabled 6544 After repeated failed login attempts, a user account was
disabled.
Log-out 24 A user logged off Content Server.
Major/Minor Disabled 42 Advanced (major/minor) versioning was disabled.
Major/Minor Enabled 41 Advanced (major/minor) versioning was enabled.
Members Changed 33 A user or group was added to, or removed from, a group.
(The audit message is from the point of view of the user or
group that was added or removed. For example, User1
was removed from GroupA.)
Membership Changed 30 A user or group was added to, or removed from, a group.
(The audit message is from the point of view of the group
that was added to or removed from. For example, GroupA
had User1 removed.)
Move 3 An item was moved from one location to another.
Owner Changed 27 The ownership of an item changed.
Physical Objects – 249 Borrowed physical item was acknowledged by the
Acknowledgement borrower.
Physical Objects – Add Code 129 Code was created in Physical Objects Table Maintenance.
Physical Objects – Assign Locator 128 Locator was assigned to physical item.
Physical Objects – Assign Transfer 154 Transfer was assigned to physical item.
Physical Objects – Assigned to Box 226 Physical item was assigned to Physical Item Box.
Physical Objects – Borrow 124 Physical item was borrowed.
Physical Objects – Borrow 157 Borrow action was cancelled.
Cancelled
Physical Objects – Box Content 229 Content was added to Physical Item Box.
Added
Physical Objects – Box Content 230 Content was removed from Physical Item Box.
Removed
Physical Objects – Copy Added 125 Physical Item Copy was added to Physical Item non
container.
Physical Objects – Copy Deleted 131 Physical Item Copy was deleted.


Physical Objects – Create Locator 135 Locator was added in Storage Management Locators.
Physical Objects – Create Transfer 154 Transfer was created in Storage Management Transfers.
Physical Objects – Delete Locator 152 Locator was deleted from Storage Management Locators.
Physical Objects – Delete Code 160 Code was deleted from Physical Objects Table
Maintenance.
Physical Objects – Delete Transfer 155 Transfer was deleted from Storage Management Transfers.
Physical Objects – Edit Code 159 Code was updated in Physical Objects Table Maintenance.
Physical Objects – Edit Locator 153 Metadata of Locator was updated in Storage Management
Locators.
Physical Objects – Edit Transfer 156 Metadata of Transfer was updated in Storage Management
Transfers.
Physical Objects – Export System 371 Physical Objects system settings was exported to xml file.
Settings
Physical Objects – Flag for Pick Up 241 Borrowed Physical Item was flagged for pick up.
Physical Objects – Import System 370 Physical Objects system settings was imported from xml
Settings file.
Physical Objects – Location 133 Home location or Current location of Physical Object was
Changed updated.
Physical Objects – Maintain 158 Location codes where updated using batch action Maintain
Location Codes Location Codes.
Physical Objects – Metadata 248 Metadata of Physical Item was updated.
changed
Physical Objects – Pass 127 Borrowed Physical Item was passed to another borrower.
Physical Objects – Reassign 150 Physical Item with assigned locator was reassigned to
Locator different locator.
Physical Objects – Reassign 151 Physical Item with transfer assigned was reassigned to
Transfer different transfer.
Physical Objects – Receive Transfer 162 Transfer was received.
Physical Objects – Remove Locator 148 Physical Item was removed from locator.
Physical Objects – Remove 149 Physical Item was removed from transfer.
Transfer
Physical Objects – Removed from 227 Physical Item was removed from Physical Item Box.
Box
Physical Objects – Request 126 Request to borrow physical item was created.
Physical Objects – Request 132 Request to borrow physical item was cancelled.
Cancelled
Physical Objects – Return 130 Borrowed Physical Item was returned.


Physical Objects – Return Date 240 Borrowed Physical Item has it’s returned date updated.
Update
Physical Objects – Security 242 Physical Item was borrowed to user with not sufficient
Override permissions by indicating to override security.
Physical Objects – Send Transfer 161 Transfer was sent.
Physical Objects – Synchronize 163 From and To dates of transfer were synchronized with
Transfer Dates transfer content.
Physical Objects – System Settings 267 Physical Objects system settings were updated.
Changed
Permissions Changed 9 The permissions of an item changed.
Print 636003 One or more items was printed using Multi-File Output.
Project Membership Changed 32 A user or group was added to, or removed from, a project.
Provider Changed 37 An item’s Storage Provider changed.
Provider Retry Delete Error 335 After an unsuccessful attempt to delete an item, a
Ignored subsequent attempt was unsuccessful. See “Administering
Blob Deletion Failures“ on page 301.
Provider Retry Deleted 225 After an unsuccessful attempt to delete an item, a
subsequent attempt was successful. For more information
on Provider Retry events, see “Administering Blob
Deletion Failures“ on page 301.
Provider Retry Queued 222 After an unsuccessful attempt to delete an item, the
deletion retry was queued. See “Administering Blob
Provider Retry Queuing Error 224 After an unsuccessful attempt to delete an item, the
queuing of the deletion retry resulted in an error. See
“Administering Blob Deletion Failures“ on page 301.
Provider Retry Retried 223 After an unsuccessful attempt to delete an item, the
deletion was attempted again. See “Administering Blob
Purge 13 An item was automatically purged from the Recycle Bin.
See “Configuring Recycle Bin” on page 374.
Purge Collections Items Audit 351 A system administrator manually deleted records
Records pertaining to operations performed on one or more
Collections. See “Purging Audit Records for Collected
Items” on page 904.
Purge now 391 A user manually purged an item in the Recycle Bin by
selecting it and clicking Purge. See “Restoring and Purging
Deleted Items” on page 372.
Records Management – Accession 243 Accession code changed for managed object.
Changed
Records Management – Add Hold 112 Disposition hold was assigned to managed item.


Records Management – Add RM 141 Code was created in Records Management Table
Code Maintenance.
Records Management – Additional 118 List of users or groups added as additional rights on RM
Rights Changed Classification was changed.
Records Management – Assign 143 Managed item was cross referenced.
Cross-Reference Code
Records Management – Batch 257 NOT USED
Update RM Classification
Metadata
Records Management – 184 RM Classification was closed.
Classification Closed
Records Management – 183 RM Classification was opened.
Classification Opened
Records Management – Create 215 New Disposition Hold was created in Records
Hold Management Hold Maintenance.
Records Management – Create RSI 114 New RSI was created in Records Management RSI.
Records Management – Create RSI 115 RSI Schedule was created.
Schedule
Records Management – Cycle 246 Update Cycle Period, Next Review Date or Last Review
Period Review Changed Date were changed for managed item.
Records Management – Delete 214 Disposition Hold was deleted from Records Management
Hold Hold Maintenance.
Records Management – Delete RM 121 Code was deleted from Records Management Table
Code Maintenance.
Records Management – Delete RSI 137 RSI was deleted from Records Management RSI.
Records Management – Delete RSI 116 RSI Schedule was deleted.
Schedule
Records Management – Delete 147 Deletion of managed item was denied in delete Workflow
Workflow Deletion Denied step.
Records Management – 145 Action of export was performed on items in the result of
Disposition Export disposition search.
Records Management – 347 Review decision was updated for items returned in
Disposition Review disposition search.
Records Management – 219 Action of updating provider was performed on items in the
Disposition Update Provider result of disposition search.
Records Management – 146 Action of delete electronic versions was performed on
Dispositions Delete Electronic items in the result of disposition search.
Records Management – Edit RM 142 Code was updated in from Records Management Table
Code Maintenance.
Records Management – Edit RSI 138 RSI was updated in from Records Management RSI.


Records Management – Edit RSI 122 RSI Schedule was updated.
Schedule
Records Management – Essential 136 Essential code was updated for managed item.
Changed
Records Management – Export 361 Records Management system settings were exported to xml
System Settings file.
Records Management – File 247 File number of RM Classification was updated.
Number changed
Records Management – Finalize 258 Action of finalize record was executed on managed item.
Record
Records Management – Finish 349 Review step for items in disposition search was finished.
Review
Records Management – Import 360 Records Management system settings were imported form
System Settings xml file.
Records Management – Make 185 Managed item was made confidential.
Confidential
Records Management – Mark 113 Managed item was mark official.
Official
Records Management – Process 253 User based hold was assigned to selected users to items
user Hold within the criteria dates.
Records Management – 236 Provenance was assigned to managed item.
Provenance Added
Records Management – 231 Provenance was disabled.
Provenance Disable
Records Management – 232 Provenance was enabled.
Provenance Enable
Records Management – 237 Provenance was removed form managed item.
Provenance Removed
Records Management – Reactivate 213 Disposition Hold was made active.
Hold
Records Management – Reassign 350 Different disposition reviewer was assigned.
Reviewer
Records Management – Record 123 Record Date or Receive Date was updated on managed
Date or Receive Date Changed item.
Records Management – Record 245 Record type assigned to document or physical item non
Type Changed container was changed.
Records Management – Remove 186 Managed item had confidential mark removed.
Confidential
Records Management – Remove 144 Cross Reference was removed from managed objects.
Cross-Reference Code


Records Management – Remove 119 Disposition Hold was removed form managed item.
Hold
Records Management – Remove 120 Managed item had official mark removed.
Official
Records Management – RM 139 RM Classification assigned to managed object.
Classification Added
Records Management – RM 110 Different RM Classification was assigned to managed
Classification Changed object.
Records Management – RM 140 RM Classification was removed form managed object.
Classification Removed
Records Management – RM 239 Metadata of RM Classification was changed.
Classification’s Metadata Changed
Records Management – RM 238 Records Management metadata was updated for managed
Metadata Changed item.
Records Management – RSI 111 RSI was updated on managed item.
Changed
Records Management – Snapshot 187 Disposition snapshot was deleted.
Deleted
Records Management – Status 117 Status was updated on managed item.
Changed
Records Management – Storage 244 Storage Medium was updated on managed item.
Medium Changed
Records Management – Suspend 212 Disposition Hold was made not active.
Hold
Records Management – System 266 Records Management system settings was changed.
Settings Changed
Records Management – Update 216 Metadata of disposition hold was updated.
Hold
Records Management – Update 252 Start Date, End Date or comments were updated for user
User Hold Criteria based hold.
Records Management – User(s) 250 Content Server user was added to user based holds.
Added to Hold
Records Management – User(s) 251 Content Server user was removed from user based holds.
Removed from Hold
Recovery Failure 209 The content of an item could not be accessed during
extraction to the search index, (so the item’s content is not
searchable). The item was placed in the recovery state.
Content Server makes additional attempts to extract the
content of items that are in the recovery state.


Recovery Success 208 After a Recovery Failure event occurred and an item was
placed in the recovery state, Content Server successfully
extracted the item’s content to the search index.
Release Created 20 A release of a compound document was created.
Release Deleted 21 A release of a compound document was deleted.
Rename 5 An item was renamed.
Rendition Created 16 A rendition of an item was created.
Rendition Deleted 17 A rendition of an item was deleted.
Reply Created 378 A reply was added to a comment on a content message or
to a comment on a content item.
Reply Deleted 380 An existing reply was deleted.
Reply Edited 379 An existing reply was modified.
Reserve 6 An item was reserved.
Restore 46 A deleted item was restored.
Revision Created 18 A revision of a compound document was created.
Revision Deleted 19 A revision of a compound document was deleted.
Saved Query Changed 341 A Search Form, Slice, or saved query was changed.
Saved Query Created 340 A Search Form, Slice, or saved query was created.
Saved Query Executed 342 A Search Form, Slice, or saved query was run.
Search Agent Disabled 369 A configured search agent for Prospectors or
Classifications was disabled.
Search Agent Enabled 368 A configured search agent for Prospectors or
Classifications was enabled.
Search Statistics Auto-Purged 218 Search statistics were automatically purged.
Security Clearance – Clearance 164 Security clearance level was changed
Level Changed
Security Clearance – Clearance 171 DOD Option 3: Any of values for Initial Security, Current
Level Information Changed Security, Reasons For, Classified By, Derived From,
Classifying Agency was changed.
Security Clearance – Declassify 172 DOD Option 3: Any of values for Declassify Type,
Information Changed Declassify Date , Declassify Event , Exemption Categories
was changed.
Security Clearance – Defined Rules 348 Defined rule was created, edited or deleted.
.
Security Clearance – Downgrade 173 DOD Option 3: Any of values for Downgrade Type,
On Information Changed Downgrade Event , Downgrade Date , Downgrade
Instructions changed.


Security Clearance – Export 366 Security Clearance codes and Supplemental Markings were
Security Clearance and exported to xml file.
Supplemental Markings
Security Clearance – mport 367 Security Clearance codes and Supplemental Markings were
Security Clearance and imported from xml file.
Supplemental Markings
Security Clearance – Item 174 DOD Option 3: Lowest Security Clearance Level was
Declassified assigned to an item.
Security Clearance – Item 175 DOD Option 3: Lower Security Clearance Level was
Downgraded assigned to an item.
Security Clearance – Item 176 DOD Option 3: Higher Security Clearance Level was
Upgraded assigned to an item.
Security Clearance – Reviewing 177 DOD Option 3: Any of values for Reviewed On, Reviewed
and Regarding Information By , Downgraded On , Downgraded By, Declassified On,
changed Declassified By, Upgraded On, Upgraded By, Upgrade
Reasons was changed.
Security Clearance – Security 260 Security Clearance Level code created.
Clearance Level Code Added
Security Clearance – Security 261 Security Clearance Level code deleted.
Clearance Level Code Removed
Security Clearance – Supplemental 262 Supplemental Marking code created.
Marking Code Added
Security Clearance – Supplemental 263 Supplemental Marking code deleted.
Marking Code Removed
Security Clearance – Supplemental 178 Supplemental Markings codes where changed for the item.
Markings Information changed
Search Statistics Purged 217 Search statistics were purged.
Shortcut Added 385 A shortcut to an item was added to a comment or to a
reply.
Shortcut Created 8 A shortcut to an item was created.
Shortcut Removed 372 A shortcut to an item was removed from a comment or
from a reply.
Thumbnail Created 352 A thumbnail image of a Content Server item was created.
Thumbnail Deleted 353 A thumbnail image of a Content Server item was deleted.
Thumbnails Deleted All 354 All of the thumbnail images of a Content Server item were
deleted.
Unreserve 7 An item was unreserved.
Version Added 11 A version was added to an item.
Version Control Changed 44 The version control changed.


Version Deleted 12 A version was deleted.
Version Locked 39 An item version was locked.
Version Opened 14 An item version was opened.
Version Promoted 43 A document item was promoted from a minor version to a
major version.
Version Superseded 228 Content Server replaced a version of a document edited
using WebDAV with a more recent document version. This
event occurs when the Enable collapse versions
within a single editing session settings is enabled
and a document is saved multiple times during a single
editing session. For more information, see “Configuring
WebDAV Version Management” on page 913.
Version Unlocked 40 An item version was unlocked.
View 26 An item was viewed.
WebReports Export to Client 2000208 A WebReport was executed with a destination of Browser.
WebReports Export to Desktop 2000201 A WebReport was executed with a destination of Desktop.
WebReports Export to email 2000202 A WebReport was executed with a destination of Email.
WebReports Export to Form 2000207 A WebReport was executed with a destination of Form.
WebReports Export to FTP Server 2000585 A WebReport was executed with a destination of FTP
Server.
WebReports Export to Node 2000203 A WebReport was executed with a destination of Content
Server Node, which creates a new Content Server item.
WebReports Export to Node 2000205 A WebReport was executed with a destination of Content
Version Server Version, which adds a version to a Content
Server item.
WebReports Export to Server 2000204 A WebReport was executed with a destination of Server.
The Server destination allows the WebReport output to
be sent to a location on the server where Content Server is
running, for example, C:/
WRoutput/myOutputFile.csv.
WebReports Run 2000209 A WebReport was executed. WebReports Run is a generic
event that is logged whenever a WebReport is run,
regardless of its destination.
WebReports Workflow 2000206 A WebReport was executed with a destination of Worklow,
which initiates a Workflow.
Workflow Status Changed 170 The status (suspended, executing, stopped, archived, or
deleted) of an executing workflow changed.
Xml Export 233 An XML export action was performed on an item.
Zip and Download 636002 An item or series of items was zipped and downloaded
using Multi File Output.

19.2. Managing Audit Records

Zip and Email 636001 An item or series of items was zipped and emailed using
Multi-File Output.
19.1.1 To View All Currently Set Auditing Interests

To view all currently set auditing interests:
1. Click the Administer Event Auditing link in the System Administration

2. On the Administer Event Auditing page, click Set Auditing Interests.
19.1.2 To Set Auditing Interests

To set auditing interests:
1. Click the Administer Event Auditing link in the System Administration

section of the Administration page.
2. On the Administer Event Auditing page, click Set Auditing Interests.
3. On the Set Auditing Interests page, in the Events section, to add an event type
that you want audited, select that event type's check box.
To stop auditing an event type, clear that event type's check box.
4. Optional In the Options section, if you want to enable the auditing of any
auditable actions performed by users with the System Administration privilege,
select Force auditing of all events performed by System Administrators.
5. Click Set Interests.
6. Click the Admin Home link to return to the Administration page.
19.2 Managing Audit Records

The Audit Query Results page lists all of the audited events and items that match
the criteria you specified on the Query Audit Log page. You can change the criteria
by clicking the Back to Query Page button and modifying the information.
Tip: To view other result pages, click the Previous or More buttons at the
bottom of the result list. To return to the Administration page, click the Admin
Home link.
The following tables list the values that are associated with the events on the Audit
Query Results page.

Permission Name Decimal Value Hex Bits

See Only 130 0x82 8, 2
See Contents Only 36865 0x9001 16, 13, 1
Modify Only 65536 0x10000 17
Edit Attributes Only 131072 0x20000 18
Add Items Only 4 0x4 3
Delete Versions Only 16384 0x4000 15
Delete Only 8 0x8 4
Reserve Only 8192 0x2000 14
Edit Permissions 16 0x10 5
Only
See Contents Perm 36995 0x9083 16, 13, 8, 2, 1
Modify Perm 65666 0x10082 17, 8, 2
Edit Attributes Perm 233603 0x39083 18, 17, 16, 13, 8, 2, 1
Add Items Perm 65670 0x10086 17, 8, 3, 2
Delete Versions Perm 118915 0x1D083 17, 16, 15, 13, 8, 2, 1
Delete Perm 118923 0x1D08B 17, 16, 15, 13, 8, 4, 2, 1
Reserve Perm 110723 0x1B083 17, 16, 14, 13, 8, 2, 1
Edit Permissions 258207 0x3F09F 18, 17, 16, 15, 14, 13,
Perm 8, 5, 4, 3, 2, 1
RightID Privileges
1 Owner
2 Group
3 Public Access
4 System (deprecated)
Audit log information is stored in tables in the Content Server database. You can
increase your database storage capacity by periodically purging unnecessary data.
You can purge the audit log based on date, user, and event type. When you purge
the audit log, Content Server removes rows from the DAuditNew table in the Content
Server database. If corresponding rows exist in the DAuditMore table, they are also
removed.
Warning
The purge action cannot be undone. To ensure that you purge the proper items
or events, you should query the audit log to display the items or events that
you intend to purge prior to purging any items. For more information, see
“Managing Audit Records” on page 315.

19.2. Managing Audit Records
After you set the auditing interests, you can consult the audit logs to monitor
database usage and diagnose problems. Content Server users can view the audit log
for single items by clicking its Functions icon , choosing Info, and then choosing
Audit.
19.2.1 To Manage Audit Records Created in Prior Releases

Note: You can manage audit records created in prior releases after you
upgrade a database from a previous version of Content Server.
To manage audit records created in prior releases:
1. On the Content Server administration page, in the System Administration

section, click Administer Event Auditing.
2. On the Administer Event Auditing page, click Manage Audit Records Created
in Prior Releases.
Note: Clicking either of the following options may be time consuming.

Once you have made your selection, you will see a progress page. Wait
until the progress page updates itself, then click Admin home.
3. On the Manage Audit Records Created in Prior Releases page, do one of the
following:
• To convert audit records from previous releases of Content Server, click

Convert Audit Records Created in Prior Releases.
• To remove audit records created in previous releases of Content Server, click
Purge Audit Records Created in Prior Releases.
19.2.2 To Query the Audit Log

To query the audit log:
1. Click Administer Event Auditing in the System Administration section of the

2. On the Administer Event Auditing page, click Query Audit Log.
3. In theTarget Items section, do one of the following:
• To view the audit log for all items, click the All radio button.
• To view the audit log for a specific type of item, click the By Type radio
button, and then select an item type from the list.
Note: Selecting User or Group will return results for the following
item types: User, Group, X-Domain Group, and Factory.
• To view the audit log for a single item, click Single Item. Click the Browse
Content Server button, navigate to the item, and then click its Select link.

• To view the audit log of events performed on a user or group, click Single
User/Group, and then find a user or group.
4. Click the type of event for which you want the audit results displayed in the
Event Type list.
Tip: Click <Any> to view results for all event types.
5. In the Performers section, do one of the following:
• To view the audit log of events performed by any user and group, click All.
• To view the audit log of events performed by a specific user, click Specific
User, and then select a user or group.
6. Click a month, day, and year in the From Date and To Date lists to specify an
inclusive time frame by which to search.
7. Click a value in the Rows Per Page list to specify the number of items that
appear on a page.
8. Click Submit Query.
Note: A broad query can potentially return a large number results, depending
on the size of the database. OpenText recommends that you restrict the results
by specifying an item type, event type, user, and/or date range. Also,
impossible combinations will return zero results. For example, if you select
Folder as the item type and Add Version as the event type, the query will not
return any results.
19.2.3 To Purge the Audit Log

To purge the audit log:
1. In the System Administration section of the Administration page, click the

Administer Event Auditing link.
2. On the Administer Event Auditing page, click the Purge Audit Log link.
3. In the Target Items section, do one of the following:
• To purge all items, click the All button.

• To purge specific items, click the By Type button, and then select the type
you want to purge from the list.
Note: Selecting User or Group will automatically purge the following

item types: User, Group, X-Domain Group, and Factory.
• To purge a single item, click the Single Item button, and then click the
Browse Content Server button, navigate to the item you want to purge, and
then click its Select link.

19.3. Managing Audit Security Settings
• To purge items that belong to a specific user or group, click the Single User/
Group radio button, and then find a user or group.
4. To purge the audit log of a specific type of event, select the event from the Event
Type list.
Tip: To purge the audit log of all event types, click <All>.
5. In the Performers section, do one of the following:
• To purge the audit log of all users and groups, click the All button.
• To purge the audit log of a specific user, click the Specific User button, and
then find a user or group.
6. To purge the audit log of items or events within a specific time frame, click a
month, day, and year from the From Date and To Date calendars.
7. Click Purge.
8. Click the Admin Home link to return to the Administration page.
19.3 Managing Audit Security Settings

To protect the accuracy and integrity of the Content Server audit log, ordinary users
cannot access the Content Server audit log administrative functions. By default, only
the Admin user and any user with the System administration rights privilege
can query the audit log, set auditing interests, and purge the audit log. You can
enable Audit Security Settings, however, to restrict these abilities even further.
Tip: You may wish to enable audit security settings if your organization is
regulated and it is mandatory that you can demonstrate the integrity of the
audit log.
Content Server Audit Security Settings allow for several levels of increased
restriction:
Tip: If you enable any of these security levels, users with the System
administration rights privilege can query the audit log, but cannot add or
remove auditing interests or purge the audit log.
For more information about the auditing interests page, see “Managing Audit
Interests” on page 303. For more information about the audit log, see “Managing
Audit Records” on page 315.
• You can configure Content Server so that only the Admin user can set auditing
interests and purge the audit log.
• You can configure Content Server so that no user at all can purge the audit log.
• You can configure Content Server so that no user at all can make changes to your
audit interests configuration.

Important
Consider carefully before you decide to prevent purging of the audit log or
changing the audit interests. Once you take either of these steps, they cannot
be disabled. For example, if you prevent changes to your audit interests
configuration, you will be unable to enable new auditing interests added by
a new Content Server module, or disable such new auditing interests that are
enabled by default.
19.3.1 To Configure Audit Security Settings

To configure audit security settings:
1. Log on to Content Server as the Admin user.
Note: You must be logged on as Admin to configure audit security

settings. It is not sufficient to log on as a user with the System
administration rights privilege.
2. In the System Administration section of the Administration page, click

Administer Event Auditing.
3. On the Administer Event Auditing page, click Audit Security Settings.
4. On the Audit Security Settings page:
a. Optional If you want to prevent any user other than the Admin user from
purging the audit log or modifying your audit interests, enable Limit Audit
Config to "Admin" User.
b. Optional If you want to prevent any user at all from purging the audit log:
i. To prevent any user, including the Admin user, from purging the audit
log, click Disable Audit Purge.
Important
Clicking Disable Audit Purge cannot be undone. If the audit
log becomes large, you may see an impact to performance.
Tip: The Disable Audit Purge button is disabled if audit purge

has already been disabled.
ii. In the Disable Audit Purge? dialog box, enable I understand the risk
involved by enabling this setting and want to continue, and then
click OK.
c. Optional If you want to prevent any user at all from changing the audit
interests configuration:
i. To prevent any user, including the Admin user, from modifying the
auditing interests and ensuring that the Set Auditing Interests page
becomes read-only, click Lock Audit Interests.

19.3. Managing Audit Security Settings
Important
Clicking Lock Audit Interests cannot be undone. In the event
that new interests are added to Content Server, for example if
you install a new module or upgrade an existing module, those
new interests cannot be audited.
Tip: The Lock Audit Interests button is disabled if auditing

interests have already been locked.
ii. In the Lock Audit Interests? dialog box, enable I understand the risk
involved by enabling this setting and want to continue, and then
click OK.
d. Click Submit.

Chapter 20
Administering Item Control
The Administer Item Control page allows you to:
1. customize Content Server's Reserve and Unreserve functions

2. set a default Version limit for Content Server items
3. specify advanced versioning parameters
4. enable the Advanced Add Item process. This allows users to choose a Category
when they add an item, if the item they are adding is of a MIME type that has
more than one Category associated with it. For this to take effect, you must select
the Display categories on second Add Item page check box. For more
information, see “Associating MIME Types and Categories” on page 225. For
general information about MIME type settings, see “Administering MIME Types
and Icons“ on page 221.
The settings you specify on the Administer Item Control page become the default
values for Content Server items that are reservable or versionable.
20.1 To Configure Item Control Parameters

To configure item control parameters:
1. In the System Administration section of the Content Server administration

page, click the Administer Item Control link.
2. On the Administer Item Control page, in the Version Limit area, type a
numerical value in the Set Version Limit Default Value field to set the default
maximum number of Versions for Content Server items.
Note: The default value for this field is unlimited. To reset the Version
limit to an unlimited value, type either Unlimited or -1 in the Set Version
Limit Default Value field.
3. In the Reserve area:
a. In the Group Reserve Capability field, select the Show group list check
box to allow groups to reserve or unreserve Content Server items.
b. In the Unreserve Document field, select the Enable "Add New Version" by
default check box to automatically enable users to add a new Version of an
item when they unreserve it.
4. In the Advanced Version Control for Documents area:
a. In the Advanced Version Control field, select the Enable advanced major/
minor versioning for Documents in the system check box to allow users to
add Versions of a Document as a major or minor Version of the original.

Chapter 20 Administering Item Control
b. In the Major Version Only Access field, select the For users with major
Version only access, hide Documents that only have minor Versions
check box to hide Documents with only minor Versions from users who
have permission to see.
5. In the Advanced Add Item area, in the Required Attributes field, select the
Display categories on second Add Item page check box to enable the two-step
Advanced Add Item process.

Chapter 21
Administering Modified Date Trigger
This page enables you to control whether or not changes to item permissions or
Categories and attributes affect the modified date of the item. These settings affect
all items in the entire Content Server system.
21.1 To Set Modification Date Restrictions

To set modification date restrictions:
1. Click the Administer Modified Date Triggers link in the System

Administration section of the Administration page.
2. On the Administer Modified Date Triggers page, do one of the following:
• Select or clear the Permissions modification check box to control whether

changing an item's permissions (including changes to access rights, Owner,
Owner Group, and Public Access) change the modified date of them item.
• Select or clear the Category values and attributes modification check box to
control whether upgrading a Category or changing an attribute in a
Category changes the modified date of items that have a Category applied to
them.

Chapter 22
Administering Object and Usage Privileges
A Content Server administrator manages Object and Usage Privileges to protect

Content Server data and system integrity:
• Object Privileges grant users and groups the ability to create certain types of
Content Server items
• Usage Privileges grant users and groups the ability to perform certain types of
Content Server tasks
22.1 Object Privileges

Content Server Object Privileges regulate the ability of users to create certain
Content Server items.
By default, all Content Server objects, except Category, LiveReport, URL, and
Custom View and Appearance object types, are unrestricted, which means that users
and groups have the necessary privileges to create the item types in Content Server.
Only the Admin user initially has the privileges necessary to create LiveReports,
URLs, and Custom Views. These settings can be changed by restricting or
unrestricting the object type for specific groups or users.
A user who has the item creation privilege for LiveReports can issue SQL statements
to the RDBMS, including statements that can alter the Content Server database. To
maintain the integrity of your Content Server database, OpenText recommends that
you restrict the LiveReports creation privilege to the Admin user or to only a small
number of users who are knowledgeable about SQL and the Content Server schema.
To protect your database, the Modify permission for LiveReports requires that a
Content Server user have the LiveReport item creation privilege.
Note: Optional installed modules have their own default settings and
restrictions. Optional modules may restrict object and usage privileges by
default.

Chapter 22 Administering Object and Usage Privileges
22.2 Usage Privileges

Content Server usage privileges regulate the ability of users to perform certain
Content Server actions. “Content Server Usage Privileges” on page 328 describes the
usage privileges that are present after you perform a basic installation of Content
Server. Optional modules may introduce additional usage privileges.
Content Server usage privileges can be restricted or unrestricted by default. The

default setting is indicated in the table, which also provides a brief description of the
usage privilege. The reason that you may choose to restrict the usage privilege is
classified as one or more of the following reasons:
Performance
The usage privilege may allow a user to perform actions that place a high load
on the Content Server computer or database.
Security
The usage privilege may elevate the user’s access permissions and possible
provide unauthorized access to items or Content Server metadata.
User Experience
• Restricting the usage privilege may simplify a user’s options by hiding
options that a user is not likely to perform.
• Restricting the usage privilege may prevent a user from inadvertently
performing an unexpected action.
• Restricting the usage privilege to a group of knowledgeable and trustworthy
users may help to protect system integrity.
Table 22-1: Content Server Usage Privileges
Usage Type Usage Name Default Reason to Effect More

Setting Restrict Information
Best Bets Set Best Bets Restricted user Allows users “Administeri
Administrati Value experience to apply or ng Best Bets”
on edit Best Bets on page 723
values.

22.2. Usage Privileges

Workflow Item Handler Restricted security Allows you to “Administer
Task Type interact with Access to the
documents as Workflow
a user of your Agent and
choosing. Full Item Handler
access to the Step”
Item Handler on page 1044
allows you to
update items
and item
metadata as
any user in
the system.
The audit log
shows the
configured
user, not the
workflow, as
the user that
made the
changes.
Storage View Storage Restricted security Allows you to “Configuring
Provider Rules see and use a Storage
Storage Rules Rules”
option in the on page 355
Tools global
menu to view
(but not edit)
Content
Server
Storage Rules.
Form SQL Table Unrestricted user Allows users “Administeri
Revisable experience to select the ng Usage
Storage SQL Table Privileges”
revision on page 1048
mechanism
when they
create a Form
and select a
template for
which a
database table
exists.


Item Handler Versioning Restricted security Allows you to “Administer
Task add versions Access to the
Operation to any items Workflow
in the system Agent and
as any system Item Handler
user Step”
regardless of on page 1044
your
permissions
to the item.
Item Handler Move/Copy Restricted security Allows you to
Task make copies
Operation of any item in
the system
and perform
the copy as
any system
user.
Item Handler Categories Restricted security Allows you to
Task change
Operation metadata for
any item in
the system
and perform
the change as
any system
user.
Item Handler Folder Restricted security Allows you to
Task Definitions create folders
Operation anywhere in
the system
and perform
the creation as
any system
user.
Form SQL Table Unrestricted user Allows users “Administeri
Submittable experience to select the ng Usage
Storage SQL Table Privileges”
submission on page 1048
mechanism
when they
create a Form
and select a
template for
which a
database table
exists.


Form User Unrestricted user Allows users
Submittable Revisable experience to select the
Storage Records User
(SQL) Revisable
Records
(SQL)
mechanism
when they
create a Form
and select a
template for
which a
database table
exists.
Form Initiate Unrestricted user Initiate OpenText
Submittable WebReport experience WebReport WebReports -
Storage (SQL) that is similar OpenText
to SQL Table. Content
The main Server User
difference is Online Help
that when the (LLESWEBR-
data is stored H-UGD)
in the SQL
table, the
primary key,
or SEQ, is
identified and
passed to a
WebReport
which is
initiated
immediately
after the form
submission.
Workflow Agent Restricted performance Allows you to “Administer
Features Performers be assigned Access to the
workflow Workflow
tasks that are Agent and
performed by Item Handler
the workflow Step”
agent. on page 1044


Workflow Assign to Restricted security Allows you to
Features Workflow assign
Agent workflow
tasks to the
workflow
agent. This
privilege
could be used
to do
malicious
actions in
bulk.
Web Forms Execute SQL Unrestricted user Allows users “Managing
Features Lookup experience the ability to Secure
create Database
database Connections”
connections on page 1051
and lookups.
Search See Restricted security Allows you to “To
Unpermissio see the true Configure
ned Result search result the Search
Counts count from Results
the Search Header and
Engine that is Footer
shown to Search”
users with the on page 683
System
Administratio
n Rights
privilege,
rather than
the estimate
that is shown
to non-
administrativ
e users.


Administrati Show Admin Unrestricted user Allows you to
on Menu experience view an
Admin global
menu that
provides links
to the Content
Server
Administratio
n page and
the Search
Admin
Browser, if
you have the
System
Administratio
n Rights
privilege. (No
effect if you
do not have
the System
Administratio
n Rights
privilege.)
Recycle Bin Recycle Bin Restricted security, user Allows you to “Recycle Bin
Administrati Manager experience view, restore, Administrati
on and purge on“
any items in on page 371
the Recycle
Bin. Allows
you to access
the Recycle
Bin even if
user access to
the Recycle
Bin has been
disabled.
Multi-Select Collect Unrestricted user Allows you to “Restricting
Command experience see and use a access to
multi-select Collections”
Collect on page 897
button to bulk
add multiple
Content
Server items
to a
Collection.


Renditions Make Restricted user Allows users OpenText
Rendition experience to create an Renditions -
Ad Hoc OpenText
Rendition of a Content
Document. Server User
Online Help
Renditions Subscribe to Restricted user Allows users (LLESRND-
Rendition experience to subscribe H-UGD)
individual
Documents
for
renditioning
whenever
new Versions
are added.
Collections Queue for Restricted performance, Allows you to “Restricting
Command Indexing user see and use a access to
experience Queue for Collections”
Indexing on page 897
command
that appears
in the
Collection’s
More Actions
menu to
submit
Content
Server
Collection
items in bulk
for addition
to the Search
Index.
Collections Queue Restricted performance, Allows you to
Command Thumbnail user request
Generation experience thumbnails to
be generated.


Collections Copy Items Unrestricted user Allows you to
Command experience see and use a
multi-select
Copy button
to bulk copy
multiple
Content
Server items.
(Actual copy
of one or
more items.
Not a copy of
one or more
Collection
items to
another
Collection.)
Collections Move Items Unrestricted user Allows you to
Command experience see and use a
multi-select
Move button
to bulk move
multiple
Content
Server items.
(Actual move
of one or
more items.
Not a move of
one or more
Collection
items to
another
Collection.)


Collections Delete Items Restricted performance, Allows you to
Command security see and use a
multi-select
Delete button
to bulk delete
multiple
Content
Server items.
(The button
deletes the
actual
Content
Server items.
It does not
simply
remove items
from the
Collection.)
Collections Copy Items to Unrestricted user Allows you to
Command Another experience see and use a
Collection Copy Items to
Another
Collection
command
that appears
in the
Collection’s
More Actions
menu to copy
Collection
items in bulk
to another
Collection.
Collections Make Disk Restricted performance, Allows you to
Command Image security see and use a
Make Disk
Image
command
that appears
in the
Collection’s
More Actions
menu to bulk
copy
Collection
items to a
Disk Image
(ISO file).


Collections Move Items Unrestricted user Allows you to
Command to Another experience see and use a
Collection Move Items
to Another
Collection
command
that appears
in the
Collection’s
More Actions
menu to move
Collection
items in bulk
to another
Collection.
Collections Remove Unrestricted user Allows you to
Command Items from experience see and use a
Collection Remove
Items from
Collection
command
that appears
in the
Collection’s
More Actions
menu to
remove
Collection
items in bulk
from the
Collection.
Collections Download as Restricted performance, Allows a user
Command Spreadsheet security to bulk export
Content
Server item
metadata to a
spreadsheet
(.csv file).


Collections Zip & Unrestricted performance Allows you to
Command Download see and use a
Command Zip &
Download
command
that appears
in the
Collection’s
More Actions
menu to bulk
copy Content
Server items
from the
Collection in a
compressed
archive.
Collections Zip & Email Unrestricted performance Allows you to
Command Command see and use a
Zip & E-mail
command
that appears
in the
Collection’s
More Actions
menu to email
a compressed
archive
containing
Content
Server items
copied from
the Collection.
Collections Print Unrestricted performance Allows you to
Command Command see and use a
Print
command
that appears
in the
Collection’s
More Actions
menu to print
multiple
Content
Server items
from the
Collection.


Collections Apply Unrestricted performance Allows you to
Command Categories see and use
an Apply
Categories
command
that appears
in the
Collection’s
More Actions
menu to
apply
Categories
and attributes
to multiple
Content
Server items.
(Categories
are applied to
actual
Content
Server items,
not merely to
the Collection
items.)
Collections Create Unrestricted performance Allows you to
Command Searchable enable
Collection searches
when creating
a new
Collection.
Collections Collect All Restricted performance Allows you to
Command Search add all the
Results items
returned by a
search query
into a
Collection.


Collections Custody Restricted performance Allows you to
Command Details in provide
Disk Image information
about the
Content
Server
software
environment,
when the
Collection
was created,
completeness
details, etc.
Warehouse Warehouse Restricted security Allows you to “Configuring
Administrati Manager see and Transport
on change an Warehouse
item’s Settings“
metadata, on page 1271
including the
owner of an
item.
Facet Knowledge Restricted performance, Allows you to “Configuring
Administrati Manager user access the Faceted
on experience Facets Browsing”
Volume from on page 49
the Tools
global menu
and to create
Content
Server facets
and columns.


WebReports Run As Unrestricted security, user Allows you to OpenText
experience run a WebReports -
WebReport as OpenText
a different Content
user without Server User
having the Online Help
System (LLESWEBR-
Administratio H-UGD)
n Rights
privilege, and
possibly to
view items
and content
that you do
not have
permission to
access.
(WebReports
Audit shows
the actual
user that
triggered the
report.)
WebReports WR Trigger Unrestricted user Allows you to OpenText
Tab experience access the WebReports -
WebReports OpenText
Trigger tab of Content
a Content Server User
Server item Online Help
without (LLESWEBR-
having the H-UGD)
System
Administratio
n Rights
privilege.
ActiveView ActiveView Restricted security, user Allows you to OpenText
Tab experience view and Content
manage Server - User
ActiveView Online Help -
overrides for ActiveView
the Classic User Help
View of the (LLESAV-H-
Content UGD)
Server user
interface.


ActiveView ActiveView Restricted security, user Allows you to OpenText
Usage Tab experience see a list of Content
which nodes Server - User
are affected Online Help -
by the current ActiveView
ActiveView User Help
template. (LLESAV-H-
UGD)
ActiveView Perspectives Restricted security, user Allows you to OpenText
Tab experience view and Content
manage Server - User
ActiveView Online Help -
overrides for ActiveView
the Smart User Help
View of the (LLESAV-H-
Content UGD)
Server user
interface.
22.2.1 To Restrict Object or Usage Privileges

To restrict object or usage privileges:
1. Click Administer Object and Usage Privileges in the System Administration

section of the Content Server Administration page.
2. On the Administer Object and Usage Privileges page, click Restrict beside the
object or usage privilege that you wish to restrict.
3. Click OK in the confirmation dialog box that appears.
4. Search for the users or groups to whom you want to grant the object or usage
privilege, and then enable Add to group beside the group or user name.
5. Click Submit.
6. When you are done selecting users and groups, click Done .

22.2.2 To Modify Object or Usage Privileges

To modify object or usage privileges:
1. Click the Administer Object and Usage Privileges in the System

Administration section of the Content Server Administration page.
2. On the Administer Object and Usage Privileges page, click Edit Restrictions
beside the object or usage privilege that you wish to modify.
3. To grant the privilege to new users or groups, search for the users or groups to
whom you want to grant the object or usage privilege, enable Add to group
beside the group or user name, and then click Submit.
To remove the privilege from existing users or groups, click the name of the
user or group on the left, and then click Remove From Group on the right.
4. When you have finished making modifications, click Done.

Chapter 23
Configuring Access Control
The Administrator can set system access control options on the Configure Access
Control page. Access Control Entries (ACEs) provide a way to restrict access rights
in the system to only allow nodes with ACEs but no owner, owner group, or public
access.
In the Default Access section, you can enable the following system access control
options, which are all disabled by default:
• Restrict "Grant Access" to Groups only, which enforces ACE assignments for
groups only. If this option is not selected, any user with the Edit permission can
search the list of users and grant selected users access. When this option is
enabled, only groups can be selected and granted access.
• Restrict restoring "Owner Access" to System Administrators, which only allows
the Administrator to restore the Owner Access permission. If this option is not
selected, any user with the Edit permission can restore the Owner Access.
• Restrict restoring "Owner Group Access" to System Administrators, which only
allows the Administrator to restore the Owner Group Access permission. If this
option is not selected, any user with the Edit permission can restore the Owner
Group Access.
• Restrict restoring "Public Access" to System Administrators, which allows only
the Administrator to restore the Public Access permission. If this option is not
selected, any user with the Edit permission can restore Public Access.
In the Moving Items across Workspaces section, you can enable:
• Always inherit the permissions from target destination, which forces an items'
permissions settings to be inherited from the destination when they are moved
between Workspaces. For more information about how copying or moving an
item affects its permissions, see OpenText Content Server User Online Help - Getting
Started (LLESRT-H-UGD).
In the eDiscovery Mode Access section, you can enable:
• eDiscovery Mode access. If Enable eDiscovery mode access is enabled, you can
assign users the eDiscovery Rights system privilege, which allows a user to set
eDiscovery Mode on the My General Settings page. (For more information, see
OpenText Content Server User Online Help - Working with Users and Groups
(LLESWBU-H-UGD).) If Enable eDiscovery mode access is cleared, no user can
be assigned the eDiscovery Rights privilege; the option to assign the eDiscovery
Rights system privilege does not appear at all on the Add New User or General
Info for: <user> page.

Chapter 23 Configuring Access Control
23.1 To Configure Access Control

To configure access control:

Configure Access Control link.
2. On the Configure Access Control page, select any of the following check boxes:
• Restrict "Grant Access" to Groups only

• Restrict restoring "Owner Access" to System Administrators
• Restrict restoring "Owner Group Access" to System Administrators
• Restrict restoring "Public Access" to System Administrators
• Always inherit the permissions from target destination
3. Click the Update button.

Chapter 24
Working with Copy and Delete Item Operations
The copy and delete item function enables users to copy and delete multiple items at
one time. You can change the default settings for the entire system.
24.1 Configuring the Status Page for Multi-Select

Actions
You can allow users to see a status page that shows the progress of items that are in
the process of being copied, moved, or deleted.
When you set the display progress to yes, you can specify the number of items that
get processed before the page refreshes itself. When the display progress is set to no,
the status page does not display until all items have been moved, copied, or deleted.
24.1.1 To Configure the Status Page for Multi-Select Actions

To configure the status page for multi-select actions:

Configure Status Page for Multi-Select Actions link.
• Click the Yes, and update progress display after X items processed radio
button, and then type a number in the text field to specify the number of
items you want to process before the page refreshes.
• Click the No, just show the results when finished radio button.
24.2 Configuring the Operations for Copy, Delete and

Move
You can specify how Content Server commits batch copy or delete operations to the
database—either individually or as a group. For a request that contains multiple
items, Content Server defaults to processing all of the copy, delete, or move
operations in a single transaction. If a single item in the transaction fails, the entire
batch rolls back to its original state and nothing is committed to the database.
Alternatively, you can configure Content Server to commit copy, delete, or move
operations to the database item by item. With this setting enabled, if an item fails, it
does not cause the entire operation to fail. Any item that is processed successfully is
committed to the database.

Chapter 24 Working with Copy and Delete Item Operations
You can also configure the move throttle control setting, which limits the number of
items that users can move from one Content Server location to another.
Note: The move control throttle setting may prevent users from moving items
even when they have apparently selected fewer items than the maximum
allowed by the move throttle. This is because items counted towards the move
throttle control setting include containers, such as Folders, and items within
containers.
For example, if the Maximum approximate number of objects allowable in

one move is set to 1,000, and a user selects 100 Documents and a Folder
containing 900 Documents, the move throttle control will prevent the move
operation.
24.2.1 To Modify the Copy, Delete, and Move Operation

Settings
To modify the Copy, Delete, and Move Operation settings:

page, click Configure the Operations for Copy, Delete and Move.
2. On the Configure the Operations for Copy, Delete and Move page, enable one
of the following settings in the Copy and Delete sections:
• Commit the transactions after all items were processed successfully, which
commits the database transaction when all items have been processed.
Note: If one item in the transaction fails, the entire transaction fails and
nothing is committed to the database.
• Commit the transaction for each item processed successfully, which
commits the database transaction for each processed node.
Note: For the Copy function, this operation copies one node at a time
and commits the database transaction using a top-down scheme.
However, for the Delete function, the operation deletes one node at a
time and commits the database transaction using a bottom-up scheme.
3. Optional In the Move section, select the Enable the move throttle control check
box, and then type the maximum number of objects allowed in a move in the
Maximum approximate number of objects allowable in one move box.
4. Click Update.

Part 5
Item Administration
Chapter 25
Storage Providers and Storage Management
Content Server allows you to store Documents and other items in multiple locations.
You can configure Content Server to use several different Storage Providers, which
allows Content Server items to be stored wherever is most appropriate, according to
the Storage Provider Rules that you implement. Storage Providers and Storage
Provider Rules can be added, deleted, or modified by the Content Server
administrator.
Note: While some storage providers are delivered with Content Server, other
storage providers require that you install additional software. For example, the
Archive Storage Provider requires that you install OpenText Archiving for
Content Server.
25.1 Managing Internal and External Storage

Content Server can store items internally in the database or externally on the file
system.
When you use internal storage, both the content and metadata (data describing a
Content Server item) are stored in the database. When you use external storage, only
an item’s metadata is stored in the database; the content of the files is stored on the
file system.
When an item is added to Content Server, the system creates a record for it in the
ProviderData table and in other Content Server database tables. The ProviderData
table stores information that tells Content Server where to retrieve the file when
users request to view or fetch it. In the case of internal storage, the ProviderData
table stores the internal database location of the file. In the case of external storage,
the ProviderData table stores the physical path of the file on the file system.
Note: When you use external document storage, Content Server uses a
numbering algorithm to name files so it can keep track of multiple versions of
the same file. Content Server does not store files on the file system under the
same names as they had when they were copied from users' disks. For
example, if a user adds a file called Expense12Mar.xls to Content Server, its
name in the external storage directory may be something like 2934eriw.233.

Chapter 25 Storage Providers and Storage Management
25.1.1 Setting Up an External File Store

If you locate an External File Store (EFS) on the primary Content Server host, writing
and retrieving documents may be slightly faster, because there is no network delay,
however testing by OpenText has shown that this performance improvement may
be marginal compared to locating the EFS on a remote host. The improvement may
be more significant if you are operating in an environment where the network is
very busy. If this is the case, consider placing the components of the Content Server
system on their own isolated subnetwork.
When you add External Document Storage, you give the new Storage Provider a
name and specify its location. Before you do:
• Create the folder that you want to use as the root of the External File Store.
Content Server will not create the folder if it does not exist.
• If the EFS is not on the same host as your primary Content Server installation,
map or mount the folder on the primary Content Server host. For Linux or
Solaris, use an NFS mount. For Windows, use a UNC path. (Do not map a drive
letter.)
• Make sure that the remote file store folder is owned by the Content Server user.
Create a user with the same name, password, and privileges on both the primary
Content Server host and the External File Store host. The servers on the primary
Content Server host must run as this user and the remote EFS folder must be
owned by this user. For more information about the permissions that a Content
Server user must have, see OpenText Content Server - Installation Guide (LLESCOR-
IGD).
Try connecting to the folder from the primary Content Server host as the Content
Server user to test whether you can access it and write to it. If you encounter
permission or ownership problems when performing this test, correct the
problems before you create the Content Server database.
25.2 Configuring Storage Providers

Storage Providers enable you to store Content Server Documents and other items.
Storage providers include:
• External folders
• Databases
• OpenText Archive Server
Storage Provider Rules determine which Storage Provider stores a given item based
on rule settings and the characteristics of the item.
Content Server always creates an internal database storage provider and a ZeroByte
storage provider. The default Content Server storage rules send zero-byte files to the
ZeroByte storage provider and objects without content to the internal database
storage provider. Each Content Server instance has a default Storage Provider that

25.2. Configuring Storage Providers
cannot be modified or deleted. If you configure an external storage provider during

the initial setup of Content Server, it becomes the default storage for documents,
emails, and all other items. Otherwise, the internal database storage provider
becomes your default storage provider.
For more information about Storage Provider Rules, see “Configuring Storage
Rules” on page 355.
Administrators can audit the movement of content from one Storage Provider to
another. By default, the Provider Changed audit interest is turned off. The audit
details for this event include the original Storage Provider name, the new Storage
Provider name, and the name of the user who moved the content. Every Document
in Content Server displays the name of its Storage Provider on the Versions tab of
the Document's Properties page. Users with the proper permissions can view the
entire list of Storage Provider Rules. This list includes the Storage Provider rule, and
the name and type of the Storage Provider.
25.2.1 To Add a Storage Provider

To add a Storage Provider:
1. On the Content Server Administration page, in the Storage Provider Settings

area, click Configure Storage Providers.
2. On the Configure Storage Providers page, from the Add Item list, click the type
of Storage Provider you want to add.
3. On the Add New Logical Storage Provider page, in the Name field, type a
name for the Storage Provider.
4. In the Configuration field, type the absolute path to the Storage Provider.
Note: The absolute path applies to external storage directories. If the

Storage Provider type is something other than an external directory, you
may need to specify a different configuration path in the Configuration
field. After you add a Storage Provider, you must define rules for it.
5. Click Submit.

25.2.2 To Modify a Storage Provider

To modify a Storage Provider:
1. On the Content Server administration page, in the Storage Provider Settings

2. On the Configure Storage Providers page, click Edit next to the storage
provider you want to edit.
3. In the Configuration field, type an absolute path to the new Storage Provider.
Note: The absolute path applies to external storage directories. If the

storage provider type is something other than an external directory, you
may need to specify a different configuration path in the Configuration
field.
If you change the storage provider's configuration path, you must
manually move existing content from the old location to the new location.
4. Click Submit.
25.2.3 To Delete a Storage Provider

Note: You cannot delete a Storage Provider when it is in use.
To delete a Storage Provider:

2. On the Configure Storage Providers page, in the Actions column for the
Storage Provider you want to delete, click Delete.
3. Click OK in the confirmation dialog.

25.3. Configuring Storage Rules
25.3 Configuring Storage Rules

You can set individual binary rules and create an ordered association between the
rules and Storage Providers to determine where Documents are stored.
Tip: You do not need to restart Content Server after you modify Storage
Providers, rules, and their associations.
You can configure as many storage rules as you want, however, OpenText
recommends that you keep the number of storage rules below 12. Storage rules are
evaluated whenever a Document is added to Content Server or whenever a Content
Move job is started. When a Document is added, the rules are evaluated in order
from the top of the list to the bottom. If the Document does not meet any of the
defined rules, it is stored in the default Storage Provider, which always appears last on
the list and cannot be configured or deleted.
A storage rule consists of a rule name, one or more conditions, and a storage target
which is selected if all the conditions are true. After a rule is created, you can modify
it, delete it, and change its order in the list. When you add a new rule, it will appear
above the current rule by default.
For each rule type you add, you specify the value of the rule, represented below by
the ? in the Value field.
The following rules are available by default when Content Server is first installed:
• Size of file in bytes is greater than '?'
• Category name is '?'
• Mime type is '?'
• Size of the file in bytes is less than '?'
• Node name contains '?'
• Always (value is ignored)
• Any additional node attribute value is '?'
• Non-specific attribute ? value is ?
• Attribute ? value is ?
• All Thumbnails
• OR '?'
• AND '?'
• NOT '?'
• Project '?'
• Volume '?'
• Creation Date/Modification Date '?'

• Newest Version '?'

• Object type in ?
• Stored below ?
• Stored below Container Type ?
• Stored in Personal Workspace (value is ignored)
• Volume Free Space (MB)
Note: When no rules are defined, the only icon that appears in the Modify
column of the Configure Storage Rules page is the Add icon.
Additional rules are installed by the following Content Server optional modules:
• OpenText Classifications
See “Storage Rules Available for the Classifications Module” on page 361 for
more information.
• Controlled Viewing and Printing
• Enterprise Library
• Records Management
See “Storage Rules Available for the Records Management and Security
Clearance Modules” on page 361 for more information.
For more information, see “Available Storage Rules” on page 356 and “Examples
Showing How to Define Storage Rules” on page 365.
25.3.1 Available Storage Rules

This page lists the storage rules available in Content Server. When a Document has
the value you define assigned to it, that Document will be stored in the Storage
Provider specified in the rule. You can find examples detailing many of these
storage rules in “Examples Showing How to Define Storage Rules” on page 365.
Default Storage Rules

The following storage rules are available by default when you install Content Server:
Note: Content Move also makes the logical operators AND, OR and NOT
available, which allow you to create complex rules.
Size of file in bytes is greater than '?'

• Description: if a Document's file size exceeds the file size stipulated in this rule,
that Document will be stored in the Storage Provider specified in the rule.
• Value Represented by '?': <file_size> in bytes. For example, to represent 100 KB,
type “1048576”.

• Syntax: Size of file in bytes is greater than '1048576'
Category name is '?'
• Description: if a Document has the specified Category assigned to it, that

Document will be stored in the Storage Provider specified in the rule.
• Value Represented by '?': <category_name>. An example of a Category name is
“myCategory”.
• Syntax: Category name is 'myCategory'
Mime Type is '?'
• Description: if a Document is of the specified MIME type, that Document will be

stored in the Storage Provider specified in the rule.
• Value Represented by '?': <MIME_type_name>. An example of a MIME type
name is “application/msword”.
• Syntax: Mime Type is 'application/msword'
Size of file in bytes is less than '?'
• Description: if a Document's file size is less than the file size stipulated in this
rule, that Document will be stored in the Storage Provider specified in the rule.
• Value Represented by '?': <file_size> in bytes. For example, to represent 100 KB,
type “1048576”.
• Syntax: Size of file in bytes is less than '1048576'
Node name contains '?'
• Description: if a Document's node name contains the specified string, that

Document will be stored in the Storage Provider specified in the rule. Enter any
string which can be part of the node name.
• Value Represented by '?': <node_name>. An example of a Node name is “test”.
• Syntax: Node name contains 'test'
Always (value is ignored)
• Description: OpenText does not recommend that you use this storage rule, as it
applies to any object type. An arbitrary value has to be entered.
Any additional node attribute value is '?'
• Description: if a Document has an additonal node attribute, and that additional

node attribute contains the specified string, that Document will be stored in the
Storage Provider specified in the rule. Enter any string which can be part of the
node attribute value.

This rule applies to additional node attributes which can be defined on the
Administering Additional Node Attributes administration page. For more
information, see “Administering Additional Node Attributes“ on page 927.
• Value Represented by '?': <node_attribute_value>. An example of a node attribute
value is “test”.
• Syntax: Any additional node attribute value is 'test'
Non-specific attribute ? value is ?
• Description: if a Document has a named, but unspecified, Category attribute that

contains the specified string, that Document will be stored in the Storage
Provider specified in the rule. The Category attribute does not need to be specified.
• Value Represented by the first ?: <category_name>.<attribute_name>. An example
of a Category name and an Attribute name is “myCategory.myAttr”.
• Value Represented by the second ?: <attribute_value>. An example of an attribute
value is “anyValue”.
• Syntax: Non-specific attribute myCategory.myAttr value is anyValue
Attribute ? value is ?
• Description: if a Document has a named and specified Category attribute that

contains the specified string, that Document will be stored in the Storage
Provider specified in the rule. The Category attribute needs to be specified. This
storage rule is available because attributes can have multiple values.
• Value Represented by the first ?: <category_name>[<x>].<attribute_name>[<z>],
where <x> and <z> are positive integers representing the specific Category and
the specific attribute. An example that references the third row of the attribute
myAttr in the Category myCategory is: “myCategory[1].myAttr[3]”.
Tip: Because there is always only one row in the Category, <x> will always
be 1, and must always be included.
Note: If the Category contains the Set attribute, and you want to specify a
value within that Set, you need to represent the Category in this form:
<category_name>[<x>].<set_name>[<y>].<attribute_name>[<z>]
An example that references the third row of an attribute named myAttr, in
the fourth row of a set named mySet, in the category named myCategory is:
“myCategory[1].mySet[4].myAttr[3]”.
• Value Represented by the second ?: <attribute_value>. An example of an attribute
value is “anyValue”.
• Syntax without Set: Attribute myCategory[1].myAttr[3] value is anyValue
• Syntax with Set: Attribute myCategory[1].mySet[4].myAttr[2] value is
anyValue

All Thumbnails
• Description: This rule routes Thumbnails to the designated Logical Storage
Provider.
• Value: No value is required.
OR '?'
• Description: This rule selects from several rules with the OR operator.
• Value: Description, Rule, Value. For details, see “To Combine Several Rules
with AND, OR Operators” on page 364.
AND '?'
• Description: This rule combines several rules with the AND operator.
• Value: Description, Rule, Value. For details, see “To Combine Several Rules
with AND, OR Operators” on page 364.
NOT '?'
• Description: This rule excludes all content to which the rule does not apply
• Value: Rule, Value.
Project '?'
• Description: This rule checks if a document is assigned to a specific project, that
you select from a list. If so, that document will be stored in the Storage Provider
specified in the rule.
• Value: the Node name of the Project.
• Syntax: Project '<project_node_name>'
Volume '?'
• Description: this rule checks if a document is stored in a specific Volume. If so,
that document will be stored in the Storage Provider specified in the rule.
• Value: select a Volume from the list. An example of a Volume is: Admin Home.
• Syntax: Volume 'Admin Home'
Creation/Modification Date '?'

• Description: This rule checks the creation date of the document, or the
modification date of the document, if one exists. If the creation date, or
modification date, of the document is equal to the date specified in the rule, that
document will be stored in the Storage Provider specified in the rule.
You can optionally select a time range, one of: earlier, later, equal, between,
exactly, more, or less.
• Value: a date value of the form DD/MM/YYYY. An example is “28/02/2014”.

Tip: Select the year first, then the current date is preset.
• Syntax: Creation/Modification Date '28/02/2014'
Newest Version '?'

• Description: If the rule is set to TRUE, the latest version or rendition of the
document will be stored in the Storage Provider specified in the rule. If the rule is
set to FALSE, all versions and renditions except the newest version or rendition
will be stored in the Storage Provider specified in the rule.
• Value: TRUE or FALSE
• Syntax: Newest Version 'TRUE' or Newest Version 'FALSE'
Object Type in ?
• Description: This rule checks if a document has a specific object type assigned. If
so, that document will be stored in the Storage Provider specified in the rule. You
can select one or more types.
OpenText recommends that you only select types with content.
• Value: an object type, which type has content, that you select from the list.
Examples of types with content include: 144, 753, 825.
• Syntax: Object Type in 144
Stored below ?
• Description: This rule checks if a document is stored in a specific Container, that
you select from a list. If so, that document will be stored in the Storage Provider
• Value: the node name of the Container.
• Syntax: Stored below <container_node_name>
Stored below Container Type ?

• Description: This rule checks if a document is stored in a specified Container
type, that you select from a list. If so, that document will be stored in the Storage
Provider specified in the rule. You can select one or more types.
• Value: the Container type.
• Syntax: Stored below Container Type <container_type>
Stored in Personal Workspace (value is ignored)

• Description: This rule checks if a document is stored in a Personal Workspace. If
so, that document will be stored in the Storage Provider specified in the rule.
• Value: Null, nothing has to be entered.
• Syntax: Stored in Personal Workspace (value is ignored)

Volume Free Space (MB)
• Description: this rule checks the remaining free space available on the volume on
which Content Server is attempting to store the Document. If the free space will
be less than the configured free space value specified in the rule, it will indicate
that the Document cannot be stored on the volume. Content Server will then try
the next volume in the list until it can save the Document. If the Document
cannot be saved to any volume, it will be stored in the default volume.
• Value: a numeric value, in MB, needs to be entered. An example is “500”.
Storage Rules Available for the Classifications Module

Certain modules have specific rules that are available only when that module is
installed. This page lists available storage rules added to Content Server by
installation of the Classifications module.
Node assigned Classifications
• Description: If a document has the specified Classification, Records Management

Classification, Records Management Folder, or Provenance assigned to it, that
document will be stored in the Storage Provider specified in the rule. The rule
applies to both primary and secondary RM Classifications and RM Folders.
• Value: <Classification path>. Select a Classification, Records Management
Classification, Records Management Folder, or Provenance value in the Browse
Classifications or My Classifications Favorites window.
• Syntax: Classification:<Classification Name, RM Classification name,
RM Folder name, or Provenance>
For information on this rule, see OpenText Content Server Classifications Admin Online
Help - Administering Classifications (LLESCLS-H-AGD)
Storage Rules Available for the Records Management and

Security Clearance Modules
Certain modules have specific rules that are available only when that module is
installed. This page lists available storage rules for the Records Management and
Security Clearance modules.
Primary RM Classification '?'
• Description: this rule checks if a Document has a specific Records Management

Classification assigned to it. If so, that Document will be stored in the Storage
Provider specified in the rule.
• Value: the Records Management Classification name. Browse the classification
tree and select a value.
• Syntax: RM Classification '<RM_classification_name>'

RM Essential '?'
Essential value assigned to it. If so, that Document will be stored in the Storage
• Value: the Records Management Essential value. Select an Essential value from
the list.
• Syntax: RM Essential '<RM_essential_value>'
RM Status '?'
Status code assigned to it. If so, that Document will be stored in the Storage
• Value: <Status Code>. Select an RM Status code value from the list.
• Syntax: RM Status '<RM_status_code>'
Security Clearance Level '?'

• Description: this rule checks if a Document has a specific Security Clearance
level assigned to it. If so, that Document will be stored in the Storage Provider
The rule applies specifically to the chosen Security Level; it does not apply to
items with a Security Level below the chosen level. If there are several levels, it
can be necessary to concatenate one or more security clearance rules.
You can only edit rules that use Security Levels for which you have the See
permission. If existing rules use Security Levels for which you do not have the
See permission, you will see that the rules exist but you cannot access them.
Documents that have their Security Levels updated will be placed in the queue
and reevaluated by the rule.
• Value: a Security Clearance level. Select a Security Clearance level from the list.
Only Security Clearance levels for which you have the See permission are
displayed in the list.
• Syntax: Security Clearance Level '<SC_level>'
Supplemental Markings '?'

• Description: this rule checks if a Document has specified Security Clearance
supplemental marking(s) assigned to it. If so, that Document will be stored in the
Storage Provider specified in the rule.
You can only edit rules that use Supplemental Markings for which you have the
See permission. If existing rules use Security Levels for which you do not have
the See permission, you will see that the rules exist but you cannot access them.
Documents that have their Supplemental Markings updated will be placed in the
queue and reevaluated by the rule.

• Value: a Security Clearance supplemental marking. Select one or more

supplemental marking(s) from the list. Only Supplemental Markings for which
you have the See permission are displayed in the list.
• Syntax: Supplemental Markings '<SC_supplemental_marking(s)>'
25.3.2 To Define a Storage Provider Rule

To define a Storage Provider rule:
1. In the Storage Provider Settings area of the Content Server administration

page, click the Configure Storage Rules link.
2. On the Configure Storage Rules page, in the Storage Rules area, under the
Modify column, click the Add new rule before this one icon, .
The new rule will appear above the current rule.
3. On the Add New Rule page, from the Rule list, select a rule.
4. In the Value field, type a rule value.
5. Optional In the Description field, type a description of your new rule.
Note: Although the Description field is optional, OpenText recommends

that you always enter a description when creating a new Storage Rule.
6. The next fields available to you will be determined by the rule you selected in
Step 3. If your new rule contained a variable, indicated by ?, you will need to
type a value for that variable. These fields are mandatory.
a. In the Value field, type the value you want to define this rule.
b. In the Attribute Specification field, type a value for the attribute
specification you want set for this rule.
c. In the Attribute Value field, type a value for the attribute you want set for
this rule.
7. From the Logical Storage Provider list, click the Storage Provider you want
associated with the rule.
8. Click Submit.

25.3.3 To Combine Several Rules with AND, OR Operators

To combine several rules with AND, OR operators:
Generally, all defined rules are processed in the order of their definition and, if any
rule applies, the content is moved to the storage provider assigned to the rule. This
corresponds with an OR operator. The rule operators AND and OR provided with
the Content Move functionality allow you to combine several rules to define a more
complex evaluation. For instance, you can make the content move dependent on a
certain file size and type, or on an attribute value or a modification date.

area, click the Configure Storage Rules link.
2. On the Configure Storage Rules page, click the Add new rule before this one
icon, for the expression you want the new rule to appear above in the list.
3. Select the type of Rule you want to define (AND, OR).
4. Define a Description for the rule, which will appear in the overview on the
Configure Storage Rules page.
5. In the Value section, define the first rule.
6. Click on Apply this value ( ) to apply the rule before defining the next rule in
the combination set.
7. Define the next rule that you want to combine with the previous one. Again, the
order of the rules is significant. Therefore, you find an Add icon behind each
rule in the combination set. Click on the appropriate Add ( ) icon, depending on
which expression you want the new rule to appear above in the set.
8. From the Logical Storage Provider list, click the Storage Provider you want
associated with the rule.
9. Click Submit.
25.3.4 To Edit a Storage Provider Rule

To edit a Storage Provider rule:

2. On the Configure Storage Rules page, click the Edit icon, , next to the
storage rule you want to edit.
3. On the Configure Rule page, change any of the available parameters.
4. Click Submit.

25.3.5 To Delete a Storage Provider Rule

To delete a Storage Provider rule:

2. On the Configure Storage Rules page, click the Delete icon, , next to the rule
you want to delete.
25.3.6 To Change the Order of a Storage Provider Rule

To change the order of a Storage Provider rule:

2. On the Configure Storage Rules page, click the Up, , or Down icon, , for a
rule until it reaches the position you want in the list.
25.3.7 Examples Showing How to Define Storage Rules

Below are examples demonstrating how to set some of the available storage rules.
Before beginning any of the examples below, you must first:
1. On the Content Server administration page, under Storage Provider Settings,

select Configure Storage Rules.
2. On the Configure Storage Rules page, in the Storage Rules area, under the
Modify column, click the Add new rule before this one button. This brings you
to the Add New Rule page.
Examples for the Storage Rules Available by Default

These examples demonstrate how to set the storage rules available by default when
you install Content Server
Example 25-1: Category name is '?'
If you want all Documents that have been assigned the Category
“Purchasing” added to a storage provider you specify:
1. From the Rule list, select Category name is '?'.

2. In the Description field, type “Documents that have been assigned the
Purchasing Category will be stored in the specified Logical Storage
Provider.”
3. In the Value field, type: Purchasing
4. From the Logical Storage Provider list, select the storage provider that
you want used to store this Document if this condition is met.

5. Click Submit.
Example 25-2: Mime type is '?'
If you want all Documents of the Mime type “application/msword” added to

a storage provider you specify:
1. From the Rule list, select Mime type is '?'.

2. In the Description field, type “Documents with Mime type 'application/
msword' will be stored in the specified Logical Storage Provider.”
3. In the Value field, type: application/msword
5. Click Submit.
Example 25-3: Node name contains '?'
If you want all Documents with a node name that contains the string “xyz”
added to a storage provider you specify:
1. From the Rule list, select Node name contains '?'.

2. In the Description field, type “Documents with a node name that
contains the string ‘xyz’ will be stored in the specified Logical Storage
Provider.”
3. In the Value field, type: xyz
5. Click Submit.
Example 25-4: Any additional node attribute value is '?'
If you want all Documents whose additional node attribute value contains
the string “xyz” added to a storage provider you specify:
1. From the Rule list, select Any additional node attribute value is '?'.
2. In the Description field, type “Documents whose additional node
attribute value contains the string ‘xyz’ will be stored in the specified
Logical Storage Provider.”
3. In the Value field, type: xyz
5. Click Submit.

Example 25-5: Non-specific attribute ? value is ?
If you want all Documents that:

• have a specific Category assigned to them, and
• which Category has a named, but not specified Attribute, and
• which Attribute has a specific value assigned to it,
1. From the Rule list, select Non-specific attribute ? value is ?.

2. In the Description field, type “Documents assigned a Category named
‘myCategory’, that has an Attribute named ‘myAttr’, which Attribute has
the assigned value ‘anyValue’, will be stored in the specified Logical
Storage Provider.”
3. In the Attribute Specification field type the Category and the Attribute:
myCategory.myAttr
4. In the Attribute Value field, type the value of the Attribute: anyValue
6. Click Submit.
Example 25-6: Attribute ? value is ? (without Set)

• which Category has a named and specified Attribute, and
• which Attribute has a specific value assigned to it,
1. From the Rule list, select Attribute ? value is ?.

‘myCategory’, that has a specific Attribute named ‘myAttr’, which
Attribute has the assigned value ‘anyValue’, will be stored in the
specified Logical Storage Provider.”
3. In the Attribute Specification field type the Category and the specific
Attribute: myCategory[1].myAttr[3]

6. Click Submit.
Example 25-7: Attribute ? value is ? (with Set)

• which Category has a Set, and
• which Set has a specific value assigned to a named attribute
1. From the Rule list, select Attribute ? value is ?.

‘myCategory’, with a Set called ‘mySet’, which Set has a specific
Attribute named ‘myAttr’, which Attribute has the assigned value
‘anyValue’, will be stored in the specified Logical Storage Provider.”
3. In the Attribute Specification field type the Category and the specific
Attribute: myCategory[1].mySet[4].myAttr[3]
6. Click Submit.
Example 25-8: Volume Free Space (MB)
If, before storing a Document, you want Content Server to assess the free
space available on the volume and only store to a volume that has 500 MB of
free space available:
1. From the Rule list, select Volume Free Space (MB).

2. In the Description field, type “Skip if less than 500 MB free.”
3. In the Volume Free Space (MB) field, type: 500
you want Content Server to assess first when storing this Document.
5. Click Submit.
Examples for the Records Management and Security Clearance

Storage Rules
These examples demonstrate how to set some of the Records Management and
Security Clearance storage rules.

Example 25-9: RM Classification '?'
If you want all Documents with a specific Records Management

Classification assigned to them added to a storage provider you specify:
1. From the Rule list, select RM Classification '?'.

2. In the Description field, type “Documents with the RM Classification
‘xyz’ assigned to them will be stored in the specified Logical Storage
Provider.”
3. In the Value field, browse the Classification tree and select a
Classification.
5. Click Submit.
Example 25-10: RM Essential '?'
If you want all Documents with a specific Records Management Essential

value assigned to them added to a storage provider you specify:
1. From the Rule list, select RM Essential '?'.

2. In the Description field, type “Documents with the RM Essential value
‘xyz’ assigned to them will be stored in the specified Logical Storage
Provider.”
3. In the Value field, select an Essential value from the list.
5. Click Submit.
Example 25-11: RM Status '?'
If you want all Documents with a specific Records Management Status code
assigned to them added to a storage provider you specify:
1. From the Rule list, select RM Status '?'.

2. In the Description field, type “Documents with the RM Status code ‘xyz’
assigned to them will be stored in the specified Logical Storage
Provider.”
3. In the Value field, type an RM Status code.
5. Click Submit.

Example 25-12: Security Clearance Level '?'
If you want all Documents with a specific Security Clearance level assigned
to them added to a storage provider you specify:
1. From the Rule list, select Security Clearance Level '?'.

2. In the Description field, type “Documents with the Security Clearance
level ‘xyz’ assigned to them will be stored in the specified Logical
Storage Provider.”
3. In the Value field, select a Security Clearance level from the list.
5. Click Submit.
Example 25-13: Supplemental Markings '?'
If you want all Documents with specified Security Clearance supplemental

marking(s) assigned to them added to a storage provider you specify:
1. From the Rule list, select Supplemental Markings '?'.

2. In the Description field, type “Documents with the Security Clearance
supplemental marking(s) ‘xyz’ assigned to them will be stored in the
specified Logical Storage Provider.”
3. In the Value field, select one or more supplemental marking(s) from the
list.
5. Click Submit.

Chapter 26
Recycle Bin Administration
By default, Content Server is installed with the Recycle Bin enabled, so that an item
that has been deleted can be restored to Content Server.
When a user deletes an item, Content Server places the item in the Recycle Bin. The
Recycle Bin allows any user that could delete the item from its original location to
restore the item or purge it from the Recycle Bin. Items that are purged from the
Recycle Bin are permanently deleted.
Not every item type can be restored after it is deleted. Content Server is capable of
restoring a wide variety of deleted item types, but certain non-restorable item types
are not placed in the Recycle Bin when they are deleted. Some item types can be
configured as restorable or non-restorable. For more information, see “Restorable
and Non-restorable Item Types” on page 374.
Note: If you do not want the Recycle Bin to be available to Content Server
users and administrators, you can disable it. See “Disabling the Recycle Bin”
on page 375.
26.1 The Recycle Bin Manager Usage Privilege

As an administrator, you can assign any Content Server user to the role of Recycle
Bin Manager. Making a user a Recycle Bin Manager allows you to delegate the work
of purging and restoring items from the Recycle Bin without assigning a user the
System administration rights privilege.
A Recycle Bin Manager is a user that can view, restore, and purge any of the items in
the Recycle Bin, regardless of the user that deleted them, including items that the
Recycle Bin Manager could not have accessed in their original location (and cannot
access after they have been restored). A Recycle Bin Manager can access the Recycle
Bin even if you have disabled user access to the Recycle Bin (see “User Options”
on page 376).
To add and remove users from the Recycle Bin Manager group, open the
Administer Object and Usage Privileges administration page and, in the Usage
Privileges section, beside Recycle Bin Administration, click Edit Restrictions. To
make a user a Recycle Bin Manager, add the user to the Recycle Bin Manager group.
By default, the Recycle Bin Administration usage privilege is restricted and is not
assigned to any user. For more information on object and usage privileges, see
“Administering Object and Usage Privileges“ on page 327.

Chapter 26 Recycle Bin Administration
26.2 Restoring and Purging Deleted Items

When a restorable item is deleted, it is placed in the Recycle Bin. Items in the Recycle
Bin can be restored to their original location in Content Server. They can also be
purged, either automatically or manually.
26.2.1 Accessing the Recycle Bin

To view the items in the Recycle Bin, click Recycle Bin on the Tools global menu.
By default, the Recycle Bin has columns that show the type, name and size of each
deleted item, the user who deleted it, the date it was deleted, and its location at the
time it was deleted. If you have enabled the Display purge date column in Recycle
Bin setting in the Recycle Bin user options (see “User Options” on page 376), it also
displays the date that an item is scheduled to be purged automatically. To locate
items in the Recycle Bin, you can use the content filter or the default Recycle Bin
views (I Deleted Today, I Deleted, Anyone Deleted Today or Anyone Deleted).
A deleted container appears in the Recycle Bin with a number in the Size column
that indicates the number of child items that were in it. Child items of a container do
not appear in the Recycle Bin if the parent container has been deleted. To restore one
or more of the items that were in the container at the time of deletion, you must
restore the container. When you restore a container, it is restored along with the
items that it contained at the time of deletion.
If you restore a deleted item or container, it is restored to its original location.
Note: Items that were deleted from a container before the container was
deleted are not restored when the container is restored. After the container is
restored, they remain in the Recycle Bin. If the container is restored, such items
become visible in the Recycle Bin and can be restored explicitly.
Restoring Deleted Items

To restore documents from the Recycle Bin:
1. Click Recycle Bin on the Tools global menu. The Recycle Bin page appears.
2. Select one or more items that you want to restore. If the item that you want to
restore resided in a Content Server container that has been deleted, select the
Content Server container to restore it and all of the sub-items that it contained at
the time of its deletion.
Tip: Use the Content Filter or the Recycle Bin views to assist you in
locating items to restore.
3. Click Restore, and then confirm the restore operation.
The items that you selected are restored. The Status on the confirmation page notes
the location that they were restored to.

26.2. Restoring and Purging Deleted Items
Purging Deleted Items

Purging can be done automatically or manually. When you purge an item from the
Recycle Bin, the item is permanently removed from Content Server. For the settings
governing automatic purges see “Automatic Purge Settings” on page 375.
To manually purge documents in the Recycle Bin:
1. Click Recycle Bin on the Tools global menu. The Recycle Bin page appears.
2. Select one or more items that you want to purge. If the item that you want to
purge resided in a Content Server container that has been deleted, select the
Content Server container to purge it and all of the sub-items that it contained at
the time of its deletion.
Tip: Use the Content Filter or the Recycle Bin views to assist you in
locating items to purge.
3. Click Purge, and then confirm the restore operation.
The items that you selected are purged. Purged items are deleted permanently and
cannot be restored.
26.2.2 Accessing Legacy Recycled or Deleted Items

If you have upgraded to Content Server 16 or later from Content Server 10.5 or
earlier and your previous version made use of Undelete or the optional Recycle Bin
module, an additional Legacy Recycled Items or Legacy Deleted Items link appears
below the default Recycle Bin views. The link is visible if you have System
administration rights privilege or the Recycle Bin Manager usage privilege. It
provides access to items that were in the Recycle Bin or Undelete Volume at the time
that Content Server was upgraded to Content Server 16 or later.
Note: Items from the Undelete Volume have a different appearance in Content
Server 16 and later. They are prefaced with the data ID of the item. A
document that appeared in the Undelete Volume as MyDocument.pdf, for
example, may appear in Content Server 16 as [1234] MyDocument.pdf.
To restore a legacy recycled or deleted item, move it to a place that is accessible to

the user who wants to regain access to the item. Adjust the item’s permissions, if
necessary, so that the user can access it.
Tip: A user with the Recycle Bin Manager usage privilege can restore a legacy
recycled or deleted item that they otherwise do not have permission to access.
Consequently, it is possible for a Recycle Bin Manager to restore an item and be
unable to access it after it is restored, even if it is restored to a location that the
Recycle Bin Manager can access, such as the Recycle Bin Manager’s personal
workspace.
When you restore a legacy recycled or deleted item, you can specify the
location to restore it to. To ensure that a user can regain use of a restored

legacy recycled or deleted item, OpenText recommends that the Recycle Bin
Manager restore the item directly to a folder that both the user and the Recycle
Bin Manager can access.
If you decide that you no longer require access to legacy recycled or deleted items,
you can purge them. Select one or more items in the legacy items folder and then
click Purge. Items that are purged are immediately deleted. They are not placed in
the Recycle Bin. Once you delete all of the items from the legacy items folder, the
link to it no longer appears in the Recycle Bin.
26.3 Configuring Recycle Bin

On the Recycle Bin Settings page, you can configure the behavior and appearance
of the Recycle Bin. There are three main sections: Supported Types, Settings and
User Options
If you have upgraded to Content Server 16 or later from Content Server 10.5 or
earlier and your previous version made use of Undelete or the optional Recycle Bin
module, an additional link appears at the top of the page: Manage Legacy Deleted
Items. Click this link to access items that were in the Recycle Bin or Undelete
Volume at the time that Content Server was upgraded to Content Server 16 or later.
26.3.1 Restorable and Non-restorable Item Types

Items that are restorable are placed in the Recycle Bin when they are deleted. They
can be restored after deletion. Items that are non-restorable are purged immediately
and cannot be restored. As an administrator, you can choose whether to make
certain item types restorable or non-restorable.
Not every item type can be configured in this manner. Some Content Server item
types can never be made restorable and some other Content Server item types are
always restorable. The remaining item types are configurable. You can set them to
restorable or non-restorable, according to your organization’s needs.
The Recycle Bin Settings page, in the Supported Types section provides
information on item types. Use the links in this section to view listings of restorable
and non-restorable item types and to configure eligible items.
Restorable Item Types

Click Edit/Review Restorable Node Types to view a listing of items that Content
Server can restore. Item types that appear in the Mandatory section are always
restorable. You cannot configure them. Item types that appear in the Optional
section are configurable. If you enable one of the item types in this section, deleted
items of that type are placed in the Recycle Bin. If you disable one of them, items of
that type are purged immediately upon deletion and cannot be restored.
Note: Changes made on this page are not retroactive. They do not affect items
that are already in the Recycle Bin.

26.3. Configuring Recycle Bin
Non-restorable Item Types

Click Review Restorable Node Types to view a listing of item types that Content
Server cannot restore. These item types can never be made restorable.
26.3.2 Settings
The Settings section of the Recycle Bin Settings page allows you to enable or
disable the Recycle Bin and configure settings that govern the automatic purging of
items in the Recycle Bin.
Disabling the Recycle Bin

You can disable the Recycle Bin in your Content Server deployment. If you do,
deleted items cannot be restored. They are scheduled for purge immediately upon
deletion.
To disable the Recycle Bin
1. On the Content Server Administration page, in the System Administration

section, click Recycle Bin.
2. On the Recycle Bin Settings page, in the Enable section, select Schedule
immediate purge of all items when they are deleted.
Automatic Purge Settings

To retain deleted items in the Recycle Bin until a user purges them, enable Keep
deleted items until manually purged. To configure Content Server to automatically
purge deleted items in the Recycle Bin after a period of time, enable Purge items
automatically and specify a number of days in the box before Days to retain
before purging.
If you want the Recycle Bin to display the date that Content Server is scheduled to
purge an item from the Recycle Bin, enable Display purge date column in Recycle
Bin. If this setting is enabled, the Recycle Bin displays a Purge Date column in
addition to the columns that appear by default (Type, Name, Size, Deleted By,
Deleted Date, and Location).

26.3.3 User Options

Recycle Bin user options govern whether Content Server users can access the
Recycle Bin, its appearance if they can, and whether they can purge deleted items
that are in the Recycle Bin.
To allow users access to the Recycle Bin, enable Ordinary users can see Recycle Bin.
If this setting is not enabled, users do not have a Recycle Bin option in their Tools
global menu. If the setting is enabled, the Recycle Bin option does appear in their
Tools global menu, and they can use it to access the Recycle Bin and restore deleted
items. If you wish to also allow users to purge items from the Recycle Bin, enable
Users can Purge items.
The options in the User View Options section enable the appearance of various
filters that can be used to regulate the appearance of the Recycle Bin. Disabling a
filter prevents Content Server users from seeing and using it in the Recycle Bin. It
has no effect on Recycle Bin Managers or users with the System Administration
rights privilege.
Important
Enable at least one filter if you want Content Server users to have access to
the Recycle Bin. Disabling every filter has the same effect as disabling
Ordinary users can see Recycle Bin: it removes the Recycle Bin option from
their Tools global menu.

Part 6
Module Administration
Chapter 27
Administering Modules
Content Server components are organized into core and optional software modules.
Core modules, such as Content Server Workspaces, Content Server Document

Management, and Content Server Projects, are automatically installed when Content
Server is installed. Optional modules, such as Content Server Forms, are installed by
a Content Server administrator during the initial installation of Content Server or
afterwards. Optional modules extend the functionality of Content Server to meet
your organization's specific needs. These may be new modules that you have
purchased or modules that were available at the time of installation, but you chose
not to install.
Tips
• For information on installing optional modules during a Content Server
installation, see OpenText Content Server - Installation Guide (LLESCOR-IGD).
• For additional information on installing, uninstalling and upgrading
modules, see OpenText Content Server - Module Installation and Upgrade Guide
(LLESCOR-IMO).
27.1 Installing Modules

You install a module in two stages:
1. Installation on the operating system

You configure your operating system to use the module, and install the
module’s components into the <Content_Server_home>/staging/ folder of
2. Installation on Content Server
You use the Content Server Administration page to move the module from the
<Content_Server_home>/staging/ folder to the <Content_Server_home>/
module/ folder, and install it in Content Server,
When you perform the installation on the operating system, you are asked to select
the instance of Content Server on which you want the module installed. You can
only install a module on one instance of Content Server at a time.
Note: When you install optional modules during the installation of Content
Server, the Help Index is automatically built to reflect help for all installed
modules.
Otherwise, update the help indexesx after you install, uninstall, or upgrade a
module so that changed content is available to be searched in the Online Help.
See “To Update the Admin and User Online Help” on page 387.

Chapter 27 Administering Modules
Installing Modules on Windows

For Windows versions of Content Server modules, you perform the first stage of an
installation using an InstallShield installation program. This installation program
allows you to select the Content Server instance to which you want to add the
module, and places the module's files in a subfolder of the Content_Server_home
\staging\ folder.
Installing Modules on Linux and Solaris

For Linux and Solaris versions of Content Server modules, you perform the first
stage of an installation using a .tar compressed archive file. The extraction of
this .tar file places the module's files in a subdirectory of the
Content_Server_home/staging/ directory.
27.1.1 To Install Modules on Content Server Running on

Windows
To install one or more modules on Content Server running on Windows:
1. Install the modules on Windows.
• Download and run each module's installer.
i. When the installer’s Welcome dialog box appears, click Next.

ii. On the License Agreement dialog box, accept the terms of the License
Agreement, and then click Next.
iii. In the Selection of install location dialog box, enable the Content
Server instance on which you want the module installed, and then
click Next.
iv. Perform the installation. When the Completing the Installation dialog
box appears, click Finish.
2. Install the modules on Content Server.
a. In the Module Administration section of the Content Server

Administration page, click Install Modules.
b. In the Installable Modules section of the Install Modules page, enable the
modules that you want to install, and then click Install.
Note: When you enable a module that requires the installation of

other modules, Content Server automatically selects the required
modules if they have been installed on the operating system. Content
Server can install as many as nine modules at once, but if you want to
install the modules one at a time, install the required modules first.
The Restart Content Server page appears. After you restart Content Server,
you are returned to the Install Modules page.

27.2. Uninstalling Modules
27.1.2 To Install Modules on Content Server Running on Linux

or Solaris
To install a module on Content Server running onLinux or Solaris:
1. Install the modules on Linux or Solaris.
• Extract each module’s installation file to the <Content_Server_home>

directory.
i. Copy the <module_name>.tar file to the <Content_Server_home>

directory of the Content Server instance on which you want the
module installed.
ii. At the shell prompt, type the following command, tar -xvf
<module_name>.tar, and then press ENTER.
2. Install the modules on Content Server.

Administration page, click Install Modules.
b. In the Installable Modules section of the Install Modules page, enable the
modules that you want to install, and then click Install.
Note: When you enable a module that requires the installation of

other modules, Content Server automatically selects the required
modules if they have been installed on the operating system. Content
Server can install as many as nine modules at once, but if you want to
install the modules one at a time, install the required modules first.
27.2 Uninstalling Modules

Content Server allows you to remove any optional module that you have installed.
Note: You can also remove certain pre-installed modules, such as Discussions,
Projects, or Workflow. However, OpenText recommends that you do not
uninstall pre-installed modules unless OpenText Customer Support instructs
you to.
Content Server modules are uninstalled in two steps:
1. Removal from Content Server

You use the Content Server Administration page to uninstall the module from
Content Server and move its files from the <Content_Server_home>/module/
folder to the <Content_Server_home>/uninstalled/<yyyymmdd_hhmmss>/
folder.

Tip: If you have previously modified or customized the module that you
are uninstalling, the module version retained in the /uninstalled/
<yyyymmdd_hhmmss>/ folder includes your customizations. If you reinstall
the module, you can use the version in the /uninstalled/
<yyyymmdd_hhmmss>/ folder, or download the released (unmodified)
version of the module from the OpenText Knowledge Center.
2. Removal from the operating system
You remove module configuration information from your operating system, and
delete the module files from the <Content_Server_home>/uninstalled/
<yyyymmdd_hhmmss>/ folder of your Content Server installation.
27.2.1 To View Uninstallable Modules

You can view a list of all Content Server modules that can be removed from your
system and verify whether a module to be removed has dependent modules on the
View Uninstallable Modules page.
To view uninstallable modules:
1. In the Module Administration section of the Administration page, click View

Uninstallable Modules.
2. On the View Uninstallable Modules page, under the Name column, read
through the list of Content Server modules which are available to be uninstalled
from your system.
If a module has an entry under the Dependencies column, the dependent
module must be uninstalled first.
3. Once you have determined the modules you need to uninstall, see “Uninstalling
a Content Server Module from Content Server” on page 382.
27.2.2 Uninstalling a Content Server Module from Content

Server
In the first step of removing a Content Server module, you uninstall it using the
Content Server Uninstall Modules administration page.
Note: Uninstalling a module from Content Server removes both the module
and any associated language pack files. You do not need to perform an
additional step to remove a module language pack.
To uninstall a module:
1. Open the Content Server Administration page.

2. On the Content Server Administration page, under Module Administration,
click Uninstall Modules.
3. On the Uninstall Modules page, click Uninstall beside the module that you
want to remove.

27.2. Uninstalling Modules
Note: If a module is depended on by another module, it has no Uninstall

button. You must uninstall every module listed in the Dependencies
column before you can uninstall the module on which they depend.
Content Server uninstalls the selected module, and then displays the Restart
Content Server page. After you restart Content Server, the Uninstall Modules
page appears again.
Removing the module from Content Server does not remove it from the operating
system or file system, so it remains available for reinstallation. If you want, you can
reinstall the module by moving the <module_#_#_#> file from the
<Content_Server_home>/uninstalled/<yyyymmdd_hhmmss>/ folder to the
<Content_Server_home>/staging/ folder and then by using the Content Server
Install Modules administration page.
Notes
• Reinstalling a module as described above allows you to retain changes and
customizations that you may have made to the module. If you have made
changes, but would rather install the released version of the module,
download it from the OpenText Knowledge Center and install it normally.
• If you uninstall a module that has additional language files, the language
files are retained. If you do not remove the module from the operating
system, the language files will be reinstalled when you reinstall the module.
However, if you remove the module from the operating system and then
later reinstall it, you must install the module and the language pack
separately.
• After you uninstall a module that has help files associated with it, update the
Help index so that the module's help files are removed from the index. See
“Updating the User and Admin Online Help” on page 386.
If you do not intend to reinstall the module, proceed to “Removing a Content Server
Module from the Operating System” on page 383 for instructions on completely
removing the module from the Content Server host computer.
27.2.3 Removing a Content Server Module from the Operating

System
In the second step of removing a Content Server module, you remove the module
from the operating system and file system. Follow the instructions in one of the
following sections:
• “Removing a Content Server Module from Windows” on page 384
• “Removing a Content Server Module from Solaris or Linux” on page 384

Removing a Content Server Module from Windows

To remove a module from Windows and the Windows file system, uninstall the
module using Windows Add/Remove Programs.
To uninstall a Content Server module from Windows:
1. Open Control Panel, and then open Add/Remove Programs.

2. Select the module that you want to uninstall, and then click Uninstall.
3. After the uninstall software finishes running, open Windows Explorer and
verify whether the module files remain in the <Content_Server_home>/
uninstalled/<yyyymmdd_hhmmss>/ folder. If necessary, delete the files
manually.
Removing a Content Server Module from Solaris or Linux

To remove a Content Server module from a Solaris or Linux operating system and
file system, delete the module files from the <Content_Server_home>/
uninstalled/<yyyymmdd_hhmmss>/ folder.
To delete the module files from a shell prompt, run the following command, logged
on as the Content Server user:
rm -rf <Content_Server_home>\uninstalled
\<yyyymmdd_hhmmss><module_#_#_#>
27.3 Upgrading Modules

OpenText releases new versions of Content Server modules from time to time that
you can download from the OpenText Knowledge Center. OpenText recommends
that you consult a module's Release Notes prior to beginning an upgrade
installation.
A module is upgraded in two stages:
1. Module Installation on the operating system

You configure your operating system to use the module, and install the
module’s components into the <Content_Server_home>/staging/ folder of
2. Module Upgrade on Content Server
You use the Content Server Administration page to move the module from the
<Content_Server_home>/staging/ folder to the <Content_Server_home>/
module/ folder, and install it in Content Server.
The way you upgrade a module depends on the operating system that Content
Server runs on. Once the new files are added to the appropriate locations in the
<Content_Server_home>/staging/ folder, the upgrade process is the same for
Windows, Linux and Solaris operating systems.

27.3. Upgrading Modules
Upgrading Modules on Windows, Linux or Solaris

For Windows versions of Content Server modules, you perform the first stage of an
upgrade using an InstallShield installation program. This installation program
allows you to select the Content Server instance on which you want to upgrade the
module and places the module's files in a subdirectory of the
<Content_Server_home>/staging/ directory.
For Linux and Solaris versions of Content Server modules, you perform the first
stage of an upgrade using a .tar compressed archive file. The extraction of
this .tar file places the module's files in a subdirectory of the
<Content_Server_home>/staging/ directory.
Completing a Module Upgrade

You perform the second stage of a module upgrade using the Upgrade Modules
administration page.
After you upgrade a module, the Restart Content Server page is the first page that
appears in most cases. However, some module upgrades require you to set certain
configuration parameters before restarting the server. For information about setting
configuration parameters, see the module's specific documentation.
Notes
• If you have installed multiple modules, you will see them on the Upgrade
Modules page. You can upgrade as many as nine modules at one time, as
long as they have no dependencies on other modules. When a module has a
dependency on another module, that module must first be added or
upgraded.
• After you upgrade a module, update the help indexes so that changed
content is available to be searched in the Online Help. For more information,
see “Updating the User and Admin Online Help” on page 386.
27.3.1 To Upgrade Modules on Content Server Running on

Windows
To upgrade modules on Content Server running on Windows:
1. Install the modules on Windows.
• Download and run each module's installer.
i. When the installer’s Welcome dialog box appears, click Next.

ii. On the License Agreement dialog box, accept the terms of the License
Agreement, and then click Next.
iii. In the Selection of install location dialog box, enable the Content
Server instance on which you want the module installed, and then
click Next.

iv. Perform the installation. When the Completing the Installation dialog
box appears, click Finish.
2. Upgrade the modules on Content Server.

Administration page, click Upgrade Modules.
b. On the Upgrade Modules page, enable the modules that you want to
upgrade, and then click Install.
27.3.2 To Upgrade Modules on Content Server Running on

Linux or Solaris
To upgrade modules on Content Server running on Linux or Solaris:
1. Install the modules on Linux or Solaris.
• Extract each module’s installation file to the <Content_Server_home>

directory.
i. Copy the <module_name>.tar file to the <Content_Server_home>

directory of the Content Server instance on which you want the
module installed.
ii. At the shell prompt, type the following command, tar -xvf
<module_name>.tar, and then press ENTER.
2. Upgrade the modules on Content Server.

Administration page, click Upgrade Modules.
b. On the Upgrade Modules page, enable the modules that you want to
upgrade, and then click Install.
27.4 Updating the User and Admin Online Help

You can create an index of the online help files in Content Server, including help
files that belong to Content Server modules. Indexing Content Server's online help
enables users to perform full-text searches on help topics. For more information
about Search Indexing, see “Creating the User or Admin Help Index” on page 411.
Most Content Server modules contain associated help files for users and
administrators. When you upgrade Content Server (or add, remove, or upgrade a
module), the User and Admin Online Help indexes typically need to be updated. If
the Help Data Source Folder or the Admin Help Data Source Folder indexes do not
already exist, you must create them before you can update the help indexes.

27.4. Updating the User and Admin Online Help
Note: Searching is one of the most common ways that users interact with
online help. OpenText strongly recommends that you create indexes of both
the admin and user online help to enable the Content Server help content to be
searched.
language packs, or when the system default locale is modified.
27.4.1 To Update the Admin and User Online Help

To update the Admin and User Online Help:
1. In the Search Administration section of the Administration page, click Open

the System Object Volume.
2. Update the User Help index:
a. On the Content Server System page, click Help Data Source Folder..
b. Click Help Data Flow Manager.
c. In the Processes section of the Help Data Flow Manager page, click the
Functions menu of the Help Directory Walker, and then click Start.
3. Update the Admin Help index
a. On the Content Server System page, click Admin Help Data Source Folder.
b. Click Admin Help Data Flow Manager.
c. In the Processes section of the Admin Help Data Flow Manager page, click
the Functions menu of the Admin Help Directory Walker, and then click
Start.
Note: OpenText strongly recommends you delete and recreate the Help Data
Source Folder and the Admin Help Data Source Folder whenever you add or
remove language packs, or when the system default locale is modified.

Part 7
User Setting Administration
Chapter 28
Administering Users and Groups
The topics in this section are written for the Content Server Administrator and for
users who have the privilege to edit users and groups. Although some information
may be duplicated, topics in the Administrator Help describe tasks from a system
administrator's point of view. In many cases, only the Admin user or users with
specific privileges can perform the tasks described in this section. For example, only
the Admin user can view the Personal Workspace of a deleted user.
The Users and Groups Administration section allows you to configure user settings,
such as passwords and name displays. You can also create and edit users and
groups and configure department selections.
For general information about working with users and groups, see the user help
topic OpenText Content Server User Online Help - Working with Users and Groups
(LLESWBU-H-UGD).
28.1 Configuring User Settings

When administering Content Server, you can specify the way in which Content
Server displays the names of the users of your system. The display names can be
configured individually for all languages that are enabled on the system.
You can preview each of the options in the Example field before finalizing your
choice.
Setting User Password Restrictions

You can set password restrictions such as the minimum password length, a
password expiration interval, and whether passwords must contain digits. To set the
password restrictions for users you need to access the Directory Services user
interface. For information about accessing the OTDS interface, see “Configuring
Directory Services Integration“ on page 1235 and OpenText Directory Services -
Installation and Administration Guide (OTDS-IWC).

Chapter 28 Administering Users and Groups
28.1.1 To Configure User Name Display

To configure the user name display:
1. Click the Configure User Name Display link in the Users and Groups
Administration or Languages section of the Administration page.
2. On the Configure User Name Display page, choose the format you want
displayed for each language from the Display Name Format list.
3. Select the Append (Log-in ID) to Display Name check box to have Content
Server display the log-in ID in parentheses in addition to user names.
28.2 Administering Users

When Content Server is first installed, there is only one user account, Admin, and
one Department group, DefaultGroup. A Department group is the principal group of
which a user is a member. Because each user in Content Server must belong to a
department group, the Admin user is added to the DefaultGroup department group
at install. After the installation and initial setup of Content Server is complete, you
must create user accounts for each person that will be using Content Server, and
organize those users into groups.
Once you have created users, you may grant another user the privilege to create or
edit other users and groups of users.
Creating Users
In addition to the Admin user, any user with the Can create/modify users or User
administration rights privilege can create a user. If you want to delegate the task of
creating users to someone else, you must give that user the Can create/modify users or
User administration rights privilege.
In some cases, the Can create/modify users privilege alone may not be sufficient when
creating a new user. Every new user is assigned to a Department group in Content
Server. A Department group is a user's home group. Users can be added to, or
removed from, several other groups, but their Department typically does not
change. Thus, if you have only the Can create/modify users privilege, you can create
users in only those groups for which you are the creator or leader. To create a user
anywhere in Content Server, you must also have the Can create/modify groups
privilege or the User administration rights privilege.
If you are logged in as the Admin user for the purpose of creating users for the first
time after installing Content Server, OpenText recommends that you create a set of
empty Department groups first, so that those groups are available for selection as
you create users.
It is important to note that a user with User administration rights privilege cannot
grant system privileges to another that the creating user does not have. For example,

28.2. Administering Users
if you do not have the User administration rights privilege, the User Administration
rights check box does not appear.
After you assign passwords to new user accounts, advise the users to change the
passwords as soon as they sign in to Content Server for the first time, and inform
them of the password requirements specified on the Configure Passwords Settings
page.
For more information about creating, viewing, editing, or deleting users, see
OpenText Content Server User Online Help - Working with Users and Groups (LLESWBU-
H-UGD).
Listing Users
When searching for users, Content Server displays no more than 30 users on a page
by default. If your search criteria results in more than 30 users, the page contains a
More button, which takes you to the next page of users. You can change this default
by modifying the MaxUsersToListPerPage parameter in the[general] section of
the <Content_Server_home>/config/opentext.ini file. Stop Content Server
before you make changes to the opentext.ini file. When you are done, restart
Content Server and, if applicable, the web application server so that your changes
take effect.
You can also search for users without typing a search term. In this case, all entries
for the specified field are displayed. However, on large Content Server systems with
hundreds or thousands of users, such a broad search can adversely affect system
performance.
28.2.1 To View the Personal Workspace of a Deleted User

To view the Personal Workspace of a deleted user:
Tip: You can access a deleted user's Personal Workspace from the Content
Server Search page. Search for any item that resides in the deleted user's
Personal Workspace. In the Search Result page's Location column, click the
link of the Personal Workspace that you want to view.
1. Choose Users & Groups on the Enterprise menu.
2. On the Users and Groups page, bring up the Personal Workspace of an existing
user. In the Find list, select the method you want to use for your search. Your
choices are: User Last Name, User First Name, User Log-in, User E-mail.
3. In the that starts with dialog box, enter the first few letters of any existing user's
name, log-in, or e-mail.
4. Click the Find button.
5. Click that existing user's Browse link in the Actions column. This will take you
to that user's personal workspace.

6. In the browser's address bar, replace the ID at the end of the URL with the ID of
the deleted user and press enter. The userid in the URL is displayed as
userID=<number>.
28.3 Administering Groups

When Content Server is installed, there is only one group, called the DefaultGroup,
which contains only one user, called Admin. The DefaultGroup is the Department
group of the Admin user. (A Department is the principal group of which a user is a
member.) Once installation and initial setup of Content Server is complete, you must
create users for each person using Content Server, and organize those users into
groups.
For performance reasons, a group can contain no more than 1,000 users and
subgroups (including the DefaultGroup). If your Content Server system supports a
large number of users, you can get around this limit by creating Department groups,
to which you can add subsets of users. Then, you can make each Department a
members of a single, master group. In this way, it becomes possible to work with
every user in the system. For example, if you want to add every user in Content
Server to a Project, you can simply add the master group to the Project.
If you delete a group that is the Department group for any user, Content Server
automatically reassigns all users in the deleted group to the DefaultGroup.
Listing Groups
Content Server allows you to list all groups or a subset of groups based on a pattern-
matching search against group names. By default, Content Server displays up to 30
groups per search result page. If your search result includes more than 30 items, the
results page includes a Morebutton, allowing you to view the next page of results.
You can change this default by modifying the MaxUsersToListPerPage parameter
under the [general] heading of the _home/config/opentext.ini file.
Preventing Recursive Groups

When creating a Subgroup in Content Server, it is possible to form recursive groups.
For example, you could assign Group A as a member of Group B, and then assign
Group B as a member of Group A. Because recursive groups can reduce system
performance, you can choose to prevent the formation of recursive groups in
Content Server.

28.4. Configuring Department Selection
28.3.1 To List Groups

To list all or a subset of groups:
1. Log in to Content Server as the user Admin or as a user with the Create/Modify
Groups or User Administration rights privilege.
3. In the Find drop-down list, click Group Name.
4. In the that starts with field, type your search term. Content Server performs a
case-insensitive starts with search.
Typing van, for example, displays groups whose name begins with van or Van.
Tip: Click the Find button without typing a search term to display all entries
for the specified field. But note that such a search may take a long time and
consume significant system resources.
28.3.2 To Prevent Recursive Groups

To prevent recursive groups:
1. In the Users and Groups Administration section on the Administration page,

click the Configure Group Settings link.
2. On the Configure Group Settings page, select the Prevent Recursive Groups
check box.
28.4 Configuring Department Selection

The department selection page allows you to configure how groups are assigned to
users in Content Server. You can specify either of the following options:
• Drop-down list, which is selected by default. When this option is selected, the
Create User and Edit User pages use a drop-down list to hold all fetched public
groups in the system. When a new user is created, all public groups are listed.
• Department dialog, which is used to find and select a department to which a
user can be assigned. When this option is selected, the Create User and Edit User
pages contain the additional Department field, where they can find a specific
group and select it as the department of the user. This option allows the system
to fetch users in a department within a small set of public groups, rather than
fetching all public groups within the Content Server system. This option should
be used in systems where there is a large numbers of groups.

Note: When the department selection is changed, the audit event Configuration
Changed is recorded. For more information, see “Managing Audit Interests”
on page 303.
28.4.1 To Configure the Department Selection

To configure the department selection:
1. In the Users and Groups Administration section of the Administration page,

click the Configure Department Selection link.
2. On the Configure Department Selection page, click one of the following radio
buttons:
• Drop-down list
• Department dialog

Chapter 29
Administering Domains
Creating Domains in Content Server enables you to create separate Workspaces,

users, and groups, within a single Content Server system. Each Domain has its own
users and groups, including a Default Group that acts as the base group for all
Domain users, and it has its own Domain Workspace, which is analogous to the
Enterprise Workspace. When you enable Domains, you make it possible for multiple
users to collaborate in a Domain workspace tailored to their needs. In effect, you can
run what appear to be multiple Content Server instances within a single Content
Server installation. Domains are ideal for application service providers and other
situations where security requires completely isolated users and groups, but some
collaboration across these divisions is desirable.
29.1 Working with Domains

When Domains are enabled, an additional field appears below the Username and
Password fields on the Content Server Log-in page. This field, which is named
Domain by default, requires the user to specify a Domain to log in to. The field's
display name varies, depending on the Domain Display Name setting you defined
on the Configure Domain page. For example, if you are using Domains to create
separate workspaces for different companies in an organization, you could set the
Domain display name to Company. Non-Domain Content Server users leave this
field blank to log in to the system.
Note: Because Content Server supports isolated Domains, different users and
groups can have the same user name in different Domains.
X-Domain Groups and X-Domain Projects
X-Domain groups, known as cross-Domain groups, are used to allow collaboration

across Domains. For example, if you have two groups of users, each in a different
Domain, that need to collaborate on a project, you can create one X-Domain group
which contains both groups of users.
An X-Domain group can contain:
• users from multiple Domains

• groups from multiple Domains
• Domains
• other X-Domain groups
You can also create an X-Domain Project, adding users and groups from multiple
Domains, to allow groups to share information.

Chapter 29 Administering Domains
To create an X-Domain project, you populate a regular Project with users, groups,
Domains, or X-Domain groups from multiple Domains.
Permissions and Privileges
Only an Administrator, or a user with both system administration and user/groups

administration privileges, can add a Domain or X-Domain group, or access different
Domains on permissions pages. The permissions interface for other users remains
the same. However, all Content Server items can be assigned permissions across
domains by the administrator, allowing users in different Domains to access these
items, especially by using Content Server Search. Similarly, only Administrators can
create X-Domain Projects.
An entire Domain can be an Owner Group for any item.
If you want Domain users to be able to access administration volumes, such as the
Workflow Volume or the Categories Volume, you must create the All Domains X-
Domain group. For the System Object Volume, the Personal Search Templates folder,
the XML DTD Volume, and the Reports Volume, you must set permissions
manually for Domain users.
Finding Domains
You search for Domains the same way that you search for users or groups. When
Domains are enabled, however, in addition to the Find drop-down list and the that
starts with field, the users and groups search bar includes the in drop-down list. By
default, this list is set to the system Domain, but below a dotted line, it lists all
Domains in the system. The system Domain is the domain of all users who do not
belong to any Domain that has been created. By default, the system Domain is
named Content Server.
When the system Domain is selected, the Find drop-down list contains the options
Domain Name and X-Domain Group Name. If you select a specific Domain in the
in drop-down list, Content Server removes these options.
When you want to display only users or groups in a particular Domain, click the
name of that Domain in the in drop-down list, and then search as you would in the
Content Server system as a whole.
Configuring and Editing Domains
Any Domain you create automatically becomes a member of the All Domains cross-
Domain group, if it exists. A DefaultGroup is created for this Domain at the time the it
is created, with the same name as the Domain. It behaves in the same manner as
DefaultGroup in the Content Server system Domain does. Once Domains are
enabled, you create new Domains and cross-Domain groups in much the same way
that you create users and groups.
Note: To populate a Domain, you must add new users and groups; you cannot
add existing Content Server users or groups as Domain users or groups. When

29.1. Working with Domains
you add a user or group to a Domain, that user or group exists only in that
Domain, not the Content Server system as a whole.
Domains cannot be deleted; they can only be disabled. When you disable Domains,
all existing Domains and cross-Domain groups remain in the database. If you re-
enable Domains, Content Server automatically restores all previously used Domains.
An Administrator sees a special version of the Users and Groups Search bar if the
Domains feature is enabled. In addition to the Find drop-down list and the that
starts with field, the Domain drop-down list appears. This new list by default has
your system Domain selected, but it lists all of the Domains in the system. When the
system Domain is selected, the Find drop-down list contains the options Domain
Name and X-Domain Group Name.
The only attribute of a Domain you can edit is its name. However, you can perform
the following tasks for Domains on the Configure Domain page:
• Enable or disable Domains
• Create an All Domains X-Domain group. When you create the All Domains group,
Content Server automatically populates it with all the Domains in the Content
Server system. The All Domains group updates automatically each time you add
another Domain, so that you do not have to manually regenerate it. In addition
to Domains, the All Domains group can contain users and groups. To add these,
you edit the group.
• Specify a display name (for example, Company) for the Domain. The name
appears on the login and user profile pages.
• Specify a system Domain name to represent the entire Content Server system. Once
you define this name, it appears above the dotted line in the Domain drop-down
list on Search Bars for the Administrator. The default name is Content Server.
29.1.1 To Find a Domain

To find a Domain:
2. Click Domain Name in the Find drop-down list.
3. Type the first few letters of the Domain name in the starts with field.

29.1.2 To Open a Domain Workspace

To open a Domain workspace:
1. Search for the Domain you want to open.
2. Click the Open link of the Domain workspace you want to review.
29.1.3 To Add a Domain

To add a Domain:
2. Click Domain in the Add Item menu.
3. Type a name for the Domain in the Domain Name field.
29.1.4 To Configure Domains

To configure Domains:
1. Click the Configure Domain link in the Users and Groups Administration
2. Do any of the following:
• To enable Domains, select the Enable Domain Support check box.

• To create the All Domains X-Domain group, select the Create check box, and
then type a name for the All Domains group in the Group Name field.
• To specify the Domain display name, type a name in the Domain Display
Name field.
• To specify the system Domain name, type a name in the System Domain
Name field.

29.2. Configuring Search for Domains
29.1.5 To Create an X-Domain Group

To Create an X-Domain Group
2. Click X-Domain Group in the Add Item menu.
3. Type a name in the X-Domain Group Name field.

The Edit Group page appears, enabling you to add members to the group, or to
rename or delete it.
29.1.6 To Create an X-Domain Project

To create an X-Domain Project:
1. Create a Project or open an existing Project.
2. Choose Participants on the Project menu.
3. Click the Add Participants button.
4. Find the desired participants.
5. For each participant, click Coordinator, Member, or Guest in the Role drop-
down list.
7. Click the Done button.
29.2 Configuring Search for Domains

When you enable Domains, you must configure Content Server Search to work
within those Domains. To configure Content Server Search, you set permissions on
various areas of the System Object Volume.
Indexing and searching are global operations which means that they operate across
all the Domains at a Content Server site. You do not create indexes for a specific
Domain; instead, you create indexes for the entire Content Server site.
When you create the Enterprise index, permissions are automatically set up so that
users from one Domain cannot access information that resides in another Domain.
For example, users in Domain A can access the documents that they have
permission to see in Domain A only. However, when you create an index other than
the Enterprise index, permissions are not automatically set up. In this case, if you
want to restrict access to the information in the index, you must set the appropriate
permissions. For example, if you want all users in Domain A to access the
information indexed in slice A but not slice B, you must set the appropriate

permissions on slice A, granting access to only those Content Server members who
are part of Domain A.
After enabling Domains, you must also grant users the permission to save search
templates in the Personal Search Templates folder. Because this set of permissions
will likely be the same for members of all Domains, you can set the permissions for
the X-Domain group that you create. The X-Domain group includes members of all
other Domains in your Content Server system.
29.2.1 To Configure Search for Domains

To configure Content Server Search for Domains:
1. Create the All Domains X-Domain group, if it does not exist.
2. Click the Open the System Object Volume link in the Search Administration
3. Click the Functions icon for the Content Server System folder, and then choose
Permissions.
4. In the Assigned Access section, click the Grant Access icon.
5. Find the X-Domain group, select its Grant Access check box, and then click the
Submit button.
6. Click the name of the X-Domain group, grant the group permission to See and
See Contents, apply the permissions to all the current item and all of its
subitems, and then click the Update button.
7. To restrict permissions on slices, navigate to the Slice Folder, add the

appropriate Domain to the Assigned Access for a particular slice, and then set
the permissions for that Domain.
8. To restrict permissions for search templates, navigate to the Personal Search

Templates folder and grant the X-Domain group permission to add items.

Part 8
Search and Collaboration Administration
Chapter 30
Administering Search
In order to use the data stored in Content Server, you must be able to find it quickly
and easily. For this reason, creating indexes and maintaining their integrity are two
of the most important tasks that Content Server Administrators perform.
Content Server Administrators create indexes by designing data flows that extract
and process the data they want to index. As the size of a Content Server repository
increases, Administrators must be able to optimize Content Server's indexing and
search functionality to accommodate the increasing demands being made on the
system. To do so requires a thorough understanding of the architecture of Content
Server's indexing and searching systems.
When you are logged in as a Content Server Administrator, the Global Menu Bar
displays the Admin menu on almost every page by default. From the Admin menu,
you can select Content Server Administration to navigate to the Administration
page, or select Search Admin Browser to access the Search Administration browser.
Search Administration browser

The Search Administration browser allows you to explore the capabilities within
Content Server for the configuration and management of search features, processes
and components. The links in the browser do not trigger actions or configuration
changes. The links guide you to the page within Content Server that contains the
feature.
The Tasks panel, if present, has links to Content Server administration pages that
contain the controls for the described activity.
30.1 Creating Indexes Using Templates

You can create an index of data using Content Server index templates. The
Templates create the system objects associated with a specific data source. Data
sources can be the following:
• The data in the Enterprise Index. For more information, see “Creating the
Enterprise Index” on page 407.
• The files in Content Server User or Admin Help system. For more information,
see “Creating the User or Admin Help Index” on page 411.
• Specific data on your file system. For more information, see “Indexing Data on
your File System” on page 413.
• Data collected by the extractor processes associated with optional Content Server
modules, such as the Content Server Spider module.

Chapter 30 Administering Search
• Data collected from an XML Activator Producer Data Flow. For more
information, see “Creating an XML Activator Producer Data Flow” on page 418.
For more information about the Content Server Spider module, see the
documentation that accompanies it.
The index templates that Content Server provides create data flows that link the
following processes in a chain: a producer process (for example, Extractor, Directory
Walker, XML Activator Producer, Content Server Spider), a Document Conversion
process, an Update Distributor process, and an Importer process.
Content Server index templates also create the following system objects that are
associated with a particular data source: a data source folder, a Data Flow Manager
(which contains data flow processes), a Search Manager (which contains Search
Federators and Search Engines), a partition map, and one or more partitions
(depending on the number that you specify). For information about partition maps,
see “Working with Partition Maps” on page 601. A Search Federator, and one or
more Search Engines and Index Engines are also created, depending on the number
of partitions that you specify to be created. For each partition, an Index Engine is
created and associated with the Update Distributor process in the data flow
automatically. For each partition, a Index Engine is also created and associated with
a Search Federator. For information about Update Distributor processes and Index
Engines, see “Configuring Indexing Processes” on page 587. For information about
Search Federators and Search Engines, see “Administering Searching Processes”
on page 690. Partitions, partition maps, the Update Distributor process, Search
Federators, Index Engines, and Search Engines are all components of an Indexing
and Searching system.
After you create an index using Content Server Templates, you can add system
objects to it at any time. For example, you can add partitions, which allows data to
be distributed into more, smaller sized indexes (each partition maintains its own
index of data, which is a portion of the entire index of data). You can also add Search
Federators (which adds Search Engines simultaneously). For information about
adding system objects to an index individually, see “Creating Index Components
Individually” on page 433. After you create an index, you can administer the system
objects (for example, searching and indexing processes, and data flow processes)
associated with it. For information about administering data flows, see
“Administering Data Flows” on page 465.

30.1. Creating Indexes Using Templates
30.1.1 Creating the Enterprise Index

The Enterprise index is an index of all the data that is stored in the Content Server
database. Under normal circumstances, the Enterprise index is automatically created
when you install Content Server. At that time, the processes that generate the
Enterprise index and keep it up to date are initialized. During the installation and
initial setup of Content Server, the Create New Enterprise Data Source page appears
automatically, prompting you to create the Enterprise index. If the Enterprise index
was not created on installation, or if it was subsequently deleted, you can
automatically generate it by choosing Enterprise Data Source on the Add Item
menu on the System Administration page. In this case, Content Server generates all
the system objects required to create the Enterprise index in a single step. However,
if you want to create the Enterprise index's system objects individually, you can add
a data flow process. For more information, see Adding Data Flow Processes.
An Enterprise data flow contains one or more Extractor processes, one or more
Document Conversion processes, and an Update Distributor process. An Extractor
process monitors the Content Server database continuously to determine whether
new information has been added, modified, or deleted. It then instructs the Server to
send the additions, modifications, and deletions to a data interchange pool (iPool). A
Document Conversion process reads from this iPool, converts the new and modified
data into HTML or raw text, and writes the converted data to another iPool along
with deletion notifications. The Update Distributor process reads data from this
iPool, passes it onto the Index Engine processes that it manages, and updates the
Enterprise index. The Update Distributor and Index Engines are also processes in an
Indexing and Searching system.
Because only one Extractor process is normally required to extract data from the
Content Server database, and only one Document Conversion process is normally
required to convert the data into HTML or raw text, OpenText recommends that
each Content Server system have only one Extractor process and only one Document
Conversion process, unless OpenText Global Services or Customer Support has
advised adding multiple processes as part of a strategy of high-volume indexing.
For more information about high-volume indexing, see“Setting Up High-Volume
Indexing” on page 457.
The Enterprise index is updated incrementally to reflect the most recent changes
made to the Content Server database. This means that Content Server users will
always receive the most up-to-date search results possible.
There are two scenarios in which you normally create the Enterprise index: during
the installation and setup of Content Server or after installation and setup are
complete.
Creating an Enterprise Index During Installation
The following conditions must be true:

• The Create New Update Enterprise Data Source page is displayed in your Web
browser, where it appeared as part of the installation and setup of Content
Server.

• If you want to create the Enterprise index on a secondary Content Server host,
you have already installed and registered that host. For more information see
OpenText Content Server - Installation Guide (LLESCOR-IGD).
If you are installing a primary Content Server installation on a host where others
already exist, ensure that the servers and data flow processes corresponding to those
existing installations are running before you create the data flow processes of this
Enterprise index. This allows Content Server to automatically detect the port
numbers that are already in use. If you want to create the Enterprise index on a
remote Content Server host, set up the Admin server on that host before configuring
the Extractor process.
Creating an Enterprise Index After Installation
You can create an Enterprise index after installation if the original Enterprise index
was deleted or if you did not create an Enterprise index during the installation
process. The index that you create in this way will include one Extractor process, one
Document Conversion process, and one Update Distributor process.
Because only one Enterprise index with the standard set of processes is normally
required to extract data from the Content Server database, OpenText recommends
that each Content Server system have only this index, unless OpenText Global
Services or Customer Support has advised adding multiple indexes or processes as
part of a strategy of high-volume indexing. For more information about high-
volume indexing, see “Setting Up High-Volume Indexing” on page 457.
To Create the Enterprise Index During Installation

To create the Enterprise index during installation:
1. To create the Enterprise index on a secondary Content Server host whose

Admin server you have registered on that host, refresh your Web page to
display the new host in the Host drop-down list in the Producer Information
section.
2. On the Create New Enterprise Data Source page, type a unique identifier for all
the system objects associated with this indexing data flow in the Processes
Prefix field. If you want to specify the number of partitions into which this
index should be divided, type a number in the Partitions field.
3. In the Port field, type a value representing the series of port numbers on which
you want the processes that are associated with this data source to listen. The
port number that you specify and the next 11 (at least) consecutive port
numbers must not be used by another data source in your system. The number
of consecutive port numbers that will be used depends on the number of
partitions that you specify in the Partitions field. Creating an Enterprise index
requires eight port numbers, and for each partition, four additional port
numbers. Valid values range from 1025 to 65530.
4. In the Write Base Directory field in the Producer Information section, type the
absolute path of the directory where you want the Extractor process to write

data. By default, the write directory is the <Content Server_home> /

index/enterprise directory on the primary Content Server host. You must
choose a directory on a drive on the primary Content Server host.
5. In the Host drop-down list in the Intermediate and Consumer Information

section, click the shortcut of the Admin server on whose host you want the
Document Conversion and Update Distributor processes to run. By default,
these processes run on an Admin server on the primary Content Server host.
6. In the Read Base Directory field, type the absolute path of the directory where
you want the Document Conversion process to read data. Specify the directory
path as it is mapped/mounted on the host of the Admin server on which the
Document Conversion process runs.
7. In the Write Base Directory field in the Intermediate and Consumer

Information section, type the absolute path of the directory where you want the
Document Conversion process to write converted data. Specify the directory
path as it is mapped/mounted on the host of the Admin server on which the
Document Conversion process runs. OpenText strongly recommends that you
choose a directory on a drive that is local to the host of the Admin server that
runs the Document Conversion process.
8. To start the data flow processes as soon as they are created, select the Start
Processes in Data Flow check box.
9. Click the Create Processes button.
10. On the “Data Flow Creation Status” on page 456 page, click the Continue
button.
To Create the Enterprise Index After Installation

To create an Enterprise index after installation:
1. On the System Object Volume page, click Enterprise Data Source on the Add
Item menu. If you previously deleted an Enterprise data source, and you want
its saved Queries and Search Forms to be associated with this new Enterprise
data source, click the Enterprise slice name of the deleted data source in the
Slice Replacement drop-down list, and then click the Enterprise [All Versions]
slice name of the deleted data source in the Slice Replacement [All Versions]
drop-down list.
2. Type a unique identifier for all the system objects that are associated with this
indexing data flow in the Processes Prefix field. This identifier is the display
name for objects associated with this index on the System Administration page
and for the index's search slice in the Slices list on the Search page. If you want
to specify the number of partitions into which this index should be divided,
type a number in the Partitions field.
port number that you specify and the next twelve (at least) consecutive port

4. In the Host drop-down list in the Producer Information section, click the
shortcut of the Admin server on whose host you want the Extractor process to
run.
absolute path of the directory (relative to the Admin server on which the
Extractor runs) where you want the Extractor process to write data. By default,
the write directory is the Content Server_home/index/enterprise directory on
the default primary Content Server host. You must choose a directory on a drive
on a primary Content Server host, and the directory must differ from the write
directories of other Enterprise data sources.

these processes run on an Admin server on the primary Content Server host.
path as it is mapped or mounted on the host of the Admin server on which the
Document Conversion process runs. This directory must be the same directory
as the write base directory that you specified in the Producer Information
section.

runs the Document Conversion process. This directory must also differ from the
write base directories of other Enterprise data sources.
11. On the “Data Flow Creation Status” on page 456 page, click the Continue
button.

To Access the System Object Volume

To access the System Administration page in the System Object Volume:
1. On the administration page, click the Open the System Object Volume link.
2. If prompted, type the user name of a Content Server user that has system
administration rights in the Username field, type the corresponding password
in the Password field, and then click the Log-in button. If you have already
logged in as a user with system administration rights during the current Web
browser session, Content Server does not prompt you to log in. For more
information about using the System Object Volume, see “Using the System
Object Volume” on page 427.
30.1.2 Creating the User or Admin Help Index

Content Server provides extensive User and Admin Online Help systems that allow
Content Server users and administrators to access information about the tasks that
they can perform. You can generate an index of the User Online Help files and the
Admin Online Help if you want all Content Server users to be able to search help
text from the Search page or directly from the User or Admin Online Help system.
Note: Only the Admin user and other Content Server users who have adequate
permissions can search or access the Admin Online Help system.
Content Server creates the User and Admin Online Help index on the primary
Content Server host, which is represented by the shortcut (usually Default) of its
Admin server.
Tip: If you add, uninstall, or upgrade a module after you create the User
Online Help index, you must update the index for the Online Help. For more
information, see “Updating the User and Admin Online Help” on page 386.
To Create the User Help Index

To create an index of the User Online Help topics:
1. On the System Object Volume page, click User Help Data Source on the Add
Item menu. If the User Online Help index already exists, User Help Data
Source does not appear on the Add Item menu. If you previously deleted a
Content Server data source and you want its saved Queries and search forms to
be associated with this User Online Help index, click the deleted data source's
slice name in the Slice Replacement drop-down list.
2. In the Base Directory field, type the absolute path of the directory in which you
want to create the User Online Help index. The default base directory is Content
Server_home/index/help. OpenText recommends that you choose a directory on
a drive on the primary Content Server host.
data source in the Process Prefix field. If you want to specify the number of

partitions into which this index should be divided, type a number in the
Partitions field.
5. On the Data Flow Creation Status page, click the Continue button.
Note: OpenText strongly recommends you delete and recreate the Help Data
Source Folder whenever you add or remove language packs to ensure that the
Help search results are available in all installed locales.
To Create the Admin Help Index

To create an index of the Admin Online Help topics:
1. On the System Object Volume page, click Admin Help Data Source on the Add
Item menu. If the Admin Online Help index already exists, Admin Help Data
Source does not appear on the Add Item menu. If you previously deleted a
Content Server data source and you want its saved Queries and search forms to
be associated with this Admin Online Help index, click the deleted data source's
slice name in the Slice Replacement drop-down list.
2. In the Base Directory field, type the absolute path of the directory in which you
want to create the Admin Online Help index. The default base directory is
Content Server_home/index/adminhelp. OpenText recommends that you
choose a directory on a drive on the default Content Server host.
data source in the Process Prefix field. If you want to specify the number of
Partitions field.
Note: OpenText strongly recommends you delete and recreate the Admin
Help Data Source Folder whenever you add or remove language packs to
ensure that the help search results are available in all installed locales.

30.1.3 Indexing Data on your File System

Using Content Server Directory Walker technology, you can create data flows that
index data on your file system. This allows Content Server users to search that data
from within Content Server. For each Directory Walker index that you create, you
specify a set of one or more top-level directories on your file system that you want to
index.
A Directory Walker data flow consists of a Directory Walker process, a Document

Conversion process, and an Update Distributor process. The Directory Walker
process walks the top-level directories that you specify (and their subdirectories, if
necessary) and looks for files that match the criteria that you specify.
You determine the types of files that the Directory Walker process collects by
specifying inclusion and exclusion criteria (such as, file name patterns, date ranges,
and file size ranges). The Directory Walker process writes the files that match your
criteria to a data interchange pool (iPool). The Document Conversion process reads
the data from this iPool, converts it to HTML or raw text, and then writes it to a
second iPool. The Update Distributor process reads the data from this second iPool,
passes the data to the Index Engines that it manages, and then issues commands to
generate or update the corresponding index.
When you create a Directory Walker data flow, Content Server generates crawl
history files. Crawl history files contain information about the files that the Directory
Walker process has already walked. When a Directory Walker process walks a set of
directories that halve already been walked, it compares the crawl history files to the
files that are currently stored in the directory to locate new, updated, or deleted files.
The Directory Walker process extracts information about added, replaced, or deleted
files to the data flow. It does not extract the entire file set again, which makes index
updating more efficient. You can modify the location of the crawl history files on the
Specific tab of the Directory Walker Properties page.
If you expect the data in the indexed directories to change, you can Maintaining
Data Flows to have it re-walk the directories or you can you can configure a Data
Flow Process to run on a set schedule. For more information, see To Configure Data
Flow Process Start Options.
Setting up a Directory Walker Data Source
You begin setting up a Directory Walker data source by naming it and specifying the
port numbers on which its processes listen.
Configuring a Hyperlink Mapping
After you name the data source and specify its port numbers, you configure its
hyperlink mappings. Hyperlink mappings allow users to access information in a
Directory Walker data source when viewing search results. Documents in a
Directory Walker data source are identified by their entire path name. When these
documents are returned in a search, they display on the Search Results page as their
path names. To ensure that each result links to the appropriate document, you must

create a hyperlink mapping that will configure the data source to serve the
documents through a Web server. You must run a Web server for hyperlink
mappings to function properly.
You list directories to walk when you configure a Directory Walker. All the
directories listed must have a common root. For example, if you set the Directory
Walker to walk c:/dirA/dir1 and c:/dirA/dir2, you can create a hyperlink
mapping from c:/dirA. If you list different root directories, such as c:/dirA and
c:/dirB or c:/dirA and d:/dirA, you cannot create a hyperlink mapping from
both these paths. If your directories do not have common roots, consider creating
separate Directory Walker indexes for them so that they can use hyperlink
mappings.
You can configure hyperlink mappings when you create a Directory Walker data
source or when you configure its Search Manager. For other non-Enterprise data
sources, you configure hyperlink mappings when you “Configuring Hyperlink
Mappings” on page 579. Examples of non-Enterprise data sources are the Admin
Help Data Source, the Directory Walker Data Source, the User Help Data Source,
and the XML Activator Producer Data Source.
Configuring Directory Walker Information
After you set up a Directory Walker data source, you configure the Directory Walker
information. The Directory Walker is a process that extracts data from your file
system and writes it to a data interchange pool (iPool).
When you create a Directory Walker index by clicking Directory Walker Data
Source on the Add Item menu on the System Administration page, Content Server
automatically specifies logging options for the corresponding data flow, using
default log files, levels, and locations. If you want to specify custom logging options,
you can modify the default values on the Directory Walker Properties page after
Content Server generates the data flow.
When specifying directories on the Create New Directory Walker Data Source page,
you must specify the directory paths as they are mapped/mounted on the host of the
Admin server whose shortcut you select in the Host drop-down list.
Configuring Document Conversion Information
After you set up a Directory Walker data source and configure the Directory Walker
process, you must configure the intermediate Document Conversion information.
The Document Conversion process reads data from a data interchange pool (iPool),
converts the data to HTML or raw text, and then writes it to a different iPool.
When specifying the read and write directories for the Document Conversion
process, you must specify the directory paths as they are mapped/mounted on the
host of the Admin server whose shortcut you select in the Host drop-down list.
Configuring the Index Engine Information
After you set up a Directory Walker data source and configure the Directory Walker
and Document Conversion processes, you must configure Update Distributor

information. For more information about configuring index updating processes, see
“Configuring Indexing Processes” on page 587.
When specifying the read and index directories for the index updating process, you
must specify the directory paths as they are mapped/mounted on the host of the
Completing a Directory Walker Data Source
After you set up a Directory Walker data source, and then configure the Directory
Walker, Document Conversion, and Update Distributor processes, you can complete
the Directory Walker data source set up.
You can specify whether you want the processes in the Directory Walker data flow
to start on creation or you can manually start the processes after you create the data
flow. For example, if you want to “Indexing XML Data” on page 453 to the Search
Engines associated with this data source, you can create the data flow, publish the
regions, and then start the data flow processes so that the XML regions are indexed
when they run.
To Set Up a Directory Walker Data Source
To set up a Directory Walker data source:
1. On the System Object Volume page, click Directory Walker Data Source on the
Add Item menu.
2. If you previously deleted a Content Server data source and you want its saved
Queries and search forms to be associated with this Directory Walker data
source, choose the deleted data source's slice name from the Slice Replacement
drop-down list.
3. Type a unique identifier for all the objects associated with this indexing data
flow in the Processes Prefix field. This identifier is the display name for objects
associated with this index on the System Administration page and for the
index's search slice in the Slices list on the Search page.
4. In the Partitions field, type the number of partitions you want to create for the
Directory Walker data source.
port number that you specify and the next eleven (at least) consecutive port
partitions that you specify in the Partitions field. Setting up a Directory Walker
data source requires eight port numbers, and for each partition, four additional
port numbers. Valid values range from 1025 to 65535.

To Configure Hyperlink Mappings

To configure a hyperlink mapping:
1. Identify the directory that you have set the Directory Walker to index (for
example, c:/dirA).
Note: This path will be specific to the environment of the system indexed
by the Directory Walker.
2. Copy the path's prefix.
3. On the Create New Directory Walker Data Source page, paste the prefix into
theFind field in the General Information section.
4. In the Replace With field, type the following: http://

Server_name/Virtual_directory_name.
Important
OpenText strongly recommends you review the document access
available through your Web Server, and if needed, properly restrict
access to sensitive folder locations.
When you create a virtual directory mapping for a non-Enterprise data
source, the Web server mapping to the folder location does not
automatically inherit the permissions defined for the search slice. This
means users may be able to access documents through the Web server
they do not have permission to see through Content Server.
Note: For an example of how to configure a hyperlink mapping using a

common user scenario, see “Configuring a Hyperlink Mapping Example”
on page 429.
To Configure Directory Walker Information

To configure Directory Walker information:
1. In the Write Directory field in the Directory Walker Information section, type
the absolute path of the directory where you want the Directory Walker process
to write data. OpenText recommends that you choose a write directory on a
drive that is local to the host of the Admin server.
2. In the Host drop-down list, click the shortcut of the Admin server on whose
host you want the Directory Walker process to run.
3. In the Directories field, type the absolute paths of the top-level directories that
you want the Directory Walker process to scan for documents, separating paths
by semicolons (;) or typing each path on its own line.
4. In the Include field, type the list of file name patterns that you want the
Directory Walker to collect, separating each with a semicolon (;) (for example,
*.html; *.txt; *.doc; and so on).

5. In the Exclude field, type the list of file name patterns that you want the
Directory Walker to ignore, separating each with semi-colons (;) (for example,
*.jpg; *.exe; *.dll; and so on). If you do not specify values in the Include and
Exclude fields, the Directory Walker collects all of the files in the specified
directories. If you specify a file type to include, the Directory Walker
automatically excludes all other file types. Similarly, if you specify a file type to
exclude, the Directory Walker automatically includes all other files types. If you
crawl a directory on an operating system in which file names are case-sensitive,
you can type file name patterns that cover all possible case combinations. For
example, *.[hH] [tT] [mM] [lL] covers *.HTML, *.hTml, and so on.
6. To specify the number of subdirectory levels below the top-level directories that
you want the Directory Walker process to scan, click one of the following
options in the Depth drop-down list:
• Unlimited, which allows the Directory Walker to scan all subdirectory levels
below the top-level directories.
• Specify, which allows you to specify the number of subdirectory levels that
the Directory Walker scans.
• None, which allows the Directory Walker to scan top-level directories only.
7. To restrict the files that the Directory Walker process collects to those within a
specific date range, type the range of dates in the format yyyy/mm/dd in the Date
Range fields.
8. To restrict the files that the Directory Walker process collects to those within a
specific file size range, type the range of file sizes in bytes in the File Size fields.
To Configure Document Conversion Information

To configure Document Conversion information:
1. In the Read Directory field, type the absolute path of the directory from which
you want the Document Conversion process to read data.
2. In the Write Directory field, type the absolute path of the directory in which
you want the Document Conversion process to write its data. OpenText
recommends that you choose a write directory on a drive that is local to the host
of the Admin server.
3. In the Host drop-down list in the Intermediate: Document Conversion section,

click the shortcut of the Admin server on whose host you want the Document
Conversion process to run.

To Configure Index Engine Information

To configure the Index Engine information:
you want the Index Engine process to read data.
2. In the Index Directory field, type the absolute path of the directory in which
you want the Index Engine process to create the index. You must choose an
index directory on a drive that is local to the host of the Admin server that runs
this process.
3. In the Host drop-down list in the Consumer: Content Server Index section,
click the shortcut of the Admin server on whose host you want the Index
Engine process to run.
To Configure Directory Walker Data Source

To complete a Directory Walker data source:
1. To start the data flow processes as soon as they are created, ensure that the Start
Processes in Data Flow check box is selected.
30.1.4 Creating an XML Activator Producer Data Flow

You create an XML Activator Producer data flow to index information generated by
a third-party application so that Content Server users can query the indexed
information and view the results in Content Server.
This procedure creates and sets up an entire data flow, including an XML Activator
Producer process, a Document Conversion process, and an Update Distributor
process. You can also create a data flow and Adding Data Flow Processes.
There are four steps involved in creating an XML Activator Producer data flow.
Setting up an XML Activator Producer Data Flow
You begin setting up an XML Activator Producer data flow by naming it and
specifying the port numbers on which its processes listen. You then configure the
XML Activator Producer process information. The XML Activator Producer process
extracts data, in the form of XML files, from your third-party application and writes
it to a data interchange pool (iPool).
When you add an XML Activator Producer data flow to Content Server, you can
specify the name of the operation and identifier tags that can appear in the
Requirements for XML Activator Files that pass through the data flow. The
operation tag specifies the action that Content Server performs with the data. The

identifier tag is a persistent and unique string that identifies the data object (the
content included in a particular XML file).
When specifying directories on the Create New XML Activator Producer Data Flow
page, you must specify the directory paths as they are mapped or mounted on the
host of the Admin server whose shortcut you choose in the Host drop-down list.
Configuring Document Conversion information
After you set up an XML Activator Producer data flow and configure the XML
Activator Producer process, you must configure the intermediate Document
Conversion information. The Document Conversion process reads data from an
iPool, converts the data to HTML, and then writes it to a different iPool.
When specifying the read and write directories for the Document Conversion
process, you must specify the directory paths as they are mapped/mounted on the
host of the Admin server whose shortcut you select in the Host drop-down list.
Configuring Index Update Information
After you set up an XML Activator Producer data flow and configure the XML
Activator Producer and Document Conversion processes, you must configure the
Update Distributor. For more information about configuring index updating
processes, see “Configuring Indexing Processes” on page 587.
When specifying the read and index directories for the index updating process, you
must specify the directory paths as they are mapped/mounted on the host of the
Completing an XML Activator Producer Data Flow
After you set up an XML Activator Producer data flow, configure the XML Activator
Producer, Document Conversion, and Update Distributor processes, you can
complete the XML Activator Producer data flow.
Note: If you place an XML Activator Producer process directly before the
HTML Conversion process in a data flow, null values in content data are not
encoded, and process error 54 is generated.
Creating an XML Activator Consumer Data Flow
The XML Activator Consumer processes an iPool, creating an output file for each
object encountered. The Activator processes the iPool in transactional batches of
approximately 1,000 objects, creating a new subdirectory for each batch.
Each subdirectory is named according to the format: ll_%YY%MM%%DD_%HH%%MM%

%SS_N, where YY is year, MM is month, DD is day, HH is hour, MM is minute, and SS is
the second when the Activator was started, and N is a left-padded 6 digit number
starting at 000000.
Each subdirectory contains files named N.xml, where N is a left-padded 3 digit

number.

A third-party process is expected to process all directories and files in either

lexicographic or modified-time based order. The third-party process only processes
files named *.xml. The last directory which is still in a transaction contains files that
are named *.tmp, which are renamed when the transaction ends. The third-party
process is expected to clean up directories containing only *.xml files as it processes
them. The Activator will clean up the *.tmp files on failed transactions.
Each file produced is in UTF-8 XML format, and closely mirrors the content of an
iPool object message. An iPool object message contains an operation which specifies
either AddORReplace or Delete, a URN specifying a unique name for the object, and
one or more metadata and content regions intermixed. The metadata regions are
nested key/value pairs. They are almost XML, except for data added by some poorly
behaved modules (mostly Workflow). The content regions contain either text or
binary data.
The XML file produced keeps as much of the original metadata structure as possible.
When a region of metadata text violates the XML specification, the closest enclosing
tag is marked as having base64 encoded data. The third-party process determines
how to handle the badly formed metadata.
The content region is always base64 encoded.
Each XML file produced has the format:
<?xml version="1.0"?>
<xml_object>
<operation>AddOrReplace or Delete</operation>
<oturn encoding='base64'>base64 encoded urn</oturn>
<metadata>
<field1>....</field1>
<field2 encoding='base64'>...</field2>
<field3>...</field3>
...
<fieldN encoding='base64'>...</fieldN>
</metadata>
<content encoding='base64'>
Base64 encoded content.
</content>
<metadata>
...
</metadata>
<content>
...
</content>
...
</xml_object>

To Set Up an XML Activator Producer Data Flow

To set up an XML Activator Producer data flow:
1. On the System Object Volume page, click XML Activator Producer Data Source
on the Add Item menu.
2. If you previously deleted a Content Server data source and you want its saved
Queries and search forms to be associated with this XML Activator Producer
data source, choose the deleted data source's slice name from the Slice
Replacement drop-down list.
3. On the Create New XML Activator Producer Data Source page, type a unique
identifier for all the objects associated with this index in the Processes Prefix
field. This identifier is the display name for objects associated with this index on
the System Administration page and for the index's search slice in the Slices list
on the Search page.
4. In the Port field, type a value for the port numbers on which you want the
processes associated with the data flow to listen. The port number that you
specify and the next eleven (at least) consecutive port numbers must not be
used by another data source in your system. The number of consecutive port
numbers that will be used depends on the number of partitions that you specify
in the Partitions field. Setting up an XML Activator Producer data flow requires
eight port numbers, and for each partition, four additional port numbers. Valid
values range from 1025 to 65535.
5. In the Host drop-down list, choose the shortcut of the Admin server on whose
host you want the XML Activator Producer process to run.
6. In the Incoming Directory field, type the absolute path of the directory in which
you want the XML Activator Producer process to read the XML files that are
generated by the third-party application.
you want the XML Activator Producer process to write the data that it extracts.
By default, values are automatically entered in all remaining fields on the
Create New XML Activator Producer Data Flow page; however, you can
modify those values to customize the read, write, and index directories.
Note: If you change the value that you originally typed in the Write
Directory field, you must manually update the values of all remaining
directories.
8. In the Operation Tag field, type the name of the XML tag that contains the
operation that XML Activator will perform on the content of XML files. This tag
is set to Operation by default. Any spaces you include in the tag name will be
ignored by Content Server.
9. In the Identifier Tag field, type the name of the XML tag that contains the
unique identifier for the content of XML files. This tag is set to OTURN by default.
Any spaces you include in the tag name will be ignored by Content Server.

10. In the Metadata List field, map XML tag names to metadata tag names to
accommodate third-party applications that write data elements that you want to
index as metadata. The tag mappings must include the XML tag name followed
by the metadata tag name, which is the name of an Defining Index Regions in
Content Server. The tag names for each mapping must be separated by a
comma and a space, and each mapping must be separated by a semicolon. For
example:
xName, OTName;xOwnerIDNumber, OTOwnerID;xFileLocation, OTLocation
Any spaces you include in the tag names will be ignored by Content Server. If
more than one instance of a tag occurs in your XML files, or if two or more tags
in an XML file are mapped to the same metadata tag, Content Server will index
the content of the tags to several instances of the same region. In this case,
Content Server users will not be able to search that region for this index;
however, if Content Server users search the index as a whole, they can access
this data. If you map two different XML tags to the same metadata tag or
include more than one instance of a tag in your XML files, Content Server users
will not be able to search the region for this index.
To Configure Document Conversion Information

To configure Document Conversion information:
you want this process to read data.
you want the Document Conversion process to write the data that it converts to
HTML. OpenText recommends that you choose a write directory on a drive that
is local to the host of the Admin server.
3. In the Host drop-down list in the Intermediate: Document Conversion section,

click the shortcut of the Admin server on whose host you want the Document
Conversion process to run.
To Configure Index Update Information

To configure index update information:
you want this process to read data.
2. In the Index Directory field, type the absolute path of the directory in which
you want the Index Engine process to create the index. You must choose an
index directory on a drive that is local to the host of the Admin server that runs
this process.
3. In the Host drop-down list in the Consumer: Content Server Index section,
click the shortcut of the Admin server on whose host you want the Update
Distributor process to run.

To Complete an XML Producer Data Flow

To complete an XML Activator Producer data flow:
30.1.5 Resynchronizing Admin Servers

Each Content Server site has a Server and an Admin server. The Server controls all
functionality and displays the pages you see in the user interface through the HTTP
server. The Admin server manages the data flow processes in the system (for
example, the Enterprise Extractor process, Directory Walker processes, Document
Conversion processes, and Update Distributor processes). It also manages a file
caching system used to improve the efficiency of certain Content Server operations,
such as hit highlighting.
Note: The Server and Admin server at each Content Server site are represented
as services in your Windows operating system.
After you install Content Server, you set up and configure the Admin servers at
your site. You can also set up the Admin server file cache. Then, you can perform
maintenance operations, such as browsing, pinging, suspending, or resetting an
Admin server. When necessary, you can also resynchronize an Admin server to
ensure that its data accurately reflects the information stored in the Content Server
database.
Resynchronizing an Admin server modifies the otadmin.cfg file to reflect the

information currently stored in the Content Server database, and instructs the
Admin server to create or delete objects as necessary to reflect the updated
information.
You can resynchronize an Admin server at any time; however, Content Server
automatically prompts you to resynchronize an Admin server after you change its
host name or port number.
Before you resynchronize an Admin server, ensure the directory paths and port
numbers recorded for data source objects in the Content Server database are valid
on the Admin server's host. To do this, go to the Specific tab of each data source
object's Properties page and verify the paths and port numbers are valid on the
Admin server's host.
The Server stores information about its Admin servers in the Content Server
database, including the data flow processes and Search Engines that it controls using
those servers. Because Admin servers are not directly connected to the Content
Server database, each Admin server also maintains its own copy of this information
in the otadmin.cfg file.

Note: The otadmin.cfg file is stored in the config directory of a primary

The information in an Admin server's otadmin.cfg file must always match the
corresponding information in the Content Server database. However, there are some
circumstances under which this information may become mismatched. For example:
• You change the host name or port number of an Admin server.
• You perform a Content Server installation on a new host and are connecting it to
a Content Server database that was created on a different host. The information
stored in the Content Server database regarding data source object locations may
not be valid for the new host due to directory mapping or mounting differences,
port conflicts, and registered Admin servers that are no longer available.
• The otadmin.cfg file of a registered Admin server is corrupt or has been
deleted.
• You change the information in the Content Server database in a way that did not
allow the corresponding changes to be made in an Admin server's otadmin.cfg
file. Although unlikely, this may happen if you modify this information by
issuing SQL commands directly to the Content Server database.
• The Admin server has entered safe mode. For details, see “Maintaining Admin
servers” on page 461.
If you suspect that the information about Admin servers and data sources that is
stored in the Content Server database does not match the corresponding information
stored in the otadmin.cfg files of the registered Admin servers, you must
resynchronize the Admin servers. Resynchronizing an Admin server checks the
stability of the server's indexes to make sure that they are not corrupt, modifies the
otadmin.cfg file to reflect the information currently stored in the Content Server
database, and then instructs the Admin server to create or delete objects (as
necessary) to reflect the updated information. However, if one or more indexes are
corrupt, the resynchronization stops and returns an error message, instructing you
to contact OpenText Customer Support.
Resynchronizing an Admin server can sometimes have unexpected results. For

example, if there is a discrepancy between the Content Server database and an
Admin server's otadmin.cfg file, concerning whether a particular index resides on
the Admin server host, there are two possible outcomes, depending on the
circumstances:
• If there is an entry for the index in an Admin server's otadmin.cfg file,
indicating that the index resides on this Admin server host, but there is no
corresponding entry in the Content Server database, resynchronizing instructs
the Admin server to remove the entry from otadmin.cfg and to delete the index
from the erroneous location.

• If the information in the Content Server database indicates that the index exists
on a particular Admin server host, but the otadmin.cfg file on that host does not
contain an entry for it, resynchronizing instructs the Admin server to add an
entry for the index in otadmin.cfg and to create an empty index in the location
specified in the Content Server database.
Orphaned or Unknown processes
After resynchronization has completed, a summary of the results is displayed. If any

processes in the otadmin.cfg file do not match the corresponding information
stored in the database, they are listed in the Orphaned or Unknown processes
section of the results.
Occasionally, errors may appear in this section since there is a known limitation in
the Admin server synchronization process that occasionally prevents some processes
from properly resynchronizing. Synchronizing twice solves this potential problem.
If any errors appear, run the resynchronization process a second time to resolve
them. There should not be any errors after a second resynchronization, so if any
errors are still not resolved, contact OpenText Customer Support.
To Resynchronize an Admin Server

To resynchronize an Admin server:
1. Go to the Specific tab of each data source object's Properties page in the Content
Server database, and verify that the directory paths and port numbers for each
object are valid.
2. On the “To Access the System Object Volume” on page 411 page, click an
Admin server's Functions icon, and then choose Resynchronize.
3. On the Resynchronize page, click the OK button.
4. On the Resynchronize Admin Server page, click the Continue link.
Reconfiguring Data Source Objects

When you install a new Content Server instance and attempt to connect to an
existing database, you must reconfigure the Admin servers, indexes, and data flow
processes that are recorded in the database and then resynchronize all the registered
Admin servers at the site. For more information, see “Resynchronizing Admin
Servers” on page 423.
Note: If you resynchronize an Admin server that manages an Enterprise index

without first moving the Enterprise index's directory to the path specified in
the database (or modifying the path to point to its true location), Content
Server creates an empty Enterprise index at the location specified in the
database. To regenerate the Enterprise index in this case, you must re-extract
the enterprise data. For more information about how to re-extract all data, see
“Re-indexing” on page 626.

Reconfiguring Admin Servers
You reconfigure an Admin server by verifying that it is available and that only valid
Admin servers are registered with it.
• Ping all registered Admin servers to ensure that the new Content Server host can
access them.
• If any of the registered Admin servers reside on remote hosts, ensure that
Content Server has been installed on those hosts and is running properly. For
more information about installing Content Server, see the Content Server
Installation Guide. After you perform Content Server installations and start the
Admin servers, you may need to modify the port number or password
information stored for them in the database.
• Unregister the Admin servers that you no longer want to use.
Reconfiguring Indexes
You reconfigure an index by verifying that all related data source objects are valid
and their directory paths are correct.
• Ensure that the Admin servers, Index Engines, and index directories are valid for
this new Content Server installation.
• To reuse the indexes created using the Content Server installation under which
the database was created, ensure that the index files exist at the index directory
paths specified on the Specific tab of the Index Engine's Properties page. If the
index directories are not located at the specified paths, edit the paths to point to
the current location or“Moving Indexes” on page 623 directories to the specified
paths.
Reconfiguring Data Flow Processes
You reconfigure data flow processes by ensuring that the Admin servers, read and
write directories, and port numbers are valid for this new Content Server
installation.
Server Resynchronization Report

Content Server displays the Resynchronize Admin Server page when you confirm
that you want to resynchronize a particular Admin server. For more information
about resynchronizing, see “Resynchronizing Admin Servers” on page 423.
The Resynchronize Admin Server page initially displays a message that states that a
resynchronization is in progress. The page refreshes every few seconds, listing the
system objects that Content Server has resynchronized up to that point. For each
system object, the page displays the action that Content Server performed (if any) to
resynchronize the object. When the resynchronization is complete, the
Resynchronize Admin Server page displays a confirmation message and a Continue
link.

If the resynchronization cannot complete successfully, you can review the log that
Content Server displays on the Resynchronize Admin Server page and correct the
errors before resynchronizing the Admin server again.
To return to the General tab on the Admin server's Properties page after the
resynchronization process completes successfully, click the Continue link.
Database Resynchronization Report

If you connect the current Content Server installation to a database that you created
with a different Content Server installation, Content Server prompts you to
resynchronize all Admin servers at the site. Resynchronizing resolves the location of
the system objects (for example, data flow processes, indexes, and iPools) at the new
Content Server installation. For more information about resynchronizing, see
“Resynchronizing Admin Servers” on page 423.
When you click the Resynchronize button on the Data Source Resynchronization
Confirmation page, Content Server displays the Resynchronize Admin Server: All
Servers page, which indicates that a database resynchronization is in progress. The
page refreshes every few seconds, listing the system objects that Content Server has
resynchronized up to that point. For each system object, the page displays the action
that Content Server performed (if any) to resynchronize the object. When the
resynchronization is complete, the Resynchronize Admin Server: All Servers page
displays a confirmation message and prompts you to continue the database
administration.
To leave the Resynchronize Admin Server: All Servers page, click the Continue link.
Depending on the state of the current installation, Content Server either prompts
you to“Creating the Enterprise Index” on page 407 (if none exists) or displays the
Congratulations page.
30.1.6 Using the System Object Volume

The System Object Volume is a special Content Server volume that contains the
system objects that control Content Server's indexing and searching capabilities. You
use the System Object Volume to create and maintain Admin servers and the data
source objects that they manage. You can add and configure Admin servers and
create or modify many different types of indexes. For more information about
administering Admin servers, see “Resynchronizing Admin Servers” on page 423.
The System Object Volume contains a hierarchy of folders. The top-level or root
folder is displayed on the System Administration page. The System Administration
page contains two tables: the Admin Servers table and the Detail View table.
The following table describes the information in the Admin Servers table on the
System Administration page.

Column Name Description

Default Identifies the Admin server shortcut that is
displayed by default in the Admin Server
drop-down lists on the Specific tab of a data
flow process's Properties page, which are
stored in the System Object Volume. A check
mark appears beside the default Admin
server shortcut.
Name Specifies the shortcut of each Admin server
that you set up in Content Server.
Functions Contains the Functions icon, which allows
you to access the functions that are
associated with an Admin server.
Status Displays the current status of each Admin
server in the system. An Admin server's
status can be Active, Unavailable, or Safe
Mode.
For details about safe mode, see

“Maintaining Admin servers” on page 461.
Processes Displays the number of processes that are
managed by each Admin server.
Running Displays the number of running processes
that are managed by each Admin server. If
the Admin server is in a state that does not
provide this information, this column will
display an unavailable status.
Errors Displays the number of processes that are
managed by each Admin server and have
errors. If the Admin server is in a state that
does not provide this information, this
column will display an unavailable status.
DCS Status Identifies (using an icon) the status of the
DCS. If a DCS does not exist, this column
will display an icon showing that no DCS
server exists. You can click the icon to access
the Specific Info page for the DCS.
The Detail View table contains a data source folder for each index that you create in
Content Server, a Slice Folder, and a Personal Search Templates folder. The data
source folders contain all the system objects that are associated with a particular
index. System objects include: Data Flow Managers, Search Managers, Backup
Managers, data flow processes, partitions, Search Engines, Search Federators, and
Index Engines. The Slice Folder contains the slices that Content Server automatically
creates for each index. It also contains any additional slices that you create. The
Personal Search Templates folder contains all the user templates and the System
Default Template which you use to configure the appearance of the Search page.

The following table describes the information in the Detail View table on the System
Administration page:

Type Contains an icon that identifies each type of
data source object in the table
Name Specifies the name of each data source object
Functions Contains the Functions icon, which allows
you to access the functions that are
associated with each data source object
Size Specifies the number of items that each data
source object contains
Modified Specifies the date and time on which each
data source object was last modified
Status Displays the current status of each data
source object in the system, when
appropriate. The values in this column vary
according to each type of data source object
30.1.7 Configuring a Hyperlink Mapping Example

The following examples demonstrate the two different ways to configure hyperlink
mappings in Content Server.
To configure a hyperlink mapping for a Search Manager:
1. Instruct the Directory Walker to walk through a specific directory searching for
a particular file, such as c:/Documents/example.doc.
2. In the Web server, create a directory that corresponds to this file's path, such as
c:/Documents/Virtual_directory_name.
3. Copy the entire path.
4. On the System Administration page, click the processes_prefix Data Source

Folder link of the data source folder that corresponds to the Directory Walker
index that you want the hyperlink mapping to use.
5. Click the Search Manager's Functions icon, choose Properties, and then choose
Specific.
6. On the Specific tab of the Search Manager Properties page, paste the path into
the Find field.


Important
that they do not have permission to see through Content Server.

On the Search Results page, the active link to the document example.doc will
now appear as follows: http://Server_name/Virtual_directory_name/Documents/
example.doc.
To configure a hyperlink mapping for a Directory Walker data source:
1. Instruct the Directory Walker to walk through a specific directory searching for
a particular file, such as c:/Documents/example.doc.
2. In the Web server, create a directory that corresponds to this file's path, such as
c:/Documents/Virtual_directory_name.
3. On the System Administration page, click Directory Walker Data Source on the
Add Item menu.
4. On the Create New Directory Walker Data Source page, paste the prefix into the
Find field in the General Information section.

Important
6. Complete the directory walker Directory Walker Data Source setup.

On the Search Results page, the active link to the document example.doc will
now appear as follows: http://Server_name/Virtual_directory_name/Documents/
example.doc.

30.1.8 Setting Up Admin Servers

The way that you set up your Admin servers depends on the configuration of
computers used to run your Content Server site. If you run Content Server in a
clustered environment (that is, in an environment where Content Server is installed
on more than one computer, allowing various Content Server operations to be
distributed among those computers), you must designate an Admin server as the
default, and then register all remote Admin servers with it. If you do not run
Content Server in a clustered environment, you have only one Admin server, which
is automatically designated as the default.
Setting Up a Default Admin Server

If you are running Content Server in a clustered environment and, therefore, have
more than one Admin server, you must designate one as the default. The default
Admin server communicates with all other Admin servers at the site and is usually
named Default. It is also listed as the default Admin server for all data flow
processes and Search Engines that you create in Content Server. If the default Admin
server resides on a remote host, you must ensure that both the Server and Admin
server are functioning correctly on that host.
If you select an existing Content Server database to connect to a Content Server

installation, the host name, port number, or password recorded for the default
Admin server in that database may not match those of the default Admin server in
the installation. In this case, Content Server prompts you to specify the correct host
name, port number, and password of the Admin server that you want to designate
as the default.
Note: The minimum length of an Admin Server password must be 6

characters. An error message is displayed if you attempt to set a shorter
password.
The Admin Server will enter safe mode if the password file
(config/otadmin.pwd) cannot be written to when you attempt to change the
password. The likely cause is read only permissions on the password file. After
verifying the file on disk, manually reset the Admin Server to exit safe mode.
You can provide Port Ranges to specify a range of ports that are used in the
automated creation of processes, such as those resulting from the execution of
control rules and automated partition creation. The range is bound to this Admin
server instance only and allows you to define different ranges when multiple Admin
servers are configured. You can change the ports that are assigned to objects and no
further range checking is performed.
Registering with the Default Admin Server

Once you have designated an Admin server as the default, you must register all
other Admin servers with it. Registering provides the Server on the computer where
the default Admin server runs with the port number and password information that

it needs to connect to the remote Admin server. To register with the default Admin
server, a remote Admin server must be running.
If you no longer want to use a remote Admin server to manage data flow processes
or Search Engines, you unregister it. If the Admin server that you want to unregister
is currently managing some data flow processes or Search Engines, you must move
them to another host before unregistering. For more information, see “To Move Data
Flow Components” on page 471. However, if there is an index residing on the
Content Server host computer of the Admin server that you want to unregister, you
can either leave the index where it is (you do not need to change its path to reflect
how it is mapped or mounted on the replacement Admin server) or you can move
the index. For more information, see “Moving Indexes” on page 623.
Notes
• If you install a remote Admin server on any Microsoft Windows operating
system, you must set up the Admin server to run as a particular Windows
user, and then use the same Windows user name and password to run the
Admin servers on all other hosts.
• If you install a remote Admin server on UNIX, do not set up the Admin
server to run as the root user. On UNIX, the Admin server runs as the user
as whom it logs in. You then use the same UNIX user name and password to
run the Admin servers on all other hosts.
Enabling the Admin Server File Cache

An Admin server file cache is a storage folder that an Admin server manages. This
file cache provides a file caching system, which improves the efficiency of certain
Content Server operations, such as hit highlighting. For more information about
enabling and setting up the file cache, see “Setting Up the Admin Server File Cache”
on page 432.
30.1.9 Setting Up the Admin Server File Cache

An Admin server file cache is a storage folder that an Admin server manages. This
file cache is also named the remote admin cache (RAC), and it, along with the Server's
local file cache, provides a file caching system that improves the efficiency of certain
Content Server operations, such as hit highlighting. Hit highlighting is Content
Server's ability to highlight query terms in the content of search result items.
Setting up an Admin server file cache involves enabling, purging, or viewing

information about it (for example, how many items the file cache contains). When
you install or upgrade Content Server, an Admin server file cache is created and
enabled on the computer on which the default Admin server resides.
If you want to set up an Admin server file cache for another Admin server in your
Content Server installation, you must create the file cache directory. Then, you
enable the file cache by specifying its directory. Enabling multiple Admin server file
caches in your Content Server installation allows file caching to continue if one

30.2. Creating Index Components Individually
Admin server becomes unavailable. You can disable any Admin server file cache in
your Content Server installation at any time.
Note: If you choose to disable the Admin server file cache, the Find Similar
command and hit highlighting will no longer work on document listings.
When you restart an Admin server that manages an Admin server file cache, the
contents of the file cache are preserved. If you want to delete the contents of the
Admin server file cache, you can purge it. To purge an Admin server file cache, you
set one of the following processing parameters:
• Purge, which automatically deletes the contents of an Admin server file cache,
based on criteria that you set (for example, all documents are deleted when they
occupy more file cache space than a set amount)
• Notify, which sends you an email message when the criteria you set for purging
have been met
• Purge and Notify, which automatically deletes the contents of the Admin server
file cache, based on the criteria that you set, and sends you an email message
notifying you that the contents of the file cache have been deleted
30.2 Creating Index Components Individually

OpenText recommends that you create indexes using the index templates that
Content Server provides. For information about creating indexes using templates,
see “Creating Indexes Using Templates” on page 405. You can also create an index
of data by creating the system objects that are associated with a data source
individually. You also create system objects individually when you want to
customize an Indexing and Searching system.
When you create index components individually, OpenText strongly recommends

that you add system objects in the following order:
• Add a data source folder to the System Administration page
• Add a Data Flow Manager to the data source folder
• Add a Search Manager to the data source folder
• Add a partition map to the data source folder. A partition map is a representation
of a data source's Indexing and Searching system, and displays all of the
components in the system (partitions, Search Engines, Search Federators, and
Index Engines). For information about partition maps, see “Working with
Partition Maps” on page 601.
• Add a partition to the Indexing and Searching system. When you add multiple
partitions, you allow data to be distributed into more, smaller sized indexes
(each partition maintains its own index of data, which is a portion of the entire
index of data).
• Add a data flow producer process to the Data Flow Manager. A producer
process is a process that locates or extracts data (for example, the Enterprise
Extractor, Directory Walker, or XML Activator process)

• Add a Document Conversion process to the Data Flow Manager, which converts
data from its native format to HTML or raw text
• Add an Update Distributor process to the Data Flow Manager, which also adds
an Index Engine for each existing partition. For information about Update
Distributor processes and Index Engines, see “Configuring Indexing Processes”
on page 587.
• Add a Search Federator to the Search Manager, which also adds a Search Engine
for each existing partition. Adding a Search Federator also adds it and Search
Engines to the Indexing and Searching system. For information about Search
Managers, Search Federators, and Search Engines, see “Administering Searching
Processes” on page 690.
• Add a Remote Search process to open a connection between Content Server
systems by adding a remote Content Server system to the Admin Server or the
Enterprise Data Source Folder. For information about Remote Search processes,
see “Configuring Remote Search” on page 699.
When you add a partition map, partitions, or Search Federators, you are setting up
the Indexing and Searching system that is associated with an index's data source.
You can add as many partitions and/or Search Federators as you need, to create an
efficient system. After you create an index, you can administer the system objects
associated with it (for example, searching and indexing processes, and data flow
processes). For information about administering data flows, see “Administering
Data Flows” on page 465.
30.2.1 Adding Index Components

When you add a Data Flow Manager, Content Server enables system management
by default. This means that Content Server automatically monitors the status of the
data interchange pools (iPools) for the data flow. You can disable system
management after the data flow manager is created by disabling the Enable System
Management check box on the Control Rules page.
If you are creating your data source's index components individually, you can add a
Search Manager to a data source folder; however, before you do so, you must add a
Data Flow Manager to the data source folder. For more information about adding
Data Flow Managers, see “Adding Index Components” on page 434. For more
information about Search Managers, see “Administering Searching Processes”
on page 690.

To Add Data Source Folders

To add a data source folder:
1. On the System Object Volume page, click Data Source Folder on the Add Item
menu.
2. On the Add: Data Source Folder page, type a name for the data source folder in
the Name field.
3. To provide a description of the data source folder on the General tab of its
Properties page, type descriptive text in the Description field.
4. To modify the categories and attributes associated with this item, click the Edit
button beside the Categories field.
To Add a Partition Map

To add a partition map:
1. On the System Object Volume page, click the processes_prefix Data Source
Folder link of the data source folder for the data source to which you want to
add a partition map.
2. Click the processes_prefix Partition Map link.
3. Type a name for the partition map in the Name field.
4. If you want to provide a description for the partition map on the General tab of
its Properties page, type a description in the Description field.
button.
To Add a Data Flow Manager

To add a Data Flow Manager:
1. On the System Object Volume page, click the Data Source Folder link of the
data source folder in which you want to create a Data Flow Manager.
2. Click Data Flow Manager on the Add Item menu.
3. On the Add: Data Flow Manager page, type a name for the data flow manager
in the Name field.
4. To provide a description of the Data Flow Manager on the General tab of its
Properties page, type descriptive text in the Description field.
5. To modify the categories associated with the Data Flow Manager, click the Edit
button beside the Categories field.

To Add a Search Manager

To add a Search Manager:

Folder link of the data source folder to which you want to add a Search
Manager.
2. Click Search Manager on the Add Item menu.
3. On the Add: Search Manager page, type a name in the Name field.
4. To provide a description of the Search Manager on the General tab of its
Properties page, type a description in the Description field.
button.
To Add a Search Federator

To add a Search Federator:

add a Search Federator.
2. Click the processes_prefix Search Manager link.
3. Click Search Federator on the Add Item menu.
4. At the Planning Page step in the Add Search Federator Wizard, review the
information presented, and then click the Next button.
5. At the Search Federator step, do the following:
• In the Name field, type a name for the Search Federator. If you want to start
the Search Federator and each Index Engine after they are added, click the
Start Automatically check box.
• Click an Admin server in the Host drop-down list to specify the server on
which the Search Federator will run.
• Type a port number in the Admin Port field to specify the port that the
Search Federator uses to run on an Admin server.
• Type a port number in the Search Port field to specify the port on which the
Search Federator listens for search requests from the Search Manager.
6. Click the Next button.
7. At the Search Engines step, provide information to add a Search Engine to each
of the partitions in your Indexing and Searching system. All of the Search

Engines that you add will be managed by the Search Federator that you are
adding. Type the following in each section on the page:
• In the Name field, type a name for the Search Engine.

which the Search Engine will run.
Search Engine uses to run on an Admin server.
• Type a port number in the Server Port field to specify the port on which the
Search Engine communicates with the Search Federator.
• Type the absolute path in the Index Directory field for the partition's index
that this Search Engine will search.
9. At the Summary step, review the information that you provided for the new
Search Federator and each Search Engine, and then click the Finish button to
add the processes.
Note: Clicking the Check port link for any of the ports allows you to check if a
port number is available. You can also add Search Federators and Search
Engines to a particular data source when you view the data source's partition
map. For more information about viewing partition maps, see “Working with
To Add a Partition
To add a partition:
add a partition.
3. Click Partition on the Add Item menu.
4. On the Planning Page step in the Add Partition Wizard, review the information
presented, and then click the Next button.
Note: You should have all required information—such as the index size
and values, the Partition Name, the index location, and the four unused
ports—before you launch the wizard. Do your planning first to determine
a suitable configuration.
Your server requires additional RAM to support the new index partition.
For a Standard partition, with a maximum content disk size of 50,000 MB,
and a maximum metadata memory size of 1,000 MB, you should provide
an additional 2.4 GB of RAM before you create the new partition.

Any ports you specify must be free and unused. You can use the Check
port links in the Wizard to verify this. Consult your network administrator
if you are unsure which ports to use. You do not need to specify the ports
for your existing Admin servers or Server processes, only the ports
required for the new partition.
You should specify the exact path of your new index as the index location,
for example, C:\opentext\index\enterprise\index2. The last
subfolder (index2 in the example) should not exist yet. It will be created
for you. Do not use the index root folder (typically C:\opentext\index or
C:\opentext\index\enterprise). It is important to specify the folder
carefully. The wizard neither suggests a suitable folder, nor does it prevent
you from using an unsuitable one.
5. At the Partition step, do the following:
• Type a name for the partition in the Name field.

• If you want to customize the amount of disk space to be allocated to indexed
content in the partition's index, type a value in the Maximum Content Disk
Size field.
• If you want to customize the amount of memory space to be allocated to
indexed metadata in the partition's index, type a value in the Maximum
Metadata Memory Size field.
7. On the Index Engine step, do the following:
• In the Name field, type a name for the Index Engine.

which the Index Engine will run.
• Type an unused port number in the Admin Port field to specify the port that
the Index Engine uses to run on an Admin server. Click the Check port link
to check if a port number is available.
• Type an unused port number in the Server Port field to specify the port that
the Index Engine processes use to communicate with the Update Distributor.
• Type the absolute path for a new index location in the Index Directory field
for this partition's index.
9. At the Search Engines step, provide information to add a Search Engine to each
Search Federator in your Indexing and Searching system. Type the following in
each section on the page:
• In the Name field, type a name for the Search Engine.

which the Search Engine will run.

• Type an unused port number in the Admin Port field to specify the port that
the Index Engine uses to run on an Admin server.
• Type an unused port number in the Server Port field to specify the port that
the Search Engine uses to communicate with the Search Federator.
• Type the absolute path for a new index location in the Index Directory field
for this partition's index. The Index Engine that you add will search this
index.
partition, the Index Engine and each Index Engine, and then click the Finish
button to add the processes.
Note: If you run into a problem and exit the wizard, you may need to delete
the incomplete partition map manually.
Once you have exited the wizard and created the new partition, restart the
partition map. If you wish, you can now switch old partitions to Read Only or
Update Only. (Whether you do or not depends on your configuration and
requirements.)
For more information, see “Administering Partitions” on page 597.
30.2.2 Adding Data Flow Processes

A data flow is a series of linked processes that exchange information. You can create
a custom data flow for a particular data source by adding and configuring data flow
processes. You add data flow processes to a Data Flow Manager. Data flow
processes include:
• Directory Walker, which extracts data from a set of files on your file system and
writes the data to a data flow. For more information on adding a Directory
Walker process, see “Adding a Directory Walker Process” on page 446. For
information on configuring a Directory Walker process, see “Configuring a
Directory Walker Process” on page 506.
• Document Conversion, which converts documents from their native formats to
HTML or raw text. For information on adding a Document Conversion process,
see “To Add a Document Conversion Process” on page 442.
• Enterprise Extractor, which is a data flow process that extracts data from the
Content Server database and writes it to an Enterprise data flow, where it is
indexed. Because only one process is normally required to extract data from the
Content Server database, OpenText recommends that each Content Server
system have only one Enterprise Extractor process, unless OpenText Global
Services or Customer Support has advised adding multiple Enterprise Extractors
as part of a strategy of high-volume indexing. For more information about high-
volume indexing, see “Setting Up High-Volume Indexing” on page 457. For
more information on adding a Enterprise Extractor process, see “To Add an
Enterprise Extractor Process” on page 441. For information on configuring an

Enterprise Extractor process, see “Configuring the Enterprise Extractor Process”

on page 481.
• Spider, which is a data flow process that extracts data from a Spider server
which crawls corporate intranets, extranets, web sites, or even from public web
sites on the World Wide Web, and writes it to the Data Flow Manager of any
non-Enterprise data source, where it is indexed. The OpenText Spider server is
an additional package that must be installed separately from your Content Server
system. An administrator can set up large, sophisticated crawling projects to
create searchable indexes of external content that are available to all users. For
more information about indexing targeted Web sources, see “To Add a New
Spider Data Flow” on page 500. For information on adding and configuring a
Spider process, see “To Add a Spider” on page 502 and “To Configure the
Spider Process” on page 506.
• Importer, which reads the data that was output by the Update Distributor
process, and then uses the data to perform a task. For example, if you have
installed Content Server Classifications, the Importer determines which assisted
and automatic classifications best match the items represented by the data. This
functionality will be built upon in future versions of Content Server and its
modules. For more information on adding an Importer process, see “To Add an
Importer Process” on page 444. For more information on configuring an
Importer process, see “Configuring an Importer Process” on page 548.
• Merge, which merges multiple Enterprise Extractor or Document Conversion
processes to combine the iPool messages from multiple processes and write them
to a single iPool for the next data flow process. For more information on adding a
Merge process, see “To Add a Merge Process” on page 459. For more
information on configuring a Merge process, see “Configuring a Merge Process”
on page 551.
• Proxy, which acts as a placeholder for a process in a data flow. You add a proxy
to represent a process that is not managed by an Admin server. For example, if
you create a custom, non-Content Server process (that creates, manipulates, or
consumes data) to use in a Content Server data flow, you can represent that
process in Content Server using a proxy. The process that the proxy represents
reads data from the data interchange pool (iPool) that you specify, performs
some process, and then writes data to another iPool, which you specify. For more
information on adding a Proxy process, see “To Add Proxies” on page 445. For
information on configuring a Proxy process, see “Configuring Proxies”
on page 553.
• Tee, which sends iPool messages to up to five iPool outputs processes that have
similar functionality, such as iPool Importer processes. Fore more information,
see “Adding and Configuring a Tee Process” on page 554.
• XML Activator, which reads data (as XML files) from the specified directory in
the file system, where a third-party application has written its information. For
more information on adding a XML Activator Producer Process, see
“Completing an XML Activator Producer Process Setup” on page 450. For
information on configuring a XML Activator Producer Process, see “Configuring
an XML Activator Process” on page 511.

You can create an indexing data flow for when you want to index data and make it
searchable. Creating an indexing data flow is part of the index creation process.
After you create a data flow, you can administer it (for example, configure its
processes or monitor its status). For more information about administering data
flows, see “Administering Data Flows” on page 465.
If you have installed an optional module (for example, the Content Server Spider
module), you can add the corresponding data flow processes to a Data Flow
Manager. For information about adding the data flow processes that an optional
module provides, see the documentation that accompanies the optional module.
To Add an Enterprise Extractor Process

To add an Enterprise Extractor process:
Folder link of the data source folder that contains the Data Flow Manager in
which you want to add the Enterprise Extractor process.
2. Click theprocesses_prefixData Flow Manager link.
3. Click Enterprise Extractor on the Add Item menu.
4. On the Add: Enterprise Extractor page, type a name for the Enterprise Extractor
process in the Name field.
5. To provide a description of the Enterprise Extractor process on the General tab

of its Properties page, type descriptive text in the Description field.
6. In the Host drop-down list, click the shortcut of an Admin server that runs on a
primary Content Server host. The Enterprise Extractor process must run on a
primary Content Server host, which is a host that runs a Server. For information
about performing primary Content Server installations, see the Content Server
Installation Guide.
7. To allow Content Server to monitor the status of this process, select the Enable
System Management check box.
8. To specify the directory in which the Enterprise Extractor process runs, type the
absolute path of the directory in the Start Directory field. This directory must be
the Content Server_home/bin directory of the Admin server that runs the
Enterprise Extractor process.
9. In the Write Data to field, type the absolute directory path of the data
interchange pool (iPool) (relative to the Admin server on which the Extractor
runs) to which you want the Enterprise Extractor process to write the data that
it extracts from the Content Server database.
10. If the data flow already contains at least one intermediate or consumer process,
the names of the processes appear in the Process drop-down list. In this list,
click the process that you want the Enterprise Extractor process to precede in
the data flow.

Tip: In most Enterprise Extractor data flows, the Enterprise Extractor

process precedes a Document Conversion process. In a high-volume
indexing data flow, the Enterprise Extractor process may precede a
Document Conversion process or a Merge process.
11. In the Start Options section, click Scheduled in the drop-down list, click the
Every radio button, and then click values in the drop-down lists to select the
interval at which you want the Enterprise Extractor process to run.
12. In the Stop Options section, click the Terminate radio button, and then type -1
in the Maximum Good Exit Code field. This causes the Enterprise Extractor
process to terminate immediately when it stops. The Maximum Good Exit
Code specifies the maximum error code number for which the Admin server
will automatically restart the Enterprise Extractor process, if it fails. By default,
the value of the Maximum Good Exit Code field is set to -1, meaning that the
Admin server will not restart this process if it fails.
To Add a Document Conversion Process

To add a Document Conversion process:
Folder link of the data source folder that contains the data flow to which you
want to add a Document Conversion process.
2. Click theprocesses_prefix Data Flow Manager link.
3. Click Document Conversion on the Add Item menu.
4. On the Add: Document Conversion page, type a name for the Document
Conversion process in the Name field.
5. To provide a description of the Document Conversion process on the General

tab of its Properties page, type descriptive text in the Description field.
host you want the Document Conversion process to run.
7. In the Read data from field, type the absolute directory path of the data
interchange pool (iPool) from which you want the Document Conversion
process to read data.
8. If the data flow already contains at least one producer or intermediate process,
the connected to drop-down list appears. In this list, click the process which
you want the Document Conversion process to follow in the data flow.
Tip: In most data flows, the Document Conversion process follows a

producer process, such as an Enterprise Extractor process or a Directory
Walker process.

9. In the Write data to field, type the absolute directory path of the data
interchange pool (iPool) to which you want the Document Conversion process
to write the data that it converts.
you want the Document Conversion process to precede in the data flow.
Tip: In most data flows, the Document Conversion process precedes the
Update Distributor process.
11. In the Start Options section, set the start settings for the Document Conversion
process.
12. In the Stop Options section, set the stop settings for the Document Conversion
process.
To Add an Update Distributor Process

To add an Update Distributor process:
add an Update Distributor process.
3. On the Data Flow Manager page, click Update Distributor on the Add Item
menu.
4. On the Planning Page step in the Add Update Distributor Wizard, review the
information presented, and then click the Next button.
5. At the Update Distributor step, do the following:
• In the Update Distributor section, type a name for the Update Distributor in
the Name field. If you want to start the Update Distributor and each Index
Engine after they are created, select the Start Automatically check box.
which the Update Distributor will run.
Update Distributor uses to run on an Admin server.
• In the Interchange Pool Info section, click the iPool directory from which
the Update Distributor process reads data in the Read Data from drop-
down list.
• Click the iPool directories to which the Update Distributor process writes
data in any of the Write Data to drop-down lists.

7. At the Index Engines step, for each Index Engine, do the following:
• In the Name field, type a name for the Index Engine.

which the Index Engine will run.
Index Engine uses to run on an Admin server.
• Type a port number in the Server Port field to specify the port that the
Search Engine uses to communicate with the Search Federator.
• Type the absolute path in the Index Directory field for this partition's index.
Update Distributor process and each Index Engine, and then click the Finish
button to add the processes.
Note: Clicking the Check port link for any of the ports allows you to check if a
port number is available. You can also add an Update Distributor process to a
particular data source when you view the data source's partition map.
To Add an Importer Process

To add an Importer process:
want to add an Importer process.
2. Click the processes_prefix Data Flow Manager link.
3. Click Importer on the Add Item menu.

4. On the Add: Importer page, type a name for the Importer process in the Name
field.
5. To provide a description of the Importer process on the General tab of its

host you want the Importer process to run.
8. To specify the directory in which the Importer process runs, type the absolute
path of the directory in the Start Directory field. If you do not specify a
directory, the Importer process runs in the Content Server_home/bin directory.
9. Click the task that you want the Importer process to perform in the Import Task
Definition drop-down list.

10. To configure the task that the Importer process performs, click the Configure
button.
11. In the Read Data from field, type the absolute directory path of the data
interchange pool (iPool) from which you want the Importer process to read
data. If the data flow already contains at least one process, the connected to
drop-down list appears.
12. Click the process that you want the Importer process to follow in the data flow
in the connected to drop-down list.
Tip: In most data flows, the Importer process follows the Update
Distributor process.
13. In the Start Options section, set the start settings for the Importer process.
To Add Proxies
To add a proxy:
want to add the proxy.
3. Click Proxy on the Add Item menu.
4. On the Add: Proxy page, type a name for the proxy in the Name field.
5. To provide a description of the Proxy on the General tab of its Properties page,
type descriptive text in the Description field.
host you want the proxy to run.
7. In the Read Data from field, type the absolute directory path of the data
interchange pool (iPool) from which you want the proxy to read data.
the connected to drop-down list appears. In this list, click the process that you
want the proxy to follow in the data flow.
9. In the Write Data to field, type the absolute directory path of the data
interchange pool (iPool) to which you want the proxy to write data.
the connected to drop-down list appears. In this list, click the process that you
want the proxy to precede in the data flow.

30.2.3 Adding a Directory Walker Process

You create most Content Server indexes using the Index Templates that Content
Server provides. Index templates allow you to create all the system objects that are
associated with a particular index in a single step. For example, you can create the
Enterprise index, a Directory Walker index, an XML Activator Producer index, an
Admin Help index, or a User Help index by clicking commands on the Add Item
menu on the System Administration page. After you provide the required
information, Content Server automatically generates the corresponding system
objects (for example, the data source folder, the Data Flow Manager, the data flow
and all its processes, and the Search Manager and its Search Engines) in a single
step. You can also create indexes by adding individual system objects to a data
source folder that you add to the System Administration page. For more information
about adding index components, see “Creating Index Components Individually”
on page 433.
You create a Directory Walker process when you want to index data that is stored in
your file system. For each Directory Walker process that you create, you specify the
top-level directories and subdirectory levels that you want the process to scan. The
Directory Walker process walks through the top-level directories that you specify
(and their subdirectories, if necessary) and extracts files that match the criteria that
you specify.
You determine the types of files that the Directory Walker process collects by
specifying inclusion and exclusion criteria (such as, file name patterns, date ranges,
and file size ranges). The Directory Walker process writes the files that match your
criteria to a data interchange pool (iPool), where they can be accessed by the next
process in the data flow.
If you create a Directory Walker index using the index template that Content Server
provides, Content Server sets up logging for the index using default values. In this
case, Content Server generates a Directory Walker log file in the logs directory of
your Content Server installation (Content Server_home/logs) and sets the log level to
Default. After the Directory Walker data flow is created, you can modify these
values when you configure the Directory Walker process. If you create a Directory
Walker index by adding individual system objects to a data source folder, you must
specify the log file location and log level for the Directory Walker process. A
Directory Walker process's log file describes the current status of the process,
indicating whether it started and stopped successfully and listing any warnings or
errors that occurred as the process extracted data.
You can also configure a Directory Walker process to store information in crawl
history database files. Crawl history database files contain information about the files
that the Directory Walker process walks. When a Directory Walker process walks a
set of directories that have already been walked, it compares the crawl history
database files to the files that are currently stored in the directory to locate new,
updated, or deleted files. The Directory Walker process extracts information about
added, replaced, or deleted files to the data flow. It does not extract the entire file set
again, which makes index updating more efficient. When you create a Directory
Walker process individually, you must specify the directory where the Directory

Walker process stores its crawl history database files. When you create a Directory
Walker data flow using the index templates, Content Server automatically creates
the crawl history database files for you. You can then modify the location of the files
when you configure the Directory Walker process.
There are four steps involved in creating an XML Activator Producer data flow.
Setting Up a Directory Walker Process

You set up a Directory Walker process by naming it and specifying the Admin
server on whose host you want the process to run.
Setting Log Options and History Files

If you want to log the activity of the Directory Walker process that you are adding to
a data flow, you can specify the name of the log file that you want to associate with
the process and the type of activity that you want to record. If you do not want to
log the activity of the Directory Walker process, you do not specify log information
when adding a Directory Walker process.
You also specify the location of the crawl history database files that the Directory
Walker creates. When a Directory Walker process runs, information about which
files the process walks are stored in the crawl history database files. The Directory
Walker process uses this information when it again walks a directory to locate new,
updated, or deleted files. OpenText recommends that you store crawl history
database files in the directory where the Directory Walker process writes data: the
directory that you specify in the Write Directory field on the Add: Directory Walker
page.
When specifying directories on the Add: Directory Walker page, you must specify
the directory paths as they are mapped/mounted on the host of the Admin server
whose shortcut you selected in the Host drop-down list.
Setting Directory Groups

Before a Directory Walker process can run, you must identify the directories that
you want the process to scan for data. You specify the top-level directories and the
levels of subdirectories that you want the process to scan. For each group of
directories that you specify, you can also identify the types of files that you want the
Directory Walker process to include or exclude.
Setting iPool and Start/Stop Options

After you set up the Directory Walker process, specify its log and crawl history
parameters, and specify which directories you want the process to scan, you must

set the location of the process's data interchange pool (iPool), and set Start Options
and Stop Options.
Note: If you mix path formats in the Directory Walker, for example, a mapped
drive as the directory to be crawled and a UNC directory in the Exclude field,
the exclude restriction is ignored. The include restriction is also ignored in the
Include field.
To Set Up a Directory Walker Process

To set up a Directory Walker process:
1. On the Open System Object Volume page, click the processes_prefixData

Source Folder link of the data source folder that contains the data flow to which
you want to add the Directory Walker process.
3. Click Directory Walker on the Add Item menu.
4. On the Add: Directory Walker page, type a name for the Directory Walker
process in the Name field.
5. To provide a description of the Directory Walker process on the General tab of
its Properties page, type descriptive text in the Description field.
host you want the Directory Walker process to run.
Note: You must wait up to ten minutes after creating a new Directory
Walker data source before the new data source is listed in the Slices list on
the Content Server Search page.
To Set Log Options and History Files

To set log options and crawl history database files:
1. Type the absolute path of the log file in the Log File field. For example, type
Content Server_home/index/prefix/logs/name.log, where name is a name
that allows you to associate the log file with this Directory Walker process.
2. Click one of the following log levels in the Log Level drop-down list:
• Default, which specifies that the log file only records errors. This is the
minimum log level.
• Verbose, which specifies that the log file records the status of messages that
are flowing through the processes and data interchange pools (iPools) of the
data flow. It also records errors.

• Debug, which specifies that the log file records detailed information about
data flow status and errors. Due to the large amount of data that is
generated, OpenText recommends that you only use the Debug level when
you are diagnosing serious problems with the data flow.
3. In the Crawl History Database Location field, type the absolute path of the
directory where you want the Directory Walker process to write its history files.
Note: If you delete a Directory Walker's history database and change the
case of the directory, the Directory Walker will consider all database
objects to be new when it recrawls the directory.
To Set Directory Groups:

To set directory groups:
1. In the Directories field for the first directory group, type the absolute paths of
the top-level directories that you want the Directory Walker process to scan,
separating paths with semicolons (;) or typing each path on its own line.
2. In the Include field, type the list of file name patterns that you want the
Directory Walker process to collect, separating each with a semicolon (;) (for
example, *.html; *.txt; *.doc; and so on).
3. In the Exclude field, type the list of file name patterns that you want the
Directory Walker process to ignore, separating each with a semicolon (;) (for
example, *.jpg; *.exe; *.dll; and so on).
If you do not specify values in the Include and Exclude fields, the Directory
Walker process collects all of the files in the specified directories. If you specify
a file type to include, the Directory Walker automatically excludes all other file
types. Similarly, if you specify a file type to exclude, the Directory Walker
automatically includes all other files types. If you crawl a directory on an
operating system in which file names are case-sensitive, you can type file name
patterns that cover all possible case combinations. For example, *.[hH] [tT]
[mM] [lL] covers *.HTML, *.hTml, and so on.
4. To specify the number of subdirectory levels below the top-level directories that
you want the Directory Walker process to walk, click one of the following
options in the Depth drop-down list:
• Unlimited, which allows the Directory Walker process to scan all

subdirectory levels below the top-level directories
• Specify, which allows you to specify the number of subdirectory levels that
the Directory Walker process scans
• None, which allows the Directory Walker process to scan top-level
directories only
5. To restrict the files that the Directory Walker process scans to those within a
specific date range, choose a range of dates in the Date Range drop-down lists.

6. To restrict the files that the Directory Walker process scans to those within a
specific file size range, type the range of file sizes (in bytes) in the File Size
fields.
7. If you want to define additional directory groups in the Directory Groups
section, repeat steps 1 to 6.
To Set iPool and Start/Stop Options

To set iPool and start and stop options:
1. In the Write data to field, type the absolute path of the directory to which you
want the Directory Walker process to write the data that it extracts.
you want the Directory Walker process to precede in the data flow.
Tip: In most Directory Walker data flows, the Directory Walker process
precedes a Document Conversion process.
3. In the Start Options section, click Manual in the first drop-down list. This
allows you to start the Directory Walker process manually whenever you want
to recrawl the specified directories.
4. In the Stop Options section, click the Terminate radio button, and then type 99
in the Maximum Good Exit Code field. The Maximum Good Exit Code field
specifies the maximum error code number for which the Admin server will
automatically restart the Directory Walker process, if it fails. Do not modify the
Maximum Good Exit Code value unless you are instructed to do so by
30.2.4 Completing an XML Activator Producer Process Setup

An XML Activator Producer process reads data (as XML files) from the specified
directory in the file system, where the third-party application has written its
information. The XML Activator Producer process then sends the data to an iPool
for the next process in the data flow.
You can use this process to index information from third-party applications in
Content Server.
Adding an XML Producer Process
You add an XML Activator Producer process to a data flow to provide a source for
the data that the data flow will process. You begin adding an XML Activator
Producer process to a data flow by naming it and specifying its configuration
parameters.
When you add an XML Activator Producer process to a data flow, you can specify
the name of the operation and identifier tags that can appear in the Requirements for

XML Activator Files that pass through the data flow. The operation tag specifies the
action that Content Server performs with the data. The identifier tag is a persistent
and unique string that identifies the data object (the content included in a particular
XML file).
When specifying directories on the Add: XML Activator page, you must specify the
directory paths as they are mapped/mounted on the host of the Admin server whose
shortcut you select in the Host drop-down list.
Completing an XML Activator Producer Process Setup
After you name and specify the configuration parameters for the XML Activator
Producer process, you finish setting it up by specifying the settings for binary
encoding, data interchange pools (iPools), and start and stop options.
The XML files that are generated by your third-party application and add or replace
data in your index contain content, usually binary data or text, which is identified by
the content tag. The content tag also includes an attribute that identifies the
encoding type of the content. By default, XML Activator Producer processes are set
to recognize <Content Encoding="Base64"> as the value of the content tag and its
attribute in the XML files, where Content is the name of the Content Tag, Encoding
is the name of the Tag Attribute, and Base64 is the Tag Attribute Value.
You change these parameters when setting up an XML Activator process if your
third-party application uses different names for the parameters. For example, if your
third-party application generates XML files with a content tag of <a b="c">, you set
Content Tag to a, Tag Attribute to b, and Tag Attribute Value to c.
You specify the actual encoding type of the content in your XML files with the
Encoding drop-down list.
To Add an XML Producer Process

To add an XML Activator Producer process to a data flow:
Folder link of an index to which you would like to add the process.
2. Click the Data Flow link of the data flow in which you want to add the process.
3. Click XML Activator on the Add Item menu.
4. On the Add: XML Activator page, type a name for the XML Activator process in
the Name field.
5. To provide a description of the XML Activator process, type descriptive text in

the Description field.
6. In the Activator Type drop-down list, click XML Activator Producer.
host you want the XML Activator Producer process to run.

8. Type the absolute path of the log file in the Log File field. For example, type
Content Server_home\index\prefix\logs\name.log, where name is a name
that allows you to associate the log file with this XML Activator process.
9. Click one of the following log levels in the Log Level drop-down list:
• Default, which specifies that the log file only reports errors. This is the
minimum log level.
• Verbose, which specifies that the log file reports the status of messages that
are flowing through the processes and iPools of the data flow. It also reports
errors.
• Debug, which specifies that the log file reports detailed information about
data flow status and errors. Due to the large amount of data that is
generated, OpenText recommends that you only use the Debug level when
you are diagnosing serious problems with the data flow.
10. In the Incoming Directory field, type the absolute path of the directory from
which you want the XML Activator Producer to read the data that has been
processed by a third-party application.
11. In the Operation Tag field, type the name of the XML tag that contains the
operation that XML Activator will perform on the content of XML files. This tag
is set to Operation by default. Any spaces you include in the tag name will be
ignored by Content Server.
12. In the Identifier Tag field, type the name of the XML tag that contains the
unique identifier for the content of XML files. This tag is set to OTURN by default.
Any spaces you include in the tag name will be ignored by Content Server.
13. In the Metadata List field, you map XML tag names to metadata tag names in
order to accommodate third-party applications that write data elements that
you wish to index as metadata. The tag mappings must include the XML tag
name followed by the metadata tag name, which is the name of an Defining
Index Regions in Content Server. The tag names for each mapping must be
separated by a comma and a space, and each mapping must be separated by a
semi-colon. For example:
xName, OTName;xOwnerIDNumber, OTOwnerID;xFileLocation, OTLocation
Any spaces you include in the tag names will be ignored by Content Server. If
more than one instance of a tag occurs in your XML files, or if two or more tags
in an XML file are mapped to the same metadata tag, Content Server will index
the content of the tags to several instances of the same region. In this case,
Content Server users will not be able to search that region for this index;
however, if Content Server users search the index as a whole, they can access
this data. If you map two different XML tags to the same metadata tag or
include more than one instance of a tag in your XML files, Content Server users
will not be able to search the region for this index.
For information about completing this procedure, see “Completing an XML

Activator Producer Process Setup” on page 450.

To Complete an XML Activator Producer Process Setup

To complete setting up an XML Activator Producer process:
1. In the Content Tag field, type the name of the XML tag that identifies the
content.
2. In the Tag Attribute field, type the name of the attribute that represents the
encoding attribute.
3. In the Tag Attribute Value field, type the value that represents the encoding
type of the XML files.
4. In the Encoding drop-down list, choose one of the following encoding types for
the content in your XML files:
• Base64, which sets the encoding type for XML files to Base64.
• None, which sets the encoding type for XML files to none.
interchange pool (iPool) to which you want the XML Activator Producer
process to write data.
you want the XML Activator Producer process to precede in the data flow.
7. Specify the To Configure Data Flow Process Start Options of the XML Activator
Producer process in the Start Options section.
8. Specify the To Configure Data Flow Process Stop Options of the XML Activator
Producer process in the Stop Options section.
30.2.5 Indexing XML Data

When an XML document is added to Content Server, the XML regions are
automatically indexed. To allow users to search XML regions, you must add an XML
Document Type Definition (DTD) file and set its regions to queryable. XML DTD
files define the elements and attributes used in XML documents. Setting an XML
DTD file's regions to queryable allows Content Server users to construct queries that
target the content of specific XML regions. If you do not set an XML region to
queryable, Content Server users can search the region's content by constructing full-
text queries. After you set an XML region to queryable, you create a search template
that displays the XML Types section on the Search page by default.
Note: Content Server users cannot use the System Attributes section on the
Search page to search for the metadata that is associated with documents that
are produced by Administering XML Activator Data Flow Processes. Instead,
they must use the XML Types section on the Search page.

Adding XML DTD Files
To index XML data, you begin by adding XML DTD files or sample XML documents
to Content Server. When you add an XML DTD file to Content Server, Content
Server analyzes the elements and attributes that the XML DTD defines, and extracts
XML regions based on those elements or attributes.
When a document is added to Content Server using the XML DTD command on the
Add Item menu, Content Server analyzes the content. If Content Server recognizes
the document as XML, it is analyzed and retagged.
The following text is a sample XML document:
<fish>
<fish_OTATTR>
<length>18</length>
<weight>5</weight>
</fish_OTATTR>
<fish_OTNODE>I caught a really</fish_OTNODE>
<commentary>
<commentary_OTATTR>
<type>lie</type>
</commentary_OTATTR>
<commentary_OTNODE>big</commentary_OTNODE>
</commentary>
<fish_OTNODE>one!</fish_OTNODE>
</fish>
You can also extract regions from sample XML documents that properly define all
the XML elements and attributes that you want to search. Whether Content Server
extracts XML regions based on XML DTD files or on sample XML documents, you
must ensure that the XML documents contain well-formed XML and are stored in
Content Server as XML DTD files. If the XML documents do not contain well-
formed XML, Content Server extracts as many regions as it can and displays a
warning message advising you to repair the XML content. Content Server attempts
to extract regions from any document that you add as an XML DTD. Although you

can add XML DTD files and sample XML documents to any Content Server location,
OpenText recommends that you store them in the XML DTD Volume, which you
access from the administration page.
Setting XML Regions to Queryable
When you set XML regions to queryable, you can select from all of the XML regions
that Content Server extracts from a particular XML DTD or sample XML document.
The XML regions that you set to queryable are the XML regions that users can
search in Content Server. Each region has a region name and a display name. The
display name is the name that Content Server displays on the Search page when
Content Server users search XML regions. The display names that you assign to the
XML regions must be descriptive so that Content Server users can easily determine
which regions they want to search.
Content Server extracts four types of XML regions, which are based on the
components of most well-formed XML documents:
• Element regions, which represent an XML element, its attributes, and its content.
These regions encompass the information in the Text regions and Attribute
regions
• Text regions, which represent the character data content (raw text) of an XML
element. These regions have _OTNODE appended to the end of their region names
• Attribute regions, which represent the attribute names and values of an XML
element. These regions have_OTATTR appended to the end of their region names
and encompass Attribute Name regions
• Attribute Name regions, which represent specific attribute names and values.
The attribute name is used to construct a region and the attribute value
represents the corresponding content of the region
To Add XML DTD Files

To add an XML DTD file:
1. On the administration page, click the Open the XML DTD Volume link.
2. Click XML DTD on the Add Item menu.
3. On the Add: XML DTD page, click the Browse button, locate the XML DTD file,
select the file's name, and then click the Open button.
4. Type a name for the XML DTD file or sample XML document in the Name field.
5. To provide a description of the XML DTD file or sample XML document on the
General tab of its Properties page, type text in the Description field.
button.
7. To specify a container for the XML DTD you are adding, click the Browse
Content Server button to navigate to the container you want.


9. If you want to make the XML DTD file's regions queryable, on the Queryable
Regions page, select the region's Queryable check box.
Tip: To edit an XML DTD file's regions, in the XML DTD Volume, click the
file's Functions icon, and then choose Set Regions. To select or clear all XML
regions simultaneously, select or clear the check box beside the Queryable
column title at the top of the Regions table.
30.2.6 Data Flow Creation Status

The Status page appears after you create an indexing data flow. It lists the objects
that were created and displays the port numbers on which the data flow processes
listen. You can review the information on the Status page to ensure that all your data
flow processes were successfully created.
To return to the System Object Volume page, click the Continue button.
If you are creating the Enterprise index as part of creating a new Content Server
database, the Congratulations page appears.
30.2.7 Administering XML Activator Data Flow Processes

The XML Activator data flow processes allow you to connect third-party
applications to data flows. This allows you to integrate Content Server and third-
party applications in several ways. You can:
• Send Content Server data flow information to a third-party application rather
than indexing the information in Content Server
• Send information from the middle of a Content Server data flow to a third-party
application, as well as to the next Content Server process
• Filter Content Server information through a third-party application before
sending it to the next Content Server process
• Index information from third-party applications in Content Server
Third-party applications do not require proprietary tools, libraries, or particular

coding languages to connect to Content Server. They interface with Content Server
through XML files.

30.3. Setting Up High-Volume Indexing
30.3 Setting Up High-Volume Indexing

Normally, Content Server requires only one Extractor process in a single Enterprise
data source to extract data from the Content Server database; Content Server is
configured this way by default. However, there are cases when the volume of objects
being indexed is so large that data sources and data flows must be customized to
allow high-volume indexing. For example, if a large organization wants to store and
index all its email in Content Server, the volume of email may require high-volume
indexing customized to the particular needs of the site.
High-volume indexing consists of setting up one or more of the following:

• Multiple Enterprise Extractor processes in an Enterprise data source
• Multiple Document Conversion processes in an Enterprise data source
• Multiple Enterprise data sources
For more information about adding Enterprise Extractor and Document Conversion
processes, see “Adding Data Flow Processes” on page 439.
Multiple Enterprise data sources are only available if you have set the opentext.ini
parameter wantMultipleEnterprise in the [SearchOptions] section to true. For
more information, see “[SearchOptions]” on page 197.
Considerations When Setting Up High-Volume Indexing
The combination of processes and data sources required for an installation depends
on the data being indexed. OpenText recommends contacting Global Services or
Customer Support for an analysis of your system before implementing high-volume
indexing. Also, OpenText recommends that you plan your usage of ports and shared
directories for iPool subareas before implementation. The test data flow function is
useful in this regard, including determining if iPool subareas have been specified
properly. For more information about the test data flow function, see “Maintaining
Data Flows” on page 467. For more information about viewing port numbers on
your system, see “Maintaining Admin servers” on page 461.
Re-Extracting Enterprise Data
When you add an Enterprise data source to Content Server, you can choose to re-
extract Enterprise data from the database upon its creation. If your database is not
very large, the re-extraction command may be useful as it will redistribute the
Enterprise data across the Enterprise data sources, balancing the load more
efficiently. However, if your database is very large, re-extraction may not be useful
as it may take considerable time. For more information, contact OpenText Customer
Support.

30.3.1 Adding Multiple Processes in an Enterprise Data Source

When you add multiple Enterprise Extractor or Document Conversion processes to a
data flow, you must also add Merge processes. These processes combine the iPool
messages from two or more processes and write them to a single iPool for the next
data flow process.
Data flows for high-volume indexing can be configured in many different ways,
depending on the site's particular needs. The following figure illustrates a data flow
with two Enterprise Extractor processes.
Figure 30-1: Two Enterprise Extractor Processes
The following figure illustrates a data flow with two Enterprise Extractor and
Document Conversion processes.
Figure 30-2: Two Enterprise Extractor and Document Conversion Processes
The following figure illustrates a data flow with four Enterprise Extractor processes
and two Document Conversion processes.

Figure 30-3: Four Enterprise Extractor Processes and Two Document

Conversion Processes
To Add a Merge Process

To add a Merge process:
Folder link of the data source folder that contains the Data Flow Manager in
which you want to add the Merge process.
3. Click Merge on the Add Item menu.
4. On the Add: Merge page, type a name for the Merge process in the Name field.
5. To provide a description of the Merge process on the General tab of its
host you want the Merge process to run.
8. To specify the directory in which the Merge process runs, type the absolute path
of the directory in the Start Directory field.
9. In the Read data from field, type the absolute directory path of the data
interchange pool (iPool) from which you want the Merge process to read data.
click the process that you want the Merge process to follow in the data flow.
interchange pool (iPool) to which you want the Merge process to write the data
that it merges.

click the process that you want the Merge process to precede in the data flow.
13. In the Start Options section, edit the parameters for the Merge process.
14. In the Stop Options section, edit the parameters for the Merge process.
To Add an Additional Enterprise Data Source

To add an additional Enterprise data source:
1. On the System Object Volume page, click Enterprise Data Source on the Add
Item menu. If you previously deleted an Enterprise data source, and you want
its saved Queries and search templates to be associated with this Enterprise data
source, click the Enterprise slice name of the deleted data source in the Slice
Replacement drop-down list, and then click the Enterprise [All Versions] slice
name of the deleted data source in the Slice Replacement [All Versions] drop-
down list.
indexing data flow in the Processes Prefix field. This identifier is the display
name for objects associated with this index on the System Administration page
and for the index's search slice in the Slices list on the Search page. Optionally,
type a number in the Partitions field to specify the number of partitions into
which this index should be divided. If you want to specify the number of
Partitions field.
port number that you specify and the next twelve (at least) consecutive port
4. In the Host drop-down list in the Producer Information section, click the
shortcut of the Admin server on whose host you want the Enterprise Extractor
process to run.
absolute path of the directory (relative to the Admin server on which the
Extractor runs) where you want the Enterprise Extractor process to write data.
By default, the write directory is the Content Server_home/index/enterprise
directory on the default primary Content Server host. You must choose a
directory on a drive on a primary Content Server host, and the directory must
differ from the write directories of other Enterprise data sources.


these processes run on the default Admin server on a primary Content Server
host.
Document Conversion process runs.

runs the Document Conversion process.
9. To allow the data flow processes to start as soon as they are created, select the
Start Processes in Data Flow check box.
10. To re-extract Enterprise data upon the data source's creation, select the Re-
Extract Database on Creation check box.
30.3.2 Maintaining Admin servers

After you set up your Admin servers, you can perform maintenance operations on
them. For example, you can browse an Admin server to determine which data flow
processes it manages, you can ping an Admin server to determine whether it is
online, and you can suspend an Admin server if you want it to run in safe mode
while you perform other administration operations. If you suspend an Admin
server, you must reset it to bring it out of safe mode. You can also view the port
numbers associated with the indexing and searching processes managed by an
Admin server.
Browsing Admin servers

Content Server sites can have many different Admin servers, and each Admin server
can manage different index components (for example, data flow processes and
Search Engines) in the Content Server database. You can browse an Admin server to
view the list of index components it manages.
If you have more than one Admin server at a Content Server site, browsing allows
you to determine how data flow processes and Search Engines are distributed
among the servers. You can also monitor the status and administer the processes or
Search Engines. The administration tasks that you can perform are the same tasks

that you can perform on the processes or Search Engines when you navigate to their
locations in the Content Server system.
Pinging Admin servers

When an Admin server becomes unavailable (that is, the Content Server
administrator takes it offline for some reason), the Server pings it three times to
determine whether it has become available again. After three failed ping attempts,
the Server considers the Admin server to be permanently offline and does not ping it
again. If this occurs, when the Admin server becomes available again, you must
manually ping it to reconnect it to the Server.
Suspending Admin servers

You suspend an Admin server when you want it to run in safe mode so that you can
perform system maintenance tasks without interfering with its primary duties.
Safe mode
The Admin server goes into a troubleshooting safe mode because:
• The administrator issues the go safe command.
• Content Server was unable to save a config or active process file.
An Admin server will enter safe mode when it cannot write to its otadmin.cfg file,
or to its otadmin.pid file. When an Admin server enters safe mode, its status is
displayed on the System Volume Object page. The General tab of the Admin
server's Properties page displays a more detailed message that describes the
condition that originally caused the Admin server to enter safe mode.
These commands are legal in safe mode:

• exit process
• quit
• reset server
• shutdown
• status process
• status ipool
• status server
• statuscode process
• statustext process
• sync
An Admin server does not check for the amount of available free disk space, so it
will not go into safe mode when disk space is low.

Resetting Admin servers

You reset an Admin server to bring it out of safe mode and return it to an active
state.
Viewing Port Numbers

You view port numbers to determine which ports are currently in use or to ensure
that all the indexing and searching processes managed by an Admin server are
running on unique ports. The list of port numbers includes those used by the
following processes (if they exist):
• Content Server Extractor

• Director Walker
• XML Activator
• Document Conversion
• Index Engine
• Search Engine
• Search Federator
• Update Distributor
• Admin Server
• DCS Server
For convenience, you can sort this list by ascending or descending port number,
object type, name, or location. Port numbers that are displayed in red indicate a port
conflict (that is, more than one process is configured to run on the same port). In this
case, you can sort by port number to identify where the conflict exists and then
adjust the conflicting port values accordingly.
Note: This list includes the ports used by the indexing and searching processes
only, not all Content Server ports. To find out what other ports are being used
by Content Server, you can look at the opentext.ini file for the site. If you are
running Content Server in a clustered environment, you must look at each
opentext.ini file in the cluster.
Updating Search Process paths

The Admin Server Path Management page allows you to update mappings and path
names for search configuration to reflect any changes that have been made during
the upgrade process. These paths must be updated once for each Admin server in
the system.

To Update Search Process paths

To update search process paths:
1. On the Administration page, in the Search Administration section, click the

2. In the Admin Servers section, for each Admin Server, click the Data Source
Folder's Functions icon, and choose Path Management.
3. On the Admin Server Path Management page, in the Find text box, enter the
9.7.1 paths, in the and replace with text box enter the Content Server 10.0 paths,
select a section of this page to update, and click Replace All.
4. In the Hyperlink Mappings section, verify the mapping changes are correct, and
click Update Hyperlink Mappings. These mappings are globally shared by all
Admin servers and are not linked to any particular Admin server, so you will
only need to update these paths once. This section will be empty if Directory
Walkers or XML Activators are not configured.
5. In the Partition Location Manager Paths section, verify the path changes are
correct, and click Update Partition Location Manager Paths. These paths are
specific to the current Admin server and must be updated separately for each
Admin server.
6. In the Process Paths section, verify the path changes are correct, and click
Update Process Paths. These paths are specific to the current Admin server and
must be updated separately for each Admin server.
30.3.3 Configuring Search Location Modifiers

The Configure Search Location Modifiers page allows you to extend a search from
the current Content Server location to also search within folders, and their child
folders, that are linked from the current folder as shortcuts.
To Configure Search Location Modifiers

To configure Search Location Modifiers:

Configure Search Location Modifiers link.
2. Click the Follow Shortcuts link.
The Follow Shortcuts link is provided by default, since Search Location
Modifiers are modular. Content Server modules may provide additional
Location Modifiers. Modules with an Administration interface are listed on this
Configure Search Location Modifiers page.
3. On the Configure Search Location Modifiers page, in the Status section, select
how a search location is extended:
• Disabled

30.4. Administering Data Flows
• Modifier available as an option

• Always apply modifier
4. In the Object Type section, the currently selected object types are shown. Click
the edit / review list link to open the Configure Object Types page.
5. Use the Configure Object Types page to select the Content Server containers
where your location modifier will apply.
6. Click Update.
7. On the Configure Search Location Modifiers page, in the Restrictions section,
enter a numeric value in the text box to specify the maximum number of linked
folders.
8. Select how the maximum number is applied:
• Truncate to maximum – limits the search to the number of folders specified

• Cancel if maximum exceeded – stops the search with an error message
• Apply no modifiers if maximum exceeded – allows the search to proceed
without any modifiers
9. Click Update to use the Search Location Modifiers settings you defined, or click
Apply to save the settings.
30.4 Administering Data Flows

A data flow is a set of linked processes that process data from a single source in
Content Server. Content Server allows you to create a data flow that indexes data
from a specific source so that it can be searched. You create indexing data flows
when you create indexes. Data flow processes in an indexing data flow include
processes that locate or extract data (for example, the Enterprise Extractor, Directory
Walker, or XML Activator process); the Document Conversion process, which
converts data from its native format to HTML or raw text; and the Update
Distributor, which passes data to Index Engines for indexing.
After you add the processes that make up a data flow, you can maintain the data
flow (for example, resume, suspend, or resynchronize).
Viewing Data Flow Pictures
Browsing, which is the default method of viewing a data flow, allows you to view
lists of processes and data interchange pools (iPools) in a data flow. When you view
a Data Flow Picture, however, you can view a graphical representation of how
processes are linked by iPools in a data flow. For more information about viewing a
Data Flow Picture, see “Viewing Data Flow Pictures” on page 478.
Monitoring Data Flow Status
You can monitor the status of a data flow in a data source folder. A data flow can
have the following statuses:

• Active, which indicates that all the processes in the data flow are running or are
scheduled to run
• Inactive: n running, which indicates that at least one of the processes in the data
flow is idle. The number n indicates the number of processes that are running or
are scheduled to run.
• Idle, which indicates that all the processes in the data flow are idle
• Problem: n running, which indicates that at least one of the processes in the data
flow is returning an error message. The number n indicates the number of
processes that are running or are scheduled to run.
When you browse the Data Flow Manager or view a Data Flow Picture, you can
monitor the status of each process in a data flow. A data flow process can have the
following statuses:
• Running, which indicates that the process is running
• Scheduled, which indicates that the process is scheduled to run, but is not
currently running new statuses
• Contacting Index Engines, which indicates that the process has finished
initializing and is attempting to contact the Index Engine processes. This status
appears for the Update Distributor process only.
• Waiting for Index Engines, which indicates that the process has not been able to
contact an Index Engine process yet
• Looking for Update Distributor, which indicates that the process is trying to
contact socket server to find out what port is being used by the Update
Distributor process. This status appears for the Index Engine process only.
• Contacting Update Distributor, which indicates that the process has found the
port for the Update Distributor process, has finished initializing, and is now
trying to contact the process. This status appears for the Index Engine process
only.
• Creating Empty Index, which indicates that the process is creating the index for
the first time. This status appears for the Index Engine process only.
• Loading Index, which indicates that the process is loading an index into
memory. This status, which is more likely to appear if the index is large, appears
for the Index Engine and Search Engine processes only.
• Restoring Index, which indicates that the process is loading a restored index into
memory. This status which is more likely to appear if the index is large, appears
for the Index Engine process only.
• Waiting for Search Engines, which indicates that the process is waiting to be
contacted by a Search Engine process. This status appears for the Search
Federator process only.
• Waiting for Initial Index, which indicates that the process is waiting for an
Index Engine process to create an initial index. This status appears for the Search
Engine process only.

• Registering with Search Federator, which indicates that the process is contacting
a Search Federator. This status appears for the Search Engine process only.
• Idle, which indicates that the process is stopped and is not scheduled to run
• Error <n>, which indicates that the process is returning an error message.
Clicking the error message displays the Specific tab of the data flow process's
Properties page, where you can modify the process parameter.
• Unknown, which indicates that Content Server was able to communicate with
the Admin server but the Admin server was unable to report the status of the
process. This can occur if the Admin server's otadmin.cfg file is damaged,
missing, or is not synchronized with the Content Server database.
• Admin N/A, which indicates that the Admin server is not available and,
therefore, cannot report the status of the process. If the Admin server is not
available, it is likely that it does not exist.
30.4.1 Maintaining Data Flows

After you create a data flow, you can maintain its data interchange pools (iPools)
and data flow processes. You can start, stop, flush, test, resynchronize, and move
data flows and their components. For more information about data flows, see
Starting and Stopping Data Flows
When you maintain a data flow, you can stop or start all data flow processes at once.
Certain data flow administration tasks (for example, testing or flushing a data flow)
may require you to suspend a data flow. If a data flow contains one or more
processes that have become idle as part of their normal operation, you may want to
suspend a data flow and then resume it. For example, the Directory Walker process
in the Help Data Flow becomes idle after it walks the help directories. If you add a
Content Server module (such asContent Server Classifications), you must update the
Help index so that the help files that are associated with the new module are added
to the Help index.
Setting Control Rules
In addition, you can set control rules for a data flow's iPools and processes. Control
rules allow you to set options such as the number of iPool messages associated with
a particular process in a data flow. For more information about setting control rules,
see “Adding Data Flow Control Rules” on page 611.
Testing Data Flows
For data to flow successfully through a data flow, the paths specified for the read
and write iPools of each of its processes must be valid and accurate. If you suspect
that data is not flowing properly through a data flow, you can test it. When you test
a data flow, Content Server suspends the data flow, deletes the contents of all iPool
directories, and then attempts to send a test message through the data flow. If
Content Server encounters an error, it displays an error message. If there are no

errors, Content Server displays the contents of the processes_prefix Data Source
Folder. To repair a failing data flow, click the iPool's Information button on the
Specific tab of each process's Properties pages and ensure that the paths displayed
in the Read and Write fields are valid and accurate, and then repeat the test.
Flushing Data Flows
If one of the processes in a data flow appears to have trouble handling the amount of
data being written to its source iPool, you can flush the data flow. Flushing a data
flow suspends the data flow and deletes all pending iPool messages from the data
flow.
Resynchronizing Data Flows
If one or more of the iPool directories in a data flow has been inadvertently deleted,
you can recreate them by resynchronizing the data flow. When you resynchronize,
Content Server reads the information that it has stored in the database about the
location of the iPool directories and then recreates or repairs them as necessary.
After you resynchronize a data flow, test the flow of data by sending a test message
through the iPools.
Maintaining Individual Data Flow Components
You can also maintain the individual components of a data flow. You can move a
data flow's iPools and processes, start or stop individual processes, configure
process's start or stop options, or resynchronize processes with the Content Server
database.
Resynchronizing Data Flow Processes
The Server stores information about all the data flow processes that it controls in the
Content Server database. Each Admin server maintains information about the data
flow processes that it manages in an otadmin.cfg file. At all times, the information
in an Admin server's otadmin.cfg file must match the corresponding information in
the Content Server database. In the following circumstances, this information may
become mismatched:
• The information about a particular data flow process in the otadmin.cfg file of a
registered Admin server is corrupt or has been deleted.
• The information about a particular data flow process in the Content Server
database has been changed in a way that did not allow the corresponding
changes to be made in the otadmin.cfg file of the Admin server that manages
the process. This may happen if SQL commands that modify this information are
issued directly to the Content Server database. OpenText strongly recommends
that you do not issue SQL commands directly to the Content Server database in
this way.

If you suspect that the information stored in the Content Server database about a
particular data flow process is inaccurate or missing in the otadmin.cfg file of the
Admin server that manages the process, you can resynchronize the process.
Resynchronizing a process writes the information recorded about the process in the
Content Server database to the otadmin.cfg file of the Admin server that manages
the process.
Note: Information about the Update Distributor process is also recorded in the
search.ini file. The search.ini file is a configuration file that contains
settings for the components of Indexing and Searching systems (for example,
partitions, Index Engines, and Search Engines). Resynchronizing the Update
Distributor process writes information about the process to the otadmin.cfg
and search.ini files.
To Maintain a Data Flow

To maintain a data flow:
Folder link of the data source that contains the data flow that you want to
configure.
2. Click the Data Flow Manager's Functions icon, choose Properties, and then
choose Specific.
3. On the Specific tab of the Data Flow Manager Properties page, click one of the
following buttons:
• Resume, which starts the processes of a suspended data flow

• Suspend, which stops the processes of a data flow
• Flush, which stops the data flow processes and deletes all pending iPool
messages from the data flow
• Test, which submits a message to the data flow to determine whether the
message successfully passes from one end of the data flow to another. When
you test a data flow, Content Server stops the data flow, purges all existing
messages, and then submits the test message.
• Resynchronize, which re-creates the iPool directories according to the
information about the data flow that is stored in the Content Server database

To Stop All Processes

To stop all the processes in a data flow:
Folder link of the data source containing the data flow whose processes you
want to stop.
2. Click the Functions icon of the data flow manager, and then choose Suspend.
To Stop Individual Processes

To stop an individual process:
Folder link of the data source containing the process that you want to stop.
3. Click the Functions icon of the process that you want to stop, and then choose
Stop.
To Start All Processes

To start all the processes in a data flow:
Folder link of the data source that contains the data flow whose processes you
want to start.
2. Click the Functions icon of the Data Flow Manager, and then choose Resume.
To Start Individual Processes

To start an individual process:
Folder link of the data source containing the process that you want to start.
3. Click the Functions icon of the data flow process that you want to start, and
then choose Start.

30.4.2 To Move Data Flow Components

A data flow has two types of components: processes and data interchange pools
(iPools). For a variety of reasons, you may need to move a process to run on a
different Admin server host, or move an iPool to a different location.
If you have more than one Admin server registered with the Server, you can move a
data flow process from one Admin server host to another. For more information
about registering Admin servers, see “Setting Up Admin Servers” on page 431.
If you move a data flow process, you may also need to modify the iPool read and/or
write directories that are associated with that process. If you modify the location of
the read and/or write directories for the process, you may also have to correct the
read and/or write directories of the surrounding processes in the data flow chain.
After you move a data flow process, ensure that all read and write directories are
valid. After you move an iPool, you should test the data flow to ensure that data
passes through the iPools correctly. Click the following links for information about
how to move data flow components:
• To Move a Data Flow Process
• To Move an Ipool
To Move a Data Flow Process

To move a data flow process:
Folder link of the data source containing the data flow process that you want to
move.
3. Click the Functions icon of the process that you want to move, and then choose
Stop.
4. Click the name link of the process that you want to move.
5. In the Admin Server drop-down list on the Specific tab of the process's
Properties page, click the shortcut of the Admin server on whose host you now
want to run the process.
6. Click the Information button.
7. On the iPool Information page, type the path of the write directory as it is
mapped/mounted on the new Admin server host in the Write field. The Write
field is not available if the data flow process that you are moving does not write
data to a directory.
8. Type the path of the read directory as it is mapped/mounted on the new Admin
server host in the Read field. The Read field is not available if the data flow
process that you are moving does not read data from a directory (for example, a
Directory Walker process).

10. Click the Functions icon of the process that you moved, and then choose Start.
To Move an iPool
To move an iPool:
Folder link of the data source containing the iPool that you want to move.
3. Click the Functions icon of the data flow's producer process, and then choose
Stop. The Enterprise Extractor, Directory Walker, and XML Activator Producer
processes are all producer processes.
4. Click a refresh interval in the refresh drop-down list. After data has been fully
processed through the data flow, click Do not refresh in the refresh drop-down
list.
5. For each data flow process that is running or scheduled to run, click the
Functions icon, and then choose Stop.
6. Click the name link of the process that writes data to the iPool that you want to
move.
7. On the Specific tab of the process's Properties page, click the Information
button.
8. On the iPool Information page, type the path of the new iPool write directory as
it is mapped/mounted on the host of the Admin server on which this process
runs in the Write field.
10. Click the name of the process that reads data from the iPool directory that you
moved.
11. On the Specific tab of the process's Properties page, click the Information
button.
12. On the iPool Information page, type the path of the new iPool read directory as
it is mapped/mounted on the host of the Admin server on which this process
runs in the Read field.
14. Click the Functions icon of the data flow, and then choose Resume.

30.4.3 Configuring Data Flow Process Start Options

When you create Content Server indexes using index templates, Content Server
automatically generates the appropriate system objects, including the data flow and
all of its processes. In this case, Content Server configures each data flow process
using default values. You can modify these default options if you want to customize
the configuration of the data flow processes. Modifying start options allows you to
customize when data flow processes run, which can improve the efficiency of data
processing. For example, depending on the amount of data that needs to be
processed at your site, you can schedule data flow processes to run each minute or
each hour every day, or every other day. Another option that can ensure the
efficiency of data processing at your site is configuring start options for the
Enterprise Extractor process and setting up control rules (rules for the delivery of
data flow management actions) for the Document Conversion and Update
Distributor processes. For example, when you configure the start options for an
Enterprise Extractor process, you can schedule it to run every day at 9:00 PM. The
Enterprise Extractor process runs until it extracts all the objects in the Content Server
database, and then transfers the extracted objects as data interchange pool (iPool)
messages to the iPool from which the Document Conversion process reads. If you
set up a control rule for the Document Conversion process, the process runs
whenever there are iPool messages in the iPool from which it reads. When there are
no iPool messages, the Document Conversion process stops running until it receives
one or more iPool messages. You can also set up this control rule for the Update
Distributor process, which is a process that passes data to Index Engines for
indexing. Whenever there are iPool messages in the iPool from which the Update
Distributor reads, the Update Distributor runs; and it stops running when there are
no messages.
You can configure the start options on the Specific tab of each data flow process's
Properties page to determine whether the process runs persistently, runs according
to a predetermined schedule, or runs when you start it manually.
The following table describes the most appropriate start options for data flow
processes.
Table 30-1: Default Start Options
Process Type Description of Default Start Option

Enterprise Extractor Schedule this process to run each minute so
that it can continuously monitor changes in
your Content Server database. Although you
can modify the time and days when the
Enterprise Extractor runs, OpenText
recommends that you do not set this process
to the Manual or Persistent start option.

Process Type Description of Default Start Option

Directory Walker Set this process to run when you manually
start it. It then continues to run until it
completes its operations. Depending on the
type of index that you are creating, you can
change the manual setting. Use the Manual
start option when indexing relatively static
data on your file system. If you expect the
content of the specified directories to change
frequently, you can configure the Directory
Walker process to run according to a
schedule (for example, once per week). In
this way, you can keep the index
synchronized with the current state of the
data in the walked directories.
Document Conversion Schedule this process to run each minute so
that it can monitor its read directory for new
data regularly. Although you can modify the
time and days when the Document
Conversion process runs, OpenText
recommends that you do not set this process
to the Manual or Persistent start option.
Update Distributor This process runs continuously so that it can
constantly monitor its read directory for data
to index. OpenText recommends that you do
not set the Update Distributor process to any
other start option.
Importer Schedule this process to run each minute so
that it can continuously respond to changes
in your Content Server database. OpenText
recommends that you do not set the Importer
process to any other start option.
XML Activator Producer Schedule this process to run each minute so
that it recrawls a directory regularly.
Although you can modify the time and days
when the XML Activator Producer process
runs, OpenText recommends that you do not
set this process to the Manual or Persistent
start option.

To Configure Data Flow Process Start Options

To configure data flow process start options:
Folder link of the data source folder that contains the process whose start
options you want to set.
3. Click the Functions icon of the process whose start options you want to set, and
then choose Stop.
4. Click the name of the process whose start options you want to set.
5. In the Start Options section, click one of the following options in the drop-
down list:
• Scheduled, which allows the process to run at a specific time on one or more
days of the week (for example, at 1:00 A.M. seven days a week) or at regular
intervals (for example, every two minutes).
• Manual, which allows the process to run only when you start it manually
(by clicking the Functions icon of the process, and then choosing Start). The
process runs until it completes its task and then stops again.
• Persistent, which allows the process to run continuously. If the process
terminates unexpectedly, its Admin server restarts it automatically. If the
Admin server stops or if there is a system reboot, the Admin server restores
the process to its previously saved state (running or stopped) when the
Admin server restarts.
6. To schedule the start options, click one of the following radio buttons:
• At This Time, which schedules the process to run at a specific time on

certain days of the week. Click values in the drop-down lists and select the
appropriate check boxes to specify the time and days of the week when you
want the process to run.
• Every, which schedules the process to run at a specific interval. Click values
in the drop-down lists to specify the time units and duration of the interval
at which you want the process to run.
8. Click the Functions icon of the process, and then choose Start.

30.4.4 Configuring Data Flow Process Stop Options

When you create Content Server indexes using index templates, Content Server
automatically generates the appropriate system objects, including the data flow and
all its processes. In this case, Content Server configures each data flow process using
default values. You can modify these default values if you want to customize the
configuration of the processes. Modifying stop options allows you to customize
when data flow processes stop running.
You can configure the stop options on the Specific tab of each data flow process's
Properties page to determine the events that occur when a process stops.
You can instruct a process to terminate immediately after it stops, or you can send a
shutdown message to the process when it stops. If you send a shutdown message,
you must specify an available port number on which the message is sent. When the
process receives the shutdown message, it performs a series of operations to shut
itself down gracefully. You can also run an executable file when a process stops. This
executable file (which you must create) can then shut down the process gracefully.
The following table describes the most appropriate stop options for data flow
processes.
Table 30-2: Default Stop Options
Process Type Description of Default Stop Option

Enterprise Extractor Configure this process to terminate when it
stops. The Enterprise Extractor process does
not support the Stop Message Port or Stop
Executable options.
Directory Walker Configure this process to terminate when it
stops. You can also configure this process to
stop when it receives a shutdown message
by specifying a port number in the Stop
Message Port field. When you set a stop
message port number, Content Server sends
a shutdown message to the Directory Walker
process, instructing it to shut down
gracefully.
Document Conversion Configure this process to stop when it
receives a shutdown message by specifying a
port number in the Stop Message Port field.
When you set a stop message port number,
the Admin server sends a shutdown message
to the Document Conversion process,
instructing it to shut down gracefully.
Although you can also configure this process
to terminate immediately after it stops,
OpenText does not recommend it.

Process Type Description of Default Stop Option

Update Distributor Configure this process to stop when it
Content Server sends a shutdown message to
the Update Distributor process, instructing it
to shut down gracefully. The Update
Distributor process does not support the
Terminate or Stop Executable options.
XML Activator Producer Configure this process to stop when it
Content Server sends a shutdown message to
the XML Activator Producer process,
instructing it to shut down gracefully. You
can also configure this process to terminate
immediately after it stops or to stop when a
specific executable file runs.
To Configure Data Flow Process Stop Options

To configure data flow process stop options:
Folder link of the data source folder that contains the process whose stop
options you want to set.
3. Click the Functions icon of the process whose stop options you want to set, and
then choose Stop.
4. Click the name of the process whose stop options you want to set.
5. To immediately terminate the process when it stops (automatically or
manually), click the Terminate radio button.
6. To send a shutdown message to the process when it stops (automatically or
manually), click the Stop Message Port radio button, and then type an available
port number (between 1025 and 65535) in the corresponding field.
7. To run an executable file when the process stops (automatically or manually),
click the Stop Executable radio button, and then type the absolute path of the
executable file (as mapped/mounted on the process' Admin server host) in the
corresponding field.
8. To change the maximum error code number for which the Admin server will
automatically restart this process, if it fails, type an error code number in the
Maximum Good Exit Code field. Do not modify this option unless you are
instructed to do so by OpenText Customer Support.


10. Click the Functions icon of the process, and then choose Start.
To Resynchronize Data Flow Processes

To resynchronize a data flow process:
Folder link of the data source folder that contains the process that you want to
resynchronize.
3. Click the name of the process that you want to resynchronize.
4. On the Specific tab of the process's Properties page, click the Resynchronize
button.
30.4.5 Viewing Data Flow Pictures

A Data Flow Picture offers an alternative way of viewing the data flow processes
and data interchange pools (iPools) in a data flow. Rather than displaying
alphabetically organized lists of the data flow processes and iPools in a data flow,
Data Flow Pictures display graphical representations of how processes in data flows
are linked to each other by iPools. The links in Data Flow Pictures show how iPools
connect one data flow process to the next, and how iPool messages flow through the
data flow.
Data Flow Pictures can represent data flow processes that are linked sequentially or
in parallel. The image below illustrates a Data Flow Picture for a standard Enterprise
data flow, in which iPool messages flow sequentially from the Enterprise Extractor
process to the Update Distributor process, and then in parallel to the Prospector
Importer and Classification Importer processes. In this example, the same iPool
messages are passed to both the Prospector Importer and the Classification Importer
processes at the same time.

Data Flow Pictures

also allow you to manage the links between data flow processes. You can add,
remove, or view information about links.
Adding and Removing Links
You can use a Data Flow Picture to link processes in a data flow. When you add a
new process to a data flow, you can either set up its link on the page you use to
create the new process, or you can set up the link using a Data Flow Picture.
Processes that are not linked when you add them to a data flow are displayed
without a connection at the top of the Data Flow Picture. Removing a link removes
the iPool connections between two data flow processes. You can reconnect data flow
processes at any time by adding a new link.
Viewing Information about Links
When you view information about a link, you can obtain information about the
iPool connections in a Data Flow Picture. For example, you can view the number of
iPool messages that have successfully passed or that are waiting to be passed
through processes in a data flow. You can also monitor the directory size, which is
the amount of disk space the iPool subarea is using, and the free disk space, which is
the amount of total space available on the computer that the iPool subarea uses.
Note: The iPool subarea stores data flow processes' read and write iPools. Two
data flow processes share each iPool subarea; one process reads data from the
subarea, while the other process writes data to the area.

To View a Data Flow Picture

To view a Data Flow Picture:

Folder link of a data source folder.
2. Click the Data Flow Manager's Functions icon, and choose View Data Flow
Picture.
Tip: To view a Data Flow Picture when you are browsing the contents of the
Data Flow Manager, click the Data Flow Manager's Functions icon, and choose
View Data Flow Picture.
To Add a Data Flow Link

To add a data flow link:
1. In the Data Flow Links section on the Data Flow Picture page, click a data flow
process in the From drop-down list.
2. Click a data flow process in the To drop-down list.
3. Click the Add a link button .
To Remove a Data Flow Link

To remove a data flow link:
• In the Data Flow Links section on the Data Flow Picture page, click a data flow
link's Remove this link button .
To View Data Flow Link Information

To view information about a data flow link:
• In the Data Flow Links section on the Data Flow Picture page, click a data flow
link's Link info button .

30.5. Configuring Data Flow Processes
30.5 Configuring Data Flow Processes

A data flow is a set of linked processes that process data from a single source in
Content Server. There are seven types of data flow processes you can configure: the
Enterprise Extractor Process, the Directory Walker Process, the XML Activator
Process, the Document Conversion Process, the Importer Process, the Merge Process,
and Proxies. Each data flow has a Data Flow Manager, which manages all the
processes that make up the data flow. A Data Flow Manager is also a Folder that
contains all the processes in a data flow.
After you add the processes that make up a data flow, you can configure them
individually.
30.5.1 Configuring the Enterprise Extractor Process

An Enterprise Extractor process is a data flow process that extracts data from the
Content Server database and writes it to a data flow, where it is indexed.
You configure Enterprise Extractor processes on their Properties pages. For example,
you can change the Admin server on whose host the Enterprise Extractor process
runs. You can also enable system object management, modify the start and
destination directories, administer start and stop options, or resynchronize the
process.
You can also configure the Enterprise Extractor process by modifying parameters in
the “[LivelinkExtractor]” on page 170 section of the opentext.ini file.
The Specific tab of the Enterprise Extractor Properties page
Element Description
Status Indicates whether the Enterprise Extractor
process is running. You cannot edit this field.
Admin Server Specifies the shortcut of the Admin server on
whose host computer the Enterprise
Extractor process runs. Do not change the
Admin server shortcut for the Enterprise
Extractor process. The Enterprise Extractor
process must run on an Admin server host
where the Server runs. This is always the
primary Content Server host where the
default (primary) Admin server is running.

Element Description
Enable System Management Controls whether Content Server monitors
this process to detect when it returns error
messages. If the process returns an error
message, Content Server records the message
in the database. System management is
enabled by default. For more information
about configuring Content Server to send
you email alerts when this or other data flow
processes encounter errors, see “To Enable
Error-Checking and E-Mail Delivery”
on page 569.
Last Update Indicates the last date and time that Content
Server ran the Enterprise Extractor process.
You cannot edit this field.
Full Extraction Progress Provides the status of the Enterprise
Extraction process. Prior to running a full
extraction process, the status is empty. While
the process is running, it provides the ID of
the last node that was processed and the
order of the process – ascending or
descending. The status changes to complete
when the extraction process is finished.
Resume Full Extraction at Specifies the node ID at which the Enterprise
Extraction process will resume.
Tip: This element does not usually

need to be edited, except in special
cases:
• An Extractor can skip a particular
node ID, known to be problematic,
if you enter the next ID after it. For
example, if 5440 was a problematic
node ID, entering 5439 would skip
it, but 5439 does not need to be a
valid node ID.
• Specifying -1 will only cancel the
full extraction process for the
Extractor being edited. On a system
with multiple Extractors, you must
edit them all to cancel the
extraction completely.
Note: This parameter is only available

when the Extractor is stopped.
Command Template Specifies the Template used to generate the
command line for the Enterprise Extractor
process. Do not change this value unless you
are instructed to do so by OpenText
Customer Support.

Element Description
Command Line Indicates the command line that Content
Server uses to run the Enterprise Extractor
process. You cannot change the value of this
field.
Start Directory Specifies the directory in which the
Enterprise Extractor process runs. The
Enterprise Extractor process must always run
in the Content Server_home/bin
directory. Do not change this value unless
you are instructed to do so by OpenText
Customer Support.
Information button Loads the Data Flow Link Management
page, which specifies the directory to which
the Enterprise Extractor process writes data.
Do not change this value unless you have
moved an iPool, or you are instructed to do
so by OpenText Customer Support.
Start Options Specifies the start settings for the Enterprise
Extractor process. When the Enterprise
Extractor process starts, it crawls the Content
Server database, adding and updating data
as necessary.
• Manual, the default option which lets
you start the Enterprise Extractor process
manually whenever you want to recrawl
the Content Server database
• Scheduled, which lets you schedule the
day and time on which the Enterprise
Extractor process runs
• Persistent, which causes the Enterprise
Extractor process to run continuously
By default, the Enterprise Extractor process is
scheduled to run each minute to process
changes that are made to the Content Server
database on a continuous basis. Depending
on your Content Server System, you may
want to change the scheduling interval.

Element Description
Stop Options Specifies the stop settings for the Enterprise
Extractor process. By default, the stop option
is set to Terminate. This is the most
appropriate stop option for the Enterprise
Extractor process. The Maximum Good Exit
Code field specifies the maximum error code
number for which the Admin server will
automatically restart the Enterprise Extractor
process, if it fails. By default, the value of the
Maximum Good Exit Code field is set to -1,
meaning that the Admin server will not
restart this process if it fails. Do not modify
the Maximum Good Exit Code value unless
Customer Support.
Start/Stop Allows you to maintain Data Flows,
depending on its current state. If the process
is running or scheduled to run, the Stop
button appears. If the process is stopped, the
Start button appears.
Resynchronize Resynchronizes information regarding this
process (in the otadmin.cfg file of the
process's Admin Server) with the
information in the Content Server database.
To Configure the Enterprise Extractor Process

To configure the Enterprise Extractor process:
1. On the System Object Volume page, click the Enterprise Extractor Data Source
Folder link.
2. Click the Enterprise Extractor Data Flow Manager link.
3. Click the Functions icon of the Enterprise Extractor process, and then choose
Stop.
4. Click the Enterprise Extractor Process link.
5. On the Specific tab of the Enterprise Extractor Properties page, edit the
parameters of the Enterprise Extractor process.
7. Click the Functions icon of the Enterprise Extractor process, and then choose
Start.

30.5.2 Setting Extractor General Settings

An Enterprise Extractor process is a data flow process that extracts objects and
metadata from Content Server and writes it to a data flow, to update the Content
Server index.
You configure most Enterprise Extractor settings on the Set Extractor General
Settings page, which controls how objects are added to the search index. There are
other settings that may affect Extractor behavior, such as MIME Type exclusions that
are defined in the opentext.ini file.
The Set Extractor General Settings page contains the following controls:
Element Description
General Settings
Log Level Specifies the logging level for Enterprise
Extractor data extraction and indexing. The
logging data is written to the Content Server
thread logs:
• Normal – Specifies the Default logging
level, which means that minimal
Extractor progress is logged.
• Information – Specifies the Verbose
logging level.
• Detailed – Specifies the Debug logging
level, which produces a detailed log for
debugging purposes.
Note: Content Server Debug Level

must be 2 or greater for Extractor
logging to function.
Content Recover Notification When selected, a notification email is sent to
the Administrator when the Extractor fails to
process documents for indexing. The default
is disabled.

Element Description
Maximum Items per Extraction Specifies the maximum number of search
index update requests the Extractor will
process when each individual type of iterator
runs:
• Collections – Processes all the objects in
an entire Collection directly.
• Recovery – Handles re-extraction of items
whose content failed to extract the first
time.
• Re-extract – Handles extracting
Enterprise data in order to create the
initial search index, or when a re-index
operation has been requested using the
Dataflow Manager's Maintenance page
for the Enterprise data source.
• Targeted Updates – Handles updating
Enterprise data in a focused manner,
where only data that pertains to a change
is extracted, rather than all. For example,
extracting only the Relevance scores for
an item, when that information changes.
OpenText Customer Support
recommends you leave this type set at
Normal Extraction, to ensure an updated
index.
• Add / Modify – Handles extracting
Enterprise data for newly added or
updated items. OpenText Customer
Support recommends you leave this type
set at Normal Extraction, to ensure an
updated index.
• Initiated Workflows – Handles
extracting the task information for
Workflows steps that are in progress.
This information exists in the search
index for the duration of the Workflow
steps, then is automatically removed.
• All others – The Extraction Types in
Content Server are extensible. This is a
catch-all setting for any older or optional
types that may not appear on this page.
For each type of iterator use the drop-down

list to select a processing option:
• Normal Extraction – Extraction proceeds
as normal.
• Pause Extraction – Extraction for this
iterator will not occur. Items in the
iterator's queue will remain, and the
queue will be allowed to grow.

Element Description
Tip: This option should only be
used temporarily, for example, to
allow other iterators to process
more data.
• Discard Indexing Requests – Extraction
for this iterator will not occur. Items in
the iterator's queue will be cleared
periodically to prevent it from filling up.
(Not available for Re-extract.)
Tip: This option can be used on an

ongoing basis.
Every iterator has a maximum number of

items per extraction request, the Item Count.
The default for each is 5000.
Every iterator has a state, the Options. The

states may be:
• Normal Extraction
• Pause Extraction
• Discard Indexing Requests
Maximum Versions to Extract Specifies the maximum number of versions
per document that should be processed in an
extraction request. It is possible that more
versions may be in the search index.
Note: If this setting is too low, it may

lead to incorrect information stored for
older versions, most notably two
different versions being marked as the
current version. The extraction of older
versions is required in order to update
common information across all
versions of items, like modified dates,
user information, and the current
version. Values below 10 are not
recommended.
Include Access Control Lists When selected, Access Control List (ACL)
permission information is added to the
dataflow and search index.
Note: Including ACL information is

generally not recommended. ACL
extraction reduces indexing
performance, and usually does not
provide value for typical installations.

Element Description
EFS Object Content There are two ways that objects stored in the
Enterprise File System can be presented to
the Document Conversion Server for
indexing:
• allowing DCS to directly read from the
EFS is usually faster. The files are not
deleted. Best practice is to ensure that the
Admin Server has read-only permission to
the EFS.
• embedding a copy of the file is preferred
when security must be maximized, or
when DCS does not have read access to
the EFS
Non-EFS Object Content The most common non-EFS storage systems
are Enterprise Library or Archive Server.
Objects extracted from these sources for
indexing by DCS can be embedded in iPool
messages, or placed in a temporary work
area.
If selecting a temporary work area, the File

Path specified must be accessible by each
Admin Server, and Content Server, and the
Document Conversion Server. For details,
see “Passing object content through data
flows” on page 491.
iPool Limits
Total Size Specifies a limit, in MB, on the maximum
total size for all embedded object contents
included in an iPool. This setting does not
specify an iPool size limit for the iPool
message itself.
iPools can have a total size of more than 2

GB, and the DCS can process iPool messages
that are larger than 2 GB on 64–bit systems.
Any positive integer is valid, and there is no

maximum value for this parameter. The
default is 1999 MB.
Note: If an object that exceeds the limit

is written to the iPool, the Extractor
closes the iPool message and proceeds
to the next message.

Element Description
Single Item Content Size Specifies a limit, in MB, on the maximum
size for single embedded object contents that
will be written to an iPool. This setting does
not specify an iPool size limit for the iPool
message itself.
iPools can have a total size of more than 2

GB, and the DCS can process individual
items in iPool messages that are larger than 2
GB on 64–bit systems.
Any positive integer is valid, and there is no

maximum value for this parameter. The
default is 1024 MB.
Note: If an object that exceeds the limit

is written to the iPool, the Extractor
closes the iPool message, and proceeds
to the next message.
Number of Items Specifies the maximum number of extracted
items that the Enterprise Extractor process
groups into a single iPool message. iPool
messages contain the information that an
index needs to remain up-to-date. For
example, requests to update or delete
indexed items. Typically, values in the range
of 100 to 500 are recommended.
If you set the number of items too low, the

overhead for iPool management and
indexing transactions can slow down the
indexing process. If this value is too high, the
size limits for iPool messages are likely to be
exceeded.
Exclusion Settings
There are a number of settings available to control which objects should be extracted and
represented in the search index. Objects that are excluded will have neither their content nor
metadata indexed.
The number of Objects currently excluded are shown for each type.
Item Types Click the edit / review list link to access
“Configuring Excluded Item Types”
on page 494 to see or add other items, and
for more information about item types.
Volume Types Click the edit / review list link to access
“Configuring Excluded Volume Types”
on page 495 to see or add other items, and
for more information about volume types.

Element Description
Locations Click the edit / review list link to access
“Configuring Excluded Locations”
on page 495 to see or add other locations,
and for more information about locations.
Rendition Types Click the edit / review list link to access
“Configuring Rendition Types” on page 496
to see or add other rendition types, and for
more information about rendition types.
Note: This setting is only displayed

when a Renditions module is installed
on your Content Server system.
Statistics Gathering Settings
Enable Statistics Gathering When selected, information about the
Enterprise Extractor data extraction and
indexing processes is collected as they are
running. Statistics Gathering is enabled by
default. This information will be available on
the Indexing Data Flow Performance
Overview page. For details, see “Monitoring
Extractor Performance” on page 497.
Enable Index Tracers When selected, special marker objects are
injected into the dataflow stream at regular
intervals, then their progress is tracked
through the indexing system to determine
how fresh or stale the search index is.
This information can be used to internally

monitor indexing delays, and may be
utilized in future eDisovery and search
features.
The message Not available with the

current extractor settings is
displayed when the
wantdescendingextractor setting in the
[LivelinkExtractor] section of the
opentext.ini file is set to TRUE. It must be
set to FALSE to process information from
oldest to newest. For more information, see
“wantDescendingExtractor” on page 170.
Days to Keep Statistics Specifies the number of days over which to
collect data. The default is 7 days.

Passing object content through data flows

EFS Object Content
When you set the EFS Object Content field to use Embed a copy of object content
in iPool messages, External File Store (EFS) object content is embedded in iPool
messages for increased indexing performance.
When you set the EFS Object Content field to Allow DCS to read object content
directly from EFS, the Enterprise Extractor process will extract document content by
referencing the location of the document in the EFS. The Document Conversion
process (DCS) must be able to access the document content using the exact reference.
Non-EFS Object Content
When you set the Non-EFS Object Content field, to use Embed a copy of object
content in iPool messages, Non-External File Store (EFS) object content is embedded
in iPool messages for increased indexing performance.
Non-External File Store (EFS) object content is embedded in iPool messages for
increased indexing performance
When you set the Non-EFS Object Content field to Create a temporary copy of
object content that DCS will delete after processing, the Extractor will use the File
Path location for binary large object (blob) content stored in the relational database
(RDB), and the Archive Server or other third-party storage providers. The Extractor
will process an object's stored content and place it in a temporary file in the File
Path directory.
Note: A temporary location for non-EFS objects should never be used if the
dataflow is split, since only one consumer of the iPool can be responsible for
deleting files from the temporary location.
To Set Extractor General Settings

Configure the Enterprise Extractor Settings link.
2. On the Configure the Enterprise Extractor Settings page, click the Set Extractor
General Settings link.
3. On the Set Extractor General Settings page, in the General Settings section,
choose one of the following log levels in the Log Level drop-down list:
• Normal – Specifies the Default logging level, which means that serious
problems are logged, along with startup and shutdown activities. Minimal
Extractor progress is logged.
• Information – Specifies the Verbose logging level.
• Detailed – Specifies the Debug logging level, which produces a detailed log
for debugging purposes.

Note: Content Server Debug Level must be 2 or greater for Extractor

logging to function.
4. In the Content Recover Notification field, click the check box to send a
notification email to the Administrator when the Extractor fails to process
documents for indexing. The default is disabled.
5. In the Maximum Items per Extraction field, specify the maximum number of
items per extraction request under Item Count (default for each is 5000) for
each iterator:
• Recovery.
• Re-extract
• Targeted Updates
• Add / Modify
• Initiated Workflows
• All others
Under Options, use the drop-down list to select a state for each iterator:
• Normal Extraction
• Pause Extraction
• Discard Indexing Requests
6. In the Maximum Versions to Extract field, type a value for the maximum
number of versions per document that are extracted to the Enterprise [All
Versions] slice.
Click the All versions check box to enable all versions of documents to be
updated when changes are made.
Note: To prevent the Extractor from slowing down the system, the
Maximum Versions to Extract value is limited at the Number of Items
value, even when set to unlimited.
7. In the Include Access Control Lists field, click the check box to place Access
Control List (ACL) permission information into the iPools.
8. In the EFS Object Content field, select a radio button to specify how External
File Store (EFS) object content is processed:
• Embed a copy of object content in iPool messages – embedded in iPool

messages for increased indexing performance
• Allow DCS to read object content directly from EFS – passed through some
stages of data flows as separate files
Note: Data files are referred to in EFS directly, rather than extracted to
disk again. The files are not deleted.

OpenText Customer Support recommends, if this setting is used, that

you set your Admin Server to read-only mode for the EFS, to prevent
data loss.
9. In the Non-EFS Object Content field, select a radio button to specify how object
content that is not External File Store (EFS) is processed:
• Embed a copy of object content in iPool messages – embedded in iPool

messages for increased indexing performance
• Create a temporary copy of object content that DCS will delete after
processing – an object's content is passed through some stages of data flows
as separate files
In the File Path field, type a valid Content Server directory path.
Note: The File Path must be defined for this setting to function. Files
are extracted to disc in this location, and are deleted once processed
further down in the dataflow.
10. In the iPool Limits section, in the Total Size field, specify a limit, in MB, for the
maximum size for document content that will be written to the iPools, for all
objects.
11. In the Single Item Content Size field, specify a limit, in MB, for the maximum
size for document content that will be written to the iPools, for all objects.
12. In the Number of Items field, specify the maximum number of extracted items
that the Enterprise Extractor process groups into a single iPool message.
13. In the Exclusion Settings section, in the Item Types field, click the edit / review
list link to open “Configuring Excluded Item Types” on page 494 to specify the
Content Server item or node types that you want to exclude from extraction.
The number of item types currently excluded is also shown.
14. In the Volume Types field, click the edit / review list link to open “Configuring
Excluded Volume Types” on page 495 to specify the Content Server volume
types that you want to exclude from extraction.
The number of volume types currently excluded is also shown.
15. In the Locations field, click the edit / review list link to open “Configuring
Excluded Locations” on page 495 to specify the Content Server locations that
you want to exclude from extraction.
The number of locations currently excluded is also shown.
16. In the Rendition Types field, click the edit / review list link to open
“Configuring Rendition Types” on page 496 to specify the Content Server
rendition types that you want to exclude from extraction.
The number of rendition types currently excluded is also shown.

17. To enable gathering of Extractor performance statistics used in charting search

indexing throughput or diagnosing Extractor performance, check the Enable
Statistics Gathering check box. The default is enabled.
18. To monitor indexing delays, and to generate data that can be included in a Disk
Image Manifest File for eDiscovery, check the Enable Index Tracers check box.
If the message Not available with the current extractor settings is
displayed, then you must set the wantdescendingextractor setting in the
[LivelinkExtractor] section of the opentext.ini file to FALSE to process
information from oldest to newest. For more information, see
“wantDescendingExtractor” on page 170.
19. In the Days to Keep Statistics text box, specify the number of days to collect
data for. The default is 7 days.
20. Click Update to use the settings you defined, or click Reset to Defaults restore
the settings to their state when you opened this page, or Cancel.
Configuring Excluded Item Types

The Configure Excluded Item Types page allows you to specify the Content Server
item or node types that you want to exclude from extraction. Excluding an item type
from extraction means that neither the content nor the metadata associated with the
specified item type are indexed by the Enterprise Extractor process.
If the Content Server item type that corresponds to the specified node type is a
container item, for example a Folder, only the metadata associated with that
container item is excluded from extraction. In other words, the content and metadata
associated with its contents are extracted unless their node types have also been
excluded.
To configure excluded Item Types:
1. On “To Set Extractor General Settings” on page 491, in the Exclusion Settings
section, in the Item Types field, click the edit / review list link.
2. On the Configure Excluded Item Types page, check Select All, or check
individual Item Types to specify the ones the Extractor should exclude from
search indexing operations.
You can “mouse over” individual Item Types to display their ID numbers in the
hover text. This is useful if two nodes have the same name, which is unlikely,
but possible.
3. If you cannot find a Content Server Item Type, look in the Unsearchable Item
Types section to see if it is listed. These objects cannot be indexed, and most of
them are functional Content Server objects that are directly involved in the
search and indexing workflow. They are hard-coded and cannot be selected, but
are displayed here for your information.
4. Click Update to use the excluded Item Types settings you defined, or click
Reset to Defaults to restore the settings to their system default state, as with a
new Content Server installation, or Cancel.

Configuring Excluded Volume Types

The Configure Excluded Volume Types page allows you to specify the volume
types that you want to exclude from extraction. Excluding a volume type from
extraction means that neither the content, nor the metadata associated with the
specified volume type, nor the items that it contains, are indexed by the Enterprise
Extractor process.
Note: Excluding a volume type excludes everything stored in the volume, even
if those nodes would normally be extracted. For example, documents are
normally extracted, but documents that are stored in excluded volumes will not
be extracted.
If you exclude a volume type which is already indexed, the objects remain in
the index. Purging and re-indexing, or running search index verification will
remove these. For details, see “Re-indexing” on page 626, and “Configuring
Index Verification” on page 631.
To configure excluded Volume Types:
section, in the Volume Types field, click the edit / review list link.
2. On the Configure Excluded Volume Types page, check Select All, or check
individual Volume Types to specify the ones the Extractor should exclude from
search indexing operations.
3. Click Update to use the excluded Volume Types settings you defined, or click
Reset to Defaults to restore the settings to their system default state, as with a
new Content Server installation, or Cancel.
Configuring Excluded Locations

The Configure Excluded Locations page allows you to specify Content Server
Folders or Items that you want to exclude from extraction. If the Content Server item
is a container type such as a Folder, the contents of the container are also excluded
from extraction. If you exclude a location after the objects have been indexed, they
will remain in the search index until you purge and re-index the database.
If the Content Server item is a container such as a Folder, the contents of the
container are also excluded from extraction. However, if you exclude a location after
it has already been indexed, the item remains in the index until you perform a purge
and re-index.
To configure excluded Locations:
section, in the Excluded Locations field, click the edit / review list link.
2. On the Configure Excluded Locations page, click the Browse Content Server
button to specify the locations the Extractor should exclude from search
indexing operations.

3. If needed, click the Add Location button, or link, to add more locations.
Click the Remove Location button to remove unneeded locations.
4. Click Update to use the excluded locations you defined, or Cancel.
Configuring Rendition Types

The Configure Rendition Types page allows you to specify the rendition types that
you want to extract and index. A rendition is a version of a document in a different
format. For example, a PDF version of a Microsoft Word document is a rendition of
the original Microsoft Word document. A rendition type is a character string.
Because the source documents for renditions are indexed, indexing the renditions is
often redundant. If you allow certain rendition types to be extracted and indexed, a
user who searches for a document can access both the source and the corresponding
rendition in their search results. This allows users to choose the format in which they
want to view the document.
Note: The Configure Rendition Types page is only available if the Renditions
module is installed. For more information, see OpenText Content Server -
Installation Guide (LLESCOR-IGD).
Indexing a rendition may be very useful if the primary object is an image. For
example, when a version has been converted to text by an optical character
recognition process (OCR), then the rendition is more useful to send to the
index.
To configure excluded Rendition Types:
section, in the Rendition Types field, click the edit / review list link.
2. On the Configure Excluded Rendition Types page, check Select All, or check
individual Rendition Types to specify the ones the Extractor should exclude
from search indexing operations.
3. Click Update to use the excluded Rendition Types settings you defined, or
Cancel.

Monitoring Extractor Performance

The Indexing Data Flow Performance Overview page allows you to monitor the
performance of the search indexing processes. This feature is available by checking
the Enable Statistics Gathering check box in “To Set Extractor General Settings”
on page 491.
Chart View
The default view is comprised of 5 graphs that display key indexing performance
metrics for a period of up to 7 days. The first 3 charts measure total throughput of all
Extractors, based on information gathered at the end of each Extractor run. These
throughput values are displayed as bar charts, measuring the following:
• Items extracted per hour – represents the number of add, delete or metadata
update operations output to iPools.
• Extractor iPool messages created per hour – number of iPool messages output.
When heavily loaded, iPools tend to contain large numbers of indexing
operations. A lightly loaded system may have more iPools, containing fewer
objects per iPool.
• Rows consumed per hour – indicates how quickly the Extractors are processing
indexing requests from Content Server. Note that a single extracted item may be
represented by multiple rows in the DTreeNotify table.
The remaining graphs provide a view into the backlog of pending operations, and
may be useful in understanding where processing bottlenecks may exist. The data
for these charts is sampled on an hourly basis.
• Hourly rows pending – represents the number of indexing requests for the
Extractors to process. If this is the only backlog, you may need to tune or add
Extractors.
• Hourly iPool messages pending – provides a count of the iPools waiting
processing at various indexing steps. The DCS line represents iPools generated by
Extractors and waiting for DCS processing. A backlog here may indicate a need
to scale out DCS. The Update Distributor line represents iPools waiting to be
indexed by the search engine. The Importers line represents iPools generated by
the Index Engines, waiting for consumption by Content Server for operations
such as Intelligent Classification or Prospectors.
Table View
A link in the upper right of this page allows switching between chart and tabular
data views. The table view shows slightly different data, focusing on the most recent
Extractor performance indicators. The values displayed have the same sources and
explanations as the chart view.
• The first table on the page shows an hourly breakdown for the most recent hours.
• The second table shows the throughput averages and totals for the most recent
days.

Diagnostic Data
A link in the upper right allows the detailed data collected for these reports to be
downloaded as a spreadsheet, which will be named extractorstats.csv. In
general, this feature should only be used if detailed diagnosis of Extractor
performance is required. The format of this file is not documented, and is primarily
intended to help Customer Support.
To monitor Enterprise Extractor performance:
1. On “To Set Extractor General Settings” on page 491, in the Statistics Gathering
Settings section, check the Enable Statistics Gathering check box, and in the
Days to Keep Statistics text box, specify the number of days to collect data for.
The default is 7 days.
3. On the Configure the Enterprise Extractor Settings page, click the Monitor
Indexing Data Flow Performance link.
4. Click the Download all data as CSV link to save a spreadsheet with the
Extractor performance information to a file, named extractorstats.csv, in
your Downloads folder.
30.5.3 Configuring the Enterprise Extractor Settings

Using the settings on the Configure the Enterprise Extractor Settings you can modify
the settings that control the Enterprise Extractor processes when it fails to receive
content.
Setting Operations when Content Cannot be Obtained

To set the operations to follow when content cannot be obtained:
1. On the administration page, click the Configure the Enterprise Extractor

Settings link.
2. On the Configure the Enterprise Extractor Settings page, click the Set the
Operations to Follow when Content Cannot be Obtained link
3. On the Set the Operations to Follow when Content Cannot be Obtained page,
select the Enabled check box to allow for the set operations to occur when the
Extractor process when it fails to receive content.
4. In the Stop on Failure section, click the Yes radio button to stop the Extractor
process.
5. In the Number of retry times section, click a value in the drop-down list to
specify the number of times the Extractor process will retry to recover the
content for the failed object.
6. In the Time between retries section, click values in the drop-down boxes to
specify the intervals between the Number of retry times.

7. In the Max number of objects to retry section, click a value in the drop-down
box to limit the number of times the Extractor process will retry to recover the
content.
8. In the Notify level on failure section, click a warning level in the drop-down
box to set the notification level of the failure.
Content Server sends Notification and stops all Enterprise Extractor processes.
30.5.4 Adding a Spider Process

A Spider extracts data from a Spider server which crawls and indexes any number of
Web-based knowledge sources that you specify as being relevant to your
organization, and makes the resulting index available for searching within the
Content Server system's Web interface.
Your users benefit by being able to submit a single search query that searches across
not only the content in the repository, but also content in targeted Web sources.
Users receive a unified set of results and are able to find relevant information
quickly, no matter where it resides.
A Spider can be combined with Content Server’s Prospectors feature to allow users
to automatically discover relevant knowledge in the data sources being crawled.
Note: The Web URLs that will be crawled, and the Project Specifications are
defined on the Spider server, which is installed separately from Content Server.
For information about the Spider server package, contact OpenText Customer
Support.
Spider producer processes may only be added to the Data Flow Manager of
any non-Enterprise data source.
Hit highlighting is not available for Spider search results.
If Content Server and the Spider process are running on UNIX and reside on
different hosts, they must share a cross-mounted drive under the same name.
This is necessary to allow Content Server data flow processes to read from the
directory to which the Spider writes the data it collects. This restriction does
not apply to Windows. On Windows, you need to have drives mapped
between the two hosts. They do not have to have the same drive letter.
For information on adding a Spider process, see “To Add a Spider” on page 502.

To Add a New Spider Data Flow

To add a new Spider data flow:

2. On the Add Item menu, click Spider Data Source.
3. On the Create New Spider Data Source page, in the Common Information
section, in the Processes Prefix field, type the character string that you want to
use as an identifier for the data flow processes.
4. From the Slice Replacement drop-down list, if necessary, click the Content
Server search slice to which multiple projects will be indexed.
5. In the Partitions field, type a number to specify the number of partitions into
which this data source should be divided.
you want the processes that are associated with this Spider data source to listen.
The port number that you specify and the next 12 (at least) consecutive port
partitions that you specify in the Partitions field. Creating a Spider data flow
7. In the Spider Information section, from the Host drop-down list, click the
shortcut of the Admin server on whose host you want the Spider data flow
process to run.
8. In the Write Directory field, type the absolute path of the directory (relative to
the Admin server on which the Spider data flow runs) where you want the
Spider process to write data, or use the Browse button. You must choose a
directory on a drive on a primary Content Server host, and the directory must
differ from the write directories of other Enterprise data sources.
9. In the Spider Servers area, enter the:
• Host name of the Spider server installation. If needed, under Action, click
the Duplicate button to add more Spider servers.
• Port number of the Spider server.
• Password to access the Spider server, if defined.
• Project Specifications for this data source to index. Click the List Projects
link to display a list of Spider Server Projects, and their Port numbers, that
are defined on the Host, and click the ones to include. You can also type the
specification directly, using the format project name, project port,
separated by ; (semi-colon). Or, if needed, you can highlight and delete
projects.

• Under Action, click the Administer Spider Server button to modify

settings on the Spider server, including Web site URLs and crawling
specifications.
• If needed, click the Remove button to remove unneeded Spider server

definitions.
10. In the Intermediate: Document Conversion section, from the Host drop-down
list, click the shortcut of the Admin server on whose host you want the
Document Conversion process to run.
11. In the Read Directory field, type the absolute path of the directory where you
want the Document Conversion process to read data, or use the Browse button.
Specify the directory path as it is mapped or mounted on the host of the Admin
server on which the Document Conversion process runs. This directory must be
the same directory as the Write Directory that you specified in the Spider
Information section.
12. In the Write Directory field, type the absolute path of the directory where you
want the Document Conversion process to write converted data, or use the
Browse button. Specify the directory path as it is mapped or mounted on the
host of the Admin server on which the Document Conversion process runs.
OpenText strongly recommends that you choose a directory on a drive that is
local to the host of the Admin server that runs the Document Conversion
process. This directory must also differ from the write directories of other
Enterprise data sources.
13. In the Consumer: Content Server Index section, from the Host drop-down list,
click the shortcut of the Admin server on whose host you want the Content
Server Index process to run.
14. In the Read Directory field, type the absolute path of the directory where you
want the Content Server Index process to read data, or use the Browse button.
Specify the directory path as it is mapped or mounted on the host of the Admin
server on which the Content Server Index process runs. This directory must be
the same directory as the Write Base directory that you specified in the Spider
Information section.
15. In the Write Directory field, type the absolute path of the directory where you
want the Content Server Index process to write converted data, or use the
Browse button. Specify the directory path as it is mapped or mounted on the
host of the Admin server on which the Content Server Index process runs.
OpenText strongly recommends that you choose a directory on a drive that is
local to the host of the Admin server that runs the Content Server Index process.
This directory must also differ from the write directories of other Enterprise
data sources.
16. In the Start Options section, select the Start Processes in Data Flow check box,
to start the data flow processes as soon as they are created.
17. Click the Create Processes button. Content Server creates the data flow
processes and displays a Status page.

To Add a Spider
You must create a Spider data flow, described in “To Add a New Spider Data Flow”
on page 500, before you can add a Spider process.
To add a Spider:
1. On the System Object Volume page, click the Spider Data Source Folder link.
2. On the Spider Data Source Folder page, click the Spider Data Flow Manager
link.
3. On the Spider Data Flow Manager page, from the Add Item menu, click
Spider.
4. On the Add: Spider page, in the Name field, type the character string that you
want to use as an identifier for the Spider.
5. In the Description field, type text to provide a description of the Spider on the
General tab of its Properties page.
6. From the Host drop-down list, click the shortcut of the Admin server on whose
host you want the Spider to run.
7. In the Spider Servers area, enter the:
• Host name of each Spider server module installed on your Content Server
system. If needed, under Action, click the Duplicate button to add more
Spider servers.
• Password to access the Spider server, if defined.
• Project Specifications for this data source to index. Click the List Projects
link to display a list of Spider Server Projects, and their Port numbers, that
are defined on the Host, and click the ones to include. You can also type the
specification directly, using the format project name, project port,
separated by ; (semi-colon). Or, if needed, you can highlight and delete
projects.
• Under Action, click the Administer Spider Server button to modify

settings on the Spider server, including Web site URLs and crawling
specifications.
• If needed, click the Remove button to remove unneeded Spider server

definitions.
8. In the Interchange Pool Info section, in the Write Data To field, under iPool
Base Area, type the absolute directory path of the data interchange pool (iPool)
to which you want the Spider to write the index data to.
9. If needed, from the Process drop-down list, select the process that you want to
follow the Spider in the data flow.

10. In the Start Options section, from the Schedule drop-down list, click one of the
following:
• Manual, the default option, which lets you start the Spider process manually
whenever you want to recrawl the specified directories.
• Scheduled, which lets you schedule the time and day on which the Spider
process runs. If you expect the directories that the Spider server projects scan
to change frequently, you can schedule the day and time or interval on
which the Spider process regularly pulls data from the Spider server.
11. Click the radio button that represents when you want the Spider process to run:
• At This Time, which schedules the Spider process to run at a specific time
on certain days of the week. Click values in the time drop-down lists, and
then select the appropriate check boxes to specify the days of the week when
you want the Spider process to run.
• Every, which schedules the Spider process to run at a specific interval. Click
values in the drop-down lists to specify the time units and duration of the
interval at which you want the Spider process to run.
12. In the Stop Options section, type a Maximum Good Exit Code to specify the
maximum error code number for which the Admin server will automatically
restart the Spider, if it fails. Do not modify the Maximum Good Exit Code value
unless you are instructed to do so by OpenText Customer Support.
Configuring a Spider Process

A Spider process is a data flow process that extracts data from one or more Spider
servers, and writes it to a data flow, where it is indexed.
You configure Spider processes on their Properties pages. For example, you can
change the Admin server on whose host the Spider process runs. You can also select
Spider projects for indexing and define their specifications, administer start and stop
options, or resynchronize the process.
The Specific tab of the Spider Properties page:
Element Description
Status Specifies whether the Spider process is
running or not running. You cannot edit this
field.

Element Description
whose host computer the Spider process
runs. Do not change the Admin server
shortcut for the Spider process. The Spider
process must run on an Admin server host
where the Server runs. This is always the
primary Content Server host where the
default (primary) Admin server is running.
Spider Server The available projects on the Spider server
identified by the Host, Port and optional
Password values. Select Spider projects for
indexing in Content Server by clicking them.
• Host name of each Spider server module
installed on your Content Server system.
If needed, under Action, click the
Duplicate button to add more Spider
servers.
• Password to access the Spider server, if
defined.
• Project Specifications for this data source
to index. Click the List Projects link to
display a list of Spider Server Projects,
and their Port numbers, that are defined
on the Host, and click the ones to include.
You can also type the specification
directly, using the format project
name, project port, separated by ;
(semi-colon). Or, if needed, you can
highlight and delete projects.
• Under Action, click the Administer
Spider Server button to modify
settings on the Spider server, including
Web site URLs and crawling
specifications.
•
If needed, click the Remove button to
remove unneeded Spider server
definitions.
command line for the Spider process. Do not
change this value unless you are instructed
to do so by OpenText Customer Support.
Command Line Specifies the command line that Content
Server uses to run the Spider process. You
cannot change the value of this field.

Element Description
iPools Loads the Data Flow Link Management page
when you click the Information button,
which specifies the directory to which the
Spider process writes data. Do not change
this value unless you have moved an iPool,
or you are instructed to do so by OpenText
Customer Support.
Log File Specifies the absolute path of the log file,
where Content Server records the activity of
the Spider process. If this field is empty,
logging is turned off.
Debug Level Specifies the level of logging (Default,
Verbose, or Debug) that is applied, if
logging is turned on.
• Default, which specifies that the log file
only records errors. This is the minimum
log level.
• Verbose, which specifies that the log file
records the status of messages that are
flowing through the processes and data
interchange pools (iPools) of the data
flow. It also records errors.
• Debug, which specifies that the log file
records detailed information about data
flow status and errors. Due to the large
amount of data that is generated,
OpenText recommends that you only use
the Debug level when you are diagnosing
serious problems with the data flow.
Schedule Represents when the Spider process is
scheduled to run:
• At This Time, a specific time on certain
days of the week.
• Every, a specific interval.
Maximum Good Exit Code The maximum error code number for which
the Admin server will automatically restart
the Spider, if it fails. Do not modify this
value unless you are instructed to do so by
Process Allows you to maintain Data Flows,

Element Description
Option Resynchronizes information regarding this
process's Admin Server) with the
Update Submits changes made on this page to the
Server.
Reset Resets the information on this page to its
state when opened.
To Configure the Spider Process

To configure the Spider process:
1. On the System Object Volume page, click the Spider Data Source Folder link.
2. Click the Spider Data Flow Manager link.
3. Click the Functions icon of the Spider process, and then choose Stop.
4. Click the Spider Process link.
5. On the Specific tab of the Spider Properties page, edit the parameters of the
Spider process.
7. Click the Functions icon of the Spider process, and then choose Start.
30.5.5 Configuring a Directory Walker Process

Directory Walker processes extract data from a set of files on your file system and
write the data to a data flow, where it is indexed.
After you create a Directory Walker process, you can modify the crawling
parameters and directories that the Directory Walker process scans. If you modify
this information, you must rerun the Directory Walker process to walk your file
system again using the new information. Rerunning the Directory Walker process
updates the index by adding new files, updating existing files, and removing deleted
files.
To walk the specified directories again without modifying the parameters of the
Directory Walker process, click the Functions icon of the corresponding data flow
manager, and then choose Resume. You can also walk directories again by clicking
the Functions icon of the Directory Walker process, and then choosing Start.
The following table describes the elements on the Specific tab of the Directory
Walker Properties page.
The Specific tab of the Directory Walker Properties page

Element Description
Status Specifies whether the Directory Walker
process is running or not running. You
cannot edit this field.
whose host computer the Directory Walker
process runs. If you change this value, you
may also have to perform one of the
following operations:
• Modify the write directory path.
• Move the write directory. If you move the
write directory, you must also change the
read directory of the data flow's
Document Conversion process.
Do not change the Admin server shortcut for
the Directory Walker process unless
necessary (for example, if the Admin server
host is no longer available).
messages. If it returns an error message,
Content Server records the message in the
database. System management is enabled by
default. For more information about
configuring Content Server to send you
email alerts when this or other data flow
processes encounter errors, see“To Enable
on page 569.
command line for the Directory Walker
Customer Support.
Server uses to run the Directory Walker
field.
Start Directory Specifies the directory in which the Directory
Walker process runs. The Directory Walker
process must always run in the Content
Server_home/config directory. Do not

Element Description
iPools Allows you to access information about the
write directory of the Directory Walker
process. The write directory is the directory
to which the Directory Walker process writes
data. Do not change the write directory
unless you move the location of the iPool or
Customer Support.
Log File Specifies the absolute path of the log file,
where Content Server records the activity of
the Directory Walker process. If this field is
empty, logging is turned off.
Log Level Specifies the level of logging (Default,
Verbose, or Debug) that is applied if logging
is turned on.
log level.
Crawl History Database Location Specifies the path of the crawl history
database files, which store information about
the directories that the Directory Walker
process scans. When a Directory Walker
process walks a set of directories that were
previously walked, it compares the crawl
history database files to the files that are
currently stored in the directory to locate
new, updated, or deleted files. The Directory
Walker process extracts information about
added, replaced, or deleted files to the data
flow. It does not extract the entire file set
again, which makes index updating more
efficient.

Element Description
Directory Groups Specifies the directory groups that the
Directory Walker process scans. Each
directory group contains the names of the
directories that the Directory Walker process
scans. It also contains the types of files that
the Directory Walker includes and/or
excludes when scanning the directories, the
subdirectories that the Directory Walker
process scans, as well as the date and size
range of the corresponding files. You can
add, modify, or remove directory groups
after a Directory Walker process is created.
Start Options Specifies the start options for the Directory
Walker process. When the Directory Walker
process starts, it crawls the directories that
you specified, adding and updating data
according to the current content of the
directories.
• Manual, the default option, which lets
you start the Directory Walker process
manually whenever you want to recrawl
the specified directories.
day and time on which the Directory
Walker process runs. If you expect the
directories that the process scans to
change frequently, you can schedule the
day and time on which the Directory
Walker process regularly recrawls the
directories.
• Persistent, which causes the Directory
Walker process to run continuously.

Element Description
Stop Options Specifies the stop options for the Directory
Walker process. There are three stop options:
• Terminate, which shuts down the process
immediately—without allowing it to stop
gracefully.
• Stop Message Port, which causes the
default Admin server to send a shutdown
message to the port on which the
Directory Walker process runs. This
shutdown message instructs the
Directory Walker process to stop
gracefully. The value that you specify in
this field is appended to the command
line when you update the settings on the
Specific tab of the Directory Walker
Properties page. This is the default stop
option for the Directory Walker process.
• Stop Executable, which specifies an
executable file that instructs the process
to stop.
The Maximum Good Exit Code field
specifies the maximum error code number
for which the Admin server will
automatically restart the Directory Walker
process if the process fails. OpenText
recommends that you set the Maximum
Good Exit Code for a Directory Walker
process to 99. Do not modify the Maximum
Good Exit Code value unless you are
instructed to do so by OpenText Customer
Support.
Start/Stop Allows you to maintain Data Flows,
Resynchronize Resynchronizes the information about this
process's Admin server) with the information
in the Content Server database.
Update Submits the changes that you make on this
page to the Content Server server.
state when opened.

To Configure a Directory Walker Process

To configure the parameters of a Directory Walker process:
Folder link of the data source folder that contains the Directory Walker process
that you want to configure.
3. Click the Functions icon of the processes_prefix Directory Walker process, and
then choose Stop.
4. Click the processes_prefix Directory Walker link.
5. On the Specific tab of the Directory Walker Properties page, edit the parameters
of the Directory Walker process.
7. Click the Functions icon of theprocesses_prefix Directory Walker process, and

then choose Start.
30.5.6 Configuring an XML Activator Process

You can perform most administrative tasks relating to an XML Activator process on
the Specific tab of its Properties page. The Specific tab of the Properties page for an
XML Activator process contains a number of different fields, which the following
table describes:
The Specific tab of the XML Activator Properties page
Field Description
Status Specifies whether the XML Activator process
is running or not running, and gives brief
information if the process is not running.
You cannot edit this field.
whose host computer the XML Activator
process runs. If you change this value, you
may also do one of the following:
• Modify the write directory path.
• Move the write directory. If you move the
write directory, you must also change the
read directory of the data flow's
Document Conversion process.
Do not change the Admin server host, unless
you have a compelling reason to do so (for
example, the Admin server host is no longer
available).

Field Description
on page 569.
command line for the XML Activator
Customer Support.
Server uses to run the XML Activator
field.
Start Directory Specifies the directory in which the XML
Activator process runs. The XML Activator
process must always run in the Content
Server_home/config directory. Do not
iPools Allows you to access information about the
XML Activator process's read and write
directories. The read directory is the
directory from which the XML Activator
process reads data. The write directory is the
directory to which the XML Activator
process writes data. Do not change the read
or write directories unless you move the
location of the iPool, or you are instructed to
do so by OpenText Customer Support.
Log File Specifies the path of the log file. If this field is
empty, logging is turned off.

Field Description
Log Level Specifies the level of logging (Default,
Verbose, or Debug) that is applied, if
logging is turned on.
log level.
Outgoing Directory Specifies the directory to which the XML
Activator process writes data as XML files.
Schedule Specifies when the XML Activator process
runs. Choose:
• Manual, the default option, to start the
XML Activator Process manually.
• Scheduled, to specify the day and time
on which the XML Activator process
runs. If you expect the incoming directory
to be updated frequently, you can
schedule the day and time on which the
XML Activator process regularly recrawls
the directory. For example, you could
schedule the XML Activator to run every
minute. OpenText recommends that you
schedule the XML Activator to run.
• Interval, to schedule the XML Activator
process to run at a specific interval. Click
values in the drop-down lists to specify
the time units and duration of the
interval.
Resynchronize To Resynchronize Data Flow Processes the
information regarding this process (in the
otadmin.cfg file of the process' Admin
server) with the information in the Content
Server database.
Update Submits changes made on this page to the
Server.

Field Description
Reset Reset the information on this page to its state
when opened.
For more information, see “Requirements for XML Activator Files” on page 580.
To Configure an XML Activator Process

To configure an XML Activator process:
Folder link of an index for which you would like to configure an XML Activator
process.
2. Click the processes_prefixData Flow Manager link.
3. Click the Functions icon of the XML Activator process, and choose Stop.
4. Click the name of the XML Activator process.
5. On the Specific tab of the XML Activator Properties page, Configuring an XML
Activator Process of the process.
7. Click the Functions icon of the XML Activator process, and choose Start.
30.5.7 Configuring Document Conversion Processes

The Document Conversion process is an intermediate data flow process in an
indexing data flow in Content Server. You create indexing data flows when you
create a data source's index. The Document Conversion process is automatically
added to an indexing data flow for a data source that you create using Content
Server Templates. When you create a data source by adding its components
individually, you can add a Document Conversion process to an indexing data flow.
After you add a Document Conversion process to an indexing data flow, you can
configure it.
Document Conversion processes read the data that the previous data flow process
outputs from a data interchange pool (iPool), and then converts that data from its
native format to HTML or raw text.
The Document Conversion process converts data to HTML or text using conversion
filters. For more information about the conversion filters used by the Document
Conversion process, see Livelink Search Administration - websbroker Module
(LLESWBB-H-AGD).
In most cases, a Document Conversion process converts the following data:

• Data that the Enterprise Extractor Process extracts from the Content Server
database

• Data that the an XML Producer Process collects from third-party applications
• Data that the a Directory Walker Process extracts from your file system
• Data that a Content Server Spider process extracts from the Web
• Data that a Lotus Notes Extractor process extracts from Lotus Notes databases (if
you purchase and install the Activator for Lotus Notes module)
Note: Excel 97 documents that contain extremely long hyperlinks do not

always filter to HTML properly.
After the Document Conversion process has converted data to HTML or text, it
writes the data to an iPool. The Update Distributor reads this data and distributes it
to the Index Engines. Index Engines use the converted data to update or create the
corresponding index. For information about modifying Update Distributors or Index
Engines, see “Configuring Indexing Processes” on page 587.
You can customize the Document Conversion process in each indexing data flow.
Customizing a Document Conversion process involves understanding and selecting
conversion filters, configuring the command line arguments, and setting the process
parameters on the Document Conversion Properties Page.
The Specific tab of the Document Conversion Properties Page displays the following
information and settings:
Element Description
Status Specifies whether or not the Document
Conversion process is running.
whose host computer the Document
Conversion process runs. Do not modify the
Admin server shortcut for the Document
Conversion process unless necessary (for
example, if the Admin server host is no
longer available).
on page 569.
Command Line

Element Description
command line for the Document Conversion
process. Do not modify this value unless you
Customer Support.
Server uses to run the Document Conversion
process. You cannot modify the value of this
field.
Start Directory Specifies the directory in which the
Document Conversion process starts. The
Document Conversion process must run in
the Content Server_home/filters directory. Do
not modify this value unless you are
Support.
Temporary Directory Specifies the directory where DCS temporary
files are written. For:
• Switch – type -tmpdir.
• Value – type the absolute path of the
directory, for example, -tmpdir c:
\opentext\temp
Tip: If Temporary Directory is not

specified, DCS uses the TMP
environment variable, so OpenText
highly recommends you configure this,
and on UNIX operating systems, you
use the /tmp directory.
Additional Command Line Specifies the optional arguments that you
want to add to the command line for the
Document Conversion process. You must
type the names and values of the arguments
that you want to add or change by
separating multiple argument/value pairs
with spaces: -argument value -argument
value.

Element Description
IPools Opens the IPool Information page, which
specifies the directory from which the
Document Conversion process reads data,
and the directory to which it writes data. Do
not modify these values unless you move an
iPool, or you are instructed to do so by
The Sub Area column identifies the working

locations used to read and write data. For
more information, see “iPool quarantine for
Data Flow processes” on page 564.
Start Options
Schedule Specifies the start settings for the Document
Conversion process:
• Manual – lets you start the Document
Conversion process manually whenever
you want it to run
• Scheduled – lets you schedule the time
and days when the process runs
• Interval – lets you schedule the interval
at which you want the process to run
• Persistent – allows the process to run
continuously. If the process terminates
unexpectedly, its Admin server restarts it
automatically.
Stop Options
Stop Message Port Specifies the stop settings for the Document
Conversion process. By default, Content
Server sends a shutdown message to the port
specified and then shuts down the process
properly. Do not modify this setting unless
Customer Support.
Maximum Good Exit Code Specifies the maximum error code number
for which the Admin server will
automatically restart the Document
Conversion process, if it fails. By default, the
value of this field is set to -1, which means
that the Admin server does not restart the
Document Conversion process if it fails. Do
not modify this setting unless you are
Support.
Actions
Process Allows you to Stop or Start Data Flows.

Element Description
Option Resynchronizes information about this
process's Admin server) with the
Update Submits the changes you make on this page
to the Content Server server.
state when opened.
To Configure a Document Conversion Process

To configure the Document Conversion process:
Folder link of a data source that contains the Document Conversion process that
you want to configure.
3. Click the Functions icon of the processes_prefix Document Conversion
process, and then choose Stop.
4. Click the processes_prefix Document Conversion link.
5. On the Specific tab of the Document Conversion Properties page, edit the
parameters of the Document Conversion process.
7. Click the Functions icon for the processes_prefix Document Conversion
process, and then choose Start.
30.5.8 Counting and extracting metadata

The settings in the [DCSmetadata] section of the dcs.ini file control how Content
Server provides a framework for supplementing extracted metadata with counts of
definable patterns, for example when creating a Collection. The dcs.ini file is
located in the <OTHOME>\config directory.
These patterns are important when responding to Freedom of Information Act

(FOIA) or eDiscovery type requests, since there are often restrictions on what
information can be collected and delivered to external entities. There are potential
privacy issues that may exist in some countries, so many documents that contain
personally identifiable information may need to be omitted or will require redaction.
These settings provide a flexible way to allow your users to add definitions for new
extracted regions based on simple pattern matching in full text context.
There are two types of metadata users can define. The OTCount_ prefix counts how
many instances are found in the content. The OTMETA_ prefix lists the metadata. With
xxxxxx being a user defined name, OTCount_XXXXX=[regular expression], the

DCS will search based on the regular expression, where the prefix OTCount_ must be
defined. Examples of useful pattern definitions are:
OTCount_PHONE=\b(($?[01]*$?)?([\s\-\/\.\_])?($?[\dlsSoO]
{1,3}$?)?)?([\s\-\/\.\_])?[\dlsSoO]{3}([\s\-\/\.\_])?[\dlsSoO]{4}
(([\x58\x78])*[\dlsSoO]{2,4})?\b
if matching results are found, a new region <OTCount_PHONE> will be generated, and
with a value equal to the number of results found.
Other examples are:
OTCount_CreditCard=\b(?:3[47]\d{2}([\ \-]?)\d{6}\1\d|(?:(?:4\d|
5[1-5]|65)\d{2}|6011)([\ \-]?)\d{4}\2\d{4}\2)\d{4}\b
OTCount_SSN=^[\dlsSoOI]{3}(\s)*(\-)*(\s)*[\dlsSoOI]{2}
(\s)*(\-)*(\s)*[\dlsSoOI]{4}\s
OTCount_SIN=^[0-9lsSoO]{3}(\-)*[0-9lsSoO]{3}(\-)*[0-9lsSoO]{3}\s
For the other type of pattern that lists metadata, with xxxxxx being a user defined
name, OTMETA_XXXXX=[regular expression], the DCS will search content based on
the regular expression, where the prefix OTMETA_ must be defined. Examples of
useful pattern definitions are:
OTMETA_HASHTAG=[\s]#([\da-zA-Z])
if results are found, a new region <OTDOC_HASHTAG> will be generated, with a value
equal to the number of all hashtag results found.
You could also define user ID as:
OTMETA_UserID=[\s]+@([A-Za-z0-9]+)
For more information, see OpenText Content Server User Online Help - Using
Collections (LLESCL-H-UGD).
The [DCSmetadata] section of the dcs.ini file contains the following parameters:
• “maxMetadataLength” • “maxPatternResults” • “metadataSearchInSubtyp

on page 519 on page 520 es” on page 521
• “maxMetadataResults” • “maxPatternSearchLength • “minMetadataLength”
on page 520 ” on page 520 on page 521
• “maxMetadataSearchLen
gth” on page 520
maxMetadataLength
• Description:
Specifies the upper limit for metadata length.
• Syntax:
maxMetadataLength=50

• Values:
maxMetadataResults
• Description:
Specifies the maximum number of results DCS will return.
• Syntax:
maxMetadataResults=10
• Values:
maxMetadataSearchLength
• Description:
Specifies the limits of the document content range where DCS will search.
• Syntax:
maxMetadataSearchLength=1000
• Values:
maxPatternResults
• Description:
Specifies the maximum number of results the DCS will return.
• Syntax:
maxPatternResults=1000
• Values:
maxPatternSearchLength
• Description:
Specifies the maximum length, in bytes, the DCS will search for a given pattern.
• Syntax:
maxPatternSearchLength=5000
• Values:

metadataSearchInSubtypes
• Description:
This optional parameter specifies the subtypes DCS will search for.
• Syntax:
metadataSearchInSubtypes=144
• Values:
Content Server subtypes, separated by a , (comma) or ; (semi-colon) or a space.
The default value for this optional parameter is empty, so there is no restriction
on subtypes.
minMetadataLength
• Description:
Specifies the lower limit for metadata length.
• Syntax:
minMetadataLength=3
• Values:
An integer greater than, or equal to, one. The default value is 3 (inclusive). By
default, this excludes cases like #1, #2, ...
30.5.9 Configuring OLE and Exif metadata

Object Linking and Embedding (OLE) is a program-integration technology that is
supported by all Microsoft Office programs. OLE allows information to be shared
among different programs. The Exchangeable image file format (Exif) contains
numerous tags for storing interchange information in digital photography image
files.
The settings in the [DCSIm] section of the dcs.ini file enable OpenText Document
Filters to provide smaller configurable subsets of OLE and Exif metadata. For
information about detecting and converting items of various formats, see “OpenText
Document Filters” on page 523. The dcs.ini file is located in the <OTHOME>
\config directory.
The OLE and EXIF specific tags are added to the metadatatags.txt and to the
htmlToOTTag.mapping files, which are also located in the <OTHOME>\config folder.
OLE and Exif tags are defined in the [COMMON], [OLE], and [EXIF] sections of the
metadatatags.txt file, and more tags will be added in future releases of Content
Server.
The tags in the [COMMON] section are extracted for both the outputEXIFinfo and for
the outputOLEinfo parameters. The two settings' possible combinations will extract
these tags:

Settings Exif - true Exif - false

Metadata tags in Metadata tags in [COMMON], [OLE],
OLE - true
metadatatags.txt list only plus all Exif metadata
All metadata tags in the document or
Exif tags in [EXIF], plus all non-Exif
OLE - false in the image file (no filters are
metadata
applied)
These parameters are defined in the [DCSIm] section of the dcs.ini file:
outputEXIFinfo
• Description:
Defines how metadata tags listed in the [EXIF] section of the metadatatags.txt
file will be extracted.
• Syntax:
outputEXIFinfo=true
• Values:
When outputEXIFinfo=true only listed metadata tags are retrieved. When
outputEXIFinfo=false, all metadata tags are retrieved.
outputOLEinfo
• Description:
Defines how metadata tags listed in the [OLE] section of the metadatatags.txt
file will be extracted.
• Syntax:
outputOLEinfo=true
• Values:
When outputOLEinfo=true only listed metadata tags are retrieved. When
outputOLEinfo=false, all metadata tags are retrieved.

30.5.10 OpenText Document Filters

The Document Conversion Service in Content Server uses filter packs to convert
items from their native file formats (for example, Microsoft Word, Microsoft Excel,
or Adobe PDF) to text for indexing, and HTML, SVG or raster images for viewing. It
can also generate thumbnails for Content Server. DCSs are controlled by the Admin
servers.
The OpenText Document Filters (OTDF) detect and convert items of the following
formats:
• Microsoft Word 95-2013
• Microsoft Excel 95-2013
• Microsoft PowerPoint 97-2013
• Microsoft Project 95-2007
• Adobe PDF
• CAD formats such as CADRA, DXF, DWF, DWFx, and IGES, etc.
Word, Excel, MSG and RTF formats are converted to HTML, while other formats are
converted as raster images when View as Web Page is selected. Calcomp, CGM,
DGN, DWF, DWG, DXF are converted to SVG while other formats are converted as
raster images when View as Web Page is selected.
The complete list of supported formats is specified in the latest Content Server
Release Notes.
For information about configuring a DCS, see OpenText Content Server - Installation
Guide (LLESCOR-IGD). Additional information about OpenText Document Filters
and OpenText Desktop Viewer documentation is available on the OpenText
Knowledge Center (https://knowledge.opentext.com).
If you have any further questions, please contact OpenText Customer Support.
Text Extraction, View as Web Page, and Thumbnail Generation

OpenText Document Filters (OTDF) is the library that communicates with DCS to
detect MIME types, provide text extraction, metadata extraction, View as Web Page
and thumbnail generation.
The library forwards TextExtraction, MIMEtype detection, View as Web Page and
thumbnail generation requests from DCS to OpenText Document Filters through the
use of filenames or buffer content. All text extracted by OTDF is returned to DCS
using UTF-8 encoding.
OpenText Document Filters uses temporary files in a configurable temporary

storage location. OTDF will use the tmpdir setting in the TmpDir=directory-path
parameter in the [FilterEngine] section of the opentext.ini file as its temp
directory location, instead of the previously used Temp Dir setting in the image.ini
file.

When a file buffer is received for a format that OTDF does not support buffer load
for, a temporary file is created and used by OTDF while converting the buffer
content. The name of the temporary file has the pattern
dcsxxxxxx_inDDMMYYHHMMSSimfilter_threadId. Each file is uniquely identified
using the day, month, year, hour, minute, second it was created, and the processing
thread identifier, for example dcsxxxxxx_in170610124733imfltr_6184. The file is
removed by OTDF when the conversion process is finished.
When a file is too large to return by buffer for pure indexing, or if a View as Web
Page request is made, an output file is created and used by OTDF and then passed
back to the DCS. The name of this file has the pattern
dcsxxxxxx_outDDMMYYHHMMSSimfilter_original-file-name.
The _x value is an additional unique identifier to accommodate multiple output files

for a single conversion.
All temporary files prefixed with dcs are deleted when the conversion is complete.
MS Word, Excel, and PowerPoint
The Hong Kong Character Set (HKCS) is supported on Windows only.
OTDF text extraction for indexing includes text from hidden objects and comments.
RTF
OTDF will extract the following types of embedded files from RTF documents on the
Windows, Solaris, and Linux operating systems:
• Word 97-2003
• RTF
• Excel 97-2003
• PowerPoint 97-2003
Metadata update
OTDF support default and custom metadata updates for:

• Word 2007, and later
• Excel 2007, and later
• PowerPoint 2007, and later
• PDF
MS Excel
The calculated numeric indexes along axes of charts are not supported for text
extraction, but Labels for the axes will be extracted. For example, a bar chart with
values explicitly marked on the graph will be extracted. However, if the bar height is

8.5 and in Excel the y-axis shows “12, 10, 8, 6, 4, 2, 0”, Document Filters will not
extract these numbers.
Open Office formats
OpenText Document Filters (OTDF) accept data from the Open Office formats that is
passed from a buffer or a file, to handle text and metadata extraction on the
Windows, Solaris and Linux platforms. The following formats are supported:
• Text data and metadata:
• Open Office Writer – odt, template ott

• StarWriter – sxw, template stw
• Open Office Calc – ods, template ots
• StarOffice Calc – sxc, template stc
• Open Office Draw – odg, template otg
• StarOffice Draw – sxd, template std
• Open Office Impress – odp, template otp
• StarOffice Impress – sxi, template sti
• Metadata only:
• Open Office math - odf

• StarOffice - sxm
MetaData Extraction
Metadata is information accompanying each Content Server item, for example, the
date that a document was created. Metadata is returned to the Document Filters as a
separate parameter (DIHS_META_DOC_INFO) at the time of TextExtraction.
During the time of TextExtraction, the filter extracts metadata, but does not remove
the data from the content returned by OTDF.
The filter recognizes HTML tags in the metadata and converts them to OT mapped
tags. A mapping of HTML to OT tags is kept in an XML file (htmlToOTTag.mapping)
located in the OTHOME\config folder. If the file cannot be found or opened, then the
original HTML tags are used.
The types of information that are extracted and returned to the DCS as metadata are
defined in the metadatatags.txt file.
The default names of metadata tags with the OT prefix are modified by adding
mappings to the htmltoOTTag.mapping file. For example, to rename the OTDocTitle
document title metadata tag to CS16, enter:
OTDocTitle = CS16DocTitle

PDF files that contain compressed cross referenced table documents are supported.
The metadata in compressed cross-reference tables and cross-reference streams
(XRefStm), can be extracted with standard or custom metadata fields.
Metadata is extracted for all the formats listed in the latest Content Server Release
Notes.
Streaming Document Conversion
When streaming is enabled, all browser client requests to view a document as

HTML are retrieved from Content Server by the servlet through streaming. The
server then streams the file to an Admin server's DCS process for conversion. The
DCS then streams the converted content to the servlet for delivery to the requesting
client browser.
For information about deploying and configuring LLServlet, see Deploying and
Configuring LLServlet in the Content Server Installation Guide.
MIME types
The list of MIME (Multipurpose Internet Mail Extensions) types that Content Server
recognizes is contained in the mime.types file. Certain optional modules add MIME
types to the mime.types file when they are installed. In addition, users can modify
the mime.types file by adding, deleting or editing entries.
By default, Content Server recognizes approximately 100 MIME types. You can
modify the list of MIME types that Content Server recognizes by editing the Content
Server home/config/mime.types file. The MIME types in this file are the ones that
appear in the MIME Type drop-down list on the Specific tab of a document's
Properties page.
When items are added to Content Server, the default MIME type detection relies on
the following sequence:
1. Browser identification.
2. Item file extension.
3. DCS process.
Generating Thumbnails
On new and upgraded installations of Content Server, Document Filters (OTDF) can
generate Thumbnails when indexing Content Server documents or objects. Specific
MIME types can be configured to create a thumbnail of the first page of a document.
This thumbnail can be used on Document Overview, large icon views, Search
Results pages, and in featured items in Content Server. All Thumbnails generated
by Document Filters are in the JPG format.
The MIME type must be defined in the [Thumbnail] section of the dcsrules.txt
file. For more information, see “DCSrules.txt file for Windows, Linux, and Solaris”
on page 530. Further rules for generating thumbnails are defined in the [IMTHUMB]
section of the dcsrules.txt file.

You must select the MIME types on the Configure Thumbnail MIME Types page
for thumbnail generation to work. For details, see “Configuring Thumbnail Options”
on page 44.
OpenText recommends you also specify the All Thumbnails Storage Provider Rule
on the Configure Storage Providers page to store thumbnails. This page is accessed
from the Content Server Administration page, by clicking the Configure Storage
Providers link in the Storage Provider Settings area. For details, see “Configuring
Storage Providers” on page 352.
Note: If other Rules appear before the Thumbnails Rule, then thumbnails may
be stored in different Storage Providers, for example, if mimetype is 'png' or
Size of file in bytes is greater than '1048576'. For more information,
see “Configuring Storage Rules” on page 355.
The file types and versions OTDF can use to generate thumbnails by default are
listed in the latest Content Server Release Notes. All file types are supported on
Windows, Linux, and Solaris.
Installing OpenText Document Filters

OpenText Document Filters (OTDF) is a core module of Content Server and is
installed automatically.
By default, DCS operations are governed by the following rules files: dcsrest.txt
and dcsrules.txt. The dcsrules.txt file contains the rules for indexing and
generating thumbnails in Content Server. Which DCS rules file(s) you copy depends
on the conversion capabilities that the custom filter pack supports. The dcsrest.txt
controls viewing and highlighted text for Search Results.
The installation process installs a new dcsrules.txt file and dcsrest.txt file in
the Content Server_home\config-reference folder. For upgrade releases you
should review the new files and make changes accordingly to your dcsrules.txt
and dcsrest.txt files.
Thumbnails support
The [DCSipool] section of the opentext.ini file controls options specific to the
configuration of data interchange pools, iPools, for the Document Conversion
Service. This section also contains several definitions needed for generating
thumbnails. More information is available in “[DCSipool]” on page 111. These
settings are part of the Content Server installation, and generally should not be
modified:
• lib=dcsipool – The name of the library the DCS should load.

• ThumbnailLocation=XXX – The temporary location where thumbnails are stored
during processing. For example, F:\OPENTEXT\CS105/tmp.
• Thumbnailpixelx=200 – the width of the generated thumbnail in pixels. The
default is 200.

• Thumbnailpixely=200 – the height of the generated thumbnail in pixels. The

default is 200.
• Thumbnailformat=JPG – the format the generated thumbnail will be saved in
• Thumbnailpagerange=1— the page range of a document or object thumbnails
will be generated for
Operating Systems
OpenText Document Filters is supported for Content Server, on Windows, Solaris,

and Linux 64-bit environments.
The Filters is supported on these platforms:

• Windows Server 2008 SP2, and Windows Server 2012
• Solaris 10 and 11
• Red Hat Enterprise Linux 6.x platforms.
For detailed information about supported operating systems, see the latest Content
Server Release Notes.
Document Filters on Solaris
On the Solaris 11 operating system, Xvfb is required. Xvfb is included on the Live
Media, and more information is provided by Oracle Corporation on the UNIX
Implementation Details (http://docs.oracle.com/cd/E23824_01/html/E24456/
gljrf.html) page of their website.
The OpenText Document Filters installation program does not overwrite the
dcsrules.txt file and dcsrest.txt file, but sample files with suggested
configurations are provided for you as examples in the Content Server_home
\config\config-reference folder.
Document Filters on Linux
OpenText Document Filters is a core module of Content Server, and is installed

automatically on 64-bit Linux environments.
The following libraries are required, so you must verify the following libraries are
installed:
• xorg-x11-server-Xvfb
• libXrender

Verifying the installation
The verify_im_filter.sh script is available for Solaris and Linux installations of

OpenText Document Filters (OTDF), beginning with Content Server 10.5, Update
2014-03. The OTDF team will generate a script, upon request, for other releases of
Content Server.
The verify_im_filter.sh script will diagnose your issues where Content Server is
running, but the DCSIm process is not executing conversions. The script verifies the
filter is installed correctly and all of the dependencies are installed on your system.
$OTHOME refers to the path to the Content Server installation. The following relative
paths exist in the $OTHOME folder:
• " ./config
• " ./lib
• " ./filters/image
To verify the installation:
1. Browse to this script in the $OTHOME/filters/image folder.
2. Open a terminal window, and change to the $OTHOME/filters/image folder

and execute the script.
3. Redirect the output of the script to a file, for example, >./

verify_im_filter.sh $OTHOME > $OTHOME/verify.txt.
4. Open the verify.txt file to examine the output:
• The “ENVIRONMENT SETTINGS” section of the output lists variables

necessary for the script to execute. If the script produces a number of errors,
examining the “ENV SET” section may provide clues to the cause, such as an
incorrect command line option.
• Dependent libraries which are required on the machine are listed in the
“VERIFY” section. In this section, an ERROR message is included if the
intended library is not found on the machine. Either the library must be
installed by the customer, or the LD_LIBRARY_PATH in start_llserver needs
to include the path to the installed library.
• Another reason for an ERROR message to be included in the “VERIFY”
section is if the required library is found, but the installed version is not the
64-bit version. You will need to install the 64-bit version of the library.
• If the script reports that the Xvfb (Virtual Frame Buffer) is not found and it is
installed, please check the startXVFB.sh script to make sure the path to the
Xvfb is set correctly.
• The “CHECK LIBS” section inspects the filter libraries included with
Content Server. An ERROR message is included if the library is missing or is
not 64-bit. In either case, the appropriate library will need to be installed. A

WARNING message is included if the file permission is not executable. If

the file is not executable, the product will still run. Setting the file permission
to executable is only necessary if all other actions failed to solve the issue.
• If the script runs without a warning or an error, but OpenText Document
Filters still fails to convert documents, there is likely an issue with
configuration.
• Finally, please execute the shutdownXVFB.sh script. This script stops the last
Xvfb process initiated by the current user. In the unlikely event that the Xvfb
process is in a bad state, ending the process may be the solution.
5. Ensure Content Server is restarted before further testing.
DCSrules.txt file for Windows, Linux, and Solaris
The dcsrules.txt file is modified on the Windows, Linux, and Solaris operating
systems to define the rules for indexing Content Server items, and generating
thumbnails. Each rules file also determines the way Document Filters behave if
errors occur during text extraction or conversion.
The Content Server installation program does not overwrite the dcsrules.txt file
in the Content Server_home\config-reference folder, but sample files with
suggested configurations are provided for you as examples in the Content
Server_home\config\config-reference folder.
dcsrest.txt file
The file dcsrest.txt contains the rules for viewing items, finding similar items, hit
highlighting search results, and synopsis and profile generation. Each rules file also
determines the way the DCS behaves if errors occur during document conversion.
The Content Server installation program does not overwrite the dcsrest.txt file,
but sample files with suggested configurations are provided for you as examples in
the Content Server_home\config\config-reference folder.
Most converted documents are displayed in View as Web Page as raster HTML
using the try DCSIMImageView parameter. Word, Excel, or RTF documents are
displayed as HTML which can be searched and indexed using the try
DCSIMAutoView parameter, which automatically defines the optimal HTML.
Library files
The installation program installs the Document Filters filter bridge file, called DCSIM,
to:
• DCSIM.dll in \bin folder on Windows

• dcsim.so in \lib folder on Solaris and Linux
• libraries to the filters\image folder
Several license files are also installed:

product="Zlib libraries"
licenseText="3rdPartyLicense/LICENSE-ZLIB.txt"
product="Apache - Xerces C++"

licenseText="3rdPartyLicense/LICENSE-Apache-2_0.txt"
product="Boost Software"
licenseText="3rdPartyLicense/LICENSE_1_0.txt"
Image.ini file
There are settings defined in the Content Server Document Filters image.ini file in
these sections:
• “[File]” on page 531
• “[Session]” on page 540
• “[System]” on page 540
• “[View]” on page 541
These sections control the color type, format, width and resolution of raster images
generated for HTML documents, and other document conversion operations.
The image.ini file is located in the Content Server_home\filters\image folder,

where Content Server_home is the root of your Content Server installation.
[File]
Note: Some settings in the [File] section cannot be modified because they are
configured internally in the Document Filters (IM Filter) program code.
CGM Page Size=ID, width, length, units
Purpose Defines the size of the CGM page.

To Change Edit the image.ini file.
Values ID = page ID
width = page width in units specified
length = page length in units specified
units = unit of measurement

Default 254,16,11.3,in
DGN MultiPage=1 | 2
Purpose Defines how IM Filter converts DGN files.

To Change This setting is configured internally in the program code so you
cannot change it.

Values 1 = text extraction (indexing)
2 = View as Web Page (HTML output)

Default 1
DGN MultiView=0 | 1
Purpose Defines whether a DGN v8 file displays all available views. This
keyname is ignored if the DGN Multipage keyname is not set.
cannot change it.
Values 1 = text extraction (indexing)
2 = View as Web Page (HTML output)

Default 0
DGN Page Size=ID, width, length, units
Purpose Defines the size of the DGN page.

Values ID = page ID

Default 254,15.6,11,in
DWG Multipage=0 | 1
Purpose Defines whether the IM Filter produces a single or multipage

view of a document.
cannot change it.
Values 1 = single page view
2 = multipage view
Default 0
DXF Page Size=ID, width, length, units
Purpose Defines the size of DXF, DWF and DWG pages.


Values ID = page ID

Default 254,15.3,10.7,in
Enable Hyperlinks=0 | 1 | 2 | 3
Purpose Controls whether to generate the hyperlinks in HTML output for

Word 2007 and Excel 2007 and newer versions.
Values 0 = No hyperlinks are generated in HTML output.
1 = HREF links are enabled.
2 = email links are enabled.
3 = HREF and email links are enabled.

Default 0
Excel Comment View=-1 | 0 | 1
Purpose Defines how the comments or notes attached to a cell, in an Excel

spreadsheet are displayed.
Values -1 = Turn off the comments.
0 = Use Excel setting for comments.
1 = Always turn on the comments.

Default 0
Note Excel Comment View=-1 does not work on Linux and Solaris.
Excel View Mode=0 | 1 | 2
Purpose Defines the mode in which to view and display extracted text in
MS Excel files.

Values 0 = View each worksheet as a single page, and print at its actual
size.
1 = View and print each worksheet as specified in the Excel Print

Setup.
2 = Use a hybrid mode that breaks each worksheet into multiple

pages based on the number of rows and columns. If the number
of rows exceeds 200, or the number of column exceeds 100, the
sheet is split into multiple pages when converting to HTML.
Default 2
HTML image color type=0 | 1 | 2 | 3 | 4
Purpose Defines the color type to use for raster images generated for
HTML documents.
Values 0 = default
1 = 256 colors. (See Notes)
2 = bilevel
3= grayscale. (See Notes)
4= 24-bit true color

Default 4
Notes Used to generate raster HTML images and thumbnails.
For value 1 the image is converted to 256 colors but saved as a

JPG file in 24-bit color type for efficient JPG compression.
For value 3 the image is converted to grayscale and saved as a

JPG file in 8-bit color type.
HTML image format=7 | 50 | 63 | 69
Purpose Defines the format to use for raster images generated for HTML
documents.
Values 7 = BMP (MS Windows Bitmap)
50 = JPG (JFIF - Baseline JPG)
63 = PNG (Portable Network Graphics). (See Notes)
69 = JPG (JFIF - JPG Q1 (low lossless compression))

Default 63

Notes Used to generate raster HTML images and thumbnails.
On Solaris, 8-bit bilevel PNG color depth output is generated by

downgrading 32-bit pixel map input. OpenText Document Filters
can downgrade a true color pixel map input to other color
depths, such as 8-bit 256-color, grayscale and bilevel.
Downgrading will cause 256-color and bilevel images to have
lower quality output caused by the color mapping so OpenText
recommends you do not use these settings. However, grayscale
output generates an acceptable quality of color type output.
HTML image maximum width=width
Purpose Defines the maximum width of raster images generated for

HTML documents.
Values The width value in pixels.
Default 2880
Notes Used only when the width and height values passed by the API
call parameter are both “0”. If either the width or height are
greater than 0 this setting is not used.
Used to generate raster HTML images only.
HTML image width=width
Purpose Defines the width of the HTML img tag when Content Server
Document Filters is generating raster HTML output.
Values The width value in pixels.
Default 1440
For example, a setting of 1440 produces the output <IMG

Width=1440 src="html_image.PNG"/>.
Notes Used only when the width and height values passed by the API
call parameter are both “0”. If either the width or height are
greater than 0 this setting is not used.
Used to generate raster HTML images only.
IGS View Mode=0 | 1
Purpose Defines the initial display style of IGES images as either 2D

projection mode or 3D model mode.

Values 0 = IGES files will be displayed in 2D mode
1 = IGES files will be displayed in 3D model mode

Default 0
PDF Library Disable=number
Purpose Enables or disables the use of the PDF Add-on library for parsing
and rendering PDF documents.
Values 0 = The "Use PDF Add-on" option is enabled. The PDF Add-on is
enabled and the document is parsed and rendered using the PDF
Add-on library.
1 = The "Use Native PDF" option is enabled. The PDF Add-on is

disabled and the document is parsed and rendered using Native
PDF support, not the PDF Add-on library.
2 = The "Use Threshold-Based Switching" option is enabled. The

PDF Add-on is enabled. Parsing and rendering depends on the
bilevel raster area threshold set by the PDF Library Threshold
keyname:
• If, on the first page of the document, the area of the largest
bilevel raster is greater than the percentage area set in the
PDF Library Threshold, the document is parsed and rendered
using Native PDF support.
• If, on the first page of the document, the area of the largest
bilevel raster is less than the percentage area set in the PDF
Library Threshold, the document is parsed and rendered
using the PDF Add-on library.
Note: The bilevel raster area is calculated by finding the

largest sized raster and calculating the ratio of raster
size to page size.
Default 1
Word Changed Formatting Color=number
Purpose Defines the color of reformatted text.


Values 24-bit RGB color
The number assigned to color attributes is calculated using the

red, green, and blue components of the color, according to the
following formula:
RGB = (R*65536) + (G*256) + B
where R, G, and B are numbers from 0 to 255 assigned to the red,

green, and blue colors.
Default 16777215 (foreground)
Note Only available when “Word Display Tracked Changes” is
enabled.
Word Changed Formatting Mark=0 |1 | 2 | 3
Purpose Defines the style of reformatted text.

Values 0 = None
1 = Bold
2 = Italic
3 = Underline
Default 3
enabled.
Word Changed Lines Color Mark=number
Purpose Defines the color of changed lines.


following formula:
RGB = (R*65536) + (G*256) + B

enabled.
Word Changed Lines Mark=0 | 8 | 9 |10

Purpose Defines the style of changed lines.

Values 0 = None
8 = Left Border
9 = Right Border
10 = Outside Border
Default 8
enabled.
Word Deleted Text Color=number
Purpose Defines the color of deleted text.


following formula:
RGB = (R*65536) + (G*256) + B

enabled.
Word Deleted Text Mark=number
Purpose Defines the style of deleted text.


following formula:
RGB = (R*65536) + (G*256) + B



enabled.
Word Display Tracked Changes=0 | 1
Purpose Defines whether tracked changes in MS Word are displayed.

Values 0 = Do not display tracked changes.
1 = Display tracked changes.

Default 0
Note Tracked changes is supported for Word 2003 and earlier versions.
Word Inserted Text Color=number
Purpose Defines the color of inserted text.


following formula:
RGB = (R*65536) + (G*256) + B

enabled.
Word Inserted Text Mark=0 |1 | 2 | 3
Purpose Defines the style for inserted text.

Values 0 = None
1 = Bold
2 = Italic
3 = Underline
Default 2
enabled.
Word Show Hidden Text=0 |1

Purpose Defines whether hidden text is displayed.

Values 0 = Do not show hidden text
1 = Show hidden text

Default 1
Word Show Highlight=0 |1
Purpose Defines whether highlights applied to text are displayed.

cannot change it.
Values 0 = Do not show highlights
1 = Show highlights
Default 1
[Session]
Merge DPI=resolution
Purpose Defines the resolution value.

Values resolution = resolution value
Default 400 dpi
[System]
Disable Setting Write=0 | 1
Purpose Defines if Content Server Document Filters can write to the

image.ini file.
Values 0 = setting changes are written
1 = setting changes are not written

Default 1
Enable File Download=0 | 1
Purpose Defines whether the file download feature is turned on or off in a

DOC/DOCX parser when a file is stored at a remote location.

Values 0 = Disable file download from the internet.
1 = Download from the internet.

Default 0
Note Available only on Windows operating systems, and only for MS
Word documents.
Splash Screen=0 | 1
Purpose Defines whether the Content Server Desktop Viewer splash

screen appears on startup.
Values 0 = do not display the splash screen
1 = display the splash screen

Default 0
Maximum Number Of Pages In Memory=number
Purpose Defines how many pages of multipage documents are kept in

memory.
Values 0 = Keep all pages loaded in memory
1 = Unload all pages but the current one
n (any other integer) = Unload all pages but the current one and
the last (n - 1) pages viewed
Default 1
[View]
Detail Level=0 | 1...10
Purpose Defines the detail level in JP2 files used for View as Web Page
and thumbnail generation.
Values 0 = Detail level is not set, so the default level in the initial load of
the JP2 files is used
1 to 10 = Where 1 means use minimum, and 10 means use

maximum detail level
OpenText recommends setting this value to 8 for View as Web

Page and generating thumbnails.
Default 0

Note Setting a low detail level value will result in a low resolution
image, with faster load speed and decreased memory usage. A
high detail level value will achieve high resolution, with slower
load speed and higher memory usage.
For information about other settings in the image.ini file refer to the Content
Server Desktop Viewer System Administrator Help.
Language support
The language support for OpenText Document Filters (OTDF) is based on your
Content Server installation, and provides text extraction for the formats specified in
the latest Content Server Release Notes. Text Extraction is supported for all
languages with Unicode-based formats such as Microsoft Office formats.
The supported language groups are format specific for non-Unicode-based formats:
• Western
• Eastern European
• Far Eastern
• Arabic
• Hebrew (for Word 2007 and 2010 documents)
• Thai (for Excel and PowerPoint 2007 to 2013 documents) for Windows only
• Other groups
Note: On UNIX operating systems, only Western languages are supported for
View as Web Page - Text and for View as Web Page - Raster.
UTF-8 Version of Content Server
Unicode supports many languages equally well, regardless of the alphabet they use.
In addition to U.S. English (the default), Content Server Enterprise Server UTF-8 is
available in French, German, and Japanese. The Japanese version of Content Server
is available only in the UTF-8 encoding.
Adobe PDF
The primary filter used to extract text from PDF documents is XPDF, while for Hit
Highlighting and View as Web Page the primary filter is DCSIm.
OpenText Document Filters (OTDF) support text extraction from PDF documents
and PDF Unicode and ASCII metadata for PDF versions 1.0 - 1.9. The Filters will
extract all the visible text and keep it in context. Words that are displayed vertically
or diagonally will also be extracted and indexed, as well as special characters.
Invisible text and markup text such as notes and annotations are also extracted.

Document Filters can load PDF files, for versions 1.5 - 1.9, that are password
protected with AES 128-bit encryption, but have read permissions. Also to do text
extraction, View as Web Page, and generate thumbnails.
Note: Text in images, raster objects, and 3D objects will not be extracted.
The PDF format handles fonts and languages differently than the other text formats.
OTDF have been verified to correctly support text extracted from the various
language groups with different fonts, including:
• Russian
• Romanian
• Polish
• Croatian
• Czech
• Serbian
• Arabic
The extracted PDF text is enhanced for words, new lines and paragraph spacing to
improve readability when displayed on a monitor or printed.
Format Support
The file types and versions the OpenText Document Filters support by default are
listed in the latest Content Server Release Notes. All file types are supported on
Windows, Linux, and Solaris, except where indicated.
Note: See “Text Extraction limitations” on page 544 for detailed information
about the types of items and text entities that are not supported in this version
of OpenText Document Filters.
Supported items and text entities
Text is successfully extracted from documents of most formats and supported

operating systems, including these types of items and text entities:
• Charts in PowerPoint 2007, 2010 and 2013 files.

• tables in PowerPoint documents are supported to display features such as:
• cell shading effects

• border effects such as bevel, shadow, and reflection
• background information such as theme colors and background fills,
background pictures, gradients, and texture
• cell shading, cell horizontal merge and cell vertical merge

• new types of shapes for PowerPoint 2007, 2010 and 2013 are supported,
including:
• left up arrow, right up arrow, bent up arrow, circular arrow, left arrow, right
arrow, bent arrow, u-turn arrow
• quad arrow, and quad arrow callout
• heart, donut, block arc, “no” symbol
• For MSG format files, indexing, View as Web Page and Thumbnail generation
are supported.
In Content Server 16, the Thumbnail feature is disabled by default. You can
enable it by selecting the check box for application/x-outlook-msg on the
Configure Thumbnail MIME Types page. For details, see “To Configure
Thumbnail Options” on page 44.
• The Visio XML format, versions 2013 and later, (application/vnd.ms-
visio.drawing (.vsdx)) is supported for text extraction and View as Web Page
Text Extraction limitations
There are several types of items and text entities that are available in their native file
formats that are not supported by the TextExtraction process, so they cannot be
viewed or indexed in Content Server.
Text in these types of items and text entities is not supported in the current version
of the DCS:
• symbols in MS Word documents
• charts in Excel 95 documents
• tables in Excel 95 documents
• for details about how data in Excel 2007 documents is processed, see “MS Word,
Excel, and PowerPoint” on page 524
• charts in PowerPoint 97–2003 documents.
• images in any documents
• encrypted (password protected) files will have their MIME type detected, but
text extraction will not be processed
• digitally signed email
• BINHEX encoded email used by the Mac OS
• text extracted from the IGES format is available only on the Windows operating
system
• CGM reader uses HBITMAP (handle to a bitmap) to create images, so this format
is available for text extraction, but not for View as Web Page
• Path gradient fill is not supported in document conversion on Solaris because of
a limitation of the libgdiplus library, which is used for rendering. Radial
gradient fill is used instead when boundary colors are the same.

The Mozilla Public License requires that modifications made to their obtained
source code be identified. For the libgdiplus 2.6.104 library, OpenText has
modified a previously unnamed union in the win32structs.h file so it is now
named MfHeader in order to compile the source code.
• Progressive JPG and JPEG 2000 (JP2) files are only supported for View as Web
Page and thumbnail generation on Windows, not on Solaris or Linux.
• Rendering of translucent filled objects on Solaris is limited by the rendering
technology. To simulate translucent fill, 50% alpha blending is used for the
translucent filled object. On Windows, the objects are bolder for this case.
• The filter recognizes the MPEG-2 and MPEG-4 MIME types only. MPEG2 audio
files recognition is not supported. MPEG-4 recognition includes multiple variants
such as mp4, m4v, m4a, and f4v.
Symbols in Symbol fonts
A Symbol font does not have an encoding for its glyphs so the symbols in a Symbol
font have only physical representation, but not logical representation. They are not
associated to Unicode characters and are meaningless when separated from their
font. During the TextExtraction process fonts are not associated to text in the result
so symbols in a Symbol font cannot be indexed and searched.
Note: This applies to any formats that may use symbols in Symbol fonts, such
as MS Office formats.
Standard compliant browsers do not support symbol fonts such as Symbol and
Wingdings, so View as Web Page maps these characters to Unicode characters
that the browser should support. If you view documents using the View as
Web Page feature, OpenText recommends you have the Arial Unicode MS and
Segoe UI Symbol fonts installed to ensure the browser can render Symbol and
Wingdings correctly.
These are examples of Symbol fonts: Bookshelf Symbol 7, CityBlueprint,

CommercialPi BT, CountryBlueprint, EuroRoman, Marlett, MS LineDraw, MS
Outlook, MS Reference Specialty, MT Extra, PanRoman, Romantic, SansSerif,
SuperFrench, Symbol, Technic, TechnicBold, TechnicLite, UniversalMath1 BT,
VisualUI, Webdings, Wingdings, Wingdings 2, Wingdings 3.
Error messages
The error and information log messages the OpenText Document Filters may
generate during the document conversion process are listed in “Error and
information log messages” on page 546. These messages are provided to DCS for
display in either the dcs_xxxx.log (xxxx is the port number) or dcsview_0.log
files.

Table 30-3: Error and information log messages
Message Meaning Type

Messages during filter initialization
DCSIM::DihsModuleInit OTIniFile Openimage.ini could not be found. Error
param not given
DCSIM::StartIM Loading IM dlls Starting IM Filter. Info
DCSIM::StartIM Could not retrieve dll DCS did not provide the dllpath for the Error
path from params Imagenation libraries.
DCSIM::StartIM Failed to load Could not find IMscore library in the Error
IMScore.dll at %s (%s = library path) path.
DCSIM::StartIM Failed to load Could not find recognition library. Error
PHX_RecogService.dll
DCSIM::SetOTCONFIG Failed to find Could not determine Content Server Error
OTConfig path path to config folder. The path is
determined by the provided parameter
path of the opentext.ini file.
Metadata::LoadHTLMToOTMapping DCSIM metadata tag names will not be Error
Failed to load htmlToOTTag.mapping mapped to OT recognized tag names.
Metadata::LoadCustomerSelectTags Failed to load selective metadata Tag file. Error
All Metadata tags will be processed.
TextExtractor::GetTextFromCongfile - If the filter failed to determine the Error
OTHOME path not found OTConfig path mentioned in the
DCSIM::SetOTCONFIG Failed to
find OTConfig path message, then
this message is displayed when
attempting to load metadata mapping
files.
TextExtractor::GetTextFromCongfile - Error when attempting to load DCSIM Error
memory allocation failed filter's metadata mapping and select files
(htmlToOTTag.mapping,
metadatatags.txt).
TextExtractor::GetTextFromCongfile - Error when attempting to load DCSIM Error
could not open %s (%s = filename) filter's metadata mapping and select files
(htmlToOTTag.mapping,
metadatatags.txt).
Messages during MIME type detection
IMDetermineMIMEType: Document Displayed if DCS document type is not Error
source type does not support mime type 'File' or 'Buffer'.
detection
IMDetermineMIMEType: Recognition Displayed during a MIME type Error
server threw an exception against file recognition failure.
%s", (%s = filename)


IMDetermineMIMEType: Could not Displayed if Recognition server returns a Error
determine mime type for \"%s\" ", (%s = null or empty MIME type or returns an
filename) error.
MimeDetector::LogError: Lower level
exception caught in Recognition Server
MimeDetector::LogError: Invalid
Recognition parameter
MimeDetector::LogError: Recognition
Server Failed to open a file
Server Failed to allocate memory
requested operation is not valid
Error code messages created by the filter
Server Unable to create trace file
- based on error codes returned by Error
MimeDetector::LogError: Recognition Recognition server.
Server Unable to create log file
Server Unable to open socket
Server Failed trying to seek, read, or
write in an archive
Server Failed trying to decompress
archive data
Server Failed to process request
Messages during TextExtraction detection
_IMConvertToHtml: Could not extract File is encrypted so data cannot be Error
text - File is encrypted extracted.
_IMConvertToHtml: Could not retrieve The document type from DCS is 'File', Error
a valid file name from DCS %s", (%s = but the file name is not available.
filename)
_IMConvertToHtml: Buffer for %s could The document type from DCS is 'Buffer', Error
not be retrieved from DCS (%s = but the buffer is empty.
filename)
_RunFileNameProc: Content Server Content Server had issues processing the Error
Document Filters threw an exception file.
processing %s (%s = filename)


_ReturnTextFromOutputFile: failed to OpenText Document Filters returned the Error
open file %s from IM (%s = filename) extracted content in a file on disk, but the
file could not be read by the filter.
TextExtractor::ExtractMetadata - Metadata could not be found in text Error
ERROR: Could not retrieve all Metadata returned from OpenText Document
Filters.
_IMConvertToHtml: Convertion process Occurs if the DCSIM filter is run as an Error
timed out internal process to DCS, and OpenText
Document Filters takes longer than the
timeout values set in the DCS to process
a request.
_IMConvertToHtml: Convertion process Conversion problem due to memory Error
failed, due to memory allocation allocation issue.
_WriteContentToDCS: Count not read OpenText Document Filters returned Error
file content extracted data in a file, but the filter
cannot read the file content to return
metadata to DCS.
IMFilter error logging
The IMLogger process writes IMFilter log messages to the Image.log file in the bin
\logs\ folder. The IMLogger process is an interface to LOG4CXX which handles
multiple threaded logging. When multiple instances of the IMFilter are running, the
image.log file must be locked to enable writing to it.
You enable or disable logging by editing the IMLOG_Config.txt file. When logging
is enabled you can define the log level in the Log Errors setting in the image.ini
file. For details, see “Image.ini file” on page 531.
30.5.11 Configuring an Importer Process

You configure the parameters of an Importer process to administer the command
line, iPool information, and start and stop options, or to resynchronize the data
associated with the process. You configure Importer processes on their Properties
pages.
The Specific tab of the Importer Properties page
Element Description
Status Specifies whether the Importer process is
field.

Element Description
on page 569.
whose host computer the Importer process
runs. Do not change the Admin server
shortcut for the Importer process unless
necessary (for example, if the Admin server
host is no longer available).
command line for the Importer process. Do
not change this value unless you are
Support.
Server uses to run the Importer process. You
cannot change the value of this field.
Start Directory Specifies the directory in which the Importer
process runs. Do not change this value unless
Customer Support.
page, which specifies the directory from
which the Importer process reads data. Do
not change these values unless you move an
iPool, or you are instructed to do so by
Import Task Definition The task that the Importer performs with the
data that was output by the Update
Distributor process (for example,
Classification).

Element Description
Start Options Specifies the start settings for the Importer
process.
• Manual, which lets you start the Importer
process manually whenever you want it
to run.
day and time on which the Importer
process runs
• Persistent, which causes the Importer
process to run continuously
Start/Stop button Starts or stops the Importer process,
depending on the current state of the
process. If the process is not running, the
Start button appears. If the process is
running or is scheduled to run, the Stop
button is displayed.
Resynchronize button Resynchronizes information about this
process in the otadmin.cfg file of the
process's Admin server with the information
in the Content Server database.
Update button Submits the changes that you make on this
Reset button Resets the information on this page to its
state when opened.
To Configure an Importer Process
To configure the parameters of an Importer process:
Folder link of a data source that contains the Importer process that you want to
configure.
3. Click the Functions icon of the processes_prefix Importer process, and then
choose Stop.
4. Click the processes_prefix Importer link.
5. On the Specific tab of the Importer Properties page, edit the parameters of the
Importer process.
7. Click the Functions icon of the processes_prefix Importer process, and then
choose Start.

30.5.12 Configuring a Merge Process

A Merge process merges the data from two or more data flow processes, and then
passes the data on to the next process in the data flow.
You configure Merge processes on their Properties pages. For example, you can
change the Admin server on whose host the Merge process runs. You can also
enable system object management, modify the start and destination directories,
administer start and stop options, or resynchronize the process.
The Specific tab of the Merge Properties page
Setting Values
Name Specify a name for the Merge.
Description Specify a description for the Merge. This
information appears on the General tab
when viewing the properties of the Merge.
Host Specify the Admin server on whose host you
want the Merge process to run.
Enable System Management Select to allow Content Server to monitor the
status of the Merge process. When enabled, if
the process returns error messages, Content
Server records the message in the database.
Tip: For more information about

configuring Content Server to send
you email alerts when this or other
data flow processes encounter errors,
see “To Enable Error-Checking and E-
Mail Delivery” on page 569.
Read Data From section:
iPool Base Area Specify the absolute directory path of the
data interchange pool (iPool) that you want
the Merge process to read data from.
Process Choose the process that you want to precede
the Merge process in the data flow.
Note: If the data flow already contains

at least one producer or intermediate
process, the names of the processes
appear in the Process drop-down list.
Write Data To section:
Add a Write iPool Optionally, click the Add a Write iPool
button
to configure a second process that follows

the Merge Process.

Setting Values
iPool Base Area Specify the absolute directory path of the
data interchange pool (iPool) to which you
want the Merge process to split data to.
Process Choose the process that you want to follow
the Merge process in the data flow.

at least one intermediate or consumer
Schedule section:
Manual Select Manual if you want the Merge to
process data when initiated by you, or
Scheduled if you want the Merge process to
run automatically.
At this time Set the time in the drop-down lists, and click
the days of the week you want the Merge
process to run.
Interval Select the interval at which you want the
Merge process to run.
Wait Set the values in the drop-down lists to select
the interval at which you want the Merge
process to run.
Persistent Select Persistent which allows the Merge
process to run continuously. If the process
terminates unexpectedly, its Admin server
restarts it automatically.
Maximum Good Exit Code Specify the maximum error code number for
which the Admin server will automatically
restart the Merge process if it fails.
Tip: If you type -1 in the Maximum

Good Exit Code field, the Merge
process will terminate immediately
when it stops. The Admin service will
not restart if the Merge process fails.
Do not modify this setting unless you are

Support.

To Configure a Merge Process

To configure a Merge process:
1. On the System Object Volume page, click the Enterprise Data Source Folder
link.
2. Click the Enterprise Data Flow Manager link.
3. Click the Functions icon of the Merge process, and then choose Stop.
4. Click the Merge Process link.
5. On the Specific tab of the Merge Properties page, edit the parameters of the
Merge process.
7. Click the Functions icon of the Merge process, and then choose Start.
30.5.13 Configuring Proxies

A proxy acts as a placeholder for a process in a data flow. You add a proxy to
represent a process that is not managed by an Admin server. For example, if you
create a custom, non-Content Server process (that creates, manipulates, or consumes
data) to use in a Content Server data flow, you can represent that process in Content
Server using a proxy. You configure proxies on their Properties pages.
Table 30-4: The Specific tab of the Proxy Properties Page
Element Description
whose host the proxy process runs. This is
the Admin server that also controls the other
components in the data flow (for example,
the read and write directories that you
specify). Do not change the Admin server
host unless necessary (for example, if the
Admin server host is no longer available). If
you change the Admin server on which the
proxy process runs, you must also change
the read and write directories that are
associated with the proxy.
page, which specifies the directory from
which the proxy process reads data, and the
directory to which the proxy process writes
data.

Element Description
state when opened.
To Configure Proxy Processes

To configure the parameters of a proxy:
Folder link of the data source that contains a proxy.
3. Click the proxy's Functions icon, and then choose Stop.
4. Click the proxy's name link.
5. On the Specific tab of the Proxy Properties page, edit the parameters of the
proxy.
7. Click the proxy's Functions icon, and then choose Start.
30.5.14 Adding and Configuring a Tee Process

You can add and configure a Tee process to send index data for a data source to
multiple processes in a data flow. A Tee process can be added between any
processes in a data flow. For example, when data is indexed without a Tee in place,
by default the index data is sent from the Extractor process to the Document
Conversion Service iPool. You can add and configure a Tee to send index data to the
Document Conversion Service iPool and to other processes.
Exporting Index Data Using a Tee Process

You can configure a Tee process to direct index data through an iPool process to up
to five iPool output processes that allow indexing of content by external Search
Engines. For example, you can configure a Tee to send index data to an XML
Activator Consumer process so the index data can then be used by specialty
applications, such as eDiscovery products.
Tip: For more information about XML Activator Producer process, see
“Completing an XML Activator Producer Process Setup” on page 450.
You can also specify filter criteria to indicate what content should be sent to the
processes. If filter criteria has been specified and is met, a copy of the content is
made and sent to the specified processes.
Tip: For information on specifying filter values, see “Configuring Tee Filter
Criteria” on page 560.

To Add a Tee
To add a Tee:
1. On the System Object Volume page, click the <prefix> Data Source Folder link of
the data source folder that contains the Data Flow Manager in which you want
to add the Tee process.
2. Click the <prefix> Data Flow Manager link.
3. On the Add Item menu, click Tee.
4. On the Add: Tee page, type a name for the Tee process in the Name field.
5. In the Description field, type a description of the Tee process.
6. From the Host drop-down list, click the shortcut of the Admin server on whose
host you want the Tee process to run.
7. Optionally, select the Enable System Management check box.
8. In the Output Mode field, select the Copy iPool messages to all outputs radio
button to send all iPool messages to several iPool output processes, or
Distribute iPool objects (message content) among all outputs to distribute all
iPool messages among output processes.
Note: When you select the distribute output mode, the Filter Region and
Filter Value fields are disabled in the Write Data To section.
9. In the Read Data From area, in the iPool Base Area field, type the absolute
directory path of the iPool from which you want the Tee process to read data.
From the Process drop-down list, select the process that you want to precede
the Tee process in the data flow.
10. Optionally, in the Write Data To area, click the Add a Write iPool button to
configure up to five processes that follow the Tee process.
In the iPool Base Area field, type the absolute directory path of the iPool to
which you want the Tee process to write data.
In the Process drop-down list, select the process that you want to follow the Tee
process in the data flow.
In the Filter Region field, type the name of the region to be applied as a filter.
In the Filter Value field, type a value valid for the region you specified in the
Filter Regions setting.
11. In the Start Options section, click Manual, or Scheduled, and then do one of
the following:
• From the At This Time drop down lists, set the time and days of the week
you want the Tee process to run.

• Click the Interval radio button, then click values in the drop-down lists to
select the interval at which you want the Tee process to run.
Click the Persistent radio button to allow the Tee process to run
continuously.
12. In the Stop Options section, type a value in the Maximum Good Exit Code
field to specify the maximum error code number for which the Admin server
will automatically restart the Tee process if it fails.
Tip: For more information on the settings available when adding a Tee process,
see “Adding a Tee Process” on page 556.
Adding a Tee Process

A Tee can be added to a data flow manger of a data source. When you add a Tee to a
data flow manger, you can configure the following settings:
Setting Values
Name Specify a name for the Tee.
Description Specify a description for the Tee. This
information appears on the General tab
when viewing the properties of the Tee.
Host Specify the Admin server on whose host you
want the Tee process to run.
status of the Tee process. When enabled, if


Setting Values
Output Mode Select:
• Copy iPool messages to all outputs – to
send all iPool messages to up to five iPool
output processes
• Distribute iPool objects (message
content) among all outputs – to
distribute all iPool messages among up to
five iPool output processes
Note: When you select the

distribute output mode, the Filter
Region and Filter Value fields are
disabled in the Write Data To area.
Interchange Pool Info
Read Data From For iPool Base Area, specify the absolute
directory path of the data interchange pool
(iPool) that you want the Tee process to read
data from.
For Process, choose the process that you

want to precede the Tee process in the data
flow.

at least one producer or intermediate

Setting Values
Write Data To For Add a Write iPool Link, optionally, click
the Add a Write iPool button to
configure up to five processes that follow the
Tee process.
For iPool Base Area, specify the absolute

directory path of the data interchange pool
(iPool) to which you want the Tee process to
split data to.
For Process, choose the process that you

want to follow the Tee process in the data
flow.

at least one intermediate or consumer
For Filter Region, specify the name of any

region. For example, you can specify the
metadata region OTDCategory, and only
objects with the OTDCategory region
applied are filtered to the destination
process.
Tip: For more information about some

metadata regions in Content Server,
see “Defining Index Regions”
on page 726.
For Filter Value, specify a value valid for the

region you specified in the Filter Regions
setting. For example, if you specify the
metadata region OTDCategory in the Filter
Regions setting, and specify the node ID of a
Category in the Filter Value field, all objects
with the OTDCategory region and the
specified category are filtered to the
destination process.
Start Options

Setting Values
Schedule Select:
• Manual if you want the Tee to process
data when initiated by you
• Scheduled if you want the Tee process to
run automatically
For At this time, set the time in the drop-

down lists, and click the days of the week
For Interval, select the interval at which you

For Wait, set the values in the drop-down

lists to select the interval at which you want
the Tee process to run.
Select Persistent to allow the Tee process to

run continuously. If the process terminates
automatically.
Stop Options
restart the Tee process if it fails.
Tip: If you specify -1, the Tee process

will terminate immediately when it
stops, and the Admin service will not
restart if the Tee process fails.

Support.
For instruction on how to add a Tee process, see “To Add a Tee” on page 555.
Note: Only information added to Content Server after you add the Tee process
is sent to the process added to the data flow. To send existing index data to the
process, you must re-index. For more information about re-indexing, see “Re-
indexing” on page 626.

Configuring Tee Filter Criteria
You can specify a filter region and value to control what information is sent to the
destination processes in a Tee process. If you leave these fields blank, all data will be
exported to the destination process.
Setting Value
Filter Region Specify the name of any region. For example,
you can specify the metadata region
OTDCategory, and only objects with the
OTDCategory region applied are filtered to
the destination process.
Tip: For more information about some

metadata regions in Content Server,
see “Defining Index Regions”
on page 726.
Filter Value Specify a value valid for the region you
specified in the Filter Regions setting. For
example, if you specify the metadata region
OTDCategory in the Filter Regions setting,
and specify the node ID of a Category in the
Filter Value field, all object with the
OTDCategory region and the specified
category are filtered to the destination
process.
Tip: You identify the node ID for most

Content Server items in the following
portion of its URL: func=ll&
objid=<value> where <value> is the
node ID.
You may only specify one Filter Region value and one Filter Value for each Write
Data To entry.
Configuring a Tee Process

After you have added a Tee process, you can view and modify the configuration
from the Tee Properties page of the Tee process. In addition to the settings you
specified when creating the Process, you can view or modify the following:
Setting Action
Status Information about the current status of the
Tee process.
Admin Server The name of the Admin server on whose
host you want the Tee process to run.

Setting Action
status of the Tee process. When enabled, if

Output Mode Select:
• Copy iPool messages to all outputs – to
send all iPool messages to up to five iPool
output processes
• Distribute iPool objects (message
content) among all outputs – to
distribute all iPool messages among up to
five iPool output processes
Note: When you select the

distribute output mode, the Filter
Region and Filter Value fields are
disabled in the Write Data To area.
Command Line
Command Template View and modify the command template.
This is a system generated command that
tells the Admin server how to build the Tee
process' command line, and is recorded in
the otadmin.cfg file on the host Admin
server.
Important
Do not change this value unless you
Customer Support.
Command Line The command line that Enterprise Server
uses to run the Tee process.
Start Options

Setting Action
Schedule Select:
• Manual if you want the Tee to process
data when initiated by you
• Scheduled if you want the Tee process to
run automatically
For At this time, set the time in the drop-

down lists, and click the days of the week
For Interval, select the interval at which you

For Wait, set the values in the drop-down

lists to select the interval at which you want
the Tee process to run.
Select Persistent to allow the Tee process to

run continuously. If the process terminates
automatically.
Start Options
restart the Tee process if it fails.
Tip: If you specify -1, the Tee process

will terminate immediately when it
stops, and the Admin service will not
restart if the Tee process fails.

Support.
Actions
Process Click Start, or Stop, to control the Tee
process.
Option Click Resynchronize to rewrite the entry for
the Command Template to the
otadmin.cfg file of the host Admin server.
Note: Only information added to Content Server after you modify the Tee
settings is sent to the process added to the data flow. To send existing index
data to the process, you must re-index. For more information about re-
indexing, see “Re-indexing” on page 626.

For more information on the settings configured when you create a Tee process, see
“Adding a Tee Process” on page 556. For instructions on how to configure a Tee
process, see “To Configure a Tee Process” on page 563.
To Configure a Tee Process

3. Click the Tee Process link for the process you want to modify.
4. On the Tee Specific Properties page, modify the settings for the Tee to reflect
any changes you want to make.
5. In the iPools section, click the More Details link to modify the iPool processes
used in the Tee process.
6. Optionally, click Start to Start the process.
7. Optionally, click Resynchronize to reset the value in the Command Template
field.
8. Click Update.
Tip: For more information about the fields on the Tee Properties page, see
“Configuring a Tee Process” on page 560.
Sending an Item to an iPool Using ipmove

You can use a Tee process and the ipmove process to specify whether to search for a
pattern in the metadata to include or exclude an item from being sent to a particular
iPool.
The ipmove section of the opentext.ini file specifies the path to the message file,
but the ipmove process does not read settings or arguments from the ipmove section.
For more information, see “[ipmove]” on page 164.
The ipmove process reads settings or arguments from the -config file which is
passed to it on the command line, for example:
F:/OpenText/cs1064dev02/bin/ipmove -config F:/OpenText/cs1064dev02/

config/stormskyX9099X18137X67963.ini
A sample of the contents of the stormskyX9099X18137X67963.ini file is:
[ipmove]
ReadArea_1=67746_3
ReadIpool_1=file://F:/OpenText/cs1064dev02/index/enterprise/data_flow
WriteArea_1=67746_4
WriteIpool_1=file://F:/OpenText/cs1064dev02/index/enterprise/
data_flow

OpenText recommends you set the readfields=true parameter for the ipmove
process by editing its Command Template, using the Specific Info tab of the Tee
process in the Content Server user interface. For details, see “To Configure a Tee
Process” on page 563.
To Send an Item to an iPool Using ipmove

3. Click the Tee Process link for the process you want to modify.
4. On the Tee Properties page, modify the settings for the Tee to reflect any
changes you want to make.
5. In the iPools section, click the More Details link to modify the iPool processes
used in the Tee process.
6. Optionally, click Start to Start the process.
7. Optionally, click Resynchronize to reset the value in the Command Template

field.
8. Click Update.
Tip: For more information about the fields on the Tee Properties page, see
“Configuring a Tee Process” on page 560.
30.5.15 iPool quarantine for Data Flow processes

After you have added and configured Content Server data flow processes, you may
find that some process libraries cannot read an iPool. After two unsuccessful
attempts by a data flow process to read the iPool, the iPool can be quarantined to
resolve this issue.
An iPool quarantine occurs on the file level, and the iPool file is made up of one or
more iPool objects. An unreadable iPool file is sent to the data_flow/_failure
directory.
When an iPool is quarantined, a notification is displayed in the Quarantined column

of the Interchange Pools section on the Enterprise Data Flow Manager page of the
System Object Volume, and a notification can be sent by email. OpenText
recommends that you read the iPool quarantine log for details about the cause. For
information about enabling error checking and email delivery, see “Enabling Error-
Checking and E-Mail Delivery” on page 568.

To View Quarantined iPool Information

To view quarantined iPool information:
1. In the Search Administration section of the administration page, click the Open
the System Object Volume link.
Folder link, and then the Enterprise Data Flow Manager link.
3. On the Enterprise Data Flow Manager page, in the Interchange Pools section,
click the link (when the number is greater than 0) in the Quarantined column.
4. On the page that appears, from the IPool File drop down list select the new file
to view.
Information about objects in the iPool is displayed:
• Operation – the iPool operation for this entry

• URN – uniform resource name
• Object Name – name of the object
• Content Size/Location – content size or location
• None – indicates no content
• Inline: NNN – indicates content stored directly in the iPool, NNN is the size
of the inline content, in bytes
• EFS Object Content – indicates content reference
• Non EFS Object Content – indicates content reference temp
5. Click the Add to Collection or the Download as CSV buttons to export the
quarantined iPool. For more information, see “Administering Collections“
on page 895 and “Administering Download as Spreadsheet” on page 723.
30.5.16 Adding E-Mail Recipients

There are five different types of system object alert email messages that Content
Server can send to report the status of objects in the System Object Volume:
• Severe Errors, which notify the recipient of critical system errors such as a Search
Engine shutting down. Severe errors immediately affect a Content Server user's
ability to perform certain Content Server operations.
• Errors, which notify the recipient of general system errors, such as a data flow
process shutting down. Most errors are not immediately critical but can become
severe over extended periods of time.
• Warnings, which notify the recipient of non-critical errors in the system, such as
a data flow that is not responding to data interchange pool (iPool) messages.
Warnings notify recipients of potential error conditions.

• Information, which notify the recipient of general status and other system
information
• Corrections, which notify recipients that a previously reported error has been
rectified. For example, if you configure Content Server to deliver severe errors to
three administrators at your Content Server site, Content Server can also send a
correction message when one of the administrators rectifies the error.
You determine the types of messages that each recipient receives when you
configure system object alert email delivery. You also associate system object alert
email messages with data flow control rules. For more information, see “Adding
Data Flow Control Rules” on page 611.
After you configure system object alerts and email delivery parameters and
configure the mail server that Content Server uses to send system object alert email
messages, you identify the email message recipients. You can configure Content
Server to send system object alert email messages to Content Server users, to the
Content Server administrator, or to any other valid email accounts. If you have not
specified an email address for the Content Server administrator at your Content
Server site, you cannot configure Content Server to send system object alert email
messages to the Content Server administrator.
By default, the Content Server administrator and Admin users will be listed in the
Recipients section of the Configure System Object Alert E-Mail Delivery page. These
users will receive SOV alert emails by default.
You add email recipients by specifying their email address and configuring the
Adding E-Mail Recipients that you want each recipient to receive. After you
configure an email recipient, you can verify the configuration by sending test
messages.
To Add E-Mail Recipients

To add email recipients:
1. On the Configure System Object Alert E-Mail Delivery page, click the Add a
User icon .
2. Type a name for this email configuration in the Configuration Name field.
3. In the Mail To section, do one of the following:
• Click the radio button beside the Find A User icon. Then click the Find A
User icon, search for a Content Server user, and click the Select link in the
Actions column of the Content Server user who you want to receive system
object alert email messages.
• Click the Other radio button, and then type a valid email address,
identifying the email account to which Content Server sends system object
alert email messages.
• If available, click the Content Server Administrator eMail radio button to
send system object alert email messages to the email account that is

currently assigned to the Content Server administrator at the Content Server

site.
4. In the Reporting Options section, select any of the following check boxes:
• Severe Errors, which notify the recipient of critical system errors, such as a
Search Engine shutting down
• Errors, which notify the recipient of general system errors, such as a data
flow process shutting down
• Warnings, which notify the recipient of non-critical errors in the system,
such as a data flow that is not responding to data interchange pool (iPool)
messages.
• Information, which notify the recipient of general status and other system
information
• Corrections, which notify recipients that a previously reported error has
been rectified
5. In the Information Level section, click one of the following radio buttons:
• Detailed Text Message, which provides recipients with a detailed

explanation of the system object alert in plain text format
• Detailed HTML Message, which provides recipients with a detailed
explanation of the system object alert in HTML format
• Short Text Message, which provides recipients with the number of errors
reported in the Content Server system
Note: Design short text messages for recipients who access email from
pagers, cellular telephones, or other hand-held devices.
6. Select the check box beside the days on which you want Content Server to send
system object alert email messages to this recipient.
7. Select the check box beside the hours at which you want Content Server to send
system object alert email messages to this recipient.

30.5.17 Enabling Error-Checking and E-Mail Delivery

Error-checking is the ability of Content Server to monitor the status of the objects
stored in the System Object Volume. When you enable error-checking, you also
configure Content Server to send system object alert email messages which report
the status of the objects in the System Object Volume. Automatic error-checking and
email delivery makes you aware of the general status, potential errors, or problems
that system objects may encounter as processes run. You can configure Content
Server to send email alert messages to Content Server users, the Content Server
administrator, or any other email account.
You enable error-checking if you want Content Server to monitor the status of
objects in the System Object Volume. Content Server records the status or condition
of the system objects and reports this information to the system object alert email
“Adding E-Mail Recipients” on page 565.
Note: If you enable error-checking but do not configure email recipients and
messages, Content Server records errors but does not alert anyone of their
existence.
To enable error-checking and system object alert email delivery, you do the
following:
• Enable Content Server Notification to make the information on the Configure
Notification page (for example, the Content Server home page URL and the
default Content Server database information) available for use in the system
object email alert messages.
• Enable error-checking.
• Configure email recipients and message types.
You disable error-checking if you do not want Content Server to monitor the status
of the objects in the System Object Volume. To disable error-checking for a particular
data flow process or Search Engine, you stop the process or Search Engine, and then
clear its Enable System Management check box. By default, error-checking is
enabled. Then, Content Server monitors the status of all of the objects in the System
Object Volume except those for which system management is disabled. By default,
system management is enabled for all system objects.

To Enable Error-Checking and E-Mail Delivery

To enable or disable error-checking:
1. On the administration page, click the Configure Alert E-mail Delivery link.
2. On the Configure System Object Alert E-Mail Delivery page, select or clear the
Enable SOV Checking check box.
3. Content Server Notification must be enabled for Content Server to send email
alerts. Verify that it is enabled by clicking Configure Notification.
Tip: To make a test connection to your SMTP server, click in the SMTP
Server ID or SMTP Port boxes. When you move your mouse pointer to
another place on the page, a Successful connection to mail server
message should appear beside the SMTP Server ID box. If the message
Failed connection to mail server appears, you can click on the
message for more information about the failure.
Tip: If you want to disable error checking for a particular object in the System
Object Volume, you can clear the Enable System Management check box on
the Specific tab of the object's Properties page.
You can also access the Configure System Object Alert E-Mail Delivery page by
clicking the Configure Alert E-Mail Delivery link on the View System Object
Status page.
30.5.18 Sending Test Messages

To ensure that you set up a recipient's system object alert email configuration
correctly, you can send a test message. If you configure a recipient's email
information correctly, the recipient receives a test system object alert email message.
You can send test messages when you add a new recipient or modify an existing
recipient.
To Send Test Messages

To send test messages:
1. On the administration page, click the Configure System Object E-Mail

Delivery link.
2. On the Configure System Object Alert E-Mail Delivery page, do one of the
following:
• Click the Add a User icon , and then configure the recipient's email
address and message type.
• Click the Edit this user icon beside the configuration for the recipient to
whom you want to send a test message.

3. On the Configuration for the User page, click the Send Test Message button.
30.5.19 Testing System Objects for Errors

Whether you enable or disable automatic system object error-checking, you can test
the Content Server system at any time to determine whether the system objects
return errors.
Note: System objects include the data flows, processes, slices, and Search
Engines in the System Object Volume.
When you test system objects for errors, Content Server generates a system object
error report which lists all of the system objects that are currently returning error
messages, along with the error message text. You can also configure Content Server
to enabling error-Checking and email delivery to the recipients that you configure
on the Configure System Object Alert E-Mail Delivery page. For more information,
see “Enabling Error-Checking and E-Mail Delivery” on page 568.
30.5.20 Viewing the System Object Status

The View system Object Status page contains three sections: Current System Object
Status, Previous Test System Object Runs, and Test the System Objects.
Current System Object Status

You can test your system object for errors at your Content Server site (for example,
the data flows, processes, and Search Engines in the System Object Volume) for
errors. When system object errors are reported, Content Server displays the object
names and the reported errors on the View System Object Status page. If an object
reports an error that prevents the indexing and searching processes from running
successfully (for example, the Admin server is not running), the error is displayed as
Severe.
To return to the administration page, click the Continue button.
Previous Test System Runs

This section provides information about past system object test runs.
By default, a Content Server agent tests the objects in the system volume for errors
every five minutes; however, you can test the system objects at any time when you
suspect that errors exist. Each time a test is performed, Content Server records the
following information in its history:
• Last Update, which is the date and time on which the system was last tested
• Notification, which indicates whether or not the test was run by a Content
Server agent
• Successful, which indicates whether or not the test reported errors

• Time Taken, which specifies the time (in seconds) that were spent running the
test
• Last Message, which specifies the name of the service that executed the test. By
default, this is System Management. If a test is not successful, this field provides a
reason for the failure.
Note: If a system object reports an error, you should investigate the issue and
correct any associated problems. Then, the next time that a system object error
report is generated, a Correction field appears, indicating that a previously
reported error has been resolved.
Test the System Objects

Whether you enable or disable automatic system object error-checking, you can test
the Content Server system at any time to determine whether the system objects
return errors.
Note: System objects include the data flows, processes, slices, and Search
Engines in the System Object Volume.
When you test system objects for errors, Content Server generates a system object
error report which lists all of the system objects that are currently returning error
messages, along with the error message text. You can also configure Content Server
to send system object alert email messages to the recipients that you configure on the
Configure System Object Alert E-Mail Delivery page. You can accessed this page via
the link in the E-mail Report section.
When automatic system object error checking and email delivery is enabled, Content
Server records any error messages returned by the system objects in the Content
Server database. OpenText recommends that you periodically purge the log of
system object error messages from the Content Server database.
To View the System Object Status Page

To view the System Object Status page:
1. In the Search Administration section of the administration page, click the View
System Object Status link.
2. On the View System Object Status page, if errors are present, you can click the
link to the container that has an error.
3. Click the Continue button to return to the administration page.

To Test System Objects for Errors

To test system objects for errors:
2. If you have specified email recipients, select the E-mail Report check box on the
View System Object Status page to send system object alert email messages to
the recipients that you specify on the Configure System Object Alert E-Mail
Delivery page.
3. Click the Test button.
4. Click the Continue button to return to the administration page.
To Purge the Log of System Object Error Messages

To purge the log of system object error messages:
2. On the View System Object Status page, select the Purge History check box, and
then click the Continue button.
30.5.21 Configuring Server Logging

Content Server allows you to log the activities of the Server (llserver), the Content
Server CGI program (Content Server), the Content Server Servlet, and the
Enterprise Extractor process (indexupdate). When debug logging is enabled,
Content Server writes the associated log files to the Content Server/logs directory.
By default, debug logging is disabled.
You set the debug level in the Content Server Debug Level list on the Configure
Debug Settings page. When you change the debug level, the same setting in the
Content Server logging list on the Configure Server Parameters page is modified.
The following table describes how the debug options on the two pages correspond:
Content Server Debug Level setting on Corresponding Content Server logging

the Configure Debug Settings Level page setting on the Configure Server
Parameters Level page
0 No logging
1 Thread logging
2 Detailed thread logging
11 Thread and CGI logging
The following table describes each level of debug logging:

Table 30-5: Debug Logging Levels
Log Level Log Files Generated Description

0 None None of the level 1, 2, or 11
files are generated.
1 llserver.out Generated each time the

Server restarts.
sockserv1.out Generated each time the
Server restarts.
thread<n>.out One file per thread is
generated and continuously
updated to record the data
that the Server sends out on
its threads. The content of
these files is partially
controlled by thread log
options.
2 All Level 1 debug files plus:

receiver<n>.out One file per thread is
generated to record the
activities on the receiver
threads.
11 All Level 2 debug files plus:

llclient<nnn>.out One file is generated each
time an end-user Web
browser sends the Content
Server CGI program a
request. The number <nnn> is
generated by Content Server.
servletclient<nnn>.out One file is generated for each
thread number (as
determined by your Servlet
container's Java Virtual
Machine). Each time an end-
user Web browser sends the
Content Server Servlet a
request, a new
servletclient<nnn>.out file is
created. If a file with that
number (<nnn>) already
exists, the request's
information is appended to
the end of the existing file.

Log Level Log Files Generated Description

llindexupdate<nnn>.out One file is generated each
time the Enterprise Extractor
starts(once per minute). The
number <nnn> is generated
by Content Server.
indexupdateOut<nnn>.out One file is generated each
time the Enterprise Extractor
stops(once per minute). The
number <nnn> is generated
by Content Server.
You can set values on the Configure Debug Settings page to enable or disable
logging for the Content Server server and to configure thread log options.
The number of thread<n>.out and receiver<n>.out files is equal to the number of

threads on which the Server runs. If you are diagnosing a problem, you can
temporarily set the Server to run on a single thread. This allows you to find
diagnostic information in a single file. Because running on a single thread severely
impairs the performance of the Server, OpenText recommends that you run in
single-thread mode during periods of low usage only and that you return the Server
to its original thread setting after you complete your diagnosis.
Caution
In Microsoft Windows Server 2008 and later, log files written by Content
Server may appear to be zero bytes in size until the Content Server services
are restarted.
log4cxx Logs
The log4cxx connect logs are controlled independently. The log4cxx logs are
turned on and off by the new opentext.logfile.enableconnect setting in the
<Content Server_HOME>/config/contentserver.logging.properties file.
All other connect logs are turned on and off by the wantLogs setting in the
opentext.ini file. For more information, see “wantLogs” on page 181.

To Configure Server Logging

To enable or disable Server logging and set thread log options:
1. On the administration page, click the Configure Debug Settings link.

2. On the Configure Debug Settings page, select one of the following numbers
from the Content Server Debug Level list:
• 1, which enables the creation of Level 1 logging files (thread<n>.out,

sockserv1.out, and llserver.out)
• 2, which enables the creation of Level 2 logging files (Level 1 +
receiver<n>.out)
• 11, which enables the creation of Level 11 logging files (Level 2 +
llclient<nnn>.out, servletclient<nnn>.out, llindexupdate<nnn>.out, and
indexupdateOut<nnn>.out)
• 0, which disables debug logging
3. To add timing information (how long it took to perform the logged action) to
the thread logs, select the Log Content Server Timings box.
4. To add information about environment variables to the thread logs, select the
Verbose logging box.
5. To add information about the actions of system objects, including those actions
relating to search Queries and results, select the Add Search and System Object
Logging to Thread Logs box.
6. Click Update.
7. Restart the Content Server server on the primary Content Server host.
30.5.22 Enabling SQL Connection Logging

You can enable SQL connection logging when you want to record the
communication that occurs between the Server and the Content Server database.
You enable SQL connection logging by turning on connection logging on the
Configure Debug Settings page.
The number of connectn.log files is equal to the number of threads on which the
Server is running. If you are diagnosing a problem, you can temporarily set the
Server to run on a single thread. This allows you to find diagnostic information in a
single file. Because running on a single thread severely impairs the performance of
the Server, OpenText recommends that you run in single thread mode during
periods of low usage only and that you return the Server to its original thread
setting after you complete your diagnosis.
Content Server allows you to record the communication that occurs between the
Server and the Content Server database. When enabled, Content Server writes
database connection logs to connectn.log files in the Content Server_home/logs
directory. By default, database connection logs are disabled.

Note: Database connection logs can increase in size quickly. OpenText

recommends that you enable connection logging if it is required to diagnose a
problem, but that you disable it as soon as the problem is solved.
To Enable SQL Connection Logging

To enable database connection logs:
2. On the Configure Debug Settings page, select the Log Connections check box.
This modifies the same setting as the SQL Logging check box on the Configure
Server Parameters page.
4. Restart the Content Server server on the primary Content Server host.
30.5.23 Configuring Admin Server Logging

When the Admin server on a primary or secondary Content Server host starts for the
first time, Content Server creates the admserv.log files in the Content
Server_home/logs directory. You can modify the log settings for the Admin server
on the primary Content Server host by setting new log values on the Configure
Debug Settings page. If you want to change the logging settings for Admin servers
on secondary Content Server hosts, you must edit the Content Server_home/config/
opentext.ini file on the secondary host. For more information about Admin servers,
see “Resynchronizing Admin Servers” on page 423.
You can modify the settings on the Configure Debug Settings page to change the
default logging options for the Admin servers on a primary Content Server host. By
default, Content Server writes all logging information for the Admin servers on a
primary Content Server host to a log file named admserv.log, which is stored in the
logs directory of the primary Content Server installation. You can change the name
and location of the Admin server log file if you want to record this information in a
different file and/or location. You can also change the default logging level or
modify the settings on the Configure Debug Settings page to specify whether you
want to record the data stream between the Server and the Admin server.
Admin Server logging is important for troubleshooting the external processes used
by Content Server. Indexing and Search rely on executables that are managed by
Admin Servers. Admin Servers also provide remote file system access which is
critical to maintaining configuration files for clustered search deployments. Process
start, stop, update, and delete operations and file accesses are all recorded in the log
file.

To Configure Admin Server Logging

To configure Admin server logging on the primary Content Server host:
2. To specify the name and/or location of the Admin server log file, select the Log
File check box in the OTAdmin ( Admin Server) section, and then type the
absolute path of the file in the corresponding field.
3. To specify the of the Admin server log file, click one of the following values in
the drop-down list:
• 1, which sets default logging

• 2, which sets verbose logging
• 3, which sets debug logging
4. To log the data stream flowing from the Server to the Admin server, select the
Input Log File check box, and then type the absolute path of a log file in the
5. To log the data stream flowing from the Admin server to the Server, select the
Output Log File check box, and then type the absolute path of a log file in the
7. Restart the Admin server on the primary Content Server host.
30.5.24 Configuring Content Server Search Logging

If you want to record the search activity in your Content Server system, you can set
search logging. Search logging records search Queries and results. You can
configure Content Server to record search logs in one or both of the following files:
• Content Server_home/logs/threadn.out, where n is a thread number. To write
search logs to the threadn.out files, you must also configure Server logging. For
more information, see “Configuring Server Logging” on page 572.
• Content Server_home/logs/search.log

To Configure Content Server Search Logging

To enable search logging:
2. Select the Log Search Queries and Results check box to record search Queries
and results in the Content Server_home/logs/search.log file.
3. To add search logs to the Content Server_home/logs/threadn.out files, select the

Add Search and System Object Logging to Thread Logs check box.
5. Restart the server on the primary Content Server host.
30.5.25 Setting Search Results Cache Expiration

When Content Server users perform searches, Content Server temporarily caches the
search results in the Content Server database. Content Server uses the cached search
results to allow users to switch between show summary and hide summary views
and to save their results without having to rerun the search.
You can set the amount of time that Content Server caches search results in the
Content Server database. The default setting is 30 minutes. After that time expires,
Content Server clears the search results from the database cache.
To Set Search Results Cache Expiration

To modify the search results cache expiration time:
1. On the administration page, click the Search Administration link.
2. Click the Configure Search Options link, and on the Configure Search Options
page, scroll down to the Cache Settings section.
3. In the Search Results Cache Expiration field, type the number of minutes for
which you want Content Server to store search results in its database cache.

30.5.26 Configuring Hyperlink Mappings

Hyperlink mappings allow users to access information in a Directory Walker data
source when viewing search results. Documents in a Directory Walker data source
are identified by their entire path name. When these documents are returned in a
search, they display on the Search Result page as their path names. To ensure that
each result links to the appropriate document, you must create hyperlink mappings
that will configure the Search Manager to serve the documents through a Web
server. While Directory Walkers created in previous versions of Content Server did
not require a Web server, currently, a Web server is required. You must run a Web
server for hyperlink mappings to function properly.
source or when you configure its Search Manager separately. If you choose to
configure the hyperlink mappings when you create a Directory Walker data source,
you do not need to configure the hyperlink mappings for the data source's Search
Manager. For other non-Enterprise data sources, you configure hyperlink mappings
when you configure the Search Manager for the data source. Examples of non-
Enterprise data sources are the Admin Help Data Source, the Directory Walker Data
Source, the User Help Data Source, and the XML Activator Producer Data Source.
For more information about Search Managers, see “Administering Searching
Important
OpenText strongly recommends you review the document access available
through your Web Server, and if needed, properly restrict access to sensitive
folder locations.

source, the Web server mapping to the folder location does not automatically
inherit the permissions defined for the search slice. This means users may be
able to access documents through the Web server that they do not have
permission to see through Content Server.
Using hyperlink mappings also allows you to modify the path to indexed
documents after the index has been created. For example, if the indexed directories
are moved after the index is created, you modify the hyperlink mappings for the
specific Search Manager. If you move the index to a new Content Server host, you
do not have to change any configuration settings, because the hyperlink mappings
are still valid, even though the path recorded in the index may not be valid
according to the index's new host.

mappings. For more information about configuring a Directory Walker data source,
see “Indexing Data on your File System” on page 413.
30.5.27 Requirements for XML Activator Files

The XML files produced by your third-party applications must meet certain
requirements to work properly with “Creating an XML Activator Producer Data
Flow” on page 418 processes.
Placement
The XML files that a third-party application places in directories for an XML
Activator process to read must be fully closed. The third-party application can fulfill
this requirement by writing files to a local directory and then moving the files to the
XML Activator process' incoming directory.
XML Activator processes also fulfill this requirement by sending fully closed files to
the directories required by third-party applications.
Naming
XML Activator processes read files in lexicographical (dictionary) order. This means
that third-party applications must name their files accordingly for proper processing
to occur.
Removal
As a third-party application finishes reading the XML files that were sent to it by an
XML Activator process, it must remove the files from its read directory.
Format
Along with their content (for example, binary data or text), the XML files that are
generated by third-party applications must include XML data that maps to data
interchange pool (iPool) messages. This XML data tells the XML Activator process
what to do with the corresponding content. The following table describes iPool key-
value pairs, which you include in XML files as tagged elements and constitute iPool
messages. You can provide the OTURN and Operation data under different tag
names, however, if you specify alternative tag mappings in Content Server in the
Identifier Tag and Operation Tag fields for the XML Activator process. These fields
are configurable on the Specific tab of each XML Activator process's Properties
page.

Table 30-6: iPool Key-Value Pairs
Key XML Tag Value

OTURN <OTUrn>, unless you have A persistent and unique
specified an alternative tag string that identifies the data
for OTURN in Content Server object (the content included in
a particular XML file). If you
do not include this element in
an XML file, the XML
Activator process will
automatically generate one.
The automatically generated
OTURN is not retrievable,
however, so you cannot use
an XML Activator process to
update or delete documents
that have automatically
generated OTURNs.
Operation <Operation>, unless you The action that Content
have specified an alternative Server performs with the
tag for Operation in data object. This value is set
Content Server to AddOrReplace or
Delete. If you do not
include this element in an
XML file, XML Activator sets
its value to AddOrReplace
by default.
Content <Content The data object. By default,
attribute="value"> attribute is set to
Encoding, value is set to
Base64, and the binary
encoding type for the content
is Base64. You can change
these parameters by
specifying alternate settings
for the Content Tag, Tag
Attribute, Tag Attribute
Value, and Encoding fields,
respectively, on the Specific
tab of each XML Activator
process's Properties page.
Any HTML, XML, or SGML
tags included within the
Content tag are processed
as part of the Content.

Key XML Tag Value

Metadata <Metadata> A series of fields, in the form
of tagged text, that describe
the data object. Metadata
fields act as queryable
attributes for users by
mapping data to either
existing Content Server
regions or to regions defined
in the XML Activator
process' .tok file. See the
following table for required
metadata fields, each of
which maps to a Content
Server region. For more
information about defining
regions in .tok files, see the
Content Server Developer's
Documentation.
The following table describes the metadata fields that OpenText recommends you
include in each XML file. Each field corresponds to a Content Server region. If you
do not include these fields, Content Server users will not be able to search them in
Content Server.
The tag names that you use must match the metadata field names, unless you
specify alternative tag mappings in Content Server under the Metadata List field for
the XML Activator process, which is located on the Specific tab of the process's
Properties page. You can also include as many additional metadata fields as
necessary by wrapping information in tags whose names match Content Server
regions, or whose names are mapped to regions in the Metadata List field for the
XML Activator process. For more information about mapping metadata tags when
adding or configuring an XML Activator process, see the Content Server Admin
Online Help.
Required Metadata Fields
Field Description
OTName The name of the data object
OTOwnerID A unique identifier for the owner of the data
object.
OTLocation The original location of the data object
OTCreateDate The date on which the data object was
created
OTCreateTime The time at which the data object was created
OTModifyDate The date on which the data object was last
modified

OTModifyTime The time at which the data object was last

modified
OTCreatedBy The node number of the creator of the data
object
OTCreatedByName The login name of the creator of the data
object
OTCreatedByFullName The full name of the creator of the data object
If you want the Operation value to be AddOrReplace, structure your XML file as
follows:
<?xml version="x.x"?>
<Top_Level_Tag>
<OTUrn>OTURN</OTUrn>
<Operation>AddOrReplace</Operation>
<Content attribute="value">Content data</Content>
<Metadata>
<OTName>Data object name</OTName>
<OTOwnerID>Owner ID number</OTOwnerID>
<OTLocation>Original location</OTLocation>
<OTCreateDate>Creation date</OTCreateDate>
<OTCreateTime>Creation time</OTCreateTime>
<OTModifyDate>Date last modified</OTModifyDate>
<OTModifyTime>Time last modified</OTModifyTime>
<OTCreatedBy>
Node number of creator
</OTCreatedBy>
<OTCreatedByName>
Login name of creator
</OTCreatedByName>
<OTCreatedByFullName>
Full name of creator
</OTCreatedByFullName>
</Metadata>
</Top_Level_Tag>
If you want the Operation value to be Delete, structure your XML file as follows,
including only the OTURN and the Operation. Do not include any content or
metadata because this Operation deletes data that already exists in the index and is
identified by its OTURN.
<?xml version="x.x"?>
<Top_Level_Tag>
<OTUrn>OTURN</OTUrn>
<Operation>Delete</Operation>
</Top_Level_Tag>

30.5.28 Understanding Document Conversion Filters

Most items stored in Content Server are not inherently indexable, making it
necessary to run them through a conversion filter. Conversion filters convert items
from their native MIME types (for example, Microsoft Word, Adobe, PDF, or ASCII
text) to a format that can be indexed: either HTML or raw text. This conversion
process occurs in data flows and is called the Document Conversion process.
Content Server provides three types of conversion filters:

• OpenText Document Filters (IM Filter)
• Quality Document Filter (QDF)
• XPDF
OpenText Document Filters (IM Filter)
OpenText Document Filters uses filter packs to convert items from their native file
formats (for example, Microsoft Word, Microsoft Excel, or Adobe PDF) to a simple
text format (for example, HTML or text) for viewing or indexing in Content Server.
The IM Filter is used to display Content Server items.
The IM Filter converts documents from their native formats to HTML or plain text
for viewing and indexing purposes. After documents are converted most can be
displayed, using the View as Web Page feature, as raster images. Files in Word,
Excel or RTF formats are displayed as text which can be searched and indexed.
The IM Filter is the library that communicates with DCS to provide text extraction
and metadata extraction. The library forwards TextExtraction and MIMEtype
detection requests from DCS to DCSIm through the use of filenames or buffer
content. All text extracted by DCSIm is returned to DCS using UTF-8 encoding.
Since DCSIm is not yet set up to handle extraction requests on buffer content for
most formats, it creates a temporary file stored on disk, except for Microsoft Office
format 95-2010 documents. You configure the IM Filter by modifying the [DCSIm]
section of the opentext.ini file. For more information, see “[DCSIm]” on page 109.
QDF
By default, Content Server uses QDFs to convert data. QDFs are conversion filters
that have been custom-designed to filter items quickly because they output raw text
instead of HTML, removing all formatting. QDFs have been designed to run in
memory rather than to be read from disk, which also contributes to their speed.
You configure QDFs by modifying the [QDF] section of the opentext.ini file. For
more information, see “[QDF]” on page 187.

30.5.29 Current System Object Error Report

You can test for system object errors at your Content Server site (for example, the
data flows, processes, and Search Engines in the System Object Volume). If the
system objects report errors, Content Server displays the object names and the errors
that they report on the Current System Object Error Report page. If an object reports
an error that prevents the indexing and searching processes from running
successfully (for example, the Admin server is not running), the error is displayed as
Severe.
By default, a Content Server agent tests the objects in the system volume for errors
every five minutes; however, you can test the system objects at any time when you
suspect that errors exist. Each time a test is performed, Content Server records the
following information in its history:
• Last Update, which is the date and time on which the system was last tested
• Notification, which indicates whether or not the test was run by a Content
Server agent
• Successful, which indicates whether or not the test reported errors
• Time Taken, which specifies the time (in seconds) that were spent running the
test
• Last Message, which specifies the name of the service that executed the test. By
default, this is System Management. If a test is not successful, this field provides a
reason for the failure.
Note: If a system object reports an error, you should investigate the issue and
correct any associated problems. Then, the next time that a system object error
report is generated, a Correction field appears, indicating that a previously
reported error has been resolved.
To return to the administration page, click the Continue button.
30.5.30 Command Line Arguments

In addition to the arguments listed below, you can specify any of the parameters
contained in the [FilterEngine] section of the opentext.ini file on the command
line for a Document Conversion process. For example, you can specify whether a
particular Document Conversion process generates summaries of the documents it
converts by passing the -summary parameter to the command line. For more
information about the parameters in the [FilterEngine] section, see
“[FilterEngine]” on page 128.
Arguments set on the command line override the global parameters set in the
opentext.ini file.
The following table describes the parameters that you can set on the command line
for a particular Document Conversion process.

Table 30-7: Document Conversion Process's Command Line Arguments
Argument Description
-readipool Specifies the absolute path to the data flow
directory, which contains the iPool
subdirectory from which the Document
Conversion process reads iPool messages
-readarea Specifies the name of the iPool subdirectory
from which the Document Conversion
process reads iPool messages
-writeipool Specifies the absolute path to the data flow
directory, which contains the iPool
subdirectory in which the Document
Conversion process writes the files that it
processes
-writearea Specifies the name of the iPool subdirectory
in which the Document Conversion process
writes the files that it processes
-sleep Specifies the number of seconds for the
Document Conversion process to sleep if the
input iPool is empty. After each sleep period,
the process checks the input iPool for more
iPool messages to process. If this parameter
is not set or is set to -1, the process exits
when it encounters an empty iPool. If you set
this parameter to a positive number, the
process is persistent. The default value is -1
-inifile Specifies the absolute path of the opentext.ini
file
-adminport Specifies the port number on which the
Document Conversion process listens for the
shutdown command. The default Admin
server sends a shutdown command to
instruct the Document Conversion process to
stop gracefully. By default, Content Server
specifies a value for this command line
argument when it creates a Document
Conversion process

30.6. Configuring Indexing Processes
30.6 Configuring Indexing Processes

Index Engines and Update Distributor processes are the indexing processes in an
Indexing and Searching system. An Index Engine is a process that indexes data for
the partition to which it belongs so that Search Engines can search the data, and users
can retrieve information in Content Server. A partition is a portion of an entire index
of data. The Update Distributor process is also a process in an indexing data flow
that manages and passes data to Index Engines. An Update Distributor process
reads data that was output by the Document Conversion process from an iPool, and
then distributes the data among Index Engines in their respective partitions. This
balances the load of data to be indexed among the partitions. The Update Distributor
process also distributes index update requests to Index Engines so that all indexed
data in each partition is kept up-to-date. To do this, the Update Distributor process
communicates with Index Engines to determine if the object that it is trying to
update exists in its partition's index. Once the object is located, the Update
Distributor process sends the updated data to that Index Engine for indexing.
Adding Indexing Processes
When you add a partition to your Indexing and Searching system, an Index Engine
is also added to the partition, and the Index Engine is associated with the Update
Distributor process automatically. To create an Update Distributor process, you add
it to an indexing data flow. The process of creating an index involves adding
partitions to Indexing and Searching systems and adding Update Distributors to
indexing data flows. You can delete indexing processes; however, deleting an
Update Distributor process stops indexing for an Indexing and Searching system.
Deleting an Index Engine can stop indexing for a partition's index or an Indexing
and Searching system as well. OpenText recommends that you do not delete
indexing processes.
Configuring Indexing Processes
After you add an Index Engine or an Update Distributor process, you can configure
it to control how it operates. Default values are configured for some settings
automatically when you add indexing processes; however, you may need to change
these values. When you configure an Index Engine, you can generate a summary of
the events that are recorded in an Index Engine's log file. The log file summary
contains statistics about the partition's index to which the Index Engine belongs. For
more information about the information that is included in index log file summaries,
contact OpenText Customer Support. Before you configure processes, you must stop
them. You can stop an individual process, or you can stop all indexing processes at
once. Whether you stop an individual process or all indexing processes, indexing for
the Indexing and Searching system to which the processes belong stops completely.
Validating an Index
When you configure an Index Engine, you can also validate the index for the
partition to which the Index Engine belongs. Validating a partition's index analyzes
it to identify potential problems. During index validation, the Update Distributor
process determines whether the data structures are synchronized. When Content

Server has finished validating a partition's index, it displays a validation log file,
which contains the percentage of deleted objects and words if the validation was
successful. If the validation was not successful, the validation log file contains
diagnostic information for use with OpenText Customer Support.
When you validate a partition's index, internal checks of the structure of the index
are performed, according to the level specified. Levels 1 to 5 are cumulative:
• Level 1 – will identify inconsistencies if the data in the otadmin.cfg and

search.ini files does not match the corresponding information in the Content
Server database. If this information is not consistent, for example, if the data
recorded in either file is deleted or has become corrupted, you may need to
resynchronize the indexing processes.
• Level 2 – also verifies the checksum of the checkpoint file. A checkpoint file stores
partition metadata in memory. A metadata integrity checksum is used to verify
that data in the checkpoint file has not been corrupted.
• Level 3 – also verifies the checkpoint is loadable into memory. Search Engines
load their status from the latest current checkpoint and index files, and apply
incremental changes from the accumlog and metalog files.
• Level 4 – also verifies the checksum of all full text index files in the OTChecksum
region to ensure that data has not been corrupted.
• Level 5 – also verifies the word pointers in the content index are consistent. Offset
files contain pointers to word location lists, used for Full Text searches, which
indicate to the Search Engine the relative position of a word within an indexed
object.
• Level 10 – Verifies that the word pointers in the metadata index are present. This
level of verification is independent of the lower levels. Metadata index files are
the same as the corresponding full text index files, except that they contain index
data for text metadata regions.
Resynchronizing
An Admin server writes information to an otadmin.cfg file and a search.ini file

to reflect changes in the Content Server database (for example, if a partition has been
configured or deleted). The otadmin.cfg and search.ini files are configuration
files that store information about the system objects that are associated with data
sources. Specifically, the search.ini file contains settings that are set by default
when components of Indexing and Searching systems (for example, partitions, Index
Engines, and Search Engines) are created. OpenText strongly recommends that you
do not modify the settings in the search.ini file. At all times, the information in
otadmin.cfg and search.ini files must match the corresponding information in
the Content Server database. However, this information can become mismatched
(for example, if the information recorded in the file is deleted or has become
corrupted). If this occurs, you may need to resynchronize indexing processes.
Resynchronizing indexing processes modifies the otadmin.cfg and search.ini
files to reflect information about the processes that is currently stored in the Content
Server database.

30.6.1 Configuring an Update Distributor Process

The Specific tab of the Update Distributor Properties page
Element Description
Process Information
Status Specifies whether the Update Distributor
process is running or not running. You
Host Specifies the Admin server on which the
process runs.
on page 569.
Maximum Good Exit Code When a process encounters an error, it
returns an error code. If the error code is less
than the number in the Maximum Good Exit
Code field, the process attempts to restart. If
the error code number is greater than the
number in the Maximum Good Exit Code
field, the process will not attempt to restart
and will require manual attention. OpenText
recommends that you not modify the
Maximum Good Exit Code, unless
Support.
Admin Port Specifies the port on which the Update
Distributor process runs. The process's
Admin server uses this port to start and stop
it. Clicking the Check Port link allows you to
verify if the port number that you specified is
available.
Max Process Memory Usage Specifies the amount of memory allocated to
the Update Distributor process.
iPools Clicking the Information button allows you
to view information about the iPools from
which the Update Distributor process reads
or to which it writes.
Actions

Element Description
Process Starts or stops the Index Engine process or all
indexing processes (the Update Distributor
process and the Index Engine process(es)
that belong to an Indexing and Searching
system). Whether you stop all indexing
processes or only the Update Distributor
process, indexing stops. If the indexing
processes are not running, the Start buttons
are displayed, and if the indexing processes
are running or are scheduled to run, the Stop
buttons are displayed.
Indexing Processes Stops and then starts all indexing processes
belonging to an Indexing and Searching
system.
Option Resynchronize – Resynchronizes the
information about the Update Distributor
process with the information in the Content
Server database.
Write Checkpoint – Writes a checkpoint file

if the metalogs are at more than 10%
capacity. This button is not available when
the page reloads after you click it, or if a
checkpoint writing operation is still ongoing.
Writing a checkpoint file is useful as part of a
graceful shutdown process, and can
dramatically improve startup time. For more
information, see “Configuring Indexing
To Configure an Update Distributor Process
To configure an Update Distributor process:
Folder link of a data source that contains the Update Distributor process that
3. On the Data Flow Manager page, click the Functions icon of the Update
Distributor process , and then choose Stop Indexing Processes.
4. Click the Functions icon of the Update Distributor process, choose Properties,
and then choose Specific.
5. On the Specific tab of the Update Distributor Properties page, edit the
parameters of the Update Distributor process.

Distributor process that you configured, and then choose Start Indexing
Processes.
Tip: You can also configure the Update Distributor process when you view the
partition map to which the process belongs.
30.6.2 Setting Advanced Update Distributor Settings

The Advanced Settings tab of the Update Distributor Properties page
Note: Some settings on this tab will be affected by related settings on the
Specific tab of a partition map's Properties page. For more information, see
“Configuring a Partition Map” on page 603. The affected settings are
identified below in the descriptions.
Element Description
Advanced Settings
Allowed Index Engine Specifies the number of consecutive Index Engine timeouts
Timeouts that are allowed before the Update Distributor process stops.
The length of time that is considered a timeout is defined by
the Index Engine Update Timeout parameter.
Index Engine Update Specifies the amount of time that the Update Distributor
Timeout process waits for a response from an Index Engine before an
index update is aborted.
Concurrent Checkpoint Specifies the number of Index Engine checkpoint files that
Write Limit may be written in parallel. This feature prevents the writing
of checkpoint files from saturating disk input/output and
“thrashing”. Possible values are integers from 1 to very large,
but a too large value will not prevent “thrashing”. The
default value is 8. An integer less than 1 will disable this
feature.
Start Directory Specifies the directory in which the Update Distributor runs.
This setting must be an absolute path in the Content
Server_home/bin directory of the Admin server that runs the
Update Distributor.
Batch Size Specifies the number of objects in transactional batches. The
default is 500.
OpenText recommends you set this value to:

• 100 when Value Storage Mode is selected
• 500 or more for Low Memory Mode
Note: This value should be less than the Number of

Items setting in the iPool Limits section of the Set
Extractor General Settings page. For details, see
“Setting Extractor General Settings” on page 485.

Element Description
Partition Biasing Specifies the number of partitions to fill before new ones are
created. This setting is optional, and is empty by default.
Index Engines may be more efficient at using the CPU, and at

reducing the number of checkpoint files that need to be
written, when this setting is at about 6 or 8 partitions.
OpenText recommends that you not modify the Partition
Biasing, unless instructed to do so by OpenText Customer
Support.
Logging
Log File Specifies the location of the Update Distributor process's log
file. The log file records information about the process and
can be used for troubleshooting if any problems occur.
Debug Level Specifies the type of message that will be recorded in the
Update Distributor process's log file:
• Info Level, which records all types of messages
• Status Level, which records periodic status messages,
warning messages, and all error messages
• Warning Level, which records warning messages and all
error messages
• Error Level, which records typical error messages and
severe error messages
• Severe Error Level, which records severe error messages.
Logging Flush Interval Specifies the number of new messages that are recorded in
the Update Distributor process's log before the process writes
it to disk.
Log File Options Specifies the parameters for writing log files.
Log File Specifies how the Update Distributor process's log file is
Actions affected when the process restarts:
• Add to Existing, which adds any new information to the
end of the current log file
• Create New, which overwrites the existing log file
• Create New (Save Existing), which saves and renames the
existing log file and creates a new log file based on the
existing log file
• Rolling, which saves and closes the existing log file and
creates a new log file
Log File Size Specifies a limit, in MB, on the maximum total size for log
files. The default is 100.
Startup Logs To Specifies the number of log files to keep before starting to
Keep overwrite them. The default is 5.
Additional Specifies the number of additional log files to keep before
Logs To Keep starting to overwrite them. The default is 10.
Actions

Element Description
Process Starts or stops the Index Engine process or all indexing
processes (the Update Distributor process and the Index
Engine process(es) that belong to an Indexing and Searching
system). Whether you stop all indexing processes or only the
Update Distributor process, indexing stops. If the indexing
processes are not running, the Start buttons are displayed,
and if the indexing processes are running or are scheduled to
run, the Stop buttons are displayed.
Indexing Processes Stops and then starts all indexing processes belonging to an
Indexing and Searching system
Option Resynchronizes the information about the Update Distributor
process with the information in the Content Server database
To Set Advanced Update Distributor Settings

To set advanced Update Distributor process settings:
Folder link of a data source that contains the Update Distributor process that
2. Click the processes_prefixData Flow Manager link.
Distributor process, and then choose Stop Indexing Processes.
and then choose Advanced Settings.
5. On the Advanced Settings tab of the Update Distributor Properties page, edit
the parameters of the Update Distributor process.
Distributor process that you configured, and then choose Start Indexing
Processes.
Tip: You can also configure the Update Distributor process when you
view the partition map to which the process belongs.

30.6.3 Configuring an Index Engine

The Specific tab of the Index Engine Properties page
Element Description
Process Information
Status Specifies whether the Index Engine is
field.
Index Engine runs.
on page 569.
returns an error code. If the error code
number is less than the number in the
Maximum Good Exit Code field, the process
attempts to restart. If the error code number
is greater than the number in the Maximum
Good Exit Code field, the process will not
attempt to restart and will require manual
attention. OpenText recommends that you
not modify the Maximum Good Exit Code,
unless instructed to do so by OpenText
Customer Support.
Admin Port Specifies the port on which the Index Engine
runs. The process's Admin server uses this
port to start and stop it. Clicking the Check
Port link allows you to verify if the port
number that you specified is available.
Server Port Specifies the port that socket processes use to
communicate with the Index Engine.
Clicking the Check Port link allows you to
verify if the port number that you specified
is available.
Max Process Memory Usage Specifies the amount of memory allocated to
the Index Engine.
Index Directory Specifies the directory of the partition's index
to which the Index Engine belongs.

Element Description
Partition Clicking a partition's name link allows you
to configure the partition to which the Index
Engine belongs.
Logging
Log File Specifies the location of the Index Engine's
log file. The log file records information
about the process and can be used for
troubleshooting if any problems occur.
Debug Level Specifies the type of message that will be
recorded in the Index Engine's log file:
• Info Level, which records all types of
messages.
• Status Level, which records periodic
status messages, warning messages, and
all error messages.
Logging Flush Interval Specifies the number of new messages that
are recorded in the Index Engine's log before
the process writes it to disk.
Log File Specifies how the Index Engine's log file is
Actions affected when the process restarts:
• Add to Existing, which adds any new
information to the end of the current log
file.
• Create New, which overwrites the
existing log file.
• Create New (Save Existing), which saves
and renames the existing log file and
creates a new log file based on the
existing log file.
• Rolling, which saves and closes the
existing log file and creates a new log file
Log File Size Specifies a limit, in MB, on the maximum
total size for log files. The default is 100.
Startup Logs Specifies the number of log files to keep
To Keep before starting to overwrite them. The
default is 5.
Additional Specifies the number of additional log files to
Logs To Keep keep before starting to overwrite them. The
default is 10.
Actions

Element Description
Process Starts or stops the Index Engine or all
process and the Index Engine(s) that belong
to a data source). Whether you stop all
indexing processes or an individual Index
Engine, indexing stops. If the indexing
Indexing Processes Stops and then starts all indexing processes
belonging to a data source.
Option Resynchronizes the information about the
Index Engine with the information in the
To Configure an Index Engine

To configure an Index Engine:
Folder link of a data source that contains the Index Engine that you want to
configure.
Distributor process, and then choose Stop Indexing Processes.
and then choose Index Engines.
5. On the Index Engines tab of the Index Engines page, click the name link for the
Index Engine that you want to configure.
6. On the Specific tab of the Index Engine Properties page, edit the parameters of
the Index Engine.
8. On the Data Flow Manager page, click the Functions icon of the Index Engine
that you configured, and then choose Start Indexing Processes.
Tip: You can also configure Index Engines when you view the partition map to
which they belong.

30.7. Administering Partitions
To Start or Stop Indexing Processes

To start or stop indexing processes:
Folder link of the data source folder with which the indexing processes that you
want to start or stop are associated.
3. On the Partition Map page, do the following:
• Click the Update Distributor process's Functions icon, and then choose Start
Indexing Processes to start all processes
• Click the Update Distributor process's Functions icon, and then choose Stop
Indexing Processes to stop all processes
• Click the Update Distributor process's Functions icon, and then choose
Restart Indexing Processes to restart all processes
• Click a process's name link, and then click the Process Start button on its
Properties page to start an individual process
• Click a process's name link, and then click the Process Stop button on its
Properties page to stop an individual process
Tip: You can also start, stop, or restart all indexing processes by clicking a
process's name link, and then clicking the Start, Stop, or Restart button on its
Properties page.
30.7 Administering Partitions

You add partitions to Indexing and Searching systems when you create indexes
using Content Server index templates or when you create index components
individually.
A partition map is a representation of a data source's Indexing and Searching system.

After you add a partition map, you can administer the partitions and the processes
in it. The processes that you can administer include: the Update Distributor, Index
Engines, Search Federators, and Search Engines. Administering processes involves
configuring the processes' specific parameters to customize their behavior. For more
information about configuring indexing processes, see “Configuring Indexing
Processes” on page 587. For more information about configuring searching
processes, see “Administering Searching Processes” on page 690. For more
information about configuring partitions, see “Configuring Partitions”
on page 598.

30.7.1 Configuring Partitions

After you add a partition to an Indexing and Searching system, you can configure it.
When you configure a partition, you can change its mode, which is sometimes
necessary when re-indexing. For information about partition modes, see “Working
with Partition Maps” on page 601. For information about re-indexing, see “Re-
You can also specify the amount of disk or memory space to be allocated to the
content and metadata of indexed documents. Each partition's Index Engine provides
the Update Distributor process with information about how much disk or memory
space is occupied in the index. The Update Distributor process then determines how
to balance the distribution of data across all of the partitions in the Indexing and
Searching system. Once a partition's maximum amount of disk or memory space is
occupied, the Update Distributor process stops sending data to the Index Engine for
indexing. For more information about Index Engines and Update Distributor
processes, see “Configuring Indexing Processes” on page 587. The content
accumulator is an operation in a partition's index that uses memory to store indexed
content before it writes the content to a subindex (a subdirectory in a partition's
index) on disk. The content accumulator collects content updates (from the Update
Distributor process) in memory before it writes the updated content to a subindex.
You can specify the amount of memory space that is allocated to the content
accumulator. When content fills the memory space, the content accumulator writes
the content to a subindex and becomes empty. Allocating a large amount of memory
space to the content accumulator can reduce the number of index merges that are
required to ensure the number of subindexes required for the partition.
Managing Partition Locations
Managing partition locations allows you to specify an Admin server, associate a

corresponding directory path, and select how many partitions can be created for that
location. Once you have specified Admin servers and their locations, you must make
at least one of the locations active. If there are no active locations, partition creation
will fail when the control rule is triggered. You can also specify the index backup
source location of the new partition. For more information about control rules, see
“Administering Control Rules” on page 609. When setting up multiple locations,
you can choose to distribute the partitions in one of the following ways:
• Sequentially, which creates the specified number of partitions in one active

location.
• Alternately, which rotates partition creation across active locations.
Note: When the Enterprise Data Source is created, one Admin server location
is added. By default, the location is set to active and the maximum number of
partitions allowed for the location is set to unlimited. If you choose to set
multiple locations for partition creation to active and the current location is not
valid, Content Server will create the partition at the next available location.
There is no Content Server validation to verify the Location Path.

Resynchronizing

theotadmin.cfg and search.ini files must match the corresponding information in
(for example, if the information recorded in a file is deleted or has become
corrupted). If this occurs, you may need to resynchronize a partition. Resynchronizing
a partition modifies the otadmin.cfg and search.ini files to reflect information
about the partition that is currently stored in the Content Server database.
To Configure a Partition
To configure a partition:
Folder link of the data source folder that contains the partition you want to
configure.
3. On the Partition Map page, click a partition's name link.
4. On the Specific tab of the Partition Properties page, in the Settings section, edit
any of the following settings:
• Mode, which specifies the mode of the partition

• Maximum Content Disk Size, which specifies the maximum amount of disk
space that document content can occupy in the partition's index
• Maximum Metadata Memory Size, which specifies the maximum amount
of memory space that document metadata can occupy in the total memory
space allocated to a partition's index
• Accumulator Memory Size, which specifies the amount of memory space
that is allocated to the content accumulator
5. In the % Full section, information is provided about:
• RAM, which shows the percentage of memory space defined by the

Maximum Metadata Memory Size setting that is currently being used by
indexed metadata
• Disk, which shows the percentage of memory space defined by the
Maximum Content Disk Size setting that is currently being used by
indexed content

6. In the Read/Write Mode Rebalancing Settings section, edit any of the

following settings:
• Start Rebalancing At, which specifies the percentage of memory used at

which no updates are accepted, and new objects are sent to other partitions,
when a partition is in Read/Write mode
• Stop Rebalancing Below, which specifies the percentage of memory used at
which updates are accepted but new objects are still sent to other partitions
• Updates Only Above, which specifies the percentage of memory used at
which new objects are sent to other partitions, when a partition is in Read/
Write mode
Note: You must restart indexing and searching processes (the Update
Distributor process, Index Engines, Search Federators, and Search Engines)
before the settings that you configure for a partition take effect.
To Resynchronize a Partition
To resynchronize a partition:
Folder link of the data source folder that contains the partition you want to
resynchronize.
3. On the Partition Map page, click a partition's Functions icon, choose Properties,
and then choose Specific.
4. On the Specific tab of the Partition Properties page, click the Resynchronize
button.
To Configure the Partition Location

To configure the Partition Location:
1. Click the Enterprise Partition Map Functions icon, choose Properties, and then
choose Partition Location Manager.
2. On the Partition Map page, in the Methods section, click one of the following
buttons:
• Distribute partitions across active locations, one at a time

• Use active locations sequentially, until full
3. In the Partition Locations section, click a server in the Admin Server drop-
down list.

4. Type an index and backup directory path in the Location Path field. Optionally,
click the Browse button to navigate the Admin server file system.
5. Click the number of partitions in the Available drop-down list.
6. Select the Active check box for each location you want to create partitions in.
Tip: You can also specify a directory path in the Location Path field by clicking
the Browse button and then navigating to and selecting the Admin server file
system. You can add or remove Admin server locations by clicking the Add
New Location button or the button, respectively.
30.7.2 Working with Partition Maps

A partition map is a representation of a data source's Indexing and Searching system.
Viewing a partition map allows you to see all of the components in an Indexing and
Searching system (for example, partitions, Index Engines, and Search Engines),
therefore making it an effective way to administer the system. For example, you can
monitor the status of each component simultaneously, which helps you to maintain
the performance of indexing and searching at your site.
From the Partition Map page, for each partition, the space being used is listed as a
percentage full value, and represents the amount of RAM (%) and Disk (%)
(memory) currently occupied by the metadata and content of indexed documents.
The State indicates the current mode of the partition, which helps you to know
when new partitions are required:
• Normal – ReadWrite mode

• Rebalancing – ReadWrite mode
• Almost Full – ReadWrite mode
• Full – ReadWrite mode
• Read Only – ReadOnly mode
• Update Only – NoAdd mode
• Retired – Retired mode
Warning
When you change a partition to Read Only, the Index Engine for that partition
shuts itself down and will not index any items that are either updated or
deleted.
Note: OpenText recommends that normally you do not use Read Only and
Update Only modes.

If you decide to re-index an item by modifying it in the GUI or by re-inserting it into

dtreenotify, the Update Distributor will ping all running Index Engines to check if the
item already exists. Since the Index Engine for the Read Only partition is shut down,
it will not return a response to the ping. The Update Distributor will assume that
this item is new and will add it to another Read/Write partition and create duplicate
items.
If items in your Content Server system will be updated through the user interface or
the SDK then you should not use Read Only partition mode. For example, when a
Content Server system is used for litigation purposes, an index must remain
unmodified, as in an email archiving system.
Note: For information about the amount of disk or memory space to be

allocated to the content and metadata of indexed documents, see “Configuring
Partitions” on page 598.
You can also configure the properties of each partition map component from a
partition map, and you can add and delete components. If you need to perform
maintenance on an Indexing and Searching system, you can stop and then start or
restart the partition map, which stops and then starts all its indexing and searching
processes. Stopping indexing and searching processes stops all indexing and
searching for a data source. When you want to customize indexing and searching
behavior for an Indexing and Searching system, you configure a partition map.
When you create a data source's index using Content Server Templates, a partition
map is created for the data source automatically. If you create a data source's index
by creating the system objects that are associated with it individually, you add a
partition map yourself. For more information about adding index components
individually, see “Creating Index Components Individually” on page 433.
Administering Partition Map Components
Administering processes also involves monitoring the status of each process. A

process can have one of the following statuses:
• Running, which is indicated by a blue check mark.
• Idle (not running), which is indicated by a gray check mark.
• Processing or Waiting, which is indicated by a yellow check mark.
• Error, which is indicated by a red X.
Configuring Partition Maps
Configuring a partition map involves specifying parameters that customize how

indexing and searching operates for a data source's index. For example, you can
specify the file cleanup interval, which allows unused files in a partition's indexes to
be deleted automatically. You can also specify rules that determine which
documents are indexed. Specifically, you set a number of parameters that detect
whether documents have a large number of unique words. If a document has too
many unique words, the document will not be indexed. Specifying parameters to

prevent certain documents from being indexed can improve your system's
performance because the wordlist that your system maintains will be smaller.
Configuring Index Merging
When you configure a partition map, you can also customize the merge operations
for a data source's index. Index merging allows subindexes (subdirectories in a
partition's index) to be merged, which reduces the size of each partition's index. You
can configure index merging operations for your site to prevent them from
occurring unnecessarily. Periodically, however, Content Server merges subindexes
to remove deleted data from the index, which can optimize search performance. You
can specify the number of subindexes that cause a merge operation to occur. If the
number of subindexes exceeds the target number, a merge occurs between the
smallest consecutive grouping of two or three subindexes. You can also specify the
oldest creation date and the merge ratio, which also determine which subindexes are
candidates for a merge. For example, if the subindexes' creation dates are older than
a specific date, they are considered for a merge so that deleted data can be removed.
In addition, if the merge ratio is set to 3 (which is equivalent to 3:1) and some
combination of the subindexes in a consecutive grouping is at least one third of the
size of the largest subindex, the grouping is considered for a merge. Merges of three
subindexes (at most) occur between the subindexes that have the largest combined
file size first. Only one merge per partition occurs at a time.
To View a Partition Map

To view a partition map:
Folder link of the data source folder that contains the partition map you want to
view.
2. Click the processes_prefixPartition Map link.
30.7.3 Configuring a Partition Map

OpenText recommends that you do not modify the default values on the Specific
tab of a partition map's Properties page without the advice of OpenText Customer
Support.
Element Description
Settings

Element Description
Search Engine Timeout Specifies the amount of time the:
• Search Federators wait for a response from the
Search Engines they manage
• the Search Engines spend evaluating a query,
before the associated Query is terminated
Search Federators wait up to 1.25 times (*) the Search
Engine Timeout value. Search Engines wait until the
timeout value.
Note: When you establish a connection with the

Search Federator, the default timeout threshold
value to issue a query is very short, so the
connection can be easily lost. You can increase
the time available to issue a query by pressing
the ENTER key immediately after you open the
Search Client. This will give you 3 minutes to
type in your query before the Search Federator
closes.
Update Request Interval Specifies how often Search Engines check a partition's
index for changes.
Content Truncation Size Specifies the maximum size for the converted content
of documents before it is truncated (cut off). Only the
truncated content is searchable.
Search Filter Memory Allocation Specifies the amount of extra memory allocated for
facets for each Search Engine process. If you change
this value, the Search Engine processes must be
resynchronized.
File Cleanup Interval Specifies how often Index Engines check a partition's
index to determine whether files and directories can
be deleted.
Text Metadata Storage Specifies which storage method is enabled for text
metadata values:
• Checkpoint files – text metadata values are stored
in the checkpoint files. This is the default.
• Incremental merge files – text metadata values
are stored in files that use background merges.
When merge files are used, search indexing
throughput is potentially higher, since the size of
checkpoint files to be written is much smaller, but
requires slightly higher concurrent CPU capacity.
Skip List Specifies the number of objects between
synchronization points in the data structure. This can
optimize search engine performance using a skip list
for text in RAM and enum data types. The default is
1000. Values of 2000 perform well, values below
500 become memory-intensive.

Element Description
Index Metalog Limits
Limits Specifies the parameters for writing a metadata log
for storage modes.
Size Specifies the size of the index, in MB. The default is
16.
Objects Specifies the number of objects in the index. The
default is 5000.
Updates Specifies the number of updates in the index. The
default is 500.
Merge Options
Merges Specifies whether or not merges are performed:
• True, which specifies that index merges are
performed.
• False, which specifies that index merges are not
performed.
OpenText recommends that you do not change the
default value of this parameter (which is True).
Merge Attempt Interval Specifies how often Index Engines check a partition's
index to determine whether index merges need to be
performed.
Target Index Number Specifies the number of subindexes that cause a
merge to occur. If the number of subindexes exceeds
the value you set for the Target Index Number
parameter, subindexes are merged.
Oldest Index Date Specifies the number of days that a subindex can age
before it is compacted to make it smaller in size. If a
subindex's creation date exceeds the number of days
that you set for the Oldest Index Date parameter, the
subindex is compacted.
Index Ratio Specifies the ratio for determining whether
subindexes are candidates for a merge operation. The
default value of the Index Ratio parameter is 3, which
specifies that the merge ratio is 3:1. For more
information about merging operations, see “Working
with Partition Maps” on page 601.
Bad Object Heuristics

Element Description
Minimum Document Size to Specifies the minimum number of words that a
Consider document's content can contain before the document
may not be indexed. You configure this parameter
with the Document Word Ratio, Restrictive
Document Word Ratio, Maximum Average Word
Length, and Restrictive Maximum Average Word
Length parameters to exclude documents from being
indexed. A document is not indexed if it exceeds the
value set for the Minimum Document Size to
Consider parameter and any of the following:
• It exceeds the values set for the Document Word
Ratio and Maximum Average Word Length
parameters.
• It exceeds the value set for the Restrictive
Document Word Ratio parameter.
• It exceeds the value set for the Restrictive
Maximum Average Word Length parameter.
Document Word Ratio Specifies the maximum ratio of unique words to total
number of words in a document's content.
Restrictive Document Word Ratio Specifies a more restrictive ratio for the criteria
defined by the Document Word Ratio parameter.
Maximum Average Word Length Specifies the maximum average for the length of
words in a document. For example, if a document
satisfies the Minimum Document Size to Consider
and the Document Word Ratio criteria, and if the
value for the Maximum Average Word Length
parameter is set to 10 (which is the default), and the
average word length for a document is 12 characters,
the document is not indexed.
Restrictive Maximum Average Specifies a more restrictive ratio for the criteria
Word Length defined by the Maximum Average Word Length
parameter.
Actions
Option Resynchronizes the information about the partition
map with the information in the Content Server
database.
Adjusting Metadata Memory Settings

In some situations, it may be useful to store some of a partition map's metadata
regions in RAM and some on disk. Managing this so-called metadata memory enables
you to make the best use of your available RAM and disk resources. The default
memory settings for the four partitions modes are as follows:
• Read/Write: all on disk, default location is disk
• Update Only: all on disk, default location is disk
• Read Only: all on disk, default location is disk

• Retired: all on disk, default location is disk
Warning
When you change a partition to Read Only, the Index Engine for that partition
deleted.
Note: OpenText recommends that normally you do not use Read Only and
Update Only modes.
The Metadata Memory Settings tab on the Properties page of a partition map
enables you to view and modify these allocations.
To Configure a Partition Map

To configure a partition map:
1. On the Administration page, under Search Administration, click Open the

System Object Volume.
Folder link of the data source folder that contains the partition map you want to
configure.
3. Click the partition map's Functions icon, choose Properties, and then choose
Specific.
4. On Specific tab of the Partition Map Properties page, edit the parameters of the
partition map.
To Start or Stop a Partition Map

To start or stop a partition map:

Folder link of the data source folder that contains the partition map that you
want to stop.
3. On the Data Source Folder page, click a partition map's Functions icon, and
then choose one of the following:
• Start, which starts all indexing and searching processes

• Stop, which stops all indexing and searching processes
• Restart, which stops and then starts all indexing and searching processes

To Adjust Metadata Memory Settings

To adjust metadata memory settings:

want to adjust metadata memory settings for.
3. Click the partition map's Functions icon, choose Properties, and then choose
Metadata Memory Settings.
4. On the Partition Map Metadata Memory Settings tab, click the Edit icon of
one of the partitions modes to adjust memory storage settings:
• Read / Write
• Update Only
• Read Only
• Retired
Warning
When you change a partition to Read Only, the Index Engine for that
partition shuts itself down and will not index any items that are either
updated or deleted.
The numbers in brackets after each mode indicate how many partitions are
currently set to that mode.
Note: OpenText recommends that normally you do not use Read Only
and Update Only modes.
5. After you have finished making memory storage adjustments, described in “To
Adjust Memory Storage” on page 608, click the Restart Indexing Processes
button.
To Adjust Memory Storage

To adjust memory storage:

want to adjust metadata memory settings for.
3. Click the Partition Map's Functions icon, choose Properties, and then choose
Metadata Memory Settings.

30.8. Administering Control Rules
4. On the Partition Map Metadata Memory Settings tab, click the Edit icon of
one of the partitions modes to adjust memory storage settings:
• Read / Write
• Update Only
• Read Only
• Retired
Note: In Retired mode, an index will accept updates and deletions, but
not new objects. In addition, a complete replacement of an object in
Retired mode will rebalance the object to another partition and delete it
from the original partition.
Note: OpenText recommends that normally you do not use Read Only
and Update Only modes.
5. On the Edit Metadata Memory Settings page, in the Region Allocations

section, do one the following:
• Click a text region to select it, or hold down CTRL to select several.
• Use the memory select text box to select regions that will save the number of
megabytes you specify.
The change in the required RAM, and the change in memory used is displayed
when you select regions.
6. Click the right arrow and the left arrow icons to move the regions so they
are stored in Searchable, or Storage Only mode.
7. Click the Apply button.
8. Return to the Metadata Memory Settings tab, described in “To Adjust Metadata
Memory Settings” on page 608, and click the Restart Indexing Processes
button.
30.8 Administering Control Rules

Control rules are rules that you define to monitor the status of data flow processes
and to manage partitions associated with a data source. They allow you to define
conditions that data flows may encounter, to associate certain actions with those
conditions, and to specify what reports to issue. With control rules, you can
administer your Content Server site more efficiently because they alert the
appropriate individuals to the status of data flows, processes, or partitions, and in
some cases create new partitions.
Before you add a control rule, you should enable Content Server Notification, and
enable error checking and email delivery. For information about enabling error

checking and email delivery, see “Enabling Error-Checking and E-Mail Delivery”
on page 568.
Note: When adding a control rule, make sure that the rule you define does not
conflict with any other control rule that exists in your system. Conflicting
control rules can seriously impact the efficiency of your system.
This section covers the following tasks:
• Enabling and disabling control rules, which allows you to activate or stop a
control rule once it has been added.
• Adding data flow control rules, which allows you to monitor data flow
conditions.
• Adding partition-management control rules, which allows you to monitor
partition capacity, and create new partitions based on either capacity or date.
• Editing and deleting control rules, which allows you to modify existing control-
rule parameters or remove a control rule.
• Understanding control rule parameters, which provides a comprehensive list of
all condition, action, and report types.
30.8.1 Enabling Control Rules

Enabling a control rule activates the rule in the system. This means that Content
Server begins monitoring the site for the conditions that you have defined in the rule
and takes the appropriate actions when those conditions are met. When you add a
control rule for the first time, it is disabled by default. When you are ready to
activate the rule, you enable it.
You disable a control rule when you want to temporarily deactivate the rule in the
system. For example, you disable a control rule before editing it. For information
about editing a control rule, see “Administering Control Rules” on page 609.
To Enable a Control Rule

To enable or disable a control rule:
1. On the System Object Volume page, click the Functions icon of the
processes_prefix Data Source Folder, choose Properties, and then choose
Control Rules.
2. On the Control Rules page, do one of the following:
• Select the Active check box for a control rule to enable it.
• Clear the Active check box for a control rule to disable it.

30.8.2 Adding Data Flow Control Rules

Data flow control rules manage the data flows at your Content Server site. They
allow you to define the states or conditions that data flows may encounter and to
associate certain actions with those conditions. For example, you can create a data
flow control rule that instructs Content Server to stop a data flow and deliver a
system object alert email when errors occur in a particular data flow process.
Note: Content Server delivers system object alert email messages to the
recipients that you specify on the Configure System Object Alert E-Mail
Delivery page. For more information, see “To Enable Error-Checking and E-
Mail Delivery” on page 569
You can create data flow control rules based on the number of iPool messages in a
data flow, the amount of time that a data flow has been idle or stalled, the process
errors in a data flow, or the amount of disk space available on the computer where
the data flow runs.
Number of Messages
A Number of Messages control rule starts or stops an iPool feeder or an iPool reader
and delivers system object alert email messages when the number of iPool messages
in a data flow is greater than or less than a number that you specify. For example, if
you want Content Server to send an information message when the number of iPool
messages in an iPool feeder exceeds 200, you can create a control rule that identifies
that condition.
Quiet Data Flow
A Quiet Data Flow control rule starts or stops an iPool feeder or an iPool reader and
delivers system object alert email messages when a data flow remains quiet (receives
no iPool messages) for a specific amount of time. Quiet data flows are data flows
whose processes are running successfully and are clear of iPool messages. For
example, if you want Content Server to send an error message when a data flow is
clear of iPool messages for 30 minutes, you can create a control rule that identifies
that condition.
This control rule is especially useful for data flows that have low volume, such as the
Help data flow, because it allows you to automatically shut down data flows when
they are no longer active. You can also use this data flow control rule to indicate
when problems occur in data flows that typically have high volume.
Stalled Data Flow
A Stalled Data Flow control rule stops an iPool feeder or the data flow and delivers
system object alert email messages when a data flow stalls for a certain amount of
time. Stalled data flows are data flows whose processes are running but are not
processing the iPool messages that the data flow receives. For example, if you want
Content Server to send a severe error message and stop the iPool feeder when a data
flow stalls for more than six hours, you can create a control rule that identifies those
conditions.

Process Errors in the Data Flow
A Process Error in the Data Flow control rule stops the data flow and delivers
system object alert email messages when errors occur during the execution of one of
the processes in a data flow. If a process error occurs, a message describing the
specific error condition is displayed on the Specific tab of the corresponding data
flow process's Properties page. You can base data flow control rules on the existence
of process errors in a data flow; however, you cannot base data flow control rules on
a specific process error itself.
Disk Space
A Disk Space control rule starts or stops an iPool feeder, an iPool reader, or the data
flow, and can deliver system object alert email messages when a certain amount of
free disk space is available. For example, if you want to stop an iPool reader and
send a warning message when a certain amount of disk space is no longer available,
you can create a control rule that identifies those conditions.
To Add a Control Rule Based on iPool Messages
To add a control rule based on iPool messages:
Control Rules.
2. On the Control Rules page, click the Add New Control Rule button.
3. On the Add a New Control page, type a name for the rule in the Name field.
4. Click Number of Messages in the Data Flow in the Templates drop-down list.
Optionally, edit the rule's description in the Description field.
5. In the Conditions section, click one of the following in the If the number of
iPool messages is drop-down list:
• < (less than)
• > = (greater than or equal to)
• = (equal to)
6. Type a number in the iPool messages field.
7. In the for , click the description of the iPool that will be monitored by this rule.
Optionally, in the Reports section, type a message to be sent with the report in
the Message field.

To Add a Control Rule Based on Quiet Data Flows

To add a control rule based on quiet data flows:
Control Rules.
4. Click Quiet Data Flow in the Templates drop-down list. Optionally, edit the
rule's description in the Description field.
5. In the Conditions section, type a number in the If idle and clear of messages
for more than field, and then click minutes, hours, or days in the drop-down
list.
6. Click the entire data flow in the for drop-down list. Optionally, in the Reports
section, type a message to be sent with the report in the Message field.
To Add a Control Rule Based on Stalled Data Flows

To add a control rule based on stalled data flows:
Control Rules.
4. Click Stalled Data Flow in the Templates drop-down list. Optionally, edit the
5. In the Conditions section, type a number in the If stalled for more than field,
and then click minutes, hours, or days in the drop-down list.
6. Click the entire data flow in the for drop-down list. Optionally, in the Reports
section, type a message to be sent with the report in the Message field.

To Add a Control Rule Based on Disk Space

To add a control rule based on disk space:
1. On the Administration page, in the Search Administration section, click Open

processes_prefix Data Source Folder. Choose Properties, and then choose
Control Rules.
5. In the Templates section, click Disk Space in the drop-down list. Optionally,
edit the rule's description in the Description field.
6. Click one of the following in the If drop-down list:
• <
• >=
• =
7. Type a number in the MB of free disk field.
8. In the for drop-down list, click the description of the iPool that will be
monitored by this rule. Optionally, in the Reports section, type a message to be
sent with the report in the Message field.
To Add a Control Rule Based on Process Errors

To add a control rule based on process errors:
1. On the Administration page, in the Search Administration section, click Open

processes_prefix Data Source Folder. Choose Properties, and then choose
Control Rules.
5. In the Templates section, click Process Error in the Data Flow in the drop-
down list. Optionally, edit the rule's description in the Description field.
6. In the Conditions section, click Data Flow Process Error in the Condition Type
drop-down list. Optionally, in the Reports section, type a message to be sent
with the report in the Message field.

To Edit a Control Rule

To edit or delete a control rule:
Control Rules.
2. On the Control Rules page, do any of the following:
• Click the Edit this control rule button, specify the settings that you want
on the Edit a Control Rule page, and then click the Update button.
• Click the Remove this control rule button for a control rule, and click the
OK button.
30.8.3 Adding Partition Management Control Rules

Partition management control rules allow you to define the states or conditions that
partitions encounter and to associate certain actions with those conditions. For
example, you can add a control rule based on partition capacity that issues a report
when every partition has reached 75% capacity. For more information about
partitions, see “Working with Partition Maps” on page 601.
Note: Content Server delivers system object alert email messages to the
recipients that you specify on the Configure System Object Alert E-Mail
Delivery page. For more information, see “To Enable Error-Checking and E-
In addition to adding control rules that monitor partition capacity, you can add
partition management control rules that automatically create new partitions when
the rules' conditions are met (partition creation control rules). These control rules can
be based on partition capacity or a set time interval (date-based partition creation).
Partition Creation Control Rules
When adding a partition creation control rule, there are several parameters that you
can specify. You can have Content Server change the modes (step down) of previous
partitions as new partitions are created, you can select how many new partitions to
create, and you can specify a partition name template and partition directory
template (variables that determine how Content Server automatically names
partitions and the directories in which they are stored). The disk locations for the
directories that store partitions are taken from the site's partition configuration,
which must be already set up for these rules to work properly. For more
information, see “Configuring Partitions” on page 598.
Note: The settings for automatically created partitions are taken from the last
partition created, not from default settings.

When adding control rules to automate partition creation, you can schedule
automated backup processes for the partitions. Before you can schedule a backup
process, you must manually create a backup manager and at least one backup
process. Once the backup processes are created for the first partition, subsequent
auto-created partitions will copy the number of processes defined for the previous
partition and apply a similar set for new partitions. When stepping down a partition
to Read-Only mode, all existing scheduled backups are canceled and a final full
backup is performed. For information about automating backup processes, see
“Backing Up and Restoring Indexes” on page 647.
Warning
When you change a partition to Read-Only, the Index Engine for that partition
deleted.
Date-based partition creation control rules are triggered when the latest object
creation date in the data flow matches or exceeds the trigger date that you have
specified. The rule then waits for the number of iPool messages in the data flow to
reach zero, creates new partitions, and then sets the next trigger date, based on an
interval that you have specified. The interval determines the amount of time
between the triggering of the rule and the next trigger date.
Note: Date-based partition creation control rules are only available if you have
set the opentext.ini file parameter wantDescendingExtractor to false. For
more information, see “[LivelinkExtractor]” on page 170.
To Add a Control Rule Based on Partition Capacity

To add a control rule based on partition capacity:
Control Rules.
4. Click Partition Capacity in the Templates drop-down list. Optionally, edit the
5. In the Conditions section, type an integer between 1 and 100 in the % capacity
field. Optionally, in the Reports section, type a message to be sent with the
report in the Message field.

To Add a Control Rule for Capacity-Based Partition Creation

To add a control rule for capacity-based partition creation:
1. On the System Object Volume page, click the Functions icon of

theprocesses_prefix Data Source Folder, choose Properties, and then choose
Control Rules.
4. Click Capacity-Based Partition Creation in the Templates drop-down list.
5. In the Conditions section, type an integer between 1 and 100 in the % capacity
field. Optionally, in the Actions section, select one of the following check boxes:
• Step down the "Read/Write" partitions to "Update Only"

• Step down the "Update Only" partitions to "Read Only"
Warning
updated or deleted.
6. Click the number of partitions you want in the Create drop-down list.
7. Type the partition name template in the Partition Name Template field.
8. Type the partition directory template in the Partition Directory Template field.
9. Type the backup process name for the partition in the Backup Process Name
Template field.
10. Type the backup directory name in the Backup Directory Name Template field.
Optionally, in the Reports section, type a message to be sent with the report in
the Message field.

To Add a Control Rule for Date-Based Partition Creation

To add a control rule for date-based partition creation:
1. On the System Object Volume page, click the Functions icon of the Enterprise
Data Source Folder, choose Properties, and then choose Control Rules.
4. Click Date-Based Partition Creation in the Templates drop-down list.
5. In the Conditions section, click the trigger date and time in the Change Trigger
Date to drop-down lists. Optionally, in the Actions section, select one of the
following check boxes:
• Step down the "Read/Write" partitions to "Update Only"

• Step down the "Update Only" partitions to "Read Only"
Warning
updated or deleted.
6. Click the number of partitions you want in the Create drop-down list.
7. Type the partition name template in the Partition Name Template field.
8. Type the partition directory template in the Partition Directory Template field.
9. Type the backup process name for the partition in the Backup Process Name
Template field.
10. Type the backup directory name in the Backup Directory Name Template field.
11. Click the amount of time before the next trigger date in the Interval drop-down
list. Optionally, in the Reports section, type a message to be sent with the report
in the Message field.

30.8.4 Control Rule Parameters

The following tables provide a comprehensive list of the conditions, actions, and
reports available when adding control rules. Although you can combine these
options to create custom control rules, OpenText recommends that you use the
control rule templates provided whenever possible. Using the templates will prevent
you from combining options inappropriately or creating overly complex rules that
contradict each other.
Certain options can only be used when creating partition-management control rules.
For example, the Content Server Extractor Control condition and the Set Next
Trigger Date action can only be used when setting up a date-based automatic
partition creation control rule for an Enterprise Data Source.
Table 30-8: Condition Types
Condition Description
Data Flow Disk Space Allows you to specify a control rule
condition that is based on the amount of
available disk space (in MB) on the computer
where a particular data flow runs.
Data Flow Process Error Allows you to specify a control rule
condition that is based on the existence of
one or more data flow process errors.
Content Server Extractor Control Allows you to specify a control rule
condition that is based on a trigger date
associated with Content Server Extractor
processes. This condition should only be
used when implementing a date-based
automatic partition creation rule as part of a
high-volume indexing solution. For more
information, see “Adding Partition
Management Control Rules” on page 615.
Number of Messages Allows you to specify a control rule
condition that is based on the number of
iPool messages in the data flow.
Partition Space Allows you to specify a control rule
condition that is based on the amount of
space used in a partition. If more than one
partition is stored in the same location, the
condition applies to all partitions. For
example, if you have five partitions in the
same location, and you have created a
partition space condition that specifies a
capacity of 75%, all of the partitions must
reach 75% (full) before the condition is met.

Condition Description
Quiet Data Flow Allows you to specify a control rule
condition that is based on the amount of time
that a data flow has been idle with no
pending iPool messages to process.
Stalled Data Flow Allows you to specify a control rule
condition that is based on the amount of time
that a data flow has been idle with pending
iPool messages to process.
Table 30-9: Action Types
Action Description
Create Partition Allows you to set the parameters associated
with automatic partition creation (for
example, stepping down the partitions and
specifying the partition name and partition
directory name). This action should only be
used when implementing an automatic
partition creation rule as part of a high-
volume indexing solution. For more
Note: If you are not using a partition

management control rule, you should
stop the data flow before creating the
partitions, and restart the data flow
and Search Federators after the
partitions are created.
The settings for automatically created

partitions are taken from the last
partition created, not from default
settings.
Restart the Search Federators Allows you to set up a control rule that
restarts all the Search Federators at a Content
Server site when the specified condition is
met. For information about Search
Federators, see “Administering Searching

Action Description
Set Next Trigger Date Allows you to set the time interval at which
the next trigger date is set for the Content
Server Extractor Control condition. This
action must be used in conjunction with the
Content Server Extractor Control condition
when implementing a date-based automatic
partition creation rule as part of a high-
volume indexing solution. For more
Start the Data Flow Allows you to start a data flow when the
corresponding condition is met.
Start the iPool Feeder Allows you to start the data flow process that
feeds messages to the specified iPool when
the corresponding condition is met.
Start the iPool Reader Allows you to start the data flow process that
reads messages from the specified iPool
when the corresponding condition is met.
Stop the Data Flow Allows you to stop a data flow when the
corresponding condition is met.
Stop the iPool Feeder Allows you to stop the data flow process that
feeds messages to the specified iPool when
the corresponding condition is met.
Stop the iPool Reader Allows you to stop the data flow process that
reads messages from the specified iPool
when the corresponding condition is met.
Table 30-10: Report Types
Report Description
Standard Defines the layout and content of the email
message that is sent to the recipients of
system object volume alert emails. If you
configure a control rule with a Standard
report, you can send an information,
warning, error, or severe error message,
depending on the conditions and actions
defined in the rule. For more information
about configuring the recipients of system
object volume alert emails and the types of
messages you can send, see “Adding E-Mail
Recipients” on page 565. If you want to
customize the email message that is sent with
a Standard Report, you can add up to 250
characters of custom text.

30.8.5 Partition Template Naming Conventions

The following table describes the values you can use when naming partitions and
their directories.
Table 30-11: Partition and Directory Naming Values
Value Description
%d The two-digit day of the month, from 01 to
31 (e.g., 01-31)
%j The three-digit day of the year, from 001
through 366
%m The two-digit month (e.g., 01-12)
%w The one-digit weekday, from 1 through 7,
where 1= Sunday
%y The two-digit year (e.g., 93)
%H The two-digit hour on a 24-hour clock, from
00 to 23
%M The minutes past the hour, from 00 to 59
%S The seconds past the minute, from 00 to 59
%Y The year, including the century (e.g., 1993)
30.9 Maintaining Indexes

After creating a data source's index, you can maintain it by moving it, gathering the
search log files for a specified data source, or verifying content and re-indexing.
After you create a data source's index by creating one or more partitions, you can
move a partition's index to a new location. You may need to move a partition's index
for a variety of reasons; for example, if the drive on which the partition's index
resides is reassigned to some other use, if you upgrade the hardware on which the
partition's index resides, or if the partition's index exceeds the capacity of the drive
on which it resides.
You can examine the search log files by gathering and archiving them to a
temporary logs directory. You can specify the number of lines you want to tail, and
gather additional files, such as the search.ini and otadmin.cfg files.
If you suspect that an index is incomplete, out-of-date, or corrupt, you can perform
some administrative tasks to help troubleshoot and correct potential problems. The
administrative tasks available to you depend on the type of data source with which
you are working. For example, if you are working with an Enterprise data source,
you can verify the contents of the Enterprise index, re-extract the data from the
Content Server database, or purge the Enterprise data flow and reconstruct the
index. If you are working with non-Enterprise data sources, you can re-extract the
data from the source, or purge the data flow and reconstruct the index.

30.9. Maintaining Indexes
30.9.1 Moving Indexes

You move a partition's index by moving the index directory and modifying the
directory paths specified for the Index Engine and the Search Engines that are
associated with the partition's index.
There are two locations to which you can move a partition's index directory:
• You can move the partition's index directory to a different local drive on the
same Content Server host, which means that you do not have to change the
Admin server that manages the corresponding Index Engine and Search Engines.
• You can move the partition's index to a drive on a different Content Server host,
which means that you must change the Admin server that manages the
corresponding Index Engine and Search Engines.
For performance reasons, OpenText recommends that Index Engines and Search
Engines have fast connections to the files in their corresponding index directories.
To move an index from one host to another, you must install more than one Content
Server host. For information about performing Content Server installations, see the
Content Server Installation Guide. For information about registering an Admin server
on remote Content Server host, see “Setting Up Admin Servers” on page 431.
To display search results as active links, you must create hyperlink mappings that
will configure the Search Manager of a Directory Walker data source to serve the
documents through a Web server. You must run a Web server for hyperlink
mappings to function properly. For information about how to configure hyperlink
mappings, see “Configuring Hyperlink Mappings” on page 579.
To Move an Index on the Same Host
To move an index directory to a different local drive on the same Content

Server host:

Folder link of the data source folder that corresponds to the index directory that
you want to move.
2. Click the Functions icon of the processes_prefix Data Flow Manager, and then
choose Suspend.
3. Click the Functions icon of the processes_prefix Search Manager, and then
choose Stop.
4. Move the index directory to its new location.
6. On the Partition Map page, click an Index Engine's name link.

7. On the Specific tab of the Index Engine Properties page, type the new path of
the index directory in the Index Directory field as it is mapped on the Admin
server selected in the Host drop-down list (for example, new_path/index).
9. Click the name link for a Search Engine that searches the index directory that
you are moving.
10. On the Specific tab of the Search Engine Properties page, type the new path of
11. Click the Update button. If you want to allow other Search Engines to search the
index that you are moving, modify the index directories for other Search
Engines.
12. Return to the processes_prefix Data Source Folder page.
choose Start.
choose Resume.
To Move an Index to a Different Host

To move an index to a local drive on a different Content Server host:

Folder link of the data source folder that corresponds to the index directory that
you want to move.
choose Suspend.
choose Stop.
4. Move the index directory to its new location.
6. On the Partition Map page, click an Index Engine's name link.
7. On the Specific tab of the Index Engine Properties page, click the shortcut of the
Admin server to whose host you moved the index directory in the Host drop-
down list.
8. Type the new path of the index directory in the Index Directory field as it is
mapped on the Admin server selected in the Host drop-down list (for example,
new_path/index).

10. Click the name link for a Search Engine that searches the index directory that
you are moving.
11. On the Specific tab of the Search Engine Properties page, type the new path of
12. In the Host drop-down list, click the shortcut of the Admin server to whose host
you moved the index directory.
13. Click the Update button. If you want to allow other Search Engines to search the
partition's index that you are moving, modify the index directories for other
Search Engines.
14. Return to the processes_prefix Data Source Folder page.
choose Start.
choose Resume.
30.9.2 Gather Data Source Search Log Files

You can gather the search log files and archive them to a temporary log directory. To
avoid gathering long files, you can specify the total number of lines you want to
collect from the log file. The line number starts at the last line in the file and counts
up to the first line of the file. For example, if there are 100 lines in the file, and you
specify 11 lines, lines 100 to 89 will be collected.
To Gather Data Source Search Log Files

To gather data source search log files:
1. On the System Volume Object page, click the Enterprise Data Source Folder's
Functions icon, and then choose Maintenance.
2. On the Data Source Maintenance page, click the Gather the log files for this
data source radio button.
4. On the Gather Logs for Data Source page, click a value in the Number of Lines
to Gather from the End of the Log File drop-down list box.
5. Select the Include Search INIs, DCS Log Files, and Admin Server Config Files
check box to gather these files.
7. On the Gather Logs for Data Source page, click the Download button, and then
specify the location where you want to download the archived files.

To Set Data Source Data Log Levels

To set log levels for this data source:
Functions icon, and choose Maintenance.
2. On the Content Server Data Source Maintenance page, click the Set log levels
for this data source radio button.
4. On the Set Log Levels for this Data Source page, click a value in the Log Level
drop-down list:
• Info Level - all types of messages.

• Status Level - periodic status messages, warning messages, and all error
messages.
• Warning Level - warning messages and all error messages.
• Error Level - typical error messages and severe error messages.
• Severe Error Level - severe error messages.
5. In the Processes to Affect drop-down list, select the types of processes to set log
levels for from the drop-down list:
• All - both searching and indexing data sources.

• Searching - only searching data sources.
• Indexing - only indexing data sources.
The page is updated with a report of each System Object affected, the log level
selected, and the name of the node.
30.9.3 Re-indexing
Re-extracting the data from the source updates out-of-date Content Server objects
and adds missing objects to the index. Purging the data flow and reconstructing the
index removes all pending objects from the data flow, empties all index partitions,
and then repopulates the partitions with data by issuing a re-extract command.
Note: Before re-extracting an Enterprise or non-Enterprise data source, ensure

that all processes in the corresponding data flow are scheduled or running. If a
process is idle, it will not be automatically restarted after the re-extraction
occurs.
Warning
For extremely large indexes, re-extraction may take considerable time.

Enterprise Data Sources
If you perform searches and the results suggest that the Enterprise index may be
incomplete or out-of-date, you can verify whether the contents of the index match
the actual contents of the Content Server database. For details, see “Configuring
Index Verification” on page 631.
If you suspect that the current version of the Enterprise index is corrupt, you can
restore a previous version, provided you have backed it up. For more information
about backing up and restoring indexes, see “Backing Up and Restoring Indexes”
on page 647. Alternatively, you can re-extract all the data from its source, which is
the Content Server database.
If you purge the data flow and then re-extract the data from its source, the index's
regions settings are reset. This means that the settings you have configured for index
regions' display names or search options (queryable, displayable, or search by
default) will be lost. For more information about configuring index regions, see
“Configuring a Hyperlink Mapping Example” on page 429. OpenText recommends
that you take note of index regions settings so that you can reset their values after
purging and re-indexing the data source.
Note: If your Enterprise index is spread across multiple Enterprise data

sources, you must perform the re-indexing operation on all Enterprise data
sources.
Notification and Auditing
You can configure Content Server so that you can track purge and re-extract
commands for Enterprise Data Sources through system alert emails or auditing.
If you have enabled Notification, and error checking and email delivery, Content
Server will deliver a system alert email each time a purge or re-extract command has
been made for an Enterprise data source. For information about enabling error
checking and email delivery, see “Enabling Error-Checking and E-Mail Delivery”
on page 568.
You can also set Enterprise data source purge and re-extract commands as auditing
interests.
Non-Enterprise Data Sources

When you create a non-Enterprise index (for example, a Directory Walker index),
you build a data flow that extracts and indexes data from its original data source (for
example, a local directory or a Web site). If you want to re-index the data at any
time, you can purge the data flow, re-extract the data from its original data source,
or do both. You re-index data when you suspect that the contents of an index are
corrupt. If you purge the data flow and then re-extract the data from its source, the
index's regions settings are reset. This means that the settings you configure for
index regions' display names or search options (queryable, displayable, or search by
default) will be lost. For more information about configuring index regions, see
“Configuring a Hyperlink Mapping Example” on page 429. OpenText recommends

that you take note of index regions settings so that you can reset their values after
purging and re-indexing the data source.
If you want to re-index the data in an XML Activator Producer data source, you
copy the original data that has been indexed by the XML Activator Producer data
source from the third-party application into the XML Activator Producer process's
incoming directory. This allows the XML Activator Producer process to reconstruct
its index from the original third-party data. For more information about XML
Activator data flows, see “Creating an XML Activator Producer Data Flow”
on page 418.
Control Rules and Re-indexing
When running control rules for capacity-based and date-based partition creation,
Content Server creates new partitions and steps down the modes of old partitions if
you have configured the rules accordingly. Because Content Server cannot update
partitions in Read-Only mode, re-extracting the data from the source will not work
properly in these cases unless all Read-Only partitions have been set to Update-Only
first. You must also have at least one Read-Write partition into which Content Server
can add missing objects.
Warning
deleted.
Similarly, because Content Server cannot delete partitions in Read-Only and

Update-Only modes, purging the Enterprise index and re-extracting data from the
Content Server database to rebuild the index will not work properly in these cases
without preparatory actions, which depend on the control rules in your system.
After the preparatory actions have been taken, the process of rebuilding the index
creates partitions as defined in the partition creation control rules. For example, if a
date-based partition creation rule specifies for a new partition to be created after
every calendar month of data, then as Content Server rebuilds the index from the
oldest object to the newest, it creates a new partition for every calendar month of
data. For more information about control rules, see “Administering Control Rules”
on page 609.
The Search Engine supports a partition in Retired mode. This mode is an alternative
to Update, Read/Write or ReadOnly modes. In Retired mode, an index will accept
updates and deletions, but not new objects. In addition, a complete replacement of
an object in Retired mode will rebalance the object to another partition and delete it
Updating Search Configuration Files

With a new installation of Content Server, the latest versions of several search
configuration files are available. These files change occasionally to improve the
performance and efficiency of the search engine, or to tune the behavior of the DCS.
If you have upgraded from an older version of Content Server or applied an Update

to Content Server, these new files are not used. Instead, your existing configuration
files are retained for compatibility.
If you are performing a purge and re-index operation, this is a good time to review
your old configuration files and potentially replace them with newer configuration
files. Once you have an existing index, changing these files is not always possible.
One source for new configuration files is the Content Server_home\config
\reference directory for your version of Content Server. In particular, you should
consider the following configuration files located in the <OTHOME>\config
directory:
• dcs.ini
• LLFieldDefinitions.txt
• LLFieldDefinitions_EL.txt
You may also want to modify these files to meet any specific requirements you may
have. If changing the files, you should first disable the Extractor and ensure there are
no iPool messages waiting for processing. Then modify the files, perform the Purge
and re-index operation, and enable the Extractor to build a new index with the
updated settings.
The following table describes the preparatory actions that you must take before
purging the data flow and re-extracting the data from its source, depending on the
control rules that you have set up for the data source.
Table 30-12: Preparatory Actions Reference Table
Control Rule Preparatory Actions

Capacity-based partition creation Change all partitions to Read-Write mode.
Date-based partition creation Delete all partitions except for the oldest one,
change that partition to Read-Write mode,
and then change the control rule's trigger
date to the original trigger date.
Capacity-based and date-based partition Delete all partitions except for the oldest one,
creation change that partition to Read-Write mode,
and then change the date-based control rule's
trigger date to the original trigger date.
For more information about changing a partition's mode, see “Working with
Manually Changed Partition Modes

If you have manually changed any partition modes to Read-Only, you must change
them to Update-Only before re-extracting the data from the source. Similarly, if you
have manually changed any partition modes to Read-Only or Update-Only, you
must change them to Read-Write before purging the data flow and re-extracting the
data from its source.

Warning
deleted.
On new and upgraded installations of Content Server Update 10.5, or later, the
Search Engine supports a partition in Retired mode. This mode is an alternative to
Update, Read/Write or ReadOnly modes. In Retired mode, an index will accept
updates and deletions, but not new objects. In addition, a complete replacement of
an object in Retired mode will rebalance the object to another partition and delete it
To Re-index the Enterprise Content

To re-index the Enterprise content:
1. Ensure that all of the processes in the Enterprise data flow are scheduled or
running.
Functions icon, and then choose Maintenance.
3. On the Data Source Maintenance page, click one of the following radio buttons:
• Re-extract the data from the source, which re-extracts the data from the
Content Server database without purging the Enterprise index
• Purge the data flow, reconstruct the index, and then extract the data from
the source, which deletes the contents of the Enterprise index before re-
extracting the data from the Content Server database
Note: With a new installation of Content Server, the latest versions of

several search configuration files are available. These files change
occasionally to improve the performance and efficiency of the search
engine, or to tune the behavior of the DCS. If you have upgraded from an
older version of Content Server or applied an Update to Content Server,
these new files are not used. Instead, your existing configuration files are
retained for compatibility.
If you are performing a purge and re-index operation, this is a good time
to review your old configuration files and potentially replace them with
newer configuration files. Once you have an existing index, changing these
files is not always possible. One source for new configuration files is the
Content Server_home\config\reference directory for your version of
Content Server. In particular, you should consider the following
configuration files located in the Content Server_home\config directory:
• dcs.ini
• LLFieldDefinitions.txt
• LLFieldDefinitions_EL.txt

You may also want to modify these files to meet any specific requirements
you may have. If changing the files, you should first disable the Extractor
and ensure there are no iPool messages waiting for processing. Then
modify the files, perform the Purge and re-index operation, and enable the
Extractor to build a new index with the updated settings.
5. On the Data Source Maintenance Results page, click the Continue button.
To Re-index Content in Non-Enterprise Indexes

To re-index content in non-Enterprise indexes:
1. Ensure that all the processes in the data flow are scheduled or running.
2. On the System Volume Object page, click the Functions icon of the data source
folder containing the data that you want to re-index, and then choose
Maintenance.
3. On the Data Source Maintenance page, click one of the following radio buttons:
• Re-extract the data from the source, which re-extracts the data from its
source without purging the existing index
• Purge the data flow, reconstruct the index, and then extract the data from
the source, which deletes the contents of the index before re-extracting the
data from its source
5. On the Data Source Maintenance Results page, click the Continue button.
30.9.4 Configuring Index Verification

The Configure Index Verification page allows you to control when index verification
will run, set rules for how objects are identified and corrected, specify report
preferences, and define the messages sent to administrators. The options for each
section of the page are explained starting with “Verification Schedule”
on page 635.
Dependencies
The verifier can issue administrator alerts under certain circumstances. These alerts
use the standard Content Server notification process, and assume that the
notification system is correctly configured.
Some features of the verifier require the use of the metadata integrity checksum
feature in the Search Engine, which does not have an administration interface within
Content Server. The default configuration in the Search Engine is for this feature to
be disabled. Refer to the Search Engine documentation for information on
configuring this feature. If not enabled, then the features of the verifier that use this
capability can be selected, but will not identify errors as expected.

Index Verification Agent
The index verification process breaks the task of checking the index into many small
chunks, which are then scheduled to run based on time of day and day of the week.
The verification process is connected to the standard Content Server 5 minute agent.
Each time the agent is run, more chunks of the verification task are performed.
For small indexes, the overall time to run through a complete analysis of the index
may be minutes. For very large indexes, depending upon the scheduling options, a
complete verification pass may require several weeks to complete.
In the [loader] section, add an entry for the verifyAgent:

[loader]
load_verify=verifyAgent
Edit the existing [agents] section to add the verifyAgent ID (12568) to the list of
excluded activities, illustrated in the last line below:
[agents]
lib=.\bin\lljob.dll
name=lljob
prio=critical
timeout=5000
info=.\config\opentext.ini;agents
StartScript=.\scripts\llfull.lxe
JobScript=.\scripts\agent_run.e
CRON=0,5,10,15,20,25,30,35,40,45,50,55 * * * *
SleepIntervalSec=60
ExcludeActivityIDs=3000,3501,5000,8999,9000,9001,9999,12568
Create a new section for the verifyAgent from a copy of the [agents] section, and
modify along these lines:
[verifyAgent]
lib=.\bin\lljob.dll
name=lljob
prio=critical
timeout=5000
info=.\config\opentext.ini;verifyAgent
StartScript=.\scripts\llfull.lxe
JobScript=.\scripts\agent_run.e
CRON=0,5,10,15,20,25,30,35,40,45,50,55 * * * *
SleepIntervalSec=60
ActivityIDs=12568
The key differences from the standard agent section are the section name, the
ActivityIDs of 12568 instead of ExcludeActivityIDs in the last line, and the name
change to verifyAgent in the info= line.
If there are multiple instances of Content Server running, it is important that the
verifyAgent be configured to run on only one instance.
The index verifier is capable of detecting and correcting several types of errors.
However, this is not a replacement for the index validation utilities provided with

the OpenText Search Engine. The validation utilities can identify potential errors
internal to the data structures within the Search and Index Engines, and should be
used on a regular basis.
Detectable Errors
The verifier is capable of detecting several types of errors and warnings, most of
which can be selectively tested. The verifier compares the index against all
Enterprise Data Sources and Enterprise Library Sources, but does not check objects
that are not managed by Content Server, such as files imported into the search index
using DirWalker or XMLActivator.
Missing objects are items managed by Content Server, which should be present in
the search index, but are missing from the index.
Stale objects are items managed by Content Server and are present in the search
index, but are out of date. The determination of stale objects is based upon the
OTModifyDate field.
Orphaned objects are those which are indexed in the Search Engine, but do not
have a corresponding entry in the database. These are almost certainly objects that
were deleted from Content Server, but not deleted from the search index. Tests for
orphaned objects obey partition restrictions and maximum object age. Tests also
obey version restrictions when the current version can be determined. For example,
if a version is orphaned but the dataID exists in Content Server then the current
version number is checked. Note that minimum object age is ignored for orphaned
objects.
Orphaned Renditions are objects that cannot be corrected, so they will remain in the
search index until the entire index is purged. The Status Code is 9.
Metadata integrity errors exist when the Search Engine believes that one or more
metadata values have unexpectedly changed since the object was indexed. The
Search Engine can create a checksum for metadata at index time, and as a
background task re-calculates the checksum. If the re-calculated checksum does not
match, an error is recorded for the object. This error code is tested for verification.
This feature requires Search Engine configuration as described in the Dependencies
section.
Content warnings are based upon the OTContentStatus metadata field. Content
Status is generated during the indexing of an object. Each object is given a grade
indicating the quality of the content. Objects with no content indexing problems
receive a low grade. Objects for which the content is not indexable at all receive a
high grade (severe rating). The content warning threshold selects the relative
severity rating of content indexing problems for which a warning should be
recorded. Content warnings are not correctable.
Metadata warnings are based upon the number of metadata fields that could not be
indexed. This occurs if dates or numbers are malformed, for example. Each
unindexable field increments the value in the OTIndexError field. A metadata

warning exists when the value in this field exceeds a definable threshold for an
object. Metadata are not correctable.
Index Verification Configuration

The Index Verification Configuration page within Content Server is accessed from
the System Object Volume page.
The configuration values are grouped into the following sections for convenience:
• Verification Schedule
• Verification Rules
• Correction Options
• Verification Report
• Notifications
• Checksum Integrity Status
Each of these sections is described in detail below. When you have finished
reviewing and modifying the configuration settings, click the Update button at the
bottom of the page to start the Verification process at the next time you defined in
the Verification Schedule section.
To access the Configure Index Verification page:

2. On the System Object Volume page, click the Enterprise Data Source folder's
Functions icon and then chose Maintenance.
3. On the Content Server Data Source Maintenance page, click the Configure
search index verification radio button.
4. On the Configure Index Verification page, use the information for each section
to configure your Content Server installation.
When you have finished, click the Update button to start the verification process at
the next time you defined in the Verification Schedule section. You can click
Verification Reports to open, download or email a report, or click Verification
Status to see the current or previous verification activity on the Index Verification
Status page.
You can perform most administrative tasks relating to Index verification on the
Configure Index Verification page which contains a number of different sections and
fields, as described in these tables:

Verification Schedule
The Verification Schedule section of the configuration page is used to control the
execution of the Verifier. There are two basic modes of operation: make one pass
through the index then stop; or perform continuous verification.
Continuous verification is generally recommended for most applications. This mode

will proactively identify problems with the search index, and possibly correct
problems without administrator intervention.
A description of each control in the Verification Schedule section follows:
Table 30-13: Verification Schedule
Field Description
Mode Select how verification will run:
• Disabled – No verification is scheduled.
• Run Once – Verification is scheduled,
and will make one iteration through the
validation process then stop.
• Run Continuously – Verification is
scheduled. When an iteration is
completed, verification will restart at the
beginning.
Suspend Verification Pause the verification process, and resume
the process from the current location.
Suspending verification is useful when
performing other resource-intensive
administration tasks. When suspended, the
button will change to Resume.
Run On These Days Select the days of the week on which the
verification process should run.
At these hours Select the hours of the day on which the
verification process should run. Typically,
verification would be scheduled for off-peak
hours, perhaps between midnight and 5 AM.
Maximum Load The verification process is designed to
control the load it places on the system. The
percentage control determines the relative
time spent active versus waiting. A higher
percentage executes faster and increases the
load on the system. Verification will check a
number of objects, then pause for a period of
time based upon this load setting. Note that
this value is an approximate target, not an
exact figure.

Field Description
Reset Error Counts Causes the verifier to discard all status and
progress information, essentially resetting
the verifier. Correction retries, unfixable and
error records are discarded. A reset is
generally recommended after making any
structural changes to the search
configuration or after changes to extraction
or verification rules.
Verification Rules
The Verification Rules section controls which objects are considered for verification,
and identifies what tests should be performed.
The verifier inherits a definition of what should be indexed from the Content Server
Extractor. The controls in this section represent additional constraints on verification
in addition to the Extractor constraints.
Table 30-14: Verification Rules
Field Description
Maximum Object Age Verification can be limited to recent objects
only. The age is specified in months,
measured from the time at which an object is
tested. The definition of recent is based upon
the Content Server Last modified date. For
example, to restrict verification to objects that
were modified in Content Server within the
last two years, enter 24 months.
Maximum Versions Per Object The upper limit on the number of versions of
the object to correct. If versions 20, 13, 10, 9,
4, 3, 1 of an object exist, then entering 5 will
test versions 20, 13, 10, 9, 4, but versions
below 4 would not be tested.
Note: Depending on the type of object,

this setting may be capped at the
Extractor setting for Maximum
Versions to Extract. Subtypes 144, 145
and 146 are not affected by the
Extractor setting.

Field Description
Minimum Object Age Content Server uses asynchronous and batch
processes when indexing and updating
objects in the Search Engine. This causes a
delay between synchronizing the status of an
object in Content Server and updates to the
object in the Search Engine.
This Minimum Object Age represents the

grace period for the delay. Any objects added
or modified within this interval are NOT
tested for correctness in order to eliminate
“false positives” (discrepancies on objects
which have not yet been completely
processed are not reported). A value of 30
minutes is usually sufficient, but longer
values may be needed for applications where
large indexing backlogs are possible.
Test For Missing Objects If selected, verification will look for objects
which are missing from the index.
When making the determination of whether

objects are missing from the index, the
contents of all the partitions are considered,
regardless of their modes or the settings for
which partition types should be checked.
Test For Orphaned Objects If selected, verification will look for objects in
the index which should have been removed.
The Maximum Versions Per Object setting

is used in cases where the dataID exists in
Content Server and therefore the current
version number can be determined. It is
orphaned if it exists in the index and there is
no corresponding object managed within
Content Server.
Test For Stale Objects If selected, Verification will look for objects
that exist in the index, but which have an
incorrect Last modified date.
Test For Metadata Integrity Errors If selected, verification will identify objects
for which the Search Engine has identified
incorrect metadata checksums. To be
effective, Search Engine configuration may
be required, refer to the Dependencies
section.
Threshold for Content Warnings If identification of objects where the content
was not correctly indexed is necessary, select
the appropriate warning threshold.

Field Description
Test for Metadata Warnings If identification of objects where metadata
fields could not be indexed is necessary,
enter the threshold for the number of bad
fields for an object.
Check Read-Write Partitions If selected, verification will examine objects
in all read-write partitions for correctness.
Check Update-Only Partitions If selected, verification will examine objects
in update-only partitions for correctness.
Check Read-Only Partitions If selected, verification will examine objects
in all read-only partitions for correctness.
Object Sub-Types All Content Server object subtypes are
checked for correctness by default. This
allows you to restrict verification to a subset
of object subtypes. Click the edit icon to
display a list of all available subtypes in the
system, then select the subtypes to include or
exclude from testing.
Object MIME-TYPES All Content Server document MIME types
are checked for correctness by default. This
allows you to restrict verification to a subset
of MIME types. Click the edit icon to display
a list of all available MIME types in the
system, then select the MIME types to
include or exclude from testing
Note: There are several metadata fields

in Content Server that may contain a
MIME-TYPE. The OTLLMIMEType
metadata field is used here.
Correction Options
In addition to reporting on the correctness of objects in the index using the

Verification rules, the correction feature can be used to fix discrepancies between the
index and objects managed within Content Server.
When correction is enabled, the current extraction rules are applied – not the
extraction rules that were in place when the object was indexed. If the extraction
rules have changed since objects were indexed, then correction will attempt to
realign the contents of the index with the current extraction rules.
Note: Changing extraction rules may trigger significant correction activity.
Correction tracks the number of attempts made to fix an object. If the object cannot
be fixed in three consecutive verification passes, then it is marked as unfixable and

skipped in future correction attempts. The Reset Error Counts feature in the
Verification Schedule section can be used to clear this tracking and provide a fresh
start to correction. The objects which can be corrected are a subset of the objects
which are verified. The rules for object verification are applied, and additional
correction constraints in the table below are possible in the correction options
section.
Objects in Read-Only partitions cannot be corrected.
Table 30-15: Correction Options
Field Description
Enable Correction When selected, enables the correction
process.
Maximum Object Age This instructs the verifier to limit correction
to recent objects only. The age is specified in
months, measured from the time at which an
object is tested. The definition of recent is
based upon the Content Server Last
modified date. For example, to restrict
correction to objects that were last modified
in Content Server within the last two years,
enter 24 months. This value cannot be greater
than the corresponding value in the
Verification Rules section.
Maximum Versions Per Object The upper limit on the number of versions of
the object to correct. If versions 20, 13, 10, 9,
4, 3, 1 of an object exist, then entering 5 will
test versions 20, 13, 10, 9, 4, but versions
below 4 would not be tested.
Note: This value cannot be greater

than the corresponding value in the
Verification Rules section.
Depending on the type of object, this

setting may be capped at the Extractor
setting for Maximum Versions to
Extract. Subtypes 144, 145 and 146 are
not affected by the Extractor setting.

Field Description
Add Missing Archived Objects If selected, verification will attempt to add
missing objects that are currently stored in
Archive Server. Archival systems may have
long access times or limited access
bandwidth. This feature is intended to limit
the extraction of content from archive
sources.
All corrections extract the full content if the

metadata is not correct, so the content is
probably not correct also. When not selected,
objects in archive servers are not corrected at
all.
Note: This control will only be visible

if Archive Server is installed.
Add Missing Objects If selected, verification will attempt to add
objects that are missing from the index. In
the Verification Rules, Test for Missing
Objects must be selected.
Remove Orphaned Objects If selected, verification will attempt to
remove orphaned objects from the index. In
the Verification Rules, Test for Orphaned
Objects must be selected.
Update Stale Objects If selected, verification will attempt to correct
objects that have an incorrect Last modified
date in the index. In the Verification Rules,
Test for Stale Objects must be selected.
Fix Metadata Integrity Errors If selected, the content and metadata for the
object with errors will be re-indexed. In
theVerification Rules section, Test for
Metadata Integrity Errors must be selected.
Fix Read-Write Partitions If selected, verification will attempt to correct
objects located in partitions that are set to
read-write mode. In the Verification Rules,
Check Read-Write Partitions must be
selected.
Fix Update-Only Partitions If selected, verification will attempt to correct
objects located in partitions that are set to
Update-Only mode. In the Verification Rules,
Check Update-Only Partitions must be
selected.
Verification Report
The Verification Report section defines how reports are created.
When an index verification and correction iteration is completed, a report is

generated containing summary and detailed information about incorrect objects.

This report is stored in the System Object Volume folder within Content Server. The
report is created in a comma-separated values (CSV) format, for import into
spreadsheets and other applications to review and analyze. More information about
the report contents is available in “Viewing the Index Verification Reports”
on page 643. This section of the verification page allows you to specify how the
report should be created.
Table 30-16: Verification Report
Field Description
Maximum Errors In Detail Report The maximum number of objects known to
be incorrect which should be included in a
detailed listing of objects with errors. This
limits the number of entries in the detailed
section of the report, but does not affect the
number of errors that will be detected,
corrected, or included in the report statistics.
Notifications
The Notifications section defines which notices are sent to administrators as part of
the verification process.
Notifications are delivered using the standard Content Server notification system.
For each possible notification, control over the message severity and the message to
be included is available.
Table 30-17: Notifications
Field Description
Verification Complete • Enabled – When selected, administrators
are sent a notice when a verification
iteration completes.
• Type of Message:
• correction, a previously reported error
has been rectified
• information, general status and other
system information
• warning , non-critical errors in the
system
• error, error messages and severe error
messages
• severe error, critical system errors
such as index verification shutting
down
• Message – The text to be included in the
notification email.

Field Description
Error Threshold • Enabled – When selected, administrators
are sent a notice when the number of
errors detected during a verification
iteration exceeds the specified error
count. This notification happens
immediately, not upon completion of the
verification process.
• Notify when number of errors >= – The
number of errors is the sum of missing,
orphaned and incorrect objects.
Exceeding this value triggers the
notification.
• Type of Message – Select the type of
message to send: correction, information,
warning, error, severe error.
• Message – The text to be included in the
notification email.
Checksum Integrity
This process runs independently of the verification and correction agent.
The Checksum Integrity feature will query the Search Engines on a periodic basis
and trigger administrator notifications if serious data integrity errors exist.
The Search Engine has a feature that computes checksums on metadata regions
when an object is first indexed, then performs continuous testing to verify that the
checksum is correct as a low-priority background task. This process is designed to
detect any corruption of metadata that may occur over time. The integrity status
feature, when enabled, queries the Search Engines on a regular basis to obtain the
number of checksum errors. If the number of errors increases, then the administrator
should be alerted to check that the hardware and configuration of the Search
Engines is operating correctly.
The Checksum integrity feature uses the same configuration of the Metadata
Integrity required for verification and correction. Refer to the “Dependencies”
on page 631 section for more information.
There is no separate report detailing objects exhibiting these errors. However, the
verification report captures statistics on these errors, and identifies objects with
metadata integrity errors.
Table 30-18: Checksum Integrity Status
Field Description
Enabled When selected, enables the checksum
integrity process.

Field Description
Metadata Integrity • Notify when number of total integrity
errors >= – The total number of checksum
integrity errors.
OpenText suggests an initial value of
‘1000’.
• or when number of new integrity errors
>=— The number of new checksum
integrity errors.
OpenText suggests an initial value of
‘100’.
• Type of Message – Select the type of
message to send:
• correction, a previously reported error
has been rectified
• information, general status and other
system information
• warning , non-critical errors in the
system
• error, error messages and severe error
messages
• severe error, critical system errors
such as index verification shutting
down
Checksum errors are relatively
serious, so OpenText suggests a severe
error message level.
• Message – The text to send in the
message.
Viewing the Index Verification Reports

A report is created when an index verification and correction iteration is complete.
The reports are created in a Comma-Separated Variable (.CSV) format and named
by their creation date. All reports are stored in the Verification Reports folder of the
System Object Volume, which can also be accessed by a link at the bottom the
Configure Index Verification page.
Note: Column #1 in the report contains a 0 for rows with configuration and
statistics information, and a 1 for rows with detail data. This is provided as a
convenience to allow easy sorting of the detailed objects by sorting on column
#1 first.
To View the Verification Reports
1. On the System Object Volume page, click the Verification Reports Folder link.
2. On the Verification Reports page, you can click each report to open a
Document Overview Page to perform a number of functions on the report.

3. You can import the report into most spreadsheet applications for review and
analysis.
The Index Verification Report is comprised of four sections: header, configuration,

statistics and details.
The header is comprised of the report title, the version of the software that generated
the report, the time of the report generation, and the name of the system.
The configuration section is a snapshot of the verification and correction settings at

the time the report was run. This information provides a perspective on the
information provided in the report, and supporting information in the event that the
status of the search index needs to be audited.
The statistics section contains a number of useful totals by error type, illustrated
below. Note that vertical numbers are NOT expected to add.
Metadata
Missing Orphaned Orphaned Stale Total
Integrity
Objects Objects Renditions Objects Objects
Errors
Newly
identified 3 2 1 0 0 6
errors
Attempted
fixes this 1 0 0 0 0 1
iteration
Marked
unfixable
0 2 0 0 0 2
this
iteration
Corrected
last 0 0 0 3 0 3
iteration
Total
unfixable 0 3 0 1 0 4
objects
Total
incorrect 3 8 1 6 0 18
objects
• Newly identified errors are those which have been identified for the first time on
this iteration.
• Attempted fixes represent the number of objects for which a correction attempt
was made on this iteration. If correction is disabled, this will always be 0.
• Marked unfixable this iteration is a count of the number of objects for which a
third correction attempt was made in the previous iteration, and the object
remains in error. The objects have been marked as unfixable, and no further
attempts to correct them will be made. Unfixable objects is a reflection of objects

where fixes where attempted. It does NOT include objects for which correction
attempts are not made. For example, bad objects in Read-Only partitions are not
included in this count.
• Corrected last iteration represents the number of objects for each error type that
were successfully fixed in the previous iteration, and are no longer in error on the
current iteration.
• Total unfixable objects represents the number of objects currently marked as
unfixable, for which correction is not attempted. This includes the newly
unfixable objects and previously unfixable objects.
• Total incorrect objects is the number of objects for each type currently found to
be in error in the last iteration.
Some additional convenience statistics are provided, including the total number of
objects found in the index, the number of objects with content or metadata warnings,
and the number of entries in the detailed object list.
The detailed object list is the final section of the report. This section contains a list of
all objects which the verifier reports to be in error, subject to the maximum value in
the Verification Report configuration section.
The report is limited to 10,000 items per report file to make it manageable. If there
are more objects to report, then they are placed in separate report files, and marked
in the description, for example: (2 of 7).
The detailed report contains the information in “Details” on page 645 below. Note
that not all values will be populated, depending upon the type of object and error.
Table 30-19: Details
Field Description
Name The Content Server object display name
(OTName)
OwnerID The numeric value Content Server uses to
represent the owner of the object.
DataID The numeric value Content Server uses as
the data ID for the object. (OTURN)
Version The Content Server version for the object.
SubType The Content Server specific type of item.
Status Code A numeric code identifying why this object is
labeled as a discrepancy.
Status A human-readable label for why the object is
labeled as a discrepancy.
Retries If correction attempts are being made, this
represents the number of attempts made to
correct the object.

Field Description
Last Retry The time and date of the last correction
attempt for this object. Will be empty if no
retries have been attempted.
Date Modified The date this object was last modified in
Content Server (OTModifyDate).
Date Created The date this object was created in Content
Server (OTCreateDate).
Partition ID The name of the partition in which the object
is located.
Partition Mode The read / update / write mode of the
partition in which the object is located.
Integrity Errors “OK” if there is no checksum integrity error,
otherwise “error”.
Content Status Numeric code representing the content
indexing status for this object. 400 series
status represents unusable content, while
100 series status is good, with points in
between.
Metadata Errors Number of metadata fields that could not be
indexed for this object.
OTObject The string value Content Server uses as the
unique identifier for this object.
Note: The status of the index verification is displayed on the Search Index
Verify Log page for one week after the verification completes.
30.9.5 Data Source Maintenance Results

Content Server displays the Data Source Maintenance Results page when you
perform certain maintenance tasks on a data source folder (for example, purging and
re-extracting data from the data source). The Data Source Maintenance Results page
records the status of these maintenance operations and identifies the actions that
Content Server took to complete them.
The links on this page take you to the help available for the tasks you can perform in
Content Server at this point. Click one of the following links to proceed:
• To Reindex the Enterprise Content

• To Reindex Content in Non-Enterprise Indexes
• Backing Up and Restoring Indexes
Click the Continue button to return to the System Administration page.

30.10. Backing Up and Restoring Indexes
30.10 Backing Up and Restoring Indexes

A data source's index allows Content Server users to search for items in that data
source. If an index has been deleted or you suspect that its contents are corrupt, you
can re-create it by purging its data flow and re-indexing its data source. However,
for a large data source, such as the Content Server Enterprise, purging and re-
indexing can be a time-consuming process. Therefore, you should back up your
indexes on a regular basis. Index backups allow you to restore an index to a recent
state without having to perform a full re-index. Because the backup and restore
processes operate only on the index, they take far less time than re-indexing a large
data source.
Content Server backs up an index by copying all the relevant files from the index's
location to a destination directory. You can then use your corporate backup software
to back up the destination directory. When you restore the index, you place the
appropriate files in a directory and specify that location to the restore process.
Content Server provides two types of backups that you can use in combination:
• Full: A full backup saves the entire index to a destination directory, overwriting
any previous backups that exist in that location. You can keep only one full
backup of an index in any given location.
• Differential: A differential backup saves only the data that has changed in the
index since the last backup. In most cases, this means that a differential backup
requires less disk space than a full backup; however, because Content Server
merges periodically, this is not always the case. For example, suppose that four
index fragments exist when you perform your first full backup. The full backup
saves all four index fragments. Then suppose that a merge operation occurs. This
results in one index fragment that contains all four previous fragments. If you
run a differential backup at this point, the remaining index fragment is saved,
but may require as much, if not more, disk space than the previous full backup.
Differential Backup and Merges

Developing a Backup Policy
To make full use of the backup and restore features, you must develop a policy that
determines the frequency and types of backups that are appropriate for your site.
For most sites, OpenText recommends scheduling full backups less frequently and
differential backups more frequently. For example, you may plan a full backup once
a week and differential backups each night.
Automating Index Backups
You can schedule automated backup processes to implement a backup policy using
a Backup Manager. A Backup Manager is a special Content Server folder that
contains the scheduled backup processes that are associated with a particular data
source. Within the Backup Manager, you can create, change, or delete scheduled
backup processes. Before you back up a data source's index, that data source must
have a Backup Manager. If the data source does not have a Backup Manager, you
must create one.
Backing Up Indexes Manually
You can manually start a backup process at any time by using the Backup Wizard,
provided there is no backup process currently running on the data source you are
trying to back up. If you try to manually start a backup process on a data source that
has no Backup Manager, Content Server prompts you to create a Backup Manager.
Note: OpenText recommends that you automate index backups.
Viewing the Index Backup History
If you want to view the backups that have been performed on a data source in the
past, you can view its backup history.
Restoring Indexes
If an index becomes damaged or corrupted, and you have backed up the index, you
can use the Restore Wizard to restore the index to its state as of the most recent
backup. You can then start the extractor or producer process for that data source to
re-extract any changes in the database since the last backup.
Before you restore an index, you must retrieve the backups of that index from your
corporate backup repository and place these files in a temporary location. From
there, Content Server Restore Wizard copies the files back into the index's home
location. You must also stop the indexing and searching processes, as well as the
Backup Manager before restoring an index. This will prevent an automatic
(scheduled) backup from occurring when the restore operation is in progress.

30.10.1 Automating Index Backups

If you want to backup an index at regular, scheduled intervals, you automate the
index backup operation. To do so, you create a Backup Manager.
Backup Managers
Before you can back up an index (either automatically or manually), the data source
must have a Backup Manager. A Backup Manager is a special Content Server folder
that contains the backup processes that are associated with a particular data source.
If you attempt to back up a data source that does not have a Backup Manager,
Content Server prompts you to create one.
If you want to change a Backup Manager's properties (for example, the default
template it uses to attach a label to each backup or the default destination directory
it uses for each backup), you edit it. If you want to remove a Backup Manager (and
the backup processes it contains) from a data source, you delete it. You delete a
Backup Manager the same way that you delete most other Content Server items.
Backup Processes
You add a backup process to a Backup Manager when you want to schedule a
backup instead of starting one manually. You schedule a backup process to
automatically occur at regular intervals.
If you want to change a backup process's properties (for example, the date and time
on which it runs), you edit it. If you want to remove a backup process from a Backup
Manager, you delete it. You delete a backup process the same way that you delete
most other Content Server items.
Note: Policy at your site will determine the appropriate combination of

backups. For example, you might want to perform a full backup once per week
and perform an incremental backup once per night.
To Add a Backup Manager

To add a Backup Manager:
1. On the System Volume Object page, click the processes_prefix Data Source
Folder link of a data source folder.
2. On the Add Item menu, click Backup Manager.
3. On the Add: Backup Manager page, type a name in the Name field.
4. To provide a description of the Backup Manager on the General tab of its

Properties page, type text in the Description field.
5. If the Backup Operation drop-down list is available (UNIX systems only), click
one of the following backup operations:

• Copy the index files to destination, which copies the index files to the
directory specified in the Destination Directory field
• Run the specified backup script, which runs a backup script (UNIX systems
only)
6. To change the default label template, edit the text in the Label Template field.
Note: The default is Data_Source %m%d%Y_%T%r, where Data_Source

represents a string identifying the data source, %m represents the month, %d
the day, %Y the year, %T the type of backup performed, and %r the partition
ID. For a complete list of the variables you can use to format the label
template, see “Date and Time Variables” on page 660.
7. For each partition that you have created, type the absolute path of the directory
where you want Content Server to back up the index in the Destination
Directory field that corresponds to the appropriate partition.
button.
To Add a Backup Process

To add a Backup Process:
Folder link of the data source folder to which you want to add a backup
process.
2. Click the processes_prefix Backup Manager link. If this link does not exist, you
must add a backup manager. For more information, see “To Add a Backup
Manager” on page 649.
3. On the processes_prefix Backup Manager page, click Backup Process on the
Add Item menu.
4. On the Add: Backup Process page, type a name in the Name field.
5. To provide a description of the backup process on the General tab of its
Properties page, type text in the Description field.
6. To have Content Server monitor this process and detect when it returns error
messages, select the Enable System Management check box.
7. Click the name of the partition that you want to backup in the Partition drop-
down list.
8. To change the format of the label string attached to the backup, edit the text in
the Backup Label field.
Note: The label allows you to identify the backup. The default is
Data_Source %m%d%Y_%T%r, where Data_Source represents a string

identifying the data source, %m represents the month, %d the day, %Y the
year, %T the type of backup performed, and %r the partition ID. For a
complete list of the variables you can use to format the label template, see
“Date and Time Variables” on page 660.
9. Click one of the following types of backup in the Backup Type drop-down list:
10. Click the level of error messaging you want in the On Error Message drop-
down list:
• None, which is the default

• Information, which notifies the recipient of general status and other system
information
• Warning, which notifies the recipient of non-critical errors in the system
• Error, which notifies the recipient of general system errors
• Severe Error, which notifies the recipient of critical system errors
Note: For more information about error messaging, see “Enabling Error-
11. In the Start Options section, click the radio button that represents when you
want the backup process to be performed:
• At This Time, which schedules the backup process to run at a specific time
on certain days of the week. Click values in the drop-down lists, and then
select the appropriate check boxes to specify the time and days of the week
when you want the backup process to run
• Every, which schedules the backup process to run at a specific interval. Click
values in the drop-down lists to specify the time units and duration of the
interval at which you want the backup process to run.
13. On the processes_prefix Backup Manager page, click the backup process's
Functions icon, and then choose Start.
To Edit a Backup Manager

To edit a Backup Manager:
1. On the System Volume Object page, click theprocesses_prefix Data Source

Folder link of the data source folder whose Backup Manager you want to
change.
2. Click the Backup Manager's Functions icon, choose Properties, and then choose
Specific.
3. On the Specific tab of the Backup Manager's Properties page, edit the
parameters of the Backup Manager.

To Edit a Backup Process
To edit a backup process:
Folder link of the data source folder that contains the backup process you want
to change.
2. Click the processes_prefix Backup Manager link.
3. Click the backup process's Functions icon, choose Properties, and then choose
Specific.
4. On the Specific tab of the backup process's Properties page, edit the parameters
of the backup process.
30.10.2 Backing Up Indexes Manually

You can back up an index at any time using the Backup Wizard. The Backup Wizard
steps through the backup operation, prompting you for the appropriate information
at the appropriate times.
If you want to backup an index at regular intervals, you automate the backup
process. For more information about the backup process, see “Automating Index
Backups” on page 649.
Using the Backup Wizard
To back up a data source's index, that data source must have a Backup Manager. If
you try to back up an index whose data source does not have a Backup Manager, the
Backup Wizard prompts you to create one. For more information about Backup
Managers, see “Backing Up and Restoring Indexes” on page 647.
Using the Command Line Interface
You back up an index using the command line interface by invoking an executable
called backuputil. You can pass parameters to backuputil using a configuration
file or command line parameters. However, OpenText recommends using a
configuration file because it allows you to preserve the settings you used when the
backup was performed.
The backup configuration file, called host#.ini by default (where # is a series of

automatically generated letters and numbers), is stored in the index directory and is
first generated by the Backup Manager when you schedule a backup process. To
have Content Server generate a configuration file for you, create a Backup Manager
and schedule a backup process. You can also create a configuration file manually.

Note: When you back up an index, Content Server creates a backup history
file, called backup.ini, inside the index's directory. In the backup.ini file,
Content Server records the history of the backups that have occurred for that
index. The backup.ini file allows Content Server to determine what has
already been backed up in that index when you perform differential backups.
Because of the importance of this file, do not name your configuration file
backup.ini if you create it manually.
To Backup an Index Using the Backup Wizard
To back up an index using the Backup Wizard:
whose index you want to back up, and then choose Maintenance.
2. On the Data Source Maintenance page, click the Back up the index radio
button, and then click the OK button. If you have not previously created a
Backup Manager, you will be prompted to add a backup manager now. Click
the OK button on the Backup Manager Create Confirmation page. On the Add:
Backup Manager page, type the required information, and then click the Add
button.
3. On the Data Source Backup page, click the Launch the Backup Wizard radio
button in the Options section, and then click the OK button.
4. On the Data Source Backup Wizard page, at the Partitions step, select the check
boxes for the partitions you want to backup, and then click the Next button.
5. At the Alert Level step, click one of the following error messages in the Alert
Level drop-down list:

information
Note: For more information about error messaging, see “To Enable Error-
7. At the Backup Type step, click one of the following radio buttons:
• Full
• Differential

Note: If the data source does not have a Backup Manager, you can only
perform a full backup type. When the Differential radio button is
unavailable, that indicates that you have not yet created a full backup.
9. At the Destination step, edit the absolute directory path for the backup in the
Destination field, or accept the default, and then click the Next button.
10. At the Label step, type an identifier for the backup in the Label field, or accept
the default, and then click the Next button.
11. At the Summary step, examine the applied wizard options. Do one of the
following:
• To continue with these options, click the Backup button.
• To change any of these options, click the Back button.
• To exit the wizard without backing up the index, click the Exit Wizard
button.
12. Click the Check Status button to refresh the process's progress. Optionally, if
you enabled error messaging for the Backup Wizard, Content Server will send
an alert message when the backup is complete.
Note: If you selected more than one partition to back up, you will be
prompted to return to step 7 to complete the backup for the remainder of
the partitions specified.
13. Click the OK button to end the Backup Wizard.
30.10.3 Viewing the Backup History

If you want to learn about which backups have been performed on a data source in
the past, you can view its backup history. The backup history includes the label that
was associated with each backup, the date and time when the backup began, the
approximate size of the backup (in MB), and the status of the backup, including an
error message if the backup failed.
To View the Backup History
To view the backup history of a data source:
Folder link of the data source folder whose history you want to view.
2. Click the Backup Manager's Functions icon, choose Properties, and then choose
History.

30.10.4 Restoring Indexes

If an index has been damaged or become corrupted, you can restore a past version of
it from a backup provided you have been regularly backing up the index. Most sites
will use a backup policy that combines periodic full backups with more frequent
differential backups. For example, you might perform a full backup once or twice
per month and a differential backup every night. A full backup preserves all the
information in an index, while a differential backup saves just the parts of the index
that have changed since the last backup was performed. Since an index will not
usually change greatly from one day to the next, differential backups are a less costly
solution.
Because an index is associated with a data source, you restore an index by launching
the Restore Wizard from the data source's maintenance page. The Restore Wizard
prompts you for the location of the most recent backup of the index, and then
determines, from the full set of backup images, which ones are needed to restore the
index to its most recent backup state.
The Restore Wizard cannot restore changes to the index made since the last backup
of that index. For example, if you made differential backups every night at midnight
and your index becomes corrupt at 6 P.M. today, any changes made to the index
between midnight and 6 P.M. will not be reflected in the restored index. Therefore,
you must remember to restart the data source's data flows and search processes. The
data flow can then re-extract any changes in the data source and add those to the
index.
For more information about restarting the data flows, see “Maintaining Data Flows”
on page 467. For more information about starting and stopping search processes see
“To Start or Stop Searching Processes” on page 698.
Note: Before you restore an index, you must retrieve the backups of that index
from your corporate backup repository and place these files in a temporary
location. From there, Content Server Restore Wizard copies the files back into
the index's home location. OpenText also recommends that you stop the
indexing and searching processes, as well as the Backup Manager before
restoring an index. This will prevent an automatic (scheduled) backup from
occurring when the restore operation is in progress.
To Restore an Index Using the Restore Wizard

To restore an index using the Restore Wizard:
1. Restart the data flow associated with the data source for whose index you want
to restore.
2. Restart the search process associated with the data source for whose index you
want to restore.
3. Stop the Backup Manager associated with the data source for whose index you
want to restore.

4. Remove all the files from the directory of the index that you want to restore.
Note: The directory path of a data source's index is stored in the Index
Directory field on the Specific tab of the Properties page for the data
source's Index Engine process.
Do not delete the index signature file and the
FieldModeDefinitions.ini file when clearing the index directory prior
to doing the restore. If you delete the signature file, the search processes
probably will not start because they are missing.
If the processes remain running, the Restore Wizard will fail since it
cannot overwrite files that are in use.
whose index you want to restore, and then choose Maintenance.
6. On the Data Source Maintenance page, click the Restore the index radio button,
and then click the OK button you have not previously created a Backup
Manager, you will be prompted to add a backup manager now. Click the OK
button on the Backup Manager Create Confirmation page. On the Add: Backup
Manager page, type the required information, and then click the Add button.
7. On the Data Source Restore Search Index Wizard page, at the Partitions step,
select all the partitions you want to restore, and then click the Next button.
8. At the Backup Image step, for the first partition that you are restoring, type the
absolute path of the directory that contains the last backup image in the Image
Location field, and then click the Next button.
Note: You must include the path to the directory in which the backup
image is stored. The Restore Wizard needs the last backup image to
determine the set of backup images to be restored.
9. At the File Status step, click the Check Status button to refresh the process's
progress.
10. When the Restore Wizard returns a page indicating that it has determined the
set of backup images to be restored, click the Next button.
11. At the Restore Status step, when the Restore Wizard displays the list of the
backup images it must restore, click the level of error messaging you want in
the Alert Level drop-down list:

information

Note: For more information about error messaging, see “To Enable Error-
13. At the Images step, when the Restore Wizard displays a backup image to be
restored, type the backup image's absolute path in the Location field, and then
click the Next button.
Note: You must include the path to the directory in which the backup
image is stored.
14. Click the Check Status button to refresh the process's progress. When the
Restore Wizard has completed restoring the specified image, click the Next
button.
15. At the Summary step, click the Next button to validate the restored index.
16. At the Index Validation step, click the Check Status button to refresh the
process's progress. If you enabled error messaging for the Restore Wizard,
Content Server will send an alert message when the restore is complete.
Optionally, if you selected more than one partition to restore, click the OK
button to repeat the steps in the Restore Wizard to restore the remainder of the
partitions. Do not click the Resynchronize button until all partitions have been
restored.
17. After all partitions have been restored, do one of the following:
• Click the OK button to close the Restore Wizard without resynchronizing

the Admin server.
• Click the Resynchronize button to resynchronize the Admin server
immediately.
Note: If you need to restore other indexes that are administered by the
same Admin server, restore them first, and then see “Resynchronizing
Admin Servers” on page 423 and restart the data source's data flow and
Search Manager.
18. Restart the data source's data flow process and restart the search process.

30.10.5 Using a Backup Manager

The Specific tab of a Backup Manager's Properties Page displays the following
information:
Element Description
Label Template Specifies the template used to attach a label
to each backup. This label allows you to
identify the backup. The default is
Data_Source %m%d%Y_%T%r, where
Data_Source represents a string
identifying the data source, %m represents the
month, %d the day, %Y the year, %T the type
of backup performed, and %r the partition
ID. For a complete list of the variables you
can use to format the label template, see
Backup Operation (UNIX only) Specifies whether backup processes will back
up indexes by copying files to a destination
directory or by executing a script that you
specify. The script option is available only on
UNIX operating systems. For information
about writing this script, contact OpenText
Customer Support.
Destination Directory Specifies the absolute path of the directory
where backup processes will store backups
for the data source. Each partition has its
own destination directory specifying where
the backup for that partition will be stored.
30.10.6 Using a Backup Process

The Specific tab of a Backup Process's Properties Page
Element Description
Status Shows whether the backup process is
running. If the process is running and you
still want to change its parameters, click the
Stop button.

Element Description
on page 569.
Partition Allows you to choose which partition you
want the backup process to back up. If you
have only one partition, that partition
appears by default.
Backup Label Specifies the template used to attach a label
to each backup. This label allows you to
identify the backup. The default is
Data_Source %m%d%Y_%T%r, where
Data_Source represents a string
identifying the data source, %m represents the
month, %d the day, %Y the year, %T the type
of backup performed, and %r the partition
ID. For a complete list of the variables you
can use to format the label template, see
Backup Type Specifies whether you want a Full backup,
which is a new backup of the entire index, or
a Differential backup, which is a backup of
what has changed in the index since the last
backup.
On Error Message Specifies the level of error messaging you
want.
Start Options Specifies the start options for the backup
process:
• At This Time, which schedules the
backup process to run at a specific time
on certain days of the week.
• Every, which schedules the backup
process to run at a specific interval.
For more information about data flow
processes, see “Configuring Data Flow
Process Start Options” on page 473.

Element Description
Start/Stop Allows you to start or stop the backup
process, depending on the current state of
the process. If the process is not running, the
Start button appears. If the process is
running, the Stop button appears. For more
information about starting and stopping data
flow processes, see “Maintaining Data
Flows” on page 467.
Resynchronize Resynchronizes the information about the
backup process (in the otadmin.cfg file of
the process's Admin server) with the
For more information about resynchronizing
data flow processes, “To Resynchronize Data
Flow Processes” on page 478.
page to the Server.
state when opened.
30.10.7 Date and Time Variables

You use date and time variables to format how OpenText Classifications includes
date and time stamps in index backup labels. When you begin or schedule a backup
process, you define how you want the backup label to be formatted. While creating
the backup, Classifications replaces the date and time variables with the current date
and time, in the format described below, for each variable. Labels allow you to
identify backups when you want to restore an index. For more information about
backing up and restoring indexes, see “Backing Up and Restoring Indexes”
on page 647.
Date and Time Variables and Their Meanings
Variable Description
%% A percentage sign
%a The three-letter abbreviated weekday name
(Mon, Tue, etc.)
%b The three-letter abbreviated month name
(Jan, Feb, etc.)
%d The two-digit day of the month (01, 02, ..., 31)
%j The three-digit day of year (001, 002, ..., 366)
%m The two-digit month of the year (01, 02, ...,
12)

30.11. Administering Searching
Variable Description
%p The two-letter abbreviated part of day in
which the time falls (AM or PM)
%r The partition ID
%w The one-digit day of the week (1 (Sunday), 2
(Monday), ..., 7 (Saturday))
%y The two-digit abbreviated year (93 instead of
1993)
%A The full weekday name (Monday,
Tuesday, ..., Sunday)
%B The full month name (January, February, ...,
December)
%H The two-digit hour on a 24-hour clock (00,
01, ..., 23)
%I The two-digit hour on a 12-hour clock (01,
02, ..., 12)
%M The two-digit number of minutes past the
hour (00, 01, ..., 59)
%P The two-letter abbreviation of the era in
which the year falls (AD or BC)
%S The two-digit number of seconds past the
minute (00, 01, ..., 59)
%T The string corresponding to the type of
backup that is being performed. If the type is
Full, this is equal to the Fullstring
parameter in the backup configuration file. If
the type is INCR, this is equal to the
INCRString parameter in the backup
configuration file.
%Y The four-digit year (..., 2001, 2002, ...)
30.11 Administering Searching

Configuring the Search JVM
When the search process is not optimal, you can specify a custom JVM provided by
OpenText Customer Support. For more information, see “Configuring the Search
JVM” on page 664.
Configuring Search Options

When you configure Content Server search options, you enable, disable, and change
settings that alter the behavior of Content Server Search for users. For more
information, see “Configuring Search Options” on page 678.

Search Filters
Search Filters are displayed in a panel beside Search Results, comprised of a title bar
and a list of values, showing a number for the metadata and a count which indicates
how frequently that value shows up in the results. For more information, see
“Search Filters” on page 685.
Administering Searching Processes

Search Federators and Search Engines are the searching processes in an Indexing and
Searching system. A Search Federator is a process that manages one or more Search
Engines and distributes searches to them. A Search Engine is a process that searches
a partition's index. Search Managers are containers for searching processes and play a
role the execution of searches. For more information, see “Administering Searching
Creating Slices
A slice is a search domain defined by a set of search criteria (Query) that is applied to
one or more indexes. When you create an index data flow, Content Server
automatically creates a slice that represents the set of all data in the resulting index.
As an administrator, you can also create custom slices by saving Queries in the Slice
Folder. Custom slices allow Content Server users to issue popular Queries without
reentering complex search criteria. For more information, see “Creating Slices”
on page 701.
Configuring Index Regions

A data source's index is divided into regions, each of which stores a different type of
information. You can configure search options for regions to customize how users
can search regions. For more information, see “Configuring Index Regions”
on page 705.
Purging Index Regions

You can synchronize the Content Server databases list of regions with those that
exist in the search index by purging the regions that do not exist in the search index.
For more information, see “To Purge Index Regions” on page 709.
Configuring Advanced Ranking

You configure advanced ranking when you administer the Search Manager for a
data source's index. Search Managers play a role in the execution of searches in an
Indexing and Searching system. Configuring advanced ranking allows you to
determine which items are most relevant at your site. This can help Content Server
users locate the most important information to them. When a user submits a Content
Server Search, Content Server assigns a score to Content Server items that meet
specific criteria. Items are listed in search results in order of their scores (from
highest to lowest). For more information, see “Configuring Advanced Ranking”
on page 709.

Configuring Hyperlink Mappings

Hyperlink mappings allow users to access information in a Directory Walker data
source when viewing search results. Documents in a Directory Walker data source
are identified by their entire path name. When these documents are returned in a
search, they display on the Search Results page as their path names. For more
information, see “Configuring Hyperlink Mappings” on page 714.
Administering Search Forms

Search forms are configurations of the Search page that you create and save. They
allow you to reuse a particular configuration of the Search page without having to
create it each time. For more information, see “Administering Search Templates”
on page 716
Administering Download as Spreadsheet

Users can create a Collection of their search results, then download the Collection as
a spreadsheet. As an administrator you can restrict certain users or groups from
using this feature on the Administer Object and Usage Privileges page. For more
information, see “Administering Download as Spreadsheet” on page 723.
Administering Best Bets

Best Bets allow you to define a searchable value for a Content Server item. For more
information, see “Administering Best Bets” on page 723.
Searching Deleted Items

When users delete items from Content Server, those items are placed in the Deleted
Documents Volume. Content Server administrators can restore deleted documents
to a Content Server Workspace using the Undelete feature. For more information,
see Administering Document Undelete.
Managing Search Statistics

When you log-in to Content Server as the Administrator, you can Manage Search
Statistics. This feature will allow you to Configure Search Statistics, View Statistics
Summary, View Search Terms, View Slice Usage, View Form Usage and Purge
Search Statistics. For more information, see “Managing Search Statistics”
on page 735.

30.11.1 Configuring the Search JVM

You can specify a custom JVM if the performance of the search processes is not
optimal. You must use the JVM provided by OpenText Customer Support.
To apply the custom JVM, you need to specify the relative Java Runtime
Environment (JRE) path and JVM arguments on the Search JVM Configuration page.
By updating these settings, you ensure that the JRE path and JVM arguments values
are set or added to the LLSystemData table, depending on whether the values exist
or not.
After modifying the settings on this page, you must:

• stop all the search process
• restart your Admin servers
• resynchronize your Admin servers
• start your search processes
To Configure the JVM for Search

To configure the JVM for search:
1. On the administration page, click the Search JVM Configuration link.

2. In the Relative Path to the JREfield, type the relative path to the Java Runtime
Environment that OpenText Customer Support provided to you for use in
Content Server.
3. In the Additional Arguments field, type any JVM arguments you want to add.
5. Stop and start all search processes, and then resynchronize your Admin servers.
30.11.2 Configuring Search Bar Appearance

The Search Bar Administration page enables you to customize the appearance of
the Content Server search bar, which is available on most Content Server pages. You
can view the available search bar configurations, add a new one by clicking the Add
New Search Bar Configuration button or edit the existing configurations. You
can also remove any existing search bar configuration, except the Standard Search
bar, by clicking the Remove button.
Click the Edit button of a search bar configuration to open the Search Bar Edit
page with the settings for that search bar mode. From this page you can define the
default appearance and the components available on the Content Server search bar.
Tip: When you create a custom search bar configuration, you can use it by first
creating an Appearance in a folder, then in the Content Server Components

section selecting the custom search bar. For details, see “To Display a Custom
Search Bar at a Specific Folder” on page 677 and OpenText Content Server User
Online Help - Working with Custom Views and Appearances (LLESAPP-H-UGD).
You can edit the standard system search configurations, as well as any new ones you
create, as described in the following table.
Name Description
Enable Last Results Link Select the Enable Last Results Link check box to display a
link for your users to return to their last Search Results
page.
Standard Search Bar The default search bar configuration that provides Full
Text search to construct Queries that contain keywords or
complex Queries constructed with the Live Query
Language (LQL).
Simple (sample) A simplified configuration based on a version of a saved
search form.
Slice Selection (sample) A configuration that allows the Slice drop-down list to be
hidden on the search bar, and lets you determine the
display and order of search slices.
Natural Language (sample) A configuration that lets users type Queries as a question,
or one or more lines of text. Content Server then
determines what criteria and keywords to search for based
on the criteria, and then runs the search.
30.11.3 Configuring the Search Bar

The Search Bar Edit page controls the settings for the Content Server search bar,
which is available on most Content Server pages.
Any changes you make to the search bar will be seen by all your users when you
click Apply because it is the default search bar configuration.
Tip: You can also save your display options settings to use as a search results
form by clicking the Save as Search Form button.
You can enable, disable, and change the default settings for the following
components:
• General Settings
• Full Text
• Nickname
• Natural Language Query

Configuring the General Settings

The General Settings section configures the search mode, the search button
appearance and text label, and enables a Help link on the search bar.
The Default mode setting determines the search mode that appears on the search
bar by default, as described in the following table.
Option Description
Full Text Lets users construct Queries that contain keywords or
complex Queries constructed with the Live Query
Language (LQL).
Nickname Lets users type nicknames as search terms. Users can
assign nicknames to items.
Natural Language Query Lets users type Queries as a question or one or more lines
of text. Content Server then determines what criteria and
keywords to search for based on the criteria, and then runs
the search
The Search Button radio buttons determine the default appearance of the search bar,
and if selected, the text label.
Tip: You can change the language used for the Search Button, and other text
fields, by entering an Xlate value instead of plain text. If you leave the text as
the default Search then it appears to other users in their own language. If you
change the text, then all users, regardless of language, will see the exact text
you enter.
The Search Bar Width text box defines how many pixels wide, between 100 and 400,
the search bar will appear.
By selecting the Help Link check box, a Help link is shown on the search bar for the
selected search mode.
The search bar's options and parameters change depending on the search mode that
users choose. You can set the default parameters for Full Text, Nickname, and
Natural Language Query in the following sections on the Search Bar Edit page.
Configuring the Full Text Search

The Full Text section determines the default Full Text appearance on the search bar.
The Include check box determines if Full Text search is available in Advanced
Options.
The Prompt Text field controls the text that appears for Full Text searches. You can
change the language used by entering an Xlate value instead of plain text.

The Component area allows you to specify which components of Full Text search
will display by default, and to configure their appearance and behavior. The
Component area contains the following settings:
• Search Mode
• Modifier
• Searchable Types (Configure)
• Created By (Configure)
• When Modified (Configure)
• Slice Selection (Slice Configuration)
• Advanced Search
• Location Modifier
By selecting the Show check box associated with a component, that component is
displayed on the search bar by default.
Configuring the Search Mode

The Search Mode component allows you to set the default search mode on the
search bar when performing a Full Text or Natural Language Query search. Content
Server returns a list of items according to the search mode you choose, as described
in the following table.
Option Description
All Words Returns a list of items that includes all words specified in the query.
Any Words Returns a list of items that includes any words specified in the
query.
Exact Phrase Returns a list of items that includes the exact phrase specified in the
query if two or more keywords are enclosed in quotation marks.
Complex Query Returns the target data you want to retrieve. Complex queries are
single statements constructed with LQL, that precisely target the
data you want to retrieve. For example, to find Content Server
items that contain the word report but do not contain the word
expense, type the complex Query report AND-NOT expense.
Configuring the Modifier drop-down list

The Modifier component allows you to set the default modifier on the search bar
when performing a Full Text search. Modifiers allow Content Server users to specify
the kind of related terms they want included in the search.
Option Description
None No modifier is specified.

Option Description
Synonyms Of Words from the thesaurus entry for the specified term.
Related To Words derived from the main part of the specified term.
Sounds Like Words that sound like the specified term, which is useful when the
user is uncertain of its spelling.
Note: The Sounds Like search modifier is currently

supported only for the English language.
Word Begins With Words that begin with the specified term.
Word Ends With Words that end with the specified term.
Configuring the Searchable Types drop-down list

The Searchable Types component defines the appearance of the menu items
displayed on the Object type drop-down list when performing a Full Text search.
The Object type drop-down list allows users to specify the types of Content Server
items to search for.
Click the Configure link associated with the Searchable Types component to open
the Configure page. The Menu Items section allows you to define the appearance of
the Object type drop-down list as described in the following table.
Option Description
Available Lists the Object type menu items that you can move to the
Displayed list. Displayed items are included in the Object type
drop-down list on the search bar.
You can also add new items to the Available list by clicking the
Add A New Menu Item button
, or remove items by selecting them and clicking the Remove the

Selected Menu Item
button.
Displayed Lists the Object type items that appear on the search bar. You can
remove items from. or add items to the Displayed list. You can also
change the order of items in the list.
Show Text in Menu By selecting the check box, text is shown in the menu selection
when a Content Server user clicks the list.
The Preview frame allows you to see the appearance of the Displayed list before
submitting your edits.
The Edit section lets you configure the default label text, an image, the indent value,
and the LQL query string for the Object type drop-down list, as described in the
following table.

Option Description
Label Determines the text label for the Object type drop-down list. You
can change the language used by entering an Xlate value instead of
plain text.
Image Provides the location of the image that is used. You must use a
relative path based in the Content Server support directory.
Indent Determines the indentation level for the menu items in the Object
type drop-down list: None, 1, or 2.
Query Specifies the LQL query associated with the Object type drop-
down list.
Configuring the Created By drop-down list

The Created By component defines the appearance of the menu items displayed on
the Created By drop-down list when performing a Full Text search. The Created By
drop-down list allows users to specify the System Attributes of the Content Server
user they are searching for.
Click the Configure link associated with the Created By component to open the
Configure page. The Menu Items section allows you to define the appearance of the
Created By drop-down list as described in the following table.
Option Description
Available Lists the Created By menu items that you can move to the
Displayed list. Displayed items are included in the Created By

Selected Menu Item
button.
Displayed Lists the Created By items that appear on the search bar. You can
remove items from. or add items to the Displayed list. You can also
change the order of items in the list.
The Preview frame allows you to see the appearance of the Created By list before
and the LQL query string for each displayed drop-down list on the search bar.

Option Description
Label Determines the name of the menu item that is displayed in the
drop-down list. You can change the language used by entering an
Xlate value instead of plain text.
Image Provides the location of the image that is used for the menu item.
You must use a relative path based in the Content Server support
directory.
Indent Determines the indentation level for a menu item in the drop-down
list: None, 1, or 2.
Query Specifies the LQL query associated with the menu item.
Configuring the When modified drop-down list

The When Modified component defines the appearance of the menu items
displayed on the Last modified drop-down list when performing a Full Text search.
The Last modified drop-down list allows users to specify a definite time period to
search for.
Click the Configure link associated with the When Modified component to open
the Configure page. The Menu Items section allows you to define the appearance of
the Last modified drop-down list as described in the following table.
Option Description
Available Lists the Last modified menu items that you can move to the
Displayed list. Displayed items are included in the Last modified

Selected Menu Item
button.
Displayed Lists the Last modified items that appear on the search bar. You
can remove items from. or add items to the Displayed list. You can
also change the order of items in the list.
The Preview frame allows you to see the appearance of the Last modified list before
and the LQL query string for each displayed drop-down list on the search bar.

Option Description
Label Determines the name of the menu item that is displayed in the
drop-down list. You can change the language used by entering an
Xlate value instead of plain text.
Image Provides the location of the image that is used for the menu item.
You must use a relative path based in the Content Server support
directory.
Indent Determines the indentation level for a menu item in the drop-down
list: None, 1, or 2.
Query Specifies the LQL query associated with the menu item.
Configuring the Slice Selection drop-down list

The Slice Selection component displays the Slices link on the search bar when
Content Server users specify the Full Text search or Natural Language Query search,
and allows you to set the order in which slices are displayed.
When the Show check box is not selected for the Slice Selection component, the
Slices drop-down list is not displayed on the search bar. However, you can still
choose which slice will be searched by default, as described in the following table.
Option Description
From Here Lets users search from the Folder or
Workspace they are currently in.
Enterprise Lets users search for current versions of
documents.
Enterprise [All Versions] Lets users search for all versions of
documents.
Click the Slice Configuration link to open the Slice Folder page to specify the
appearance of the Slices component in Advanced Search.
The Slice Folder page lets you select the alphabetical order in which slices are
displayed, or define a custom configuration.
The Search Bar and Slices Component Slice Order section lets you select the
alphabetical order in which slices are displayed, or you can define a custom
configuration by selecting the Custom radio button. The Available and Displayed
slices on your Content Server system are shown so you can move them so they
appear in the order you choose.
The Add "From Here" option to Search Bar check box will display the From Here
option in the Slices list.
The Advanced Search Slices component Menu Size field determines the maximum
number of slices that are displayed on the Slices list.

Advanced Search
The Advanced Search component on the Search Bar Edit page displays the
Advanced Search link on the search panel when Content Server users specify the
Full Text or Natural Language Query search.
Location Modifier
The Location Modifier check box will display the Location component in the Add
to Search Form list.
The drop-down list allows you to specify the Content Server default location
modifier to use, based on the Content Server modules installed on your system. For
details, see “Configuring Search Location Modifiers” on page 464.
Nickname
The Nickname component determines the default Nickname settings that are
available on the search bar. A nickname is a word or phrase assigned to a Content
Server item, with a short URL generated for both the Properties and Open functions.
The Include check box determines if a Nickname search is available on the search
bar.
The Prompt Text field controls the text that appears for Nickname searches in the
Select Search Type drop-down list above the search bar. You can change the
language used by entering an Xlate value instead of plain text.
The component section allows you to specify which components the Nickname
search will display by default and to configure their appearance and behavior.
The Show check box determines if the Action component is displayed on the search
bar. Two actions are available in the drop-down list, Open and Properties. These
actions allow Content Server users access to the Open command or the Properties
page of the item when exact matches are found.
Configuring the Natural Language Query Search

The Natural Language Query component determines the default Natural Language
Query settings that are available on the search bar.
The Include check box determines if a Natural Language Query search is available
in Advanced Options.
The Prompt Text field controls the text that appears for Natural Language Query
searches in the search bar. You can change the language used by entering an Xlate
value instead of plain text.
You can specify which components the Natural Language Query search will display
by default and to configure their appearance and behavior.

Option Description
NLQ Mode Natural Language Query has two modes:
• Content Server Aware is used for Queries that involve
people, dates, and Content Server item types, such as
Documents and Folders. Content Server Aware uses a rule set
to determine this context by retrieving information about file
types and attributes from the entered text
• Keyword Extraction is used for Queries if no specific
information about people, dates, or Content Server item types
is available. It identifies the top five words or phrases from
the Query that are not stop words (words that add no
semantic value to a sentence, such as a, and, and the), and then
searches for items that contain some or all of those five words
or phrases
You can choose one of these modes as the default mode that
appears on the search bar.
Slice Selection The Slice Selection component displays the Slices link on the
search bar when Content Server users specify the Full Text search
or Natural Language Query search, and allows you to set the
order in which slices are displayed.
Advanced Search Displays Advanced Search on the search bar by default.
Location Modifier Displays the Location component in the Add to Search Form list.
The drop-down list allows you to specify the Content Server
default location modifier to use, based on the Content Server
modules installed on your system. For details, see “Configuring
Search Location Modifiers” on page 464.
To Create or Edit Search Bar Configurations

To create and manage search bar layouts:
1. On the Administration page, in the Appearances Administration section, click

the Search Bar Administration link.
2. To configure default search bar modes, click the Edit button to open the Search
Bar Edit page.
3. On the Search Bar Edit page, select options to enable, disable, and change
settings of the behavior of Content Server Search for users.
For more information about the Search Bar Edit page, see “Configuring the General

To Configure the Default Mode

To configure the Default mode:

2. On the Search Bar Administration page, click the Edit button for a search bar
configuration.
3. On the Search Bar Edit page, click an option in the Default mode drop-down
list.
4. In the Search Button section, click the Icon or Text radio button to select the
default appearance of the search bar, and text label.
5. In the Button Text field, enter a text label. You can change the language used by
entering an Xlate value instead of plain text.
6. In the Search Bar Width field, enter a value between 100 and 400 for how many
pixels wide the search bar will appear.
7. In the Help Link section, select the Show check box.
Note: You must click the Apply button on the Search Bar Edit page to
apply your changes.
For more information about the default search bar mode options, see “Configuring
the General Settings” on page 666.
To Configure the Full Text Search

To configure the Full Text search:

2. On the Search Bar Administration page, click the Edit button for Full Text.
3. On the Search Bar Edit page, select the Include check box.
4. In the Prompt Text field, type the text you want to appear on the search bar.
You can change the language used by entering an Xlate value instead of plain
text.
5. In the Component section, select the Show check box next to each search
component you want to display by default, and then click the default
component setting. For more information about the Configure links, see
“Configuring the Searchable Types drop-down list” on page 668, “Configuring
the Created By drop-down list” on page 669, “Configuring the When modified
drop-down list” on page 670, or “Configuring the Slice Selection drop-down
list” on page 671.

Note: You must click the Apply button on the Search Bar Edit page to apply
your changes.
For more information about the Full Text options, see “Configuring the Full Text
Search” on page 666.
To Configure the Nickname Search

To configure the Nickname search:

2. On the Search Bar Administration page, click the Edit button for a search bar
configuration.
3. On the Search Bar Edit page, in the Nickname section, select the Include check
box.
4. In the Prompt Text field, type the text you want to appear in the Select Search
Type drop-down list above the search bar. You can change the language used
by entering an Xlate value instead of plain text.
5. In the Component section, select the Show check box, and then select the action
from the drop-down list box.
apply your changes.
For more information about the Nickname options, see “Nickname” on page 672.
To Configure the Natural Language Query Search

To configure the Natural Language Query search:

2. On the Search Bar Administration page, click the Edit button for Natural
Language (sample).
3. On the Search Bar Edit page, in the Natural Language Query section, select the
Include check box.
4. In the Prompt Text field, type the text you want to appear Natural Language
Query searches in the search bar. You can change the language used by entering
an Xlate value instead of plain text.
5. In the Component section, select the check box next to each search component
you want to display by default, and then click the default component settings.

For information about the Slice Selection component, see “Configuring the Slice
Selection drop-down list” on page 671.
apply your changes.
For more information about the Natural Language Query options, see “Configuring
the Natural Language Query Search” on page 672.
To Set Options on the Full Text Configure Pages

To set options on the Full Text Configure pages:

2. On the Search Bar Administration page, click the Edit button for a search
bar configuration.
3. On the Configure Search Options page, in the Full Text section, click the
Configure link associated with one of the following:
• Searchable Types
• Created By
• When Modified
• Slice Selection
4. In the Menu Items section on the Configure page, do any of the following:
• In the Available list, click the items you want to appear in the drop-down
list on the search bar, and then click the Display button to move them to
the Displayed list.
• In the Displayed list, click the items you do not want to appear in the drop-
down list on the search bar, and then click the Remove button to move
them to the Available list.
• Click the Move up and Move down buttons to re-order items in the
Display list.
Tip: You can remove a menu item from the Available list by clicking the
Remove the Selected Menu Item button .
5. Select the Show Text in Menu check box.
6. In the Edit section, do the following:

• Type the name of the menu item in the Label field. You can change the
language used by entering an Xlate value instead of plain text.
• Type the relative path of the image in the Image field.
• Click the indentation level in the Indent drop-down list.
• Type the LQL query in the Query field.
Notes
• You must select a menu item from the Available or Displayedlist
prior to editing.
• To add a menu item to the Available list, specify the settings in the
Edit section, and then click the Add a New Menu Item button .
7. Verify the menu item settings in the Preview section.
apply these settings.
For more information about the options, see “Configuring the Full Text Search”
on page 666.
To Display a Custom Search Bar at a Specific Folder

In Content Server 10, you can tie a Search Bar configuration to an Appearance, then
apply that Appearance to a folder. For information about Appearances, see OpenText
Content Server User Online Help - Working with Custom Views and Appearances
(LLESAPP-H-UGD).
To display a custom Search Bar at a specific folder:
1. Browse to the folder in Content Server where you want to add an Appearance.
For more information, see OpenText Content Server User Online Help - Working
with Custom Views and Appearances (LLESAPP-H-UGD).
2. Open the Appearance.
3. Click the Content Server Components section link in the bottom right of the
page.
4. From the Search Bar Menu, select the one you'd like to use.
5. Click submit.
6. Back on the Edit page for the Appearance, click the top Settings link.
7. On the Settings page, choose how to apply the Appearance and then enable it.
Since Appearances are shown based on the permissions of the user, it is possible to
have a different Search Bar appear, depending on which Appearance the user sees in

that folder. To define Global appearances, from the Administration page, in the
Appearances Administration section, and click the Open the Appearances Volume
link.
An alternate way to get a customized search interface in a folder is to use a Custom

View Search. For more information, see OpenText Content Server User Online Help -
Searching Content Server (LLESWBB-H-UGD).
30.11.4 Configuring Search Options

The Configure Search Options page controls the settings for Content Server search
components.
Note: Any changes you make to the search settings will affect all your users
when you click Update because the settings are the default search
configuration.
You can enable, disable, and change the default settings for the following
components:
• Search Language Rules

• Find Similar
• Hit Highlight in Summary
• Search Results Header and Footer
• Search Results Display
• Timeout Settings
• Cache Settings
Configuring the Search Language Rules
Option Description
Stemming Default – Specifies the language dictionary used by Content Server
for searching.
Dynamic – When selected, stemming rules are adjusted to match

the user's metadata language preference.
Thesaurus Default – Specifies either:
• the language of the thesaurus used by Content Server for
searching, or
• a custom Thesaurus. For more information, see “Administering
Thesauruses” on page 740.
Dynamic – When selected, the Thesaurus is adjusted to match

user's metadata language preference.

Configuring the Find Similar Search

The Find Similar component allows you to add the Find Similar command to the
Functions menu for documents in Workspaces and on the Search Results page.
Finding similar items is a quick way to search Content Server for documents that are
similar to the original. The command searches Content Server for documents that
contain the five most common key phrases (recurring words and word combinations,
especially those involving unusual words) of the original. If the original document
has no key phrases then the command searches Content Server for documents that
contain the words in the title of the original.
The key phrases used for the Find Similar search can be different from key phrases
for the document. The key phrases generated in the Find Similar query do not
correspond to the key phrases that are reported when searching for that document.
A Find Similar query from the Search Results page uses the phrases generated by
the DCS before indexing. Also, key phrases that are three words long are shortened
to two words.
The Find Similar feature for documents searches only against the Enterprise Index. If
no Enterprise Index is defined for a particular Content Server installation, a Find
Similar search yields no results, even though there may be similar documents in
other slices.
Configuring the Hit Highlight in Summary Search

The Hit Highlight in Summary section allows you to enable the highlighting of
search terms in the summary of documents on the Search Results page. Highlighting
search terms allows Content Server users to quickly scan the summary of a
document on the Search Results page to determine if it contains the required
information.
Note: Hit Highlighting is available on the Search Results page for OpenText
Enterprise Library Variants only.
If an expanded search generates 100 or more search terms, Content Server will
Hit Highlight only the first 100 terms. This is a known hard-coded limitation
for performance optimization.
If Lotus Notes e-mail objects (DXL objects) are indexed via an e-mail
monitoring/management solution, then these objects cannot be Hit Highlighted
from a Search Results page.
Configuring the Search Results Header and Footer

The Result Count Header Template field in the Search Results Header and Footer
section allows you to configure the display of the Search Results Header component
on the Search Results page. This component can display the current listing of the

first and the last search result numbers, the total number of estimated results, and
the sort key or sort direction.
The Estimate and Exact templates represent the strings shown to different classes of
users. You can change the language used by entering an Xlate value instead of plain
text.
The Estimate template is used to generate the header string for regular users who
are shown estimated search results counts, by default.
The Exact template is for users with System Admin permissions, eDiscovery rights,
and those included in the “See Unpermissioned Result Counts” privilege group.
These users are shown the true search result count from the Search Engine.
You can change the language used by entering an Xlate value instead of plain text.
For more information, see “Defining Search Results Counts” in “Administering
Searching Processes” on page 690.
The Edit See Unpermissioned Result Counts Restrictions link allows you to add or
modify the users or groups.
The Index Time Footer Template field displays an estimated indexing delay, and
the most recent tracer time value (needed for validation of eDiscovery). Users with
System Admin permissions, eDiscovery rights, and those included in the “See
Unpermissioned Result Counts” privilege group, are shown the literal values from
the Search Engine, not estimates.
The Revert to Default buttons allow you to reset the Search Results Header and
Footer displays.
Configuring the Search Results Display

The Search Results Display section configures display settings on Search Results
pages.
Note: These display options do not apply uniformly to all search result styles.
Option Description
Name Length Specifies the maximum number of characters for the Name and
Location columns on the Search Results pages. The default is 40.
Path Length Specifies the maximum number of characters for the Breadcrumbs
path. The default is 80.
Path truncation is triggered by path lengths greater than the

specified value. When generating a breadcrumb path, the truncation
length of each element within the breadcrumb is considered. The
truncation algorithm drops elements in the middle of the path and
works outward until the breadcrumb path is completely displayed,
or until the character limit is reached.

Option Description
Breadcrumbs Specifies if the breadcrumb-style path for container locations will
display on Search Result pages. The default is True.
Configuring the Timeout Settings

The Timeout Settings section configures the internal timeouts that apply during
search operations.
Option Description
Result Retrieval Specifies the maximum number of seconds after which Content
Server times out when returning search results. The default is 180
seconds.
Federator Wait Specifies the maximum number of seconds after which Content
Server times out the Search Federator. The default is 180 seconds.
Search Engine Provides a link to set Search Engine Timeout values. See
Timeout “Configuring a Partition Map” on page 603.
Configuring the Cache Settings Search

The Cache Settings section configures the cache for Content Server Search and
affects how quickly Content Server generates the search page.
The following table lists and describes the options in the Cache Settings section.
Option Description
Current Brokers Displays the total number of current brokers in your system.
A broker is a slice, saved Query, or search template
Cached Brokers to Lets you specify the number of most recently used brokers you
Keep want to cache. Valid values begin at 0, but the maximum depends
on the amount of memory in your system
Current Region Sets Displays the total number of region sets in your system.
A region set is a set of all the regions that are associated with a
particular data source
Cached Region Sets Lets you specify the number of most recently used region sets you
to Keep want to cache. Valid values begin at 0, but the maximum depends
on the amount of memory in your system
Caching brokers and region sets improves system performance up
to a point, but setting these values too high can reduce system
performance
Search Results Cache Lets you specify the number of minutes that search results are
Expiration cached in the Content Server database. Valid values begin at 0, and
the default is 60
Note: Caching brokers and region sets improves system performance up to a

point, but setting these values too high can reduce system performance.

OpenText recommends that you do not make changes to these settings unless
advised to do so by OpenText Customer Support.
To Configure the Search Language Rules

To configure the Search Language Rules:

Configure Search Options link.
2. On the Configure Search Options page, in the Search Language Rules section,
for Stemming, from the drop down list select the Default language dictionary
Content Server should use for searching.
For Dynamic, click the check box to enable adjusting the stemming rules to
match the user's metadata language preference.
3. For Thesaurus, for Default:
• click the radio button, and from the drop down list select the language of the
thesaurus used by Content Server for searching, or
• click the radio button, and specify the name and location of a custom
Thesaurus. For more information, see “Administering Thesauruses”
on page 740.
For Dynamic, click the check box to enable adjusting the selected Thesaurus to
match the user's metadata language preference.
To Configure the Find Similar Search

To configure the Find Similar search:

2. On the Configure Search Options page, in the Find Similar section, click the
Enable radio button to add the Find Similar command to the Functions menu
for documents.

To Configure the Hit Highlight in Summary Search
To configure the Hit Highlight in Summary search:

2. On the Configure Search Options page, in the Hit Highlight in Summary

section, click the Enable radio button to enable the highlighting of query terms
in the document summaries.
To Configure the Search Results Header and Footer Search
To configure the Search Results Header and Footer Search:

2. On the Configure Search Options page, in the Search Results Header and
Footer section, review the information in the Legend field.
3. In the Result Count Header Template field, type the strings to show to
different classes of users:
• Estimate – the template to generate the header string for regular users who
are shown estimated search results counts, by default.
• Exact – the template for users with System Admin permissions, eDiscovery
rights, and those included in the “See Unpermissioned Result Counts”
privilege group. These users are shown the true search result count from the
Search Engine.
Click the Revert to Default buttons to reset the displays. You can change the
language used by entering an Xlate value instead of plain text. For more
information, see “Defining Search Results Counts” in “Administering Searching
4. Click the Edit See Unpermissioned Result Counts Restrictions link to edit the
users or groups you wish to add or modify.
5. In the Index Time Footer Template field, type the strings to show an estimated
indexing delay, and the most recent tracer time value. Users with System
Admin permissions, eDiscovery rights, and those included in the “See
Unpermissioned Result Counts” privilege group, are shown the literal values
from the Search Engine, not estimates.

To Configure the Search Results Display

To configure the Search Results display:

2. In the Name Length field, control the width in characters for the Name and
Location columns on the Search Results page. The default is 40.
3. Type a value in the Path Length field for the Breadcrumbs path length.
4. Click the True radio button in the Breadcrumbs field to display the path for
container locations.
To Configure the Timeout Settings

To configure the timeout settings:

2. On the Configure Search Options page, in the Timeout Settings section, in the
Result Retrieval field, type the maximum number of seconds after which
Content Server times out when returning search results. The default is 180
seconds.
3. In the Federator Wait field, type the maximum number of seconds after which
Content Server times out the Search Federator. The default is 180 seconds.
4. In the Federator Wait field, click the Partition Map Properties page link to open
the Enterprise Partition Map, to set the Search Engine Timeout value. For
details, see “Configuring a Partition Map” on page 603.
To Configure the Cache Settings Search

To configure the Cache Settings search:

2. On the Configure Search Options page, in the Cache Settings section, type a
value in the Cached Brokers to Keep field.
3. Type a value in the Cached Region Sets to Keep field.
For more information, see “Configuring the Cache Settings Search” on page 681.

30.11.5 Search Filters

Search Filters let users generate a new search request, based on their Search Results,
by selecting values that include additional restrictions.
Note: When using Search Filters, Remote Search results are excluded from the
filter values and counts.
Search Filters currently does not support Aggregate-Text regions.
The unique values with additional restrictions used by Search Filters may sometimes
show a higher number of Search Results than really exist. This happens when a
particular value is deleted from every object, but the value string is still in the
dictionary. There are only two ways of knowing when to remove it:
• for every delete, iterate for every internal objectID over the Search Filters data
structure, to see if the value still exists
• keep a count for every dictionary entry, and decrement it
Either way is not currently feasible, so the higher number of Search Results will
sometimes show, until Search Filters self-correct when the Search Engine is
restarted.
For a detailed overview of Search Filters, and how users can refine their Search
Results, see OpenText Content Server User Online Help - Searching Content Server
(LLESWBB-H-UGD).
Restricted Filters
If an attribute filter is applied, and users do not have permissions for the attribute's
Category, they will see (Restricted Filters) displayed in the active Filters. This
indicates there are some Filters applied that affect the Search Results that they don't
have permissions to see. They cannot remove a single restricted Filter, but they can
click the Remove all filters link.
Hidden Containers
Users can introduce Search Filters constraints into a saved Query. For information
about saved Queries, see Livelink Search Administration - websbroker Module
(LLESWBB-H-AGD). Some constraints may contain information that users don't have
permissions to see. If they run a saved Query where they don't have permission for
the Filter data, for example, if there is a Filter on the location “Folder A”, and they
don't have permissions to see this folder, the data is marked (hidden) on the Search
Results and Advanced Search pages.

Incomplete facet sets

You can increase the maximum number of search filter region values considered by
the Search Engine by adjusting the MaximumNumberOfValuesPerFacet parameter in
the [DataFlow_xxx] section of the search.ini file. The Search Engine accumulates
only 32767 facets per region, by default, so if this value is reached, then the facet set
of Search Results will be incomplete.
When the threshold is reached, an indicator, in the form of an asterisk *, is displayed

on the search filter region title bar. When you mouse over the asterisk *, a message
will display, for example, “More than X values”, where X is the total count of facet
values for the region, to indicate the facet set is incomplete.
Note: The indicator that the facet set is incomplete is only displayed for users
with System Admin permissions, and those included in the “See
Unpermissioned Result Counts” privilege group. These users are shown the
true search result count from the Search Engine. For more information, see
“Defining Search Results Counts” in “Administering Searching Processes”
on page 690.
The values displayed for the Search Filter are estimates.
To Configure Search Filters
To configure Search Filters

Configure Search Filters link.
2. On the Configure Search Filters page, in the General Settings section, in Status,
select the Enable check box to display Search Filters in a panel beside the Search
Results.
3. In Filter Regions, select which Regions to display, by clicking the left and right
arrow buttons to move them between the Available and Active columns, then
click either the up or down arrow buttons to set the Region order.
Note: You can select search options for index regions on the Search
Manager administration page. For details, see “Configuring Index
Regions” on page 705
The Author Search Region is incorrectly configured. You should remove it
from the Active column, or select the Queryable check box for it on the
Search Manager administration page.
4. In Number of Filters, click a value in the drop-down list to specify the

maximum number of Regions the Search Filters will display. You can increase
the maximum number of search filter region values considered by the Search
Engine. For details, see “Incomplete facet sets” on page 686.

5. In Number to prefetch, click a value in the drop-down list to specify the

number of Regions Content Server will store in its cache to display Search
Results more quickly.
6. In the Text Filters section, in Less, click a value in the drop-own list to specify
the maximum number of values to display when showing Less....
7. In More, click a value in the drop-own list to specify the maximum number of
values to display when showing More....
8. In the Date Filters section, click a value in the drop-down list to specify the
maximum number of values to display for a Date region.
9. In the Display Counts section, click a value in the drop-down list to specify the
threshold for displaying result counts:
• Always – always show result counts

• Never – never show result counts
• a value between > 1 and > 100 – show result counts when there are more
than the value specified
You can use this setting to specify that, for small count values, if the user is not
included in the “See Unpermissioned Result Counts” privilege group, the count
is not displayed. OpenText recommends using this setting for Content Server
installations where security considerations are a major concern, or where the
System Admin does not want any counts displayed for Search Filters.
Users with the “See Unpermissioned Result Counts” privilege can see the true
Search Filter value count, rather than an estimate. Search Filter counts are
always displayed for users in the “See Unpermissioned Result Counts” group,
even when Never is selected. The Display Counts section applies only to users
not in this group.
10. Click Update to use the Search Filters settings you defined, or click Apply to
save the settings.
30.11.6 Mandatory Search Terms

The Configure Mandatory Search Terms page lets administrators define search term
restrictions for your users, based on membership in a Content Server user group.
Each of your users is given membership in a particular group to facilitate using
refined search criteria, for example, to restrict searching to a specific email
journaling source, or anywhere in the Enterprise folder.
Note: Search restrictions must be expressed using the OpenText Search Query
Language (OTSQL), the query language supported by the OpenText Search
Engine, and not using Live Query Language (LQL). For details, see the current
version of the Understanding Search Engine 10.5 guide in the OpenText
Knowledge Center (https://knowledge.opentext.com/).

Use the links on the Configure Mandatory Search Terms page to analyze user
coverage by the search term groups:
• Users with multiple Mandatory Search Terms
• Users with no Mandatory Search Terms
Examples of typical search term clauses are:

• Limit results to the Enterprise Workspace (typically DataID 2000): ([region
"OTLocation"] "2000")
• Limit results to the SQL storage provider and Enterprise Workspace: ( ([region
"OTProvider"] "SQL") and ([region "OTLocation"] "2000") )
When you enter a clause in the Search Term text box, a validation error is displayed
if the syntax used is not correct.
To Configure Mandatory Search Terms

To configure mandatory search terms:

Configure Mandatory Search Terms link.
2. On the Configure Mandatory Search Terms page, for Apply restrictions to

Users with eDiscovery rights, select the check box to enable these restrictions.
3. For Apply restrictions to Users with System Administration rights, select the
check box to enable these restrictions.
4. In the Group text box, enter the name of the group to restrict.
5. In the Search Term text box, enter the search term clause. A validation error is
displayed if the syntax used is not correct.
6. Click Update to use the mandatory terms you defined, or click Apply to save
the settings.
30.11.7 Search Agents

The Manage Search Agents page lets administrators review all configured search
agents for Prospectors and Classifications on your Content Server system, to see
what search agents are running, and to allow you to disable or manage one or more
of them selectively.
You can modify the availability of these nodes by removing the associated queries
from the related query files in an attempt to optimize indexing performance. When
you re-enable these processes, the previous state of these nodes is restored.
If you suspend or resume any Intelligent Classifications (IC) or Prospectors agents,

these events may be displayed globally on the Query Audit Log page. For more
information, see “Managing Audit Interests” on page 303. If you suspend or resume

any Prospector or Classification Search Agents, you have the option to automatically
send an email notification to the owner of the agent, with a predefined message, and
a link to directly access the location of the search agents. For more information, see
“Enabling Error-Checking and E-Mail Delivery” on page 568.
Managing Search Agents

To manage search agents:

Manage Search Agents link.
2. On the Manage Search Agents page, in the Search Agents section, for each
Prospectors or Classifications search agent listed, click the On/Off button to
enable or disable their availability.
3. In the Actions section, for each search agent listed, click Email Search Agent
Owners to define the text for the email to send to the owner, with a link to
directly access the location of the search agents.
30.11.8 Configuring Relevance Rules

The Configuring Relevance Rules page lets you adjust the relevance of several
parameters for search queries. You can modify the rules by adjusting the Boost
value of specific indexed Content Server items that are relevant to the user entering
a search query. With an increased or decreased Boost value, these items are shown
higher or lower in the Search Results, giving you a greater ability to optimize search
performance. A Boost value must be an integer between -200 and 200.
The relevance configuration is comprised of the current user’s ID, Content Server
locations or regions, and the weight of Boost value assigned to each one. The
weights indicate how important the parameter is in scoring.
To gather data to help you optimize search relevance rules, you can start collecting
Relevance Reports. For details, see “To View Relevance Reports” on page 740.
Content Server also enables you to define relevant settings on the Configuring
Advanced Ranking page, and to search for supplemental extracted metadata with
counts of definable patterns, for example credit card or government-issued identity
card numbers. For details, see “Configuring Advanced Ranking” on page 709 and
“Counting and extracting metadata” on page 518.

To Configure Relevance Rules

To configure relevance rules:

Configure Relevance Rules link.
2. On the Configure Relevance Rules page, in the Rule Type column, select the
check box as needed for each rule:
• Current User – indexed items created or owned by the current user

• Personal Workspace – indexed items located in the current user’s personal
workspace
• Recent Locations – indexed items located in recent locations the current user
has browsed
• Current Container – indexed items located in the container the user is
currently in
• Custom – indexed items based on metadata regions, for example, summary,
creation date, or size, and the boost value to apply
3. In the Settings column, enter a Boost value between -200 and 200 as needed for
each rule.
a. For the Recent Locations rule, in the Number of Locations text box, enter a
positive integer to define how many locations should be included in
weighing the search calculations.
b. For the Custom rule, in the Relevance Clause text box, using the syntax
[region "<region name>"] "<query>" BOOST[<boost value>], enter one
Content Server metadata region name, the query term, and a boost value
between -200 and 200.
4. To define more Custom rules if needed, in the Actions column, click the Add
Custom button , and again enter a metadata region name, the query term,
and the Boost value.
30.11.9 Administering Searching Processes

Searching processes work together in the following way to allow users in Content
Server to search a data source's index:
• The Search Manager accepts search requests (in the form of a Query) from users
in Content Server and then gives the request to a Search Federator to handle.
• The Search Federator gives the search request to all the Search Engines that it
manages.
• The Search Engines search their partitions' indexes, and then produce search
results based on the data they locate.
• The Search Engines give the search results to the Search Federator.

• The Search Federator merges together all the search results that it receives and
then gives the final search results to the Search Manager.
• The Search Manager accepts the search results and then gives them to Content
Server to be displayed to users in Content Server on Search Results pages.
Note: When you establish a connection with the Search Federator, the default
timeout threshold value to issue a query is very short, so the connection can be
easily lost. You can increase the time available to issue a query by pressing the
ENTER key immediately after you open the Search Client. This will give you 3
minutes to type in your query before the Search Federator closes.
Adding Searching Processes

When you create a data source's index using Content Server templates, a Search
Manager, a Search Federator, and a Search Engine are created automatically. If you
create a data source's index by adding system objects individually, you must add a
Search Manager, a Search Federator, and a Search Engine yourself.
You can add Search Federators and Search Engines to your Indexing and Searching
system at any time. When you add a Search Federator, you also add one or more
Search Engines simultaneously. One Search Engine is added for each partition in
your system; for example, if there are three partitions in your system, adding a
Search Federator also adds three Search Engines.
Adding multiple Search Federators can create a redundant searching system.

Redundancy means that searching continues even if a Search Federator becomes
unavailable; other Search Federators are available to handle any search requests.
When you add multiple partitions to your system, you can increase the speed of
searching because more Search Engines are available to search smaller sets of data
simultaneously. If you want to see all the Search Federators and Search Engines in
an Indexing and Searching system, you can view a partition map. For more
information about partition maps, see “Working with Partition Maps” on page 601.
You can view the status of Search Federators that are running to see if they are active
or idle. If a Search Manager contains more than one Search Federator, the status and
the number of Search Federators running is listed in the Status column.
If you no longer need a Search Engine, you can delete it; however, each partition in
your system must have at least one Search Engine for it to be searchable. You can
also delete a Search Federator if you no longer need the Search Engines it manages,
as deleting a Search Federator also deletes all of its Search Engines. You delete
Search Engines the same way that you delete most other Content Server items.
Configuring Searching Processes

After you add searching processes to your Indexing and Searching system, you can
configure them to control how they operate. Default values are configured for some
settings automatically when you add the processes; however, you may need to
change these values. Before you configure searching processes, you must stop them.

You can stop an individual process, or you can stop all searching processes at once.
Whether you stop an individual process or all searching processes, this stops
searching for the Indexing and Searching system to which the processes belong.
Resynchronizing
otadmin.cfg and search.ini files must match the corresponding information in
(for example, if the information recorded in the file is deleted or has become
corrupted). If this occurs, you may need to resynchronize searching processes.
Resynchronizing searching processes modifies the otadmin.cfg and search.ini
files to reflect information about the processes that is currently stored in the Content
Server database.
Configuring Search Managers

You can configure Search Managers to customize searching behavior for an Indexing
and Searching system. For example, you can make regions in a data source's index
available to users for searching when you configure index regions. You can also
configure advanced ranking options, which allows you to determine which
documents at your site are most relevant in search results. For more information
about configuring advanced ranking, see “Configuring Advanced Ranking”
on page 709.
For a non-Enterprise data source, you can set up hyperlink mappings when you
configure its Search Manager. Hyperlink mappings allow users to access
information in the data source's index when viewing search results. For more
information, see “Configuring Hyperlink Mappings” on page 714.
Defining Search Results Counts

You can configure the number of extra search results Content Server will check the
permissions for, and if the end of the “unpermissioned” result set can be reached in
that range, the exact count is displayed. Only the results a user has permission to see
are included in the count. The maximum value of 225, which is the default, will
display the number of search results, up to 225, and the number of pages they are
displayed on. Users can click on any page of the results to see them immediately.
Note: The resultCountLookAhead parameter only affects non-bypass users

(and users not in the new group). Users who need an accurate count all the
time can be assigned to the new “See Unpermissioned Result Counts” group.

Administrators have a bypass privilege that automatically grants full

permissions to all items and locations in Content Server without permissions
verification.
For more information about the resultCountLookAhead parameter, see

“[SearchOptions]” on page 197.
30.11.10 Configuring a Search Federator

The Search Federator receives queries from Content Server, sends queries to Search
Engines, gathers the results from all Search Engines together, and responds to the
Content Server with the search results.
The Specific tab of the Search Federator Properties page.
Element Description
Process Information
Status Specifies whether the Search Federator is
field.
Search Federator runs.
on page 569.
returns an error code. If the error code
number is less than the number in the
Maximum Good Exit Code field, the process
attempts to restart. If the error code number
is greater than the number in the Maximum
Good Exit Code field, the process will not
attempt to restart and will require manual
attention. OpenText recommends that you
not modify the Maximum Good Exit Code,
unless instructed to do so by OpenText
Customer Support.

Element Description
Search Port Specifies the port that socket processes use to
communicate with the Index Engine.
Clicking the Check Port link allows you to
verify if the port number that you specified
is available.
Admin Port Specifies the port on which the Index Engine
runs. The process's Admin server uses this
port to start and stop it. Clicking the Check
Port link allows you to verify if the port
number that you specified is available.
Max Process Memory Usage Specifies the amount of memory the Java
Runtime Environment will request when
starting the Search Federator. Total memory
use may be higher due to Java overhead. The
default is 256 MB.
Search Result Cache Directory Specifies the location where the Search
Federator will cache search results when
running long search queries. This location
must be a directory the Search Federator can
access, and is used for temporary files that
will hold cache results. Click the Browse
System button to specify the location for
temporary files.
When this field is empty the feature is

disabled.
Time before Caching Results Specifies how long a query must be active
before the Federator will fetch and cache all
the search results. The default is 180 seconds
(3 minutes).
Actions
Process Starts or stops the Search Federator or all
process and the Index Engine(s) that belong
to a data source). Whether you stop all
indexing processes or an individual Index
Engine, indexing stops. If the indexing
Searching Processes Stops and then starts all searching processes
belonging to a data source.
Option Resynchronizes the information about the
Search Federator with the information in the
The Advanced Settings tab of the Search Federator Properties page.

Element Description
Advanced Settings
Note Specifies whether the Search Federator is running. You
Query Queue Size Specifies the queue size which determines how many
search queries can be active and waiting. The default is
25. Larger values consume more system resources.
Search Result Encoding Specifies the name of the character set encoding
specification to use to display Search Results. The
default is UTF-8.
Query Queue Threads Specifies how many worker threads can be active at
once. The default is 10. Larger values consume more
system resources.
Logging
Log File Specifies the location of the Search Federator process's
log file. The log file records information about the
process and can be used for troubleshooting if any
problems occur.
Debug Level Specifies how Search Federator log files record
information.
• Info Level, which records all types of messages
• Status Level, which records periodic status
messages, warning messages, and all error messages
• Warning Level, which records warning messages
and all error messages
• Error Level, which records typical error messages
and severe error messages
• Severe Error Level, which records severe error
messages
Logging Flush Interval Specifies the number of new messages that are recorded
in the Search Federator process's log before the process
writes it to disk.
Log File Actions Specifies how the Search Federator process's log file is
affected when the process restarts:
• Add to Existing, which adds any new information
to the end of the current log file
• Create New, which overwrites the existing log file
• Create New (Save Existing), which saves and
renames the existing log file and creates a new log
file based on the existing log file
• Rolling, which saves and closes the existing log file
and creates a new log file

Element Description
Log File Size Specifies a limit, in MB, on the maximum total size for
log files. The default is 100.
Startup Logs To Specifies the number of log files to keep before starting
Keep to overwrite them. The default is 5.
Additional Logs Specifies the number of additional log files to keep
To Keep before starting to overwrite them. The default is 10.
Actions
Process Starts or stops the Search Federator process. When you
stop the Search Federator process, searching stops. If
the searching processes are not running, the Start
button is displayed, and if the Search Federator process
is running or is scheduled to run, the Stop button is
displayed.
Searching Processes Stops and then starts all searching processes belonging
to a searching system.
Option Resynchronizes the information about the Search
Federator process with the information in the Content
Server database.
To View the Status of a Search Federator

To view the status of a Search Federator:
1. On the System Administration page, click the <processes_prefix> Data Source

Folder link of a data source that contains the Search Federator for which you
want to view the status.
2. View the Status column of the Search Manager.
To Configure a Search Federator

To configure a Search Federator:

Folder link of a data source that contains the Search Federator that you want to
configure.
2. Click the <processes_prefix> Search Manager link.
3. On the Search Manager page, click the Functions icon of the Search Federator,
and then choose Stop Searching Processes.
4. Click the Functions icon of the Search Federator, choose Properties, and then
choose Specific.
5. On the Specific tab of the Search Federator Properties page, edit the parameters
of the Search Federator as described in “Configuring a Search Federator”
on page 693.


7. Click the Functions icon of the Search Federator that you configured, and then
chooseStart Searching Processes.
Tip: You can also configure Search Federators when you view the partition
map to which they belong.
To Set Advanced Search Federator Settings

To set advanced Search Federator settings:

Folder link of a data source that contains the Search Federator that you want to
configure.
3. On the Search Manager page, click the Functions icon of the Search Federator,
and then choose Stop Searching Processes.
choose Advanced Settings.
5. On the Advanced Settings tab of the Search Federator Properties page, edit the
parameters as described in “Configuring a Search Federator” on page 693.
7. Click the Functions icon of the Search Federator that you configured, and then
choose Start Searching Processes.
Tip: You can also configure Search Federators when you view the partition
map to which they belong.
30.11.11 Configuring a Search Engine

A Search Engine is responsible for performing searches on a single partition,
computing relevance score, sorting results, and retrieving metadata regions to return
in a query. Every partition requires a Search Engine to support queries.

To Configure a Search Engine

To configure a Search Engine:

Folder link of a data source that contains the Search Engine that you want to
configure.
3. On the Search Manager page, click the Functions icon of the Search Federator
that manages the Search Engine you want to configure, and then choose Stop
Searching Processes.
choose Search Engines.
5. On the Search Engines tab of the Search Federator Properties page, click the
name link for the Search Engine that you want to configure.
6. On the Specific tab of the Search Federator Properties page, edit the parameters
of the Search Engine.
8. Click the Functions icon of the Search Federator that manages the Search
Engine that you configured, and then choose Start Searching Processes.
Tip: You can also configure Search Engines when you view the partition map
to which they belong.
To Start or Stop Searching Processes

To start or stop searching processes:

Folder link of the data source folder with which the searching processes that
you want to start or stop are associated.
2. Click the <processes_prefix> Partition Map link.
3. On the Partition Map page, do any of the following:
• Click a Search Federator's Functions icon, and then choose Start Searching
Processes to start all processes
• Click a Search Federator's Functions icon, and then choose Stop Searching
Processes to stop all processes
• Click a Search Federator's Functions icon, and then choose Restart
Searching Processes to restart all processes
• Click a process's name link, and then click the Process Start button on its
Properties page to start an individual process

• Click a process's name link, and then click the Process Stop button on its
Properties page to stop an individual process
Tip: You can also start, stop, or restart all searching processes by clicking a
process' name link, and then clicking the Start, Stop, or Restart button on its
Properties page.
30.11.12 Configuring Remote Search

You can use OpenText Content Server Remote Search to search multiple Content
Server installations. You set up a remote connection between installations by adding
and configuring a remote Content Server system, which resides within a Data
Source and is accessible to slices. This allows the Administrator the ability to create
new slices to search against remote Content Server systems, or add the object to
existing ones. For information about slices, see “Creating Slices” on page 701.
When the administrator browses to the parent of this object, this object would have a
status or either idle, searching, or process error, like other search processes. For
information about data sources, see “Changing Your Content Server Database“
on page 263. The Specific properties page would consist of the following settings:
Configuring Remote Search
You configure a Remote Search process to open a connection between Content

Server systems by adding a remote Content Server system to the Enterprise Data
Source Folder. This process acts as a web browser by communicating information to
the Content Server system which functions as a remote server via HTTP. Also, this
process accepts connections from a Content Server system which functions as a client
server. When adding a remote Content Server system, you must set up user
authentication for the Administrator logging into that remote Content Server
system. For information about search processes, see Livelink Search Administration -
webotcindex Module (LLESWBO-H-AGD).
Notes
• This user can either be the System Administrator or a user with system
administration privileges.
• When a Content Server system functioning as a client server runs search
result operations that are to be handled by a Content Server system
functioning as a remote server, the client server must be added as a Valid
Referrer to the remote server. Examples of search result operations include
Hit Highlighting and Function Menu commands. For more information
about adding a Valid Referrer to Content Server, see “Configuring Security
You must also indicate the permission-type for the user performing the search on
the remote Content Server system. When adding a new remote Content Server
system, you can specify one of the following user access control settings:
• Native User Only, searches on the remote server are performed as the initiating
user from the local Content Server system.

Note: If the user does not already exist on the remote server, the search
query will return a “no results found” error, and is logged in the log file as
a warning.
• Named Public User, searches on the remote server are always performed as a
single user. The user name is entered in the input field.
• Native User with Fallback to Named Public User, same as Native User Only if
the initiating user from the local Content Server system exists on the remote
server. If the local user does not exist on the remote server, searches execute as
the specified user name on the remote server.
To Configure Remote Search
To configure Remote Search:

Open System Object Volume link.
2. On the Content Server System page, click the Enterprise Data Source Folder
link.
3. On the Enterprise Data Source Folder page, from the Add Item menu, click
Remote Content Server.
4. On the Remote Content Server page, in the Name field, type a name for the
data source process.
5. Optional To provide a description of the Remote Content Server, on the General

tab of its Properties page, type descriptive text in the Description field.
6. In the Host list, click the shortcut of an Admin server on whose host you want
the Remote Search process to run.
7. Optional To allow Content Server monitoring of this process status, select Enable
System Management.
8. Optional To start the Remote Search process immediately after you create it, select
Start Remote Search Process. The process will start by default, unless you
deselect the check box.
9. Optional To allow the client admin server to communicate with the remote admin
server, type the port number in the Admin Port field.
10. Optional To allow search query executions on the remote server, type the number
in the Search Port field.
11. In the Remote Content Server Settings section, in the Site Name field, type the
name you want to appear on the Search Result page when a search is
performed on the remote server.
12. In the URL field, type the path for the location of the remote server.

13. Optional In the Optional Search API Parameters field, you can either enter
specific parameters for inclusion in the Search API request, or click the View
Remote Slices... button to retrieve a list of slices available on the remote server.
An example of specific parameters for inclusion: &slice=X, where X is the
DataID of the slice, or &template=Y, where Y is the DataID of the Search
template.
Note: This field is not restricted to slice or template parameters; any

Search API parameters for the remote site may be entered.
14. In the Admin User field, type the login name of the Administrator of the remote
server.
15. In the Admin Password field, type the password for the Administrator of the
remote server.
16. Optional To enable user control access, do the following:
• To perform searches on the remote server as the initiating user from the local
Content Server system, select Native User Only.
• To allow searches to be performed on the remote server as a single user,
select Named Public User, and type a name in the Public User field.
• To limit search results to the user logged into the local server, but allow
public access if that user is not logged in, select Native User Fallback to
Named Public User, and type a name in the Public User field.
17. Click Add.
To Test a Remote Search Connection

To test a Remote Search connection:
1. On the remote server's Properties page, click Test Connection.
2. On the Test Connection page, click the Continue link to return to the Enterprise
Data Source Folder.
30.11.13 Creating Slices

When Content Server users construct Queries on the Search page, they specify
search criteria and can choose a search slice (Content Server searches the Enterprise
search slice by default). Content Server applies each Query that Content Server users
submit to the search slice that they specify. The names of the search slices that are
available at a particular Content Server site are displayed in the Slices list on the
Search page and in the drop-down list in the search bar at the top of most other
Content Server pages.
A Query that you save in the Slice Folder becomes a slice. This means that the slice
name automatically appears in the Slices list on the Search page. If you save Queries
in any other Content Server Folder, they are saved Queries that you can run again at

any time. After you create a slice, you can click its name link in the Slice Folder to
run the corresponding Query and display its search results.
When you delete an index data flow, the slice that represents the set of all data in
that index is also deleted. As a result, the saved Queries, search forms and templates
that are associated with that search slice will not have a set of data to search and will
produce no search results. When you create an index with an index template,
however, you can choose to replace the slice of the deleted index with the slice of the
new index. This associates those saved Queries, search forms and templates with the
new index.
You can design slices to fit the needs of your organization. The following list
describes some popular types of slices:
• If your Content Server system contains more than one index (for example,
Enterprise, Directory Walker, Help, and Content Server Spider indexes), you can
create a slice that includes all your indexes.
• You can create a slice based on a Query that you construct on the Search page.
• You can create a slice based on a search form that you construct on the Search
page.
• You can create a slice that allows Content Server users to query the information
in a particular Content Server Folder and all its subfolders.
• You can create a slice that allows Content Server users to query the information
in a particular project.
You can also define a custom order for the slices on the Search Bar and for Advanced
Search. In addition, you can enable or disable the From Here option on the Search
Bar, and define the size of the Advanced Search Slices component. For details, see
“To Configure Slices in a Custom Order” on page 705.
To Create a Slice from All Indexes

To create a slice from all indexes:
1. Click the Tools menu, and then choose Search.

2. On the Search page, click All Words in the Look For drop-down list.
3. Type the following text (including the quotation marks) in the field in the Full
Text text box:"<otdoc>"
4. Click the Slices link in the Advanced Options section to view the slices that are
available at your Content Server site.
5. Hold down CTRL, and click the name of each slice in the Slices list.
6. Click the Save Search Query button.
Tip: When you or another user are logged in with System Administration
rights, a Save as Slice button is available under Save Options, so you do

not need to navigate to the Slice Folder as the target location for saving
your query.
7. On the Save Search Query page, type a unique name for the slice in the Name
field.
8. To provide a description of the slice on the General tab of its Properties page,
9. To modify the Categories associated with this item, click the Edit button.
10. Click the Browse Content Server button, browse to the System Folder, and click
the Select link in the Actions column.
11. On the Save Search Query page, click the Add button.
Note: You create a search slice that encompasses all existing indexes at a
Content Server site when you want to apply Queries to all of the available
indexes simultaneously.
To Create Slices from Queries
To create a slice from a Query:
1. Click the Tools menu, and then click Search.
2. On the Search page, specify the search criteria.
3. Click the Save Search Query button.
Tip: When you or another user are logged in with System Administration
rights, a Save as Slice button is available under Save Options, so you do
not need to navigate to the Slice Folder as the target location for saving
your query.
4. On the Save Search Query page, type a unique name for the slice in the Name
field.
6. To modify the Categories associated with this item, click the Edit button.
the Select link in the Actions column.
Note: You create a search slice from a Query when you want to apply Queries
to the set of data defined by the search criteria in the slice.

To Create Slices from Content Server Folders

To create a slice for a Content Server Folder and its contents:
1. Go to the root of the Content Server Folder for which you want to create a slice.
2. In the Search field at the top of the page, type an Asterisk (*).
3. Click From Here in the drop-down list, and then click the Go button.
4. On the Search Results page, click the Save Your Search button.
5. On the Add: Query page, type a unique name for the slice in the Name field.
button.
the Select link in the Actions column of the Slice Folder.
Note: You create a search slice from a Content Server Folder when you want to
allow Content Server users to issue Queries against the Folder and its contents.
To Create Slices from Projects

To create a slice for a Content Server project and its contents:
1. Go to the Project Workspace page of the project for which you want to create a
slice.
2. Type the following text in the Search field on the search bar at the top of the
Project Workspace:* (asterisk)
3. Click From Here in the drop-down list, and then click the Go button.
4. Ensure the search bar reads Search Content Server for.
5. On the Search Results page, click the Save Query button.
6. On the Add: Query page, type a unique name for the slice in the Name field.
button.
the Select link in the Actions column of the Slice Folder.

Note: You create a search slice from a Content Server project when you want
to allow Content Server users to issue Queries against the project's contents.
To Configure Slices in a Custom Order

To configure slices in a custom order:

2. Click the Slice Folder’s Functions icon, and choose Configure Slices.
3. On the Slice Folder page, for Search Bar and Slices Component Slice Order,
select the alphabetical order in which slices are displayed. You can define a
custom configuration by selecting the Custom radio button. The Available and
Displayed slices on your Content Server system are shown so you can move
them so they appear in the order you choose.
4. In Add "From Here" option to Search Bar, select the check box to display the
From Here option in the Slices list on the Search Bar in Advanced Search.
5. In Advanced Search Slices Component Menu Size, enter the height, in rows, of
the Advanced Search Slices component menu.
6. Click Update.
30.11.14 Configuring Index Regions

You can select the following search options for index regions:
• Queryable, which allows users to choose the regions that appear as System
Attributes on the Advanced Search Page
• Displayable, which allows users to display regions on the Search Results page
• Search by Default, which specifies that the regions are searched automatically
• Sortable, which allows users to sort using these regions on the Search Results
page
• Filter, which allows users to use Search Filters with these regions on the Search
Results page. For more information, see “Search Filters” on page 685.
Note: It is important to review which regions are queryable, displayable,

searchable by default, and sortable when you install a new module or upgrade
Content Server or any of its modules, as the new software may include new
regions. You cannot configure search options for the new regions, however,
until the new software has been indexed and the regions have data. If regions
that you expect to see on a Search Manager's Regions tab do not appear, it may
be because the regions are nested. You can configure nested regions by
modifying the LLFieldDefinitions.txt file in the Config directory of your

When you configure index regions, you can also make the attributes within
Categories displayable. If you want to make a Category's attributes queryable by
default (that is, appear by default when the Category is added to the Search page),
select the Show in Search check box when you add or edit an attribute.
Users can search existing regions using the Live Query Language (LQL), regardless
of the search options you specify for regions. Specifying the queryable option or the
search by default option for a region eliminates the need for users to specify the
region name in an LQL statement.
To Configure Search Options for Index Regions

To configure search options for index regions:


Folder link of the data source containing the index regions that you want to
make queryable and/or displayable.
3. Click the Functions icon of the Search Manager, choose Properties, and then
choose Regions.
4. On the Regions tab of the Search Manager Properties page, choose which
options to apply for each region shown:
a. Type a new name in a region's Display Name field to modify the region's
name.
Note: There are two situations when you cannot edit the Display
Name for some regions:
• The display name of category attribute regions is derived from both

the category and attribute names according to this template
[category name]:[attribute name]. In this case, a link to the category
definition is given in the attribute region display name.
• A small set of basic search regions have hard-coded region display
names, and cannot be edited. These include: OTDocumentRating,
OTLocation, OTName, OTObjectDate, OTObjectSize.
b. Select a region's Queryable check box to allow users to search it.
Note: The Queryable check box is not shown for category attribute
regions. For these regions, it is the Show in Search check box on the
attribute definition page that dictates whether the region will appear
in the Category search component.
Index workflow attributes are stored in region WFATTR. By default,
these regions are not searchable on the Advanced Search page. To
make them searchable, enable the Queryable check box for each

region. Once enabled, the attribute region will appear in the system
attributes component.
c. Select a region's Displayable check box to allow users to display it on the
Search Results page.
d. Select a region's Search by Default check box to make it searchable by
default.
e. Select a region's Sortable check box to allow users to sort using these
regions on the Search Results page.
Note: If a region does not have a Displayable check box, it is because no item
with that attribute has been added to the Content Server database. After an
item with the attribute in question is added and indexed, a Displayable check
box will appear in the region's row.
The Displayable check box is not conditional on the region being indexed. It is
always present for most regions. If an optional region like a Category attribute
is not yet indexed, it will not appear on the Search Manager regions tab.
To Configure Region Attributes for Index Regions

To configure region attributes for index regions:


apply region attributes to.
choose Region Attributes.
4. On the Region Attributes tab of the Search Manager Properties page, specify
the Default Attributes for the language to apply to the OTName and
OTDComment regions. You can change the language used by entering an Xlate
value instead of plain text.
Note: With a new Content Server 10.0 installation, no default values for
region attributes are set, so the text box is empty.
In Content Server 10.0, OTName, OTDComment and OTGUID are the only
regions currently using attributes, but more will be added in future
releases. OTName and OTDComment are existing regions from previous
releases, OTGUID is new in Content Server 10.0.
With an installation where Enterprise Data Sources have been upgraded
from Content Server 9.7.1, or after content has been updated in Content
Server 10.0, the OTName and OTDComment region attributes will be set to
the system default metadata language, and shown in the text box.

You can set the metadata language for all existing OTName and
OTDComment values in an upgraded index. For example, to set region
attributes to French language enter:
OTName="lang","fr"
OTDComment="lang","fr"
To Configure Region Modifiers for Index Regions

The Search Engine supports a region modifier for search queries, the “like” operator.
When applied to regions of type PartNum, this operator will perform aggressive
tokenization to try and match common patterns found in part numbers and file
names.
The Search Engine also has the ability to create search regions comprised of the
domain portions of email addresses, to support eDiscovery processes with email.
On new and upgraded installations of Content Server, the Live Query Language
(LQL) and OpenText Structured Query Language (OTSQL) support the “like”
keyword in the Full Text search in Advanced Search. These languages will recognize
the new QLLIKE keyword, and will enable Complex Query mode.
Regular “Text” type regions need to be explicitly configured for “like” support on
the Region Modifiers page. On new installations, the OTName region is configured
for “like” support through default entries on the Region Modifiers page of each
Search Manager.
Any region declared as type PartNum in the LLFieldDefinitions.txt file, receives

“like” support by definition. In Content Server there are no PartNum type regions by
default.
The “like” keyword will function as a non-operator, performing a normal

unmodified query of the region. If a region is not configured for “like”, it will
operate as an AND of terms in the expression.
If the region with part number properties is included in the list of default search
regions, then the QLLIKE operation will be used automatically for that region.
To configure region modifiers for Index Regions:


apply region modifiers to.
choose Region Modifiers.

4. In the Like Modifier area, in the first text box, enter a comma-separated list of
search regions configured to use the “like” modifier.
5. In the second text box, enter a comma-separated list of search regions

configured for default application of the “like” modifier.
6. In the E-mail Domains area, enter a comma-separated list of regions containing

email addresses.
7. Restart the Index Engines for all Admin servers in the Content Server cluster for
the modifications to take effect.
To Purge Index Regions

You may need to remove unused regions from the Content Server representation of
data source regions. Only regions present in the Content Server model, but not in the
search index may be purged.
To purge index regions:

2. Click the Enterprise Data Source Folder link.
3. On the Enterprise Data Source Folder page, click the Enterprise Search
Manager’s Functions icon, and choose Properties and then Purge Regions.
4. Under Purge, click the top check box to select or deselect all the check boxes.
5. Or, select the check box for each region to remove from the Search Manager
regions.
6. Click Update or Apply to remove the regions you selected.
Note: If no region names are displayed on this page, then all regions in
Content Server also exist in the search index.
30.11.15 Configuring Advanced Ranking

An item's search result relevance score is based upon several parameters which can
be tuned and adjusted to reflect your application needs. In most cases, the
configuration is comprised of weights and regions. The weights indicate how
important the parameter is in scoring.
Note: These weight values are relative. Setting all the weights high is the same
as setting all the weights to a medium value. The difference in weights is
ultimately what matters.
The calculation of an item's score is based on the weighted average of its query score
and its advanced criteria scores. A query score is the measure of an item's match to a
Query. The closer that an item matches a Query, the higher its query score.

Advanced criteria are additional ways of determining a score for an item. Like the
query score, the closer that an item matches the advanced criteria (for example, if it
is a specific MIME type), the higher its associated advanced criteria score. Queries
have a weight value, and each advanced criterion has its own weight value. The
higher the weight value, the more that score affects the search result score. The
combination of an item's query score and advanced criteria scores are combined as a
weighted average to produce the item's search result score. Advanced criteria
include the following:
• Field Rank, which is based on an item's metadata regions. Metadata regions
store information (metadata) about indexed items (for example, summary,
location, MIME type, creation date, and size). When you configure the field rank,
you specify the metadata regions that are most important. If a query term in a
Query matches the metadata in a region that you specified (for example,
OTSummary), the item is given a higher score. For more information about index
regions, see “Configuring Index Regions” on page 705.
• Date Rank, which is based on one or more of the date metadata regions of an
item. When you configure the date rank, you specify the date metadata region
(for example, OTModifyDate) that is used to calculate an item's score. Items that
are closer to the real-time date are given higher scores.
Date relevance is computed using a decay rate from the current date. The decay
rate is one of the configurable values. Small values for decay rates will reduce the
score of older items more rapidly. A simplified approximation of the algorithm
is:
Date Relevance = decay / (recentness + decay)
In practice, a very aggressive value that strongly favors recent objects would be a
decay rate of 20 days.
• Type Rank, which is based on an item's enum type metadata regions. For
example, when you configure the type rank, you can specify the enum type
metadata regions (for example, OTFilterMIMEType) that are most important.
Items that have a value that you specify (for example, application/msword or
text/plain) are given higher scores.
• Object Score, which is based on an item's OTObjectScore metadata region. This
region is a measure of the value placed upon an item by users of the system.
When you configure the object score, you also specify the weight values for the
three criteria that make up the object score: the Favorites weight (the number of
times an item has been added to users' Favorites), the Shortcuts weight (the
number of Shortcuts that have been made to the item), and accesses weight (the
number of times the object has been accessed). The higher the weight, relative to
the other two, the more influence it has on the object score. For the accesses
weight to contribute to the object score, Recommender must be enabled. For
more information about enabling Recommender, see “Administering
Recommender“ on page 797. When you change the weight values, Content
Server may update the OTObjectScore region for all of the items in the index.
However, rather than fully re-indexing the Enterprise data source, which may
take considerable time for large indexes, Content Server lessens the performance
impact by using a lightweight extraction system to update the items. If the

performance impact is still too great, you can disable the object rank advanced
ranking by setting the ObjectRankEnabled parameter in the opentext.ini file to
FALSE. For more information, see “[options]” on page 177.
When you configure advanced ranking, you specify an integer that establishes the
weight that is associated with Queries, advanced criteria, or both. The following
table provides information about the format that you should use when you
configure each advanced ranking option.
Format for Advanced Ranking Options
Advanced Ranking Option Format

Query Weight The weight integer establishes the overall
base value against which other relevance
computation options are calculated.
Weights can range from 1 to unbounded, but

if you do not specify a value, 100 is used by
default.
Note: All weight values in all fields

must be expressed as integers.
Field Rank regionName,weight, where regionName
represents the name of a metadata region,
and weight represents an integer that
establishes how important this ranking
option is.
This example of a field rank configuration,

"OTSummary",15, ranks the document
summary region at a value of 15 out of the
base value of 100.
To configure multiple field rank values, use a

semicolon-separated list: "regionName1",
weight1;"regionName2",weight2


Date Rank regionName,decay,weight where
regionName is the name of a date metadata
region.
The decay value sets the number of days for

an item's score. As an item gets older (in
increments of this number), it is assigned a
lower score. For example, if you set the
decay value to 10, and an item was created
or modified within the last 10 days, it is
assigned the highest score. If an item was
created or modified within the last 20 days, it
is assigned a lower score. The item's score
continues to decrease, based on how many
days ago it was created or modified. Items
that were created or modified too many days
ago are assigned a score of zero.
This example of a date rank configuration,

"OTModifyDate",10,5, sets the item
modification date region to a decay rate of
10, and ranks it at a value of 5 out of the base
value of 100.
To configure multiple date rank values, use a

semicolon-separated list in the following
format: "regionName1",
decay1,weight1;"regionName2",
decay2,weight2


Type Rank regionName,textWeight:text,region
Weight, where regionName is the file
MIME type metadata region.
textWeight is the relative weight for this

text string within this region, and should be
an integer from 1 to 100, and text is a string
to check. If found, the associated textWeight
value is used.
regionWeight is the importance relative to

other elements of the relevance computation.
This example of a type rank configuration
uses the file's MIME type region, a
textWeight of 20, the text string that defines
MS Word documents, and the relative
importance compared to other elements at
30: "OTFilterMIMEType",
20:"application/msword",30
To configure multiple type rank values, use a

semicolon-separated list in the following
format: "regionName1",
textWeight1:"text1",
regionWeight1;"regionName2",
textWeight2:"text2",regionWeight2
You can list many regionName and text

settings, separated by colons. For example:
"OTFilterMIMEType",
20:"application/msword",
50:"text/plain",
20:"application/vnd.ms-excel";
"OTSubType",10:"144",10
Object Score "OTObjectScore",weight represents the
value placed on a object by Content Server
users, which allows you to further adjust the
weight given to search rankings.
This example sets the region that measures

user’s value of an item to
100:"OTObjectScore",100
The Favorites Weight, Shortcuts Weight,

and Accesses Weight values allow you to
specify the weights used by the indexing
system, based on factors such as references
the number of accesses, when it calculates
the Object Score. The weights do not need to
add up to a specific number since they
represent the relative importance of the three
factors.

To Configure Advanced Ranking

To configure advanced ranking:

Folder link of the data source for which you want to configure advanced
ranking.
choose Ranking.
3. On the Ranking tab of the Search Manager Properties page, configure the
• Query Weight
• Field Rank is based on an item's metadata regions.
• Date Rank
• Type Rank
• Object Score
For more information about the parameters you can set, see “Configuring
Advanced Ranking” on page 709.
30.11.16 Configuring Hyperlink Mappings

To ensure that each result links to the appropriate document, you must create
hyperlink mappings that will configure the Search Manager to serve the documents
through a Web server. While Directory Walkers created in previous versions of
Content Server did not require a Web server, currently, a Web server is required.
You must run a Web server for hyperlink mappings to function properly.
source or when you configure its Search Manager separately. If you choose to
configure the hyperlink mappings when you create a Directory Walker data source,
you do not need to configure the hyperlink mappings for the data source's Search
Manager. For other non-Enterprise data sources, you configure hyperlink mappings
when you configure the Search Manager for the data source. Examples of non-
Enterprise data sources are the Admin Help Data Source, the Directory Walker Data
Source, the User Help Data Source, and the XML Activator Producer Data Source.
For more information about Search Managers, see “Administering Searching
Using hyperlink mappings also allows you to modify the path to indexed
documents after the index has been created. For example, if the indexed directories
are moved after the index is created, you modify the hyperlink mappings for the
specific Search Manager. If you move the index to a new Content Server host, you
do not have to change any configuration settings, because the hyperlink mappings

are still valid, even though the path recorded in the index may not be valid
according to the index's new host.
mappings. For more information about configuring a Directory Walker data source,
see “Indexing Data on your File System” on page 413.
To Configure a Hyperlink Mapping

To configure a hyperlink mapping:
1. Check the Directories field on the Specific tab of the Directory Walker's
Properties page to identify the root path that is common to all the directories
that the Directory Walker crawls. For example, if the Directories field contains
c:/dirA/dir1 and c:/dirA/dir2, your common root path is c:/dirA.
Note: The common root path will be specific to the environment of the
system indexed by the Directory Walker.
2. Copy the path's prefix.
3. On the System Administration page, click the <processes_prefix>Data Source

Folder link of the data source folder that corresponds to the Directory Walker
index that you want the hyperlink mapping to use
4. Click the Search Manager's Functions icon, choose Properties, and then choose
Specific.
5. On the Specific tab of the Search Manager Properties page, paste the path prefix
into the Find field.
6. In the Replace With field, type the following: http://<Server_name>/

<Virtual_directory_name>.
Important

Tip: You can also perform a search in Content Server to locate the relevant root
path.
30.11.17 Administering Search Templates

Search templates allow you to define the default appearance of the Search page in
Content Server. You can configure specific fields and values that you want to appear
by default when users perform a search using a search form. For example, if users
frequently search on documents that they created, you can add the Created By
system attribute to the Search page and save it as a search form so that Created By
appears by default when using this search form.
You can perform search template administration tasks when you log in to Content
Server as the Admin user. You can modify or delete system templates as well as all of
the personal templates that Content Server users have created. When you modify a
search form to change its appearance, the changes that you make are immediately
available to those users who can access the search form. If you no longer want a
search form to be available to Content Server users, you can delete it. You can also
perform other standard Content Server functions (such as changing permissions,
setting notification, and viewing general or specific information) on all of the search
templates in the system.
Note: If you have enabled domains and you delete all search templates and
then reset the system default template, you must reapply the Add Item and
Delete permissions for the Personal Search Templates folder.
If you modify the name of a User's Personal Search Template folder, this will
delete that User's saved templates. Your User will not be able to use the
existing templates because they no longer appear on the drop-down list.
When you create a search form, you can also configure the search results display
options to be associated with that search form. For more information, see
“Configuring Search Results Display Options” on page 719.
System Search Templates
You can create up to 100 system search templates to allow for different Search page
configurations for different user needs. You can set permissions on each search
template so that they only appear for the designated users and groups. Users can
then select a search template from the list available to them for easy access to search
configurations that are relevant to them. When you create a search template when
logged in as the Admin user, the search template is automatically saved as a system
search template. For more information on creating and using search templates in
Content Server, see OpenText Content Server User Online Help - Searching Content
Server (LLESWBB-H-UGD).
System Default Search Template
When logged in as a user with Admin user permissions, you can also modify or reset
the system default search template. When you log in for the first time, Content

Server generates a system template named Admin-Default. This template is a copy of

the original system default template and is available to all Content Server users. The
system default search template defines the appearance of the Content Server Search
page when Content Server users access the page for the first time, when no other
search templates exist in the system, or when Content Server users choose not to use
personal or system search templates to perform a search. You can modify the system
default search template to specify the appearance of the Content Server Search page
in these cases. If you want to delete the changes that you have made to the system
default template, you can reset the template. Resetting deletes and then recreates the
system default template in its original configuration. For more information, see “To
Reset Search Templates” on page 719.
Note: Because a Content Server site must always contain a system default
template, Content Server automatically resets the Admin-Default template if
you attempt to delete it.
Personal Search Templates
By default, each Content Server User can create 20 personal Search Forms; however,
if you want to allow Content Server Users to create more or less than 20, you can
change this value. This allows you to regulate the number of personal Search Forms
at your Content Server site (between 0 and 100 per user) and can make Search
Template administration more manageable. You can delete or modify Users
personal Search Forms from the Administration pages.
Note: If you modify the name of a User's Personal Search Template folder, this
will delete that User's saved templates. Your User will not be able to use the
existing templates because they no longer appear on the drop-down list.
Search Results Templates
By default, each Content Server User can create 20 personal Search Results
Templates; however, if you want to allow Content Server Users to create more or
less than 20, you can change this value. This allows you to regulate the number of
personal Search Results Templates at your Content Server site (between 0 and 100
per user) and can make Search Template administration more manageable. You can
delete or modify Users personal Search Results Templates from the Administration
pages.

To Modify a Search Form

To modify a search form:
2. Click the Personal Search Templates link.
• To locate a system search form, click the Admin link.

• To locate a Content Server user's personal search form, click the appropriate
user's login name.
4. Click the Search Form's Functions icon, and choose either Edit or Properties,
and then Specific.
5. Modify the search criteria on the Search page.
Notes
• You can also modify the system default search template by clicking the Edit
the System Default Template link on the administration page and then
redesigning the template.
• You can also modify the search forms that you create by redesigning them
on the Search page. For more information, see Livelink Search Administration -
websbroker Module (LLESWBB-H-AGD).
To Delete a Search Form

To delete a search form:
• To delete a system search form, click the Admin link, click the Search Form's
Functions icon, and then choose Delete.
• To delete a User's personal search form, click the appropriate user's login
name, click the Search Form's Functions icon, and then choose Delete.
4. In the dialog box that prompts you to confirm the deletion, click the OK button.
Tips
• You can delete all search templates, system search templates only, or
personal search templates only by clicking the Reset the system default

Search Template link on the Reset Search Templates page. For details, see
“To Reset Search Templates” on page 719.
• If you have enabled domains and you delete all search templates and reset
the system default template, you must reapply the Add Item and Delete
permissions for the Personal Search Templates folder.
To Reset Search Templates

To reset the default search template:
1. On the administration page, in the Search Administration section, click the

Manage Search Templates link, then the Reset Search Templates link.
2. On the Reset Search Templates page, click the Reset the default system Search
template radio button.
3. Click Submit.
4. In the dialog box that prompts you to confirm the deletion, click OK.
To Manage the Number of Search Forms and Search Templates

To manage the number of search forms and search templates:

Manage Search Templates link, then the Configure Search Templates link.
2. On the Configure Search Templates page, in the Search Forms section, enter a
value between 0 and 100 in the Maximum per User text box to define the
number of personal search forms that you want to allow each Content Server
user to create. The default is 20.
3. In the Search Results Templates section, enter a value between 0 and 100 in the
Maximum per User text box to define the number of personal Search Results
Templates that you want to allow each Content Server user to save. The default
is 20.
4. Click Update.
30.11.18 Configuring Search Results Display Options

When a user performs an Advanced Search, or performs a search from the
Enterprise Server search bar, the Search Results page appearance is determined by
the user’s default Search Results Template. If no default Search Results Template is
defined for the user, the Search Results page appearance is determined by the
Default System Search Templates. For more information on search forms, see
“Administering Search Templates” on page 716.
You can specify the way search results appear when using the System Default
Search Template or other System Search Templates on the Display Options page.
You can set the same display options for each search form, use the default display

options configuration, or you can customize the display options for each Search
form.
For example, you can define two system Search Templates; one for the Legal
Department and one for the Billing Department, each with different Search Results
page appearances. In the Legal Department Search Template, you can add the
metadata field “Case Number” as a Displayed Result Field. It will then appear on
the Search Results page when searching using the Legal Department Search
Template. You can then add the metadata field “Client Name” as a Displayed Result
Field on the Billing Department Search Template. It will then appear on the Search
Results page when searching using the Billing Department Search Template.
The following options can be configured on the Display Options page:

• Results Page Layout
• Number of Results
• Show Summaries/Descriptions
• Show Key Phrases
• Show Full Path in Location
• Result Fields
• Sort By
For detailed information on these settings, see OpenText Content Server User Online
Help - Searching Content Server (LLESWBB-H-UGD).
Notes
• Result fields that are required cannot be removed. These fields, if any, will
appear in the Required section on the Display Options page. For more
information on required search fields, see “Configuring Required Search
Results Fields” on page 722.
• The options available in the Sort By field are determined by which index
regions have been configured as sortable. For more information, see
“Configuring Index Regions” on page 705
Display Options for Search Templates can be set from within the administration
pages. When logged in to Enterprise Server as an Admin user, you can also modify
Search Templates by selecting Search Templates from the Personal drop-down
menu.

To Set Search Results Display Options for Search Forms from

the administration page:
To set search results display options for Search Templates from the
administration page
3. Click the Admin link.
4. Click the Search Results Template's Functions icon, and click the Edit the
Display Options link.
5. On the Display Options page, specify the display options you want.

the Personal Menu:
To set search results display options for a System Search Template from the
Personal Menu:
1. Log in to Enterprise Server as an Admin user.
2. Click the Personal menu and then click Search Templates.
3. Click the Search Results Template's Functions icon, and click the Edit the
Display Options link.

the Search page:
To set search results display options for Search Forms from the Search page:
1. Log in to Enterprise Server as an Admin user.
2. Click the Advanced Search link, and select the Search Form you want to modify
from the Use this Search Form drop-down list.
3. Click the Edit the Display Options link from the Results Display Style drop-
down list.

30.11.19 Configuring Required Search Results Fields

You can set specific search results fields as required so that these fields always
appear on the Search Results page. If a result field is set as required, when you
configure search results display options for search results templates, or when users
modify the search results display options before or after performing a search, the
fields are fixed and cannot be removed.
For example, if you have a metadata field called Security Level that you always want
to appear on the Search Results page, you can set this field as required, and it cannot
be removed, even when modifying display options after search results have been
returned. For more information, see “Administering Search Templates” on page 716.
For more information on configuring search results display options, see
“Configuring Search Results Display Options” on page 719.
You can set fields as required and configure the order in which they appear on the
Search Results page from the Configure Required Search Results Fields page.
Required search results field always appear in the first position after the MIME type
icon in the order that you specify.
To Configure Required Search Results Fields

To configure required search results fields:

Configure Required Search Result Fields link.
2. On the Configure Required Search Result Fields page, in the Available

column, choose the fields you want to make required, and then click the right
arrow button to add them to the Required column. Optionally, click a field in
the Required column and then click either the up or down arrow button to
reorder the fields.
3. Click Apply.
Tip: When logged in as a user with System Administration rights, you can also
modify Required Search Results Fields on the Display Options page in the
Required section by clicking the Configure Required Search Results Field
link. For more information on the Display Options page, see “Configuring
Search Results Display Options” on page 719.

30.11.20 Administering Download as Spreadsheet

When a user creates a Collection from the results of a search , the Collection can
downloaded as a spreadsheet, or multiple spreadsheets are created and compressed
into a single ZIP file. You can control which users or groups are able to use this
feature by clicking the Download as Spreadsheet links in the Usage Privileges
section of the Administer Object and Usage Privileges page in the System
Administration section. For details, see “Administering Object and Usage
Privileges“ on page 327.
By default, this feature is restricted to administrators on new and upgraded

installations of Content Server Update 5, or later.
The Collections General Settings page allows you to specify the:

• maximum value for the size of downloaded spreadsheets
• maximum number of items that can be placed in a single spreadsheet
• maximum number of objects that can be exported using the Download as
Spreadsheet feature
For more information about these configuration parameters, see “Configuring

Collections General Settings” on page 895.
For information about the download procedure, and the data written to the
spreadsheet, see OpenText Content Server User Online Help - Searching Content Server
(LLESWBB-H-UGD).
30.11.21 Administering Best Bets

When a user performs a search using a Best Bets value, any results containing the
value are displayed at the top of the Search Results page. For example, you may
have a corporate event that you want to promote, such as a company picnic. You can
apply a value, such as corporate events, company picnic, or both to items
containing information about the event.
You can also apply a Best Bets expiry date to items, so that when the expiry date is
reached, the Best Bets value associated with the expiry date no longer appears in the
Best Bets section on the Search Results page. For more information about the Search
Results page, see OpenText Content Server User Online Help - Searching Content Server
(LLESWBB-H-UGD).
There are two index regions associated with best bets; they are OTBestBetsValue
and OTBestBetsExpiryDate. For more information, see “Configuring Index
Regions” on page 705.
Designating Best Bets Administrators
Before users can apply or edit Best Bets values, they must have permissions to
modify items. For more information about permissions, see OpenText Content Server
User Online Help - Getting Started (LLESRT-H-UGD). Also, you must add the user to

the Best Bets Administrators group. This is done by editing the Best Bets usage
privileges. For more information about usage privileges, see “Administering Object
and Usage Privileges“ on page 327.
Configuring Best Bets
Configuring Best Bets allows you to define or change how Best Bets results are
displayed, and the number of results to display, on the Search Results page. If you
choose to display a large number of results that exceeds the maximum page limit,
the most recently modified Best Bets value results are displayed on the first page.
You can also configure the Best Bets value label and expiry date label, which appear
on the General tab of an item's Properties page.
Managing Best Bets
Once Best Bets values have been applied to Content Server items, you can monitor
the values on the Manage Best Bets Items page. You can modify or remove Best Bets
values, and use a search bar to locate items with values applied to them. When
searching for items that use a phrase as a Best Bets value, place the phrase in double
quotation marks.
To Configure Best Bets Settings

To configure Best Bets settings:
1. On the administration page, in the Best Bets Administration section, click the
Configure Best Bets Settings link.
2. On the Configure Best Bets Settings page, in the Best Bets Options section, to
allow Content Server to monitor the status of this process, select the Enable
check box.
3. Type a number of search results in the Number to Display field. The default is
5.
4. Type the Best Bets value label in the Properties Page Label field.
5. Type the expiry date label in the Expiry Date Label field.
6. In the Best Bets Pattern Matching section, in the Maximum Keywords to

Check field, type the number of search terms to use, or select the No limit check
box. The default is 4.
7. In the Minimum Keyword Length field, type the number of characters a search
term stem modifier must be before being translated to an SQL-like query. The
default is 4.
8. In the Nickname Pattern Matching section, to enable Nickname search, select

the Include Nicknames check box.
9. In the Maximum Keywords to Check field, type the number of search terms to
use, or select the No limit check box. The default is 3.

10. In the Minimum Keyword Length field, type the number of characters a search
term stem modifier must be before being translated to an SQL-like query. The
default is 4.
Tip: You can change the language used in the Properties Page Label and the
Expiry Date Label fields by entering an Xlate value instead of plain text.
To Remove a Best Bets Value

To remove a Best Bets value:
1. On the administration page, in theBest Bets Administration section, click the

Manage Best Bets Items link.
2. On the Manage Best Bet Items page, type a Best Bets value in the Search your
Best Bets items field, and then click the Go button.
3. Select the check box for each item from which you want to remove the Best Bets
value.
4. Click the Remove Best Bets Entries button.
Tip: You can select the check box at the top of the list to remove all best-bet
values.
30.11.22 Searching Deleted Items

You cannot view the Deleted Documents Volume directly. You can purge deleted
documents that list all deleted items. You can also search the list of deleted items by
creating an advanced Query. For more information, see “Restoring and Purging
Deleted Items” on page 372.
Note: If you do not restrict permissions on the saved Query that you create
during this procedure, users will be able to access it.
To Search Deleted Items

To search the list of deleted items:
1. Start the SQL program for your database and log in with the appropriate user
name and password.
2. In a query window, type and execute the following SQL query:select DataID
from DTree where SubType=402. The value returned from this Query is the
node ID of the Deleted Documents Volume.
3. Log in as a Content Server administrator, and then go to the Advanced Search
page in Content Server.
4. Click Complex Query in the Look For drop-down list.

5. Type "<OTLocation>nnnn" in the Full Text search field, where nnnn is the node
ID of the Deleted Documents Volume retrieved in step 2.
6. Click the Save Query button.
7. On the Add: Query page, type Deleted Objects in the Name field.
8. Click the Browse Content Server button to browse to the System folder, and
then click the Select link beside the Slice Folder.
9. On the Add: Query page, click the Add button.
10. Navigate to the Slice folder.
11. Click the Functions icon beside the Deleted Objects slice, and then click
Permissions.
12. On the Permissions page, turn off permissions for all groups and users other
than administrators, and then click the Done button.
30.11.23 Defining Index Regions

The content of indexed documents is stored in regions. Other regions exist to store
location, MIME type, creation date, size, and other information about the indexed
documents. These non-content regions are called metadata. In the case of the
Enterprise index, the metadata regions correspond to the attributes of items in the
Content Server database, including any custom attributes that you assign.
For a particular item type (Document, Folder, Task, and so on), its content and
metadata are indexed. Regions divide the overall set of data (content and/or
metadata) that is indexed into separately searchable and displayable
subcomponents. For example, OTAssignedTo and OTDateCompleted are both
regions in metadata of a standard Enterprise index. Region searches allow users to
limit their searches to parts of the index that they are more interested in. The
Configure Regions page of any index lists all of the metadata regions that have
values in that index.
After you create an index (for example, the Enterprise index, the Help indexes, a
Directory Walker index, or another type of index), you need to select the metadata
regions of the index that you want to make queryable in the System Attributes
section of the Content Server Search page and for display on the Search Results
page. You can also select the metadata regions of the index that you want to make
searchable by default or sortable. For more information about making index
metadata regions queryable, displayable, searchable by default, or sortable see
“Configuring Index Regions” on page 705.
The following table describes the standard set of metadata regions in the Enterprise
index. Regions marked with one asterisk (*) are the default queryable regions; those
marked with two asterisks (**) are the default displayable regions, those marked
with three asterisks (***) are the default regions that are searchable by default, and
the regions with four asterisks (****) are the default sortable regions. The region
names in the first column of the table below are used in the tags that delimit regions

in the index. For example, the <OTAssignedTo> and </OTAssignedTo> tags delimit
the OTAssignedTo region.
Table 30-20: Regions of a Standard Enterprise Index
Region Name in the Index Default Display Name Region Description

Author Author Current user's name
Title Title The display name of the item
OTAssignedTo OTAssignedTo Assignee's login name
OTAssignedToFullName OTAssignedToFullName Assignee's full name
OTAssignedToName * Assigned To Assignee's login name
OTCatalog OTCatalog Content Server object that is a
catalog
OTCDMajor OTCDMajor Major revision number of
compound document
OTCDMinor OTCDMinor Minor revision number of
compound document
OTCreateDate * Creation Date Date when item was created
OTCreatedBy ** Created By Creator's user ID
OTCreatedByFullName OTCreatedByFullName Creator's full name
OTCreatedByName * Created By Creator's name
OTCreateTime OTCreateTime Time when item was created
OTCurrentVersion Version Current version of a
document
OTDataID OTDataID A file's data ID
OTDataSize OTDataSize A file's data size
OTDateAssigned * Assigned Date Date when item was assigned
OTDateCompleted * Completed Date Date when item was
completed
OTDateDue * Due Date Date when item is due
OTDateEffective OTDateEffective Date when item becomes
effective
OTDateExpiration OTDateExpiration Date when item expires
OTDateStarted * Started Date Date when item was started
OTDCategory OTDCategory DataIDs of the categories
assigned to an object


OTDComment*** OTDComment Text provided in the
Description field for an
object, containing a metadata
language code.
OTDocumentRating OTDocumentRating Overall rating of the
document
OTDocumentSynopsis*** OTDocumentSynopsis Synopsis of the document
OTDocumentUserComment* OTDocumentUserComment User comments about the
** document
OTDocumentUserExplanatio OTDocumentUserExplanatio Explanations for user
n*** n comments about the
document
OTFileName*** OTFileName Any Content Server file
name, including its location.
File names can be any
alphanumeric string, but
cannot include spaces
OTFilterMIMEType OTFilterMIMEType File's MIME type as
determined by the
conversion filter
OTHP OTHP Hot phrases in a document
OTHotWords OTHotWords Hot words in a document
OTLLMIMEType OTLLMIMEType File's MIME type as
determined by Content
Server when adding the file
OTLocation ** OTLocation Item's location
OTLocked OTLocked Any locked items currently
in Content Server
OTLockedBy OTLockedBy User ID of the user who
locked specific items
OTLockedByFullName OTLockedByFullName Specific users' full names
OTLockedByName OTLockedByName Specific users' login names
OTLockedDate OTLockedDate Dates when items were
locked
OTLockedTime OTLockedTime Time when items were
locked
OTMIMEType * ** Type File's MIME type
OTModifyDate * ModificationDate Dates when items were
modified
OTModifyTime OTModifyTime Times when items were
modified


OTName * ** *** Name The display name of the item,
containing a metadata
language code
OTObject OTObject Unique identifier for a
Content Server object,
containing the node ID and
version number
OTObjectDate * ** **** Date Date when object was last
modified
OTObjectSize * ** **** Size Size of object as a whole
number
OTObjectTime OTObjectTime Time when file was last
modified. The time is
expressed as whole numbers
in the format hh:mm:ss
OTOwnerID OTOwnerID ID of the volume that owns a
particular item (for example,
a user's Personal Workspace)
OTPDFPage OTPDFPage Content of one page of a PDF
document
OTPDFPageNum OTPDFPageNum Page number of a PDF page
defined by the OTPDFPage
region
OTPriority OTPriority Priority flag
OTProjectStatus OTProjectStatus Status of the project
OTReservedByFullName OTReservedByFullName Specific users' full names
OTReservedByName * Reserved By Specific users' login
names
OTReservedDate * Reserved Date Date when item becomes
reserved
OTRightIDs OTRightIDs Permissions IDs for users
OTRootSubType OTRootSubType Specific type of item at the
top of the parent list
OTStatus OTStatus Status flag
OTSubType * Object Type Specific type of item
OTSubTypeName OTSubTypeName Specific name of an item
OTSummary*** OTSummary Summary of document
OTTimeAssigned OTTimeAssigned Time when item was
assigned to user


OTTimeCompleted OTTimeCompleted Time when item was
completed
OTTimeDue OTTimeDue Time when item is due
OTTimeEffective OTTimeEffective Time when item becomes
effective
OTTimeExpiration OTTimeExpiration Time when item expires
OTTimeStarted OTTimeStarted Time when item starts
OTUserFullName OTUserFullName Current user's full name
OTUserID OTUserID Current owner's ID
OTUserName OTUserName Current owner's name
OTVerCDate OTVerCDate Date when a version was
created
OTVerCTime OTVerCTime Time when a version was
created
OTVerMDate OTVerMDate Date when a version was last
modified
OTVerMTime OTVerMTime Time when a version was last
modified
OTVersion OTVersion Version number of item
OTWFInitiatorFullName OTWFInitiatorFullName Workflow Map initiator's full
name
OTWFInitiatorID OTWFInitiatorID Workflow Map initiator's
user ID
OTWFInitiatorName OTWFInitiatorName Workflow Map initiator's
name
OTWFManagerID OTWFManagerID Workflow Map manager's
user ID
OTWFMapData OTWFMapData Workflow Map's data
OTWFMapDescription*** OTWFMapDescription Description of the Workflow
Map
OTWFMapDueDate OTWFMapDueDate Workflow Map's due date
OTWFMapDueDuration OTWFMapDueDuration Time a Workflow Map
should take to complete
OTWFMapInstructions OTWFMapInstructions Workflow Map's instructions
for user
OTWFMapManagerID OTWFMapManagerID Workflow Manager's user ID
OTWFMapProject OTWFMapProject Workflow Map project
OTWFMapStartDate OTWFMapStartDate Workflow Map start date


OTWFMapSubType OTWFMapSubType Workflow Map subtype
OTWFMapTaskData OTWFMapTaskData Workflow Map task's data
OTWFMapTaskDescription** OTWFMapTaskDescription Description of the Workflow
* Map task
OTWFMapTaskDueDate OTWFMapTaskDueDate Workflow Map task's due
date
OTWFMapTaskDueDuration OTWFMapTaskDueDuration Time a Workflow Map task
should take to complete
OTWFMapTaskInstructions** OTWFMapTaskInstructions Workflow Map task
* instructions
OTWFMapTaskPerformerID OTWFMapTaskPerformerID Workflow Map task
performer's user ID
OTWFMapTaskPriority OTWFMapTaskPriority Workflow Map task priority
(not currently used)
OTWFMapTaskStartDate OTWFMapTaskStartDate Workflow Map task start
date
OTWFMapTaskSubMapID OTWFMapTaskSubMapID Workflow Map task sub-
Workflow Map identifier
OTWFMapTaskSubType OTWFMapTaskSubType Workflow Map task subtype
OTWFMapTaskTitle*** OTWFMapTaskTitle Workflow Map task title
OTWFMapTaskType OTWFMapTaskType Workflow Map task type
OTWFMapTaskUserFlags OTWFMapTaskUserFlags Workflow Map task user
status
OTWFMapTitle*** OTWFMapTitle Workflow Map title
OTWFMapType OTWFMapType Workflow Map type
OTWFMapWorkPackage OTWFMapWorkPackage Workflow Map package
OTWFSubWorkData OTWFSubWorkData Sub-Workflow Map's data
OTWFSubWorkDateComplet OTWFSubWorkDateComplet Date when sub-Workflow
ed ed Map was completed
OTWFSubWorkDateDue OTWFSubWorkDateDue Sub-Workflow Map's due
date
OTWFSubWorkDateIntiated OTWFSubWorkDateIntiated Date when sub-Workflow
Map is initiated
OTWFSubWorkMapID OTWFSubWorkMapID Sub-Workflow Map identifier
OTWFSubWorkTasks OTWFSubWorkTasks Sub-Workflow Map tasks
OTWFSubWorkTitle*** OTWFSubWorkTitle Sub-Workflow Map title
OTWFSubWorkWorkPackag OTWFSubWorkWorkPackag Sub-Workflow Map package
e e


OTWFTaskData OTWFTaskData Workflow task data
OTWFTaskDateDone OTWFTaskDateDone Date when workflow task
was completed
OTWFTaskDateDue OTWFTaskDateDue Workflow task due date
OTWFTaskPerformerID OTWFTaskPerformerID Workflow task performer's
identifier
OTWFTaskTitle*** OTWFTaskTitle Workflow task's title
OTWFTaskWorkPackage OTWFTaskWorkPackage Workflow task package
OTWFWorkDateCompleted OTWFWorkDateCompleted Date when workflow was
completed
OTWFWorkDateDue OTWFWorkDateDue Workflow's due date
OTWFWorkDateIntiated OTWFWorkDateIntiated Date when workflow was
initiated
* = Default queryable regions for a standard Enterprise index** = Default displayable

regions for a standard Enterprise index*** = Search by default regions for a standard
Enterprise index
Workflow Regions
You can manually edit your LLFieldDefinitions.txt file so a specific Workflow

region will be indexed and made searchable, or be excluded. For details, see “To
Configure Optionally Extracted Workflow Regions” on page 735.
In a new Content Server installation, certain Workflow metadata regions are marked
as DROP or REMOVE in the LLFieldDefinitions.txt file, so they will not be indexed
to improve the performance and efficiency of the Search Engine. Your installation
might not be using a new LLFieldDefinitions.txt file to maintain compatibility.
For more information, see the “Updating Search Configuration Files” section of “Re-
The following table describes optionally extracted Workflow regions in the

Enterprise index that you can configure.
Table 30-21: Optionally Extracted Workflow Regions

OTWFInitiatorPerms OTWFInitiatorPerms Workflow Map initiator's
management permissions
OTWFMapArchiveCb OTWFMapArchiveCb Callback data invoked when
Workflow Map is archived
OTWFMapCompleteCb OTWFMapCompleteCb Callback data invoked when
Workflow Map completed


OTWFMapCustomData OTWFMapCustomData Workflow Map's custom
data
OTWFMapDueTime OTWFMapDueTime Workflow Map's due time
OTWFMapExAtts OTWFMapExAtts Data used during Workflow
Map painting
OTWFMapFlags OTWFMapFlags Workflow Map's status
OTWFMapInitiateCb OTWFMapInitiateCb Callback data invoked when
Workflow Map initiated
OTWFMapPainter OTWFMapPainter Data for displaying the
Workflow Map in graphical
format
OTWFMapPriority OTWFMapPriority Workflow Map's priority
(not currently used)
OTWFMapResumeCb OTWFMapResumeCb Callback data invoked when
Workflow Map resumed
OTWFMapSuspendCb OTWFMapSuspendCb Callback data invoked when
Workflow Map suspended
OTWFMapTaskCompleteCb OTWFMapTaskCompleteCb Callback data invoked when
task completed
OTWFMapTaskConditionCb OTWFMapTaskConditionCb Callback data invoked on
task condition
OTWFMapTaskCustomData OTWFMapTaskCustomData Workflow Map task's custom
data
OTWFMapTaskDoneCb OTWFMapTaskDoneCb Callback data invoked when
Workflow Map task
completed
OTWFMapTaskDueTime OTWFMapTaskDueTime Workflow Map task's due
time
OTWFMapTaskExAtts OTWFMapTaskExAtts Data used during Workflow
Map painting
OTWFMapTaskFlags OTWFMapTaskFlags Workflow Map task's status
OTWFMapTaskForm OTWFMapTaskForm Data about what is displayed
at each step
OTWFMapTaskInitiateCb OTWFMapTaskInitiateCb Callback data invoked when
Workflow Map task initiated
OTWFMapTaskKillCb OTWFMapTaskKillCb Callback data invoked when
Workflow Map task killed
OTWFMapTaskPainter OTWFMapTaskPainter Data for displaying the
Workflow Map in graphical
format


OTWFMapTaskPerformerCb OTWFMapTaskPerformerCb Callback data invoked on
Workflow Map task
performer
OTWFMapTaskReadyCb OTWFMapTaskReadyCb Callback data invoked when
Workflow Map task ready
OTWFMapTaskResurrectCb OTWFMapTaskResurrectCb Callback data invoked when
task is resurrected
OTWFMapTasks OTWFMapTasks List of Workflow Map tasks
OTWFMapTaskSubMapIDCb OTWFMapTaskSubMapIDCb Callback data invoked on
sub-Workflow Map task
identifier
OTWFMapTaskUserData OTWFMapTaskUserData Workflow Map task user
data
OTWFMapUserData OTWFMapUserData Workflow Map user data
OTWFMapUserFlags OTWFMapUserFlags Workflow Map user status
OTWFSubWorkCustomData OTWFSubWorkCustomData Sub-Workflow Map's custom
data
OTWFSubWorkFlags OTWFSubWorkFlags Sub-Workflow Map status
OTWFSubWorkProject OTWFSubWorkProject Sub-Workflow Map project
OTWFSubWorkUserData OTWFSubWorkUserData Sub-Workflow Map user
data
OTWFTaskCustomData OTWFTaskCustomData Workflow task custom data
OTWFTaskDateMilestone OTWFTaskDateMilestone Workflow task milestone
OTWFTaskDateReady OTWFTaskDateReady Date when workflow task is
ready
OTWFTaskFlags OTWFTaskFlags Workflow task status
OTWFTaskUserData OTWFTaskUserData Workflow task user data
OTWFWorkCustomData OTWFWorkCustomData Workflow custom data
OTWFWorkFlags OTWFWorkFlags Workflow status
OTWFWorkProject OTWFWorkProject Workflow project
OTWFWorkUserData OTWFWorkUserData Workflow user data

To Configure Optionally Extracted Workflow Regions

To configure an optionally extracted Workflow region:
1. Open the new sample LLFieldDefinitions.txt file in the Content

Server_home\config\reference directory in a text editor, and search for
workflow to see which Workflow regions are being indexed.
2. Search for the Content Server Workflow section to see which Workflow
regions are marked DROP or REMOVE, and are not being indexed.
3. Open your active LLFieldDefinitions.txt file in the Content Server_home
\config directory in a text editor.
4. In the Content Server Workflow section of your active

LLFieldDefinitions.txt file, type # at the start of a region you want to be
indexed, if the line begins with DROP or REMOVE.
The # comments out the Index Engine directive to discard the region.
5. Save and close your active LLFieldDefinitions.txt file in the Content
Server_home\config directory.
6. Reconstruct the index. For information about reconstructing the index, see
“Data Source Maintenance Results” on page 646.
30.11.24 Administering Searching

Managing Search Statistics
When you log in to Content Server as an Administrator, you can manage search
statistics and identify what users are doing with search.
This feature allows you to do the following:

• Configure Search Statistics
• View Statistics Summary
• View Search Terms
• View Slice Usage
• View Template Usage
• Purge Search Statistics
Configuring Search Statistics

The Configure Search Statistics page allows you to choose whether your Content
Server system records search queries anonymously, or if the identity of each user
performing each query is recorded.
Note: Detailed user and search query information is disabled by default due to
potential privacy issues that may exist in some countries.

Viewing Statistics Summary

The View Statistics Summary page allows you to see general search statistics for
users. The statistics include: total searches, number of forms and slices used, search
query sources, and search types.
“Statistics Summary” on page 736 provides a brief description of the View

Statistics Summary page:
Table 30-22: Statistics Summary

Search Summary
Total Searches The total searches completed
Search Forms Used The number of forms used
Slices Searched The number of slices searched
Oldest Search The date and time of the oldest search
Average Search Time The average search time
Query Source
Advanced Search Page The number of Advanced Search page
searches
Search API The number of search API searches
Custom View Search The number of Custom View searches
Saved Query The number of Saved Query searches
Search Bar The number of Search Bar searches
Target Browse The number of Target Browse searches
Enterprise Connect For Enterprise Connect searches:
• Advanced Search – The number of
Advanced Search searches
• Custom View Search – The number of
Custom View Search searches
• Simple Search – The number of Simple
Search searches
Note: These searches are configurable,

and are only available when Enterprise
Connect is installed.
Advanced Option Types
Full Text The number of full text searches
Slices The number of slices used in searches

Location The number of times Location was used in

searches
Viewing Search Terms

Viewing search terms allows you to view the most commonly searched terms, or
search for a particular term. Selecting this link will allow you to choose one of the
following:
• View Most Commonly Searched Terms. This page provides a listing of the most
commonly searched terms including frequency of search, and last searched date
and time.
• View Unproductive Searches. This page provides a listing of the most commonly
searched terms that did not yield any results by Content Server users. A search
that includes multiple slices or locations will display Multiple in the slice
column.
• View Statistics on a Specific Term. This page provides data on a specific term,
including terms searched in the same query; and the number of results returned.
When a text string is wrapped in quotation mark (e.g., “log in”), the search will
yield results that are similar to single term searches.
Viewing Slice Usage

Slice usage allows you to view the number of slices, most used slice, and specific
slice usage.
Viewing Form Usage

Form usage allows you to view the number of forms, most used forms, and specific
form usage.
Purging Search Statistics

Purge search statistics allows you to manually or automatically purge data. Both the
manual and auto purge will log data in the standard Content Server Audit Log for
tracking purposes.
Viewing Relevance Reports
Viewing relevance reports allows you to monitor how successful your users are able
to search for indexed items in Content Server. This feature is available by checking
the Relevance Measurement check box on “To Configure Search Statistics”
on page 738. You can use the data provided by these reports to adjust the relevance
of several parameters for search queries. For details, see “Configuring Relevance
Rules” on page 689.

To Configure Search Statistics
To configure search statistics:
1. On the administration page, click the Manage Search Statistics link.
2. On the Manage Search Statistics page, click the Configure Search Statistics
link.
3. On the Configure Search Statistics page, click a radio button to:
• record search queries anonymously (default)

• record the identity of each user performing each query
Note: Detailed user and search query information is disabled by default

due to potential privacy issues that may exist in some countries.
4. To start collecting Relevance Reports, select the Relevance Measurement check

box. This setting is on by default, which may result in slightly slower search
performance.
To View Statistics Summary
To view statistics summary:
1. On the administration page, click the Manage Search Statistics link.
2. On the Manage Search Statistics page, click the View Statistics Summary link.
To View Search Terms
To view search terms:
• On the Content Server Manage Search Statistics page, click the View Search
Terms link.
To View Most Commonly Searched Terms
To view most commonly searched terms:
1. On the Content Server View Search Terms page, click the View Most
Commonly Searched Terms link.
2. On the View Most Commonly Searched Terms page, select from the drop-
down list Number to Display (default is 10).
3. Enter the number of days required in the Within last field (leaving this field
blank will display all days).
4. Click the Get Results button.

To View Unproductive Searches
To view unproductive searches:
1. On the Content Server View Search Terms page, click the View Unproductive
Searches link.
2. On the View Unproductive Searches page, select from the drop-down list
Number to Display (default is 10).
3. Enter the number of days required in the Within last field (leaving this field
blank will display all days).
To View Statistics on a Specific Term
To view statistics on a specific term:
1. On the Content Server View Search Terms page, click the View Statistics on a
Specific Term link.
2. On the View Statistics on a Specific Term page, enter a specific term in the
Term field.
3. Select from the drop-down list Number of Queries (default is 10).
To View Slice Usage
To view slice usage:
1. On the Content Server Manage Search Statistics page, click the View Slice
Usage link.
2. Select from the drop-down list Number to Display (default is 10).

Results are listed from greatest to least, and in order of number of searches.
To View Search Form Usage
To view search form usage:
1. On the Content Server Manage Search Statistics page, click the View Search
Form Usage link.
2. Select Number to Display from drop-down list (default is 10).

Results are listed from greatest to least, and in order of number of searches.

To Purge Search Statistics
To purge search statistics:
1. On the Content Server Manage Search Statistics page, click the Purge Search
Statistics link.
2. On the Purge Search Statistics page, specify your purge criteria.
3. Click either the OKbutton or the Purge All Statistics button.
To View Relevance Reports
To view relevance reports:
1. On the Content Server Manage Search Statistics page, click the View
Relevance Reports link.
2. On the Relevance Reports page, the default view is comprised of 6 graphs that
display key parameters that measure how successful your users’ searches are
for a period of up to one week. These successful results are displayed as graphs,
with each row containing two charts measuring the following:
• Weekly rate – for the past 3 months

• Daily rate – for the past 2 weeks
The three rows of graphs measure the criteria below:
• Success Percentage –
• Selected Result Position – the average position of first Search Result the
user interacts with, for example, opening an indexed item, or downloading
it, or looking at the Properties page
• Number of User Steps – the average number of steps the user takes before
stopping to search, for example, paging through the Search Results, or using
Search Filters
30.12 Administering Thesauruses

Using thesauruses allows you to search for synonyms of a search term, as well as the
search term itself. Before synonyms can be searched, they must be compiled by
using Content Server advanced search sounds like functionality, or by using a
thesaurus modifier.
Note: The sounds like search modifier is currently supported only for the
English language.
You can specify which thesaurus to use in the opentext.ini file. When specifying
which thesaurus to use, you can choose from one of Content Server standard
thesauruses, a custom-created thesaurus, or a combination of thesauruses. The
standard Content Server thesauruses include English, French, German, and Spanish

30.12. Administering Thesauruses
versions, as well as a multi-lingual thesaurus. The multilingual thesaurus cross-

references terms across English, French, German, and Spanish by meaning.
Therefore, the multilingual thesaurus will return synonyms of terms for each
language, based upon its universal meaning. If you specify a combination of the
language-specific thesauruses, there is no attempt to return search results associated
with the universal meaning of the search term. You create a custom thesaurus by
creating an XML template file, and then building the file, which contains the
thesaurus entries that you want to include.
30.12.1 Specifying a Thesaurus

You can specify which thesauruses you want Content Server to use by changing the
DefaultThesaurus setting in the [SearchOptions] section of the opentext.ini file,
which is usually located in the Content Server_home/config directory. If the
[SearchOptions] section does not exist, you will need to create it. You can specify a
single-language, multi-lingual, or custom thesaurus. You can also combine
thesauruses by listing them, each separated with a comma. When listing multiple
thesauruses, you can stop producing results at a certain point based on returned
results by applying a stop marker ('-'). For example, you place a stop marker before a
custom thesaurus in a list of specified thesauruses, the stop marker sends a signal to
stop producing results if results are returned for either the custom thesaurus or any
of the thesauruses that precede it in the list.
To Specify a Thesaurus
To specify a thesaurus:
To... Set the following Parameter...

Specify a standard-language thesaurus DefaultThesaurus=<thesaurus_langu
age>
Specify the multilingual thesaurus DefaultThesaurus=thesaurus.eur
Specify a custom thesaurus DefaultThesaurus=<custom_thesauru
s_name>
List multiple thesauruses DefaultThesaurus=<thesaurus_name
,thesaurus_language,thesaurus_nam
e>
Apply a stop marker DefaultThesaurus=-
<specified_thesaurus>

30.12.2 Creating a Custom Thesaurus

You can create a custom thesaurus manually in a text editor, or you can write a
script that translates your data to the syntax required by the Thesaurus
Customization utility. The Thesaurus Customization utility is a single executable file
called either buildths.bat (on Microsoft Windows) or buildths.sh (on UNIX).
Before you build a custom thesaurus, you must create an XML template file that
contains your own specialized thesaurus entries. With the Thesaurus Customization
utility, OpenText provides a sample XML template file that you can modify. For
example, you can add synonyms or translations for existing words, or add new
words altogether. The main word in a thesaurus entry is called a head word.
Tag Name What the tag contains Where the tag must be
<OTThesaurus> All the tags in the thesaurus At the beginning of the
template template file
<Headword> Information about a head Within the <OTThesaurus>
word or group of synonyms tag
<Headword_Text> The head word itself Within the <Headword> tag
<Meaning> Information about a Within the <Headword> tag
particular meaning of the
head word. You can have
more than one meaning of a
head word.
<Meaning_Text> Text distinguishing a Within the <Meaning> tag
particular meaning
<PartofSpeech> The head word's part of Within the <Meaning> tag
speech (for example, noun,
verb, adverb, adjective, and
so on)
<Synonym> A synonym for the head Within the <Meaning> tag
word
After creating an XML template file, you transfer the thesaurus file as a parameter to
the Thesaurus Customization utility, which builds the thesaurus file. Content Server
Search Engines use this file to provide synonyms in search results. The thesaurus file
that you generate with this utility is not dynamically updated. If you want to add
entries to your thesaurus, you must generate a new thesaurus file manually.

30.12.3 Building a Custom Thesaurus File

You can build the thesaurus in any location where you have write permissions and
sufficient disk space. The thesaurus file can be quite large, depending upon how
many terms are defined in your template file. For example, if your template file
contains 1,000,000 entries, the resulting thesaurus file could be as large as 100 MB.
Before you can use the thesaurus in the Search Engine, you must copy the file to the
configuration directory, which is usually Content Server_home/config. Once you have
created the XML template file that you want to use, you build your custom
thesaurus using the buildths command.
To... Set the following Parameter...

Specify a standard-language thesaurus DefaultThesaurus=<thesaurus_langu
age>
Specify the multilingual thesaurus DefaultThesaurus=thesaurus.eur
Specify a custom thesaurus DefaultThesaurus=<custom_thesauru
s_name>
List multiple thesauruses DefaultThesaurus=<thesaurus_name
,thesaurus_language,thesaurus_nam
e>
Apply a stop marker DefaultThesaurus=-
<specified_thesaurus>
Syntax
All parameters are required.
buildths -name <thesaurusname> -infile <inputxmlfile>
where <thesaurusname>.ths is the path to the thesaurus file you are creating, and
<inputxmlfile> is the path to the XML template file.
Note: The buildths command is located in your Content Server bin directory,
which is normally Content Server_home/bin. You can invoke the command from
the bin directory or the Content Server_home directory.
30.12.4 Sample XML Template File

Sample XML Template File
The following code is the sample XML template provided by OpenText (included in
Content Server installations as Content Server_home/config/sample_thesaurus.xml).
Note the first <Headword> entry. The word answer is the head word, or main entry,
for the thesaurus definition. Because answer can act as a noun or a verb, the
thesaurus entry for answer contains two distinct meaning definitions, a noun
meaning and a verb meaning, corresponding to these two cases.
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<OTThesaurus>

<Headword>
<Headword_Text>answer</Headword_Text>
<Meaning>
<Meaning_Text>noun meaning</Meaning_Text>
<PartOfSpeech>noun</PartOfSpeech>
<Synonym>response</Synonym>
<Synonym>reply</Synonym>
<Synonym>acknowledgement</Synonym>
<Synonym>riposte</Synonym>
<Synonym>return</Synonym>
<Synonym>retort</Synonym>
<Synonym>repartee</Synonym>
</Meaning>
<Meaning>
<Meaning_Text>verb meaning</Meaning_Text>
<PartOfSpeech>verb</PartOfSpeech>
<Synonym>respond</Synonym>
<Synonym>reply</Synonym>
<Synonym>rebut</Synonym>
<Synonym>retort</Synonym>
<Synonym>rejoin</Synonym>
<Synonym>echo</Synonym>
</Meaning>
</Headword>
<Headword>
<Headword_Text>consent</Headword_Text>
<Meaning>
<Synonym>assent</Synonym>
<Synonym>approval</Synonym>
<Synonym>compliance</Synonym>
<Synonym>agreement</Synonym>
<Synonym>acceptance</Synonym>
</Meaning>
<Meaning>
<Synonym>assent</Synonym>
<Synonym>yield</Synonym>
<Synonym>admit</Synonym>
<Synonym>allow</Synonym>
<Synonym>concede</Synonym>
<Synonym>grant</Synonym>
</Meaning>
</Headword>
<Headword>
<Headword_Text>recommend</Headword_Text>
<Meaning>
<Synonym>commend</Synonym>
<Synonym>acclaim</Synonym>
<Synonym>applaud</Synonym>

<Synonym>compliment</Synonym>
<Synonym>hail</Synonym>
<Synonym>praise</Synonym>
</Meaning>
</Headword>
<Headword>
<Headword_Text>drive</Headword_Text>
<Meaning>
<Synonym>move</Synonym>
<Synonym>actuate</Synonym>
<Synonym>impel</Synonym>
<Synonym>mobilize</Synonym>
<Synonym>propel</Synonym>
</Meaning>
</Headword>
<Headword>
<Headword_Text>tool</Headword_Text>
<Meaning>
<Synonym>implement</Synonym>
<Synonym>instrument</Synonym>
<Synonym>utensil</Synonym>
</Meaning>
</Headword>
<Headword>
<Headword_Text>acerbic</Headword_Text>
<Meaning>
<Meaning_Text>adjective meaning</Meaning_Text>
<PartOfSpeech>adjective</PartOfSpeech>
<Synonym>sour</Synonym>
<Synonym>dry</Synonym>
<Synonym>tart</Synonym>
<Synonym>acetose</Synonym>
<Synonym>acidulous</Synonym>
</Meaning>
<Meaning>
<Meaning_Text>adjective meaning</Meaning_Text>
<PartOfSpeech>adjective</PartOfSpeech>
<Synonym>sarcastic</Synonym>
<Synonym>caustic</Synonym>
<Synonym>corrosive</Synonym>
<Synonym>archilochian</Synonym>
<Synonym>acerb</Synonym>
</Meaning>
</Headword>
</OTThesaurus>

30.13 Configuring Security Settings for Searching and

Indexing
When you configure security settings for Searching and Indexing, you increase the
level of security for your Content Server system.
30.13.1 Controlling IP Access to Search Components

Controlling IP access to Search components provides you with a way to enhance the
security of your Content Server system by restricting access to the components used
by Search. You do this by registering the IP addresses of the computers for which
you want to allow access. Content Server then stores these IP addresses in the
Content Server database and in a policy file (otsearch.policy) in the config
directory of each Content Server server (for example, Content Server_home/config).
Because Content Server overwrites the policy file each time it adds or removes an IP
address from the file, you should not normally modify the file manually.
Warning
When no IP addresses are registered, Content Server allows access to all

computers. However, once IP addresses have been registered, Content Server
only allows access to computers with those IP addresses. Therefore, you must
register the IP addresses of all the computers that host Servers and Admin
servers, otherwise the Search system may not respond.
If you do register incorrect IP addresses and are no longer able to control IP access
through the Content Server interface, you can restore access by replacing the current
policy file with an empty policy file, which will then allow access to Search
components for all IP addresses. An empty policy file is available in the same
directory as the current policy file, under the name otsearch.policy.bak (this file is
generated when you modify the policy file for the first time). However, while the
Search system uses the policy file when controlling IP access, the Content Server
interface displays the values stored in the Content Server database. Therefore, after
replacing the policy file, you should update the values in the Content Server
interface.
To Control IP Access to Search Components

To control IP access to Search components
1. On the administration page, click the Control IP Access to Search Components

link.
2. On the Control IP Access to Search Components page, type an IP address in the

field next to the Add IP Address button, and then click the Add IP Address
button.
Repeat step 2 for each IP address that you want to add.

30.13. Configuring Security Settings for Searching and Indexing
4. Restart the Admin server.
Warning
If you do not add IP addresses for all the computers that host Servers and
Admin servers, the Search system may not respond.
Tip: To revoke network access for a computer, click its IP address in the list
next to the Delete button, click the Delete button, click the OK button, and
then restart the Admin server.
30.13.2 Setting Up Secure Deletion of Temporary Files

When indexing, the Document Conversion Service (DCS) and the iPools in data
flows generate temporary files that may contain text or other content extracted from
the files being indexed. When a temporary file is no longer needed, the data flow
uses normal system calls to delete it. In most cases, this means that the system
removes the file's entry from the file table and leaves the file image on the disk to be
overwritten by a new file. However, some software can recover the deleted file from
the image, which can present a security risk.
When you set up the secure deletion of temporary files, you specify a secure delete
level, which determines how the system overwrites file images left on the disk.
Possible values are integers from 0 to 4, which set varying levels of secure deletion.
The following table describes the differences between these values.
Value Description
0 Perform no secure deletion.
1 Overwrite the file image in one pass with
null bytes. This option is recommended for
non-journaling file systems (for example,
Solaris 9).
2, 3, or 4 Overwrite the file image with a more
complex set of bytes (in non-null bit
patterns), with more than one pass, making
file recovery increasingly difficult. The value
of the level represents the number of passes
made to overwrite the data; the value 4
provides the most security. These options are
recommended for journaling file systems (for
example, Windows and Solaris 10).
Note: Run-length encoding of data on drives requires the use of specific bit
patterns to remove the previous data completely. Using secure delete levels of
2, 3, or 4 will not guarantee that journaling file systems will be secure, but the
probability of recovering file data decreases with each secure delete level.
Since the value of each secure delete level represents the number of passes
made when overwriting temporary files, the performance impact increases
with each secure delete level.

You specify the secure delete level in two or more places. The first is the
Securedelete parameter in the [DCS] section of the opentext.ini file, which
specifies the secure delete level for the DCS. For more information about
Securedelete, see “[DCS]” on page 102.
You specify the secure delete level for iPools in the data flows' ipool.cfg files. There
is one for each data flow directory for each data source (for example, Content
Server_home\index\enterprise\data_flow for the Enterprise data source). You
specify the level by adding the following line before the </InterchangePool> line that
ends the file:
<SecureDeleteLevel>x<SecureDeleteLevel>
where x is the value of the secure delete level.
Note: If the read and write directories for a data source are on different
computers, you must add this setting to the ipool.cfg files on both computers.
OpenText recommends that you specify the same secure delete level for both the
DCS and the iPools. The temporary files for both of these components frequently
contain the same data, so increasing the secure delete level for only one of these
components only marginally enhances security.
30.14 Content Server Error Messages

The following topics list and describe error messages that you might encounter.
30.14.1 Content Server Admin Server Error Messages

The following table describes the Admin server system process errors that can occur
when the Admin server cannot invoke a data flow process.
If these errors persist, contact OpenText Customer Support for additional

information.
Table 30-23: Admin Server System Process Error Messages
Number Message Description Remedy

1000 Invalid system The Admin server Examine the contents of the
parameters could not start the admserv.log file for detailed
specified process because some information about the operation that
of its system the Admin server was performing.
parameters are The admserv.log file is stored in the
invalid. logs directory of your Content Server
installation.

30.14. Content Server Error Messages

1001 Unable to The Admin server Examine the contents of the
allocate memory could not allocate admserv.log file for detailed
enough memory to information about the operation that
start the process. the Admin server was performing.
The admserv.log file is stored in the
logs directory of your Content Server
installation.
30.14.2 Directory Walker Error Messages

The following table describes the error messages that may appear when constructing
Directory Walker data flows.

information.
Table 30-24: Directory Walker Error Messages

1 Content Server An internal error Contact OpenText Customer
core error occurred when Support.
Content Server
attempted to create or
set parameters in the
configuration file for a
Directory Walker
process.
2 Unable to read a Content Server Check the configuration file to ensure
configuration encountered an error that all parameters have valid values.
parameter while reading a Directory Walker configuration files
parameter in the are stored in the Content Server_home/
configuration file for config directory and have the .dw
the Directory Walker file extension. The name of a
process. particular Directory Walker
configuration file is specified in the
command line for the process. You
can view the command line for a
Directory Walker process on the
Specific tab of its Properties page.
3 Unable to set a Content Server Check the values that you specified
configuration encountered an error when creating or updating the
parameter while setting a Directory Walker process. If you are
parameter in the updating a Directory Walker process,
configuration file for you can check the values specified on
the Directory Walker the Specific tab of its Properties
process. page.


4 Unable to Content Server could Check the Admin server that is
connect to the not connect to the associated with the Directory Walker
Admin server Admin server that process and ensure that it is
manages the Directory available. If you are updating an
Walker process. existing Directory Walker process,
you can change the Admin server by
clicking a value in the Admin Server
drop-down list on the Specific tab of
its Properties page.
5 Unable to Content Server could Check your system to ensure that
initialize the not initialize the adequate memory resources are
configuration file configuration file for available.
the Directory Walker
process.
6 Unable to find Content Server could Check the configuration file's name
the configuration not find the to ensure that it matches the
file configuration file for configuration file name that is
the Directory Walker specified in the command line for the
process. Directory Walker process. Ensure
that the configuration file is not
currently in use, and check the file's
permissions to ensure that the
Directory Walker process can read
data from it
Directory Walker configuration files
are stored in the Content Server_home/
config directory and have the .dw file
extension. The name of a particular
Directory Walker configuration file is
specified in the command line for the
process. You can view the command
line for a Directory Walker process
on the Specific tab of its Properties
page.


7 Unable to write Content Server could Check the configuration file's
data to the not write data to the permissions to ensure that the
configuration file configuration file for Directory Walker process can write
the Directory Walker data to it. You can also check your
process. system to ensure that adequate disk
space is available and that the
configuration file is not currently
locked
page.
8 Unable to delete Content Server could Check the configuration file name to
the configuration not delete the ensure that it matches the
the Directory Walker specified in the command line for the
process. Directory Walker process. Ensure
that the configuration file is not
currently in use, and check the file's
permissions to ensure that the
Directory Walker process can write
data to it.
page.
9 Unable to set the Content Server could Ensure that you specified a valid
write directory not set the write directory path in the Write data to
directory for the field when you created the Directory
Directory Walker Walker process. If you are updating
process. The write an existing Directory Walker process,
directory is the you can change the write directory
directory in which the by clicking the Information button
data flow's read and on the Specific tab of the Directory
write iPools are Walker Properties page, and then
created. setting a new value in the Write field.


10 Unable to set the Content Server could Contact OpenText Customer
write area not set the write area Support.
for the Directory
Walker process.
11 Unable to set the Content Server could Ensure that a valid directory path
log file not set the log file for and file name is specified for the log
the Directory Walker file. If you are updating an existing
process. Directory Walker process, you can
specify the absolute path and file
name of the log file in the Log File
field on the Specific tab of the
Directory Walker Properties page.
12 Unable to set the Content Server could Ensure that a valid log level is
log level not set the log level for specified for the Directory Walker
the Directory Walker process. If you are updating an
process. existing Directory Walker process,
you can specify a log level in the Log
Level drop-down list on the Specific
tab of the Directory Walker
Properties page.
14 Unable to set the Content Server could Ensure that you specified the
crawl history not set the crawl absolute path of a valid directory
database location history database when you created or updated the
location for the Directory Walker process. OpenText
Directory Walker recommends that you specify the
process. The crawl same directory that you specify for
history database the write directory of the Directory
location is the Walker process.
directory where you
want the Directory
Walker process to
write its history files.
Disable not set the value of the Support.
parameter in the Disable parameter in
configuration file the configuration file
for the Directory
Walker process. The
Disable parameter
allows Content Server
to temporarily remove
particular directory
groups from the list
that the Directory
Walker scans.


Traversal not set the Support.
parameter in the Traversal parameter
configuration file in the configuration
file for the Directory
Walker process. The
Traversal parameter
works in conjunction
with the value that
you specify in the
Depth drop-down list
when creating the
Directory Walker
process to determine
whether the Directory
Walker scans
directories recursively.
directory depth not set the depth of the value in the Depth drop-down list
directories that the when you created or updated the
Directory Walker Directory Walker process. The
process scans. following list describes the values in
the Depth drop-down list:
• Unlimited, which specifies that
the Directory Walker scans all
subdirectories below the top-level
directories
• Specify, which allows you to
specify a non-negative number
representing the exact number of
subdirectory levels for the
Directory Walker to scan
• none, which specifies that the
Directory Walker process scans
the specified directory only
If you are updating an existing
Directory Walker process, you can
change the depth by clicking a value
in the Depth drop-down list on the
Properties page.


23 Unable to set the Content Server could Ensure that you specified a non-
minimum file not set the minimum negative integer value in the
size required size of the appropriate File Size field when you
files that the Directory created the Directory Walker process.
Walker process scans. The minimum file size must be less
than or equal to the maximum file
size. If you are updating an existing
change the file size by setting new
values in the File Size fields on the
Properties page.
24 Unable to set the Content Server could Ensure that you specified a non-
maximum file not set the maximum negative integer value in the
size size of the files that the appropriate File Size field when you
Directory Walker created the Directory Walker process.
scans. This value must be greater than or
equal to the minimum required size.
If you are updating an existing
change the file size by setting new
values in the File Size fields on the
Properties page.
date of the oldest not set the date of the date in the appropriate Date Range
files that the oldest files that the drop-down lists when you created or
Directory Walker Directory Walker updated the Directory Walker
process scans scans. This is the first process. The date of the oldest files
value in the date range must be less than or equal to the date
that you specified for of the newest files in the range. If you
the directory group. are updating an existing Directory
Walker process, you can change the
date range by setting new values in
the Date Range drop-down lists on
the Specific tab of the Directory
date of the not set the date of the date in the appropriate Date Range
newest files that newest files that the drop-down lists when you created
the Directory Directory Walker the Directory Walker process. The
Walker process process scans. This is date of the newest files must be
scans the second value in the greater than or equal to the date of
date range that you the oldest files in the range. If you
specified for the are updating an existing Directory
directory group. Walker process, you can change the
date range by setting new values in
the Date Range drop-down lists on
the Specific tab of the Directory


28 Unable to set the Content Server could Ensure that you specified the
top-level not specify the top- absolute paths of the top-level
directories level directories that directories in the Directories field
you want the when you created the Directory
Directory Walker Walker process, separating each
process to scan. directory path with a semicolon or
carriage return. If you are updating
an existing Directory Walker process,
you can change the directory paths
by setting new values in the
Directories fields on the Specific tab
of the Directory Walker Properties
page.
29 Unable to specify Content Server could Ensure that you specified a valid list
the types of files not specify the list of of file name patterns that you want
that you want to file types that you the Directory Walker to scan (for
include want the Directory example, *.html; *.txt; *.doc; and so
Walker process to scan on). You specify file name patterns in
when it walks the the Include field when you create the
specified directories. Directory Walker process. If you are
updating an existing Directory
Walker process, you can change the
file name patterns by setting new
values in the Include field on the
Properties page.
30 Unable to specify Content Server could Ensure that you specified a valid list
the types of files not specify the list of of file name patterns that you do not
that you want to file types that you do want the Directory Walker to scan
exclude not want the Directory (for example, *.html; *.txt; *.doc; and
Walker process to scan so on). You specify these file name
when it walks the patterns in the Exclude field when
specified directories. you create the Directory Walker
process. If you are updating an
existing Directory Walker process,
you can change the file name
patterns by setting new values in the
Exclude field on the Specific tab of
the Directory Walker Properties
page.


name of the not associate a valid Support.
crawl history name with the crawl
database location history database
location that you
specified. This name is
the name that you
specify in the
Processes Prefix field
when you create the
Directory Walker
process.
100 Invalid command The Directory Walker Check the command line arguments
line arguments process failed to start that are specified in the Command
specified because some of its Line field on the Specific tab of the
command line Directory Walker Properties page. If
arguments are invalid. you discover errors (for example,
invalid syntax), stop the process and
correct them by editing the
Command Template field. Then run
the Directory Walker process again.
101 Unable to read The Directory Walker Check the configuration file's
the configuration process could not read permissions to ensure that the
file the configuration file Directory Walker process can read
or some of its settings. data from it. You can also check your
system to ensure that adequate disk
space is available and that the
configuration file is not currently
locked. Finally, ensure that the
configuration file is stored in the
location specified in the command
line.
process.
If you suspect that the configuration
file contains invalid parameters,
check the command line arguments
that are specified in the Command
Line field on the Specific tab of the
Directory Walker Properties page. If
you discover errors (for example,
invalid syntax), stop the process and
correct them by editing the
Command Template field. Then run
the Directory Walker process again.


102 Unable to open The Directory Walker Check the log file's permissions to
the log file process could not open ensure that the Directory Walker
the log file in which it process can write data to it. You can
records data. also check your system to ensure that
adequate disk space is available and
that the log file is not currently
locked. Finally, ensure that the log
file is stored in the location specified
in the Log File field on the Specific
Properties page. By default,
Directory Walker log files are stored
in the Content Server_home/logs
directory.
103 Unable to read The Directory Walker Ensure that the log level specified on
the log level process could not read the Specific tab of the Directory
the log level specified Walker Properties page matches the
in the configuration log level specified in the
file. configuration file. Valid values
include:
• Default, which reports errors
only
• Verbose, which reports the status
of messages flowing through the
processes and iPools of the data
flow as well as errors
• Debug, which reports highly
detailed information about data
flow status and errors
line arguments on the Specific tab of
page.


104 Insufficient The Directory Walker Check the Specific tab of the
Directory Walker process failed to start Directory Walker Properties page to
information because you have not ensure that you have specified a
specified a write write directory for the Directory
directory or a Walker process and that you have
directory to scan. specified the directories that you
want the Directory Walker process to
scan. Verify that the values specified
on the Specific tab of the Directory
Walker Properties page match the
values specified in the configuration
file.
page.
105 Unable to set up The Directory Walker Ensure that a valid port number is
the stop message process could not set specified in the command line on the
port up the stop message Specific tab of the Directory Walker
port. The stop message Properties page. The port number
port is a port on which that you specify must not be used by
Content Server sends a any other process and must be
shut down message to between 1025 and 65535. You can
stop the Directory change the port number by typing a
Walker process. new value in the Stop Message Port
field on the Specific tab of the
Directory Walker Properties page.


106 Unable to read The Directory Walker Ensure that a valid directory path is
the write process could not read specified in the Write field, which
directory the write directory in you access by clicking the
the configuration file. Information button on the Specific
The write directory is tab of the Directory Walker
the directory in which Properties page. Then ensure that the
the data flow's read same directory path is specified in
and write iPools are the configuration file (iPool
created. identifier).
configdirectory and have the .dw file
page.
107 Unable to make The Directory Walker Ensure that a valid directory path is
an iPool process could not specified in the Write field, which
connection connect to an iPool. you access by clicking the
Information button on the Specific
Properties page. Then ensure that the
same directory path is specified in
the configuration file.
page.
108 An internal iPool The Directory Walker Contact OpenText Customer
error has process encountered Support.
occurred an error when trying
to start an iPool
transaction.
109 Unable to read The Directory Walker Contact OpenText Customer
the write area process could not read Support.
the write area from the
configuration file.


the crawl history process could not read Support.
database location the crawl history
database location from
the configuration file.
The crawl history
database location is
the directory where
the Directory Walker
process writes its
history files.
116 Unable to rename Content Server could Check the permissions of the crawl
the crawl history not rename the crawl history database files to ensure that
database files history database files. the Directory Walker process can
In normal rename them. You can also check
circumstances, there your system to ensure that adequate
are three crawl history disk space is available and that the
database files, named crawl history database files are not
name.new name.old, currently locked. Finally, ensure that
and name.junk. When a the crawl history database files are
new crawl history stored in the directory specified in
database file is the Crawl History Database
generated, the Location field on the Specific tab of
Directory Walker the Directory Walker Properties
process renames the page. By default, crawl history
name.new file to database files are stored in the write
name.old. At the same directory for the process.
time, the Directory
Walker process
renames the name.old
file to name.junk.


117 Unable to create The Directory Walker Ensure that the directory where the
a new crawl process could not crawl history database files reside
history database create a new crawl exists, and then check the directory's
file history database file permissions to ensure that the
(name.new). In normal Directory Walker process can write
circumstances, there data to it. You can also check your
are three crawl history system to ensure that adequate disk
database files, named space is available and that the
name.new name.old, directory is not currently locked.
and name.junk. When a
new crawl history
database file is
generated, the
Directory Walker
process renames the
name.new file to
name.old. At the same
time, the Directory
Walker process
renames the name.old
file to name.junk.
118 Unable to read a The Directory Walker Check the values that are specified
directory group process failed to read for each directory group on the
the scanning Specific tab of the Directory Walker
information that is Properties page. Ensure that valid
associated with a information is provided in all of the
directory group. appropriate fields, and that the
information matches the information
in the configuration file. Then run the
Directory Walker process again.
page.
119 An internal iPool The Directory Walker Contact OpenText Customer
occurred an internal error of an
unspecified nature.


the name of the process could not read Support.
crawl history the name associated
database location with the crawl history
database location. This
name is the name that
you specified in the
Processes Prefix field
when you created the
Directory Walker
process.
30.14.3 XML Activators Error Messages

The following table describes the error messages for XML Activator processes:

information.
Table 30-25: Error Messages for XML Activators

1 Content Server An internal error Contact OpenText Customer
core error occurred when Support.
Content Server
attempted to create or
set parameters in the
configuration file for
an XML Activator
process.
2 Unable to read Content Server Check the configuration file to ensure
configuration encountered an error that all parameters have valid values.
parameter while reading a XML Activator configuration files are
parameter in the stored in the Content
configuration file for Server_home/config directory and
the XML Activator have the .xml file extension. The
process. name of a particular XML Activator
process on the Specific tab of its
Properties page.


3 Unable to set Content Server Check the values that you specified
configuration encountered an error when creating or updating the XML
parameter while setting a Activator process. If you are
parameter in the updating an XML Activator process,
configuration file for you can check the values specified on
the XML Activator the Specific tab of its Properties
process. page.
4 Unable to Content Server could Check the Admin server associated
connect to not connect to the with the XML Activator process and
Admin server Admin server that ensure that it is available. If you are
manages the XML updating an existing XML Activator
Activator process. process, you can change the Admin
server by clicking a value in the
Admin Server drop-down list on the
Specific tab of the XML Activator
Properties page.
5 Unable to Content Server could Check your system to ensure that
initialize the not initialize the adequate memory resources are
configuration file configuration file for available.
the XML Activator
process.
6 Unable to find Content Server could Check the configuration file's name
the configuration not find the to ensure that it matches the
the XML Activator specified in the command line for the
process. XML Activator process. Ensure that
the configuration file is not currently
in use, and check the file's
permissions to ensure that the XML
Activator process can read data from
it.
XML Activator configuration files are
stored in the Content
Server_home/config directory and
have the .xml file extension. The
name of a particular XML Activator
Properties page.


7 Unable to write Content Server could Check the configuration file's
data to the not write data to the permissions to ensure that the XML
configuration file configuration file for Activator process can write data to it.
the XML Activator You can also check your system to
process. ensure that adequate disk space is
available and that the configuration
file is not currently locked.
Properties page.
8 Unable to delete Content Server could Check the configuration file name to
the configuration not delete the ensure that it matches the
the XML Activator specified in the command line for the
process. XML Activator process. Ensure that
the configuration file is not currently
in use, and check the file's
permissions to ensure that the XML
Activator process can write data to it.
have the .xml file extension. You can
view the command line for a process
page.
11 Unable to record Content Server could Ensure that a valid directory path
the log file not record the log file and file name is specified for the log
for the XML Activator file. If you are updating an existing
process. XML Activator process, you can
specify the absolute path of the log
file on the Specific tab of its
Properties page.
12 Unable to set the Content Server could Ensure that a valid log level is
log level not set the log level for specified for the XML Activator
the XML Activator process. If you are updating an
process. existing XML Activator process, you
can specify a log level on the Specific
tab of its Properties page.


13 Unable to set the Content Server could Ensure that a valid port number
administration not set the (from 1024 to 65534) is specified for
port administration port the XML Activator process. If you are
for the XML Activator updating an existing XML Activator
process. process, you can specify an
administration port in the Stop
Message Port field on the Specific
tab of its Properties page.
read directory not set the read directory path in the Read data from
directory for the XML field when you created the XML
Activator process. The Activator process. If you are
read directory is the updating an existing XML Activator
directory in which the process, you can change the read
process' read iPool is directory by setting a new value in
created. the Read field, which you access by
clicking the Information button on
the Specific tab of its Properties
page. Also, check the permissions on
the directory to make sure that the
XML Activator process can write
data to it.
31 Unable to set Content Server could The read area is a directory within
read area not set the read area the read iPool directory. On the
for the XML Activator Specific tab of the XML Activator
process. Properties page, the read area
appears following the Read field,
which you access by clicking the
tab of the XML Activator Properties
page. The Read field gives the
location of the source iPool directory.
The name of the read area will be a
number (for example, /2645_0).
Check the permissions on this
directory to make sure that the XML


write directory not set the write directory path in the Write data from
directory for the XML field when you created the XML
Activator process. The Activator process. If you are
write directory is the updating an existing XML Activator
directory in which the process, you can change the write
process' write iPool is directory by setting a new value in
created. the Write field, which you access by
clicking the Information button on
the Specific tab of the XML Activator
Properties page. Also, check the
permissions on the directory to make
sure that the XML Activator process
can write data to it.
33 Unable to set Content Server could The write area is a directory within
write area not set the write area the destination iPool directory. On
for the XML Activator the Specific tab of the XML Activator
process. Properties page, the write area
appears following the Write field,
which you access by clicking the
page. The Write field gives the
location of the destination iPool
directory. The name of the write area
will be a number (for example, /
2645_0). Check the permissions on
this directory to make sure that the
XML Activator process can write
data to it.
34 Unable to set Content Server could Ensure that you specified a valid
outgoing not set the outgoing directory path in the Outgoing
directory directory for the XML Directory field when you created the
Activator process. XML Activator process. If you are
updating an existing XML Activator
process, you can change the outgoing
directory by setting a new value in
the Outgoing Directory field on the
Properties page. Also, check the
permissions on the directory to make
sure that the XML Activator process
can write data to it.


35 Unable to set Content Server could Ensure that you specified a valid
incoming not set the incoming directory path in the Incoming
directory directory for the XML Directory field when you created the
Activator process. XML Activator process. If you are
process, you can change the
incoming directory by setting a new
value in the Incoming Directory field
on the Specific tab of the XML
Activator Properties page. Also,
check the permissions on the
directory to make sure that the XML
identifier tag not set the identifier identifier tag value in the Identifier
tag for the XML Tag field when you created the XML
Activator process. Activator process. If you are
process, you can change the identifier
tag by setting a new value in the
Identifier Tag field on the Specific
page.


metadata list not set the metadata metadata list value in the Metadata
list for the XML List field when you created the XML
process, you can change the metadata
list by setting a new value in the
Metadata List field on the Specific
page.
The metadata list must include the
XML tag name followed by the
metadata tag name, which is the
name of an existing region in Content
Server. The tag names for each
mapping must be separated by a
comma and a space, and each
mapping must be separated by a
semi-colon. For example:
xName,
OTName;xOwnerIDNumber,
OTOwnerID;xFileLocation,
OTLocation
Any spaces you include in the tag
names will be ignored by Content
Server. If more than one instance of a
tag occurs in your XML files, or if
two or more tags in an XML file are
mapped to the same metadata tag,
Content Server will index the content
of the tags to several instances of the
same region. In this case, users will
not be able to search that region for
this index; however, if Content
Server users search the index as a
whole, they can access this data.
operation tag not set the operation operation tag value in the Operation
tag for the XML Tag field when you created the XML
process, you can change the
operation tag by setting a new value
in the Operation Tag field on
Properties page.


content tag not set the content tag content tag value in the Content Tag
for the XML Activator field when you created the XML
process. Activator process. If you are
process, you can change the content
tag by setting a new value in the
Content Tag field on the Specific tab
of the XML Activator Properties
page.
40 Unable to set the Content Server could Ensure that you specified a valid tag
tag attribute not set the tag attribute value in the Tag Attribute
attribute for the XML field when you created the XML
process, you can change the tag
attribute by setting a new value in
the Tag Attribute field on the
Properties page.
41 Unable to set the Content Server could Ensure that you specified a valid tag
tag attribute not set the tag attribute value in the Tag Attribute
value attribute value for the Value field in the Binary Encoding
XML Activator section when you created the XML
process. Activator process. If you are
process, you can change the tag
attribute value by setting a new value
in the Tag Attribute Value field on
the Specific tab of the XML Activator
Properties page.
encoding type not set the encoding encoding type value in the Encoding
type for the XML drop-down list in the Binary
Activator process. Encoding section when you created
the XML Activator process. If you are
process, you can change the encoding
type by choosing a new value in the
Encoding drop-down list on the
Properties page.
43 An internal The XML Activator Contact OpenText Customer
configuration process encountered Support.
error has an error when
occurred configuring the
process.


process.
process.
process.
process.
process.
50 Invalid The XML Activator Contact OpenText Customer
arguments found process could not read Support.
in command line the configuration file
or the initialization file
specified by the
command line.
51 Unable to read The XML Activator Check the configuration file to make
configuration file process could not read sure that the file exists and is not
from the configuration open, and make sure that the syntax
file. is correct. Also, check the
permissions on the file to make sure
that the XML Activator process can
read it.
Properties page.


52 Unable to read The XML Activator Check the initialization file to make
initialization file process could not read sure that the file exists, is not open,
the initialization file. and make sure that the syntax is
correct. Also, check the permissions
on the file to make sure that the XML
Activator process can read it.
53 Unable to set up The XML Activator On the Specific tab of the XML
log file process could not set Activator Properties page, verify that
up the log file. the value for the Log File field is
valid. Also, make sure that the hard
drive is not full, and check the
permissions on the log file directory
to make sure that the XML Activator
process can write to it.
54 Unable to process The XML Activator Look in the XML Activator log file
ReadiPool process could not for more information, including what
process the data from error was encountered while
the data interchange processing the iPool data.
directory specified by The location of the log file is specified
the ReadiPool on the Specific tab of the XML
parameter in the Activator Properties page.
configuration file.
If you place an XML Activator
Producer process directly before the
HTML Conversion process in a data
flow, null values in content data are
not encoded, and this error is
generated.
55 Unable to process The XML Activator Look in the XML Activator log file
Incoming process could not for more information, including what
directory process the data from error was encountered while
the Incoming directory processing the XML data from the
specified by the Incoming directory.
InputDirectory
parameter in the The location of the log file is specified
configuration file. on the Specific tab of the XML
Activator Properties page.
100 Error validating The XML Activator Look in the XML Activator log file
parameters process encountered for more information, including
an error while which parameter in the configuration
validating the file caused the error.
parameters in the The location of the log file is specified


101 Invalid The XML Activator Look in the XML Activator log file
ReadiPool process encountered for more information. Also, check the
an error while configuration file to make sure that
validating the the ReadiPool parameter is
ReadiPool included and its value is valid.
process on Specific tab of its
Properties page.
102 Invalid ReadArea The XML Activator Look in the XML Activator log file
process encountered for more information. Also, check the
validating the the ReadArea parameter is included
ReadArea parameter and its value is valid.
in the configuration The location of the log file is specified
file. on the Specific tab of the XML
Properties page.


WriteiPool process encountered for more information. Also, check the
validating the the WriteiPool parameter is
WriteiPool included and its value is valid.
Properties page.
WriteArea process encountered for more information. Also, check the
validating the the WriteArea parameter is
WriteArea included and its value is valid.
Properties page.
105 WriteiPool and The XML Activator Open the configuration file and add
Outgoing process could not run the WriteiPool and
directory not because neither the StorageDirectory parameters,
specified WriteiPool nor the ensuring their values are valid.
StorageDirectory XML Activator configuration files are
parameter has been stored in the Content
specified in the Server_home/config directory and
configuration file. The have the .xml file extension. The
StorageDirectory name of a particular XML Activator
parameter configuration file is specified in the
corresponds to the command line for the process. You
Outgoing directory in can view the command line for a
the interface. process on the Specific tab of its
Properties page.


106 Invalid Outgoing The XML Activator Look in the XML Activator log file
directory process encountered for more information. Also, check the
validating the the StorageDirectory parameter
StorageDirectory is included and its value is valid.
configuration file. The on the Specific tab of the XML
StorageDirectory Activator Properties page.
parameter XML Activator configuration files are
corresponds to the stored in the Content
Outgoing directory in Server_home/config directory and
the interface. have the .xml file extension. The
Properties page.
107 Unable to find The XML Activator Check the Outgoing directory in your
Outgoing process could not find file system to make sure that it exists
directory the Outgoing and that its permissions allow
directory specified by Content Server to read and write data
the to it. Also, check the configuration
StorageDirectory file to make sure that the value of the
parameter in the StorageDirectory parameter is
configuration file. valid.
Properties page.


108 Invalid Incoming The XML Activator Look in the XML Activator log file
directory process encountered for more information. Also, check the
validating the the InputDirectory parameter is
InputDirectory included and its value is valid.
configuration file. The on the Specific tab of the XML
InputDirectory Activator Properties page.
parameter XML Activator configuration files are
corresponds to the stored in the Content
Incoming directory in Server_home/config directory and
the interface. have the .xml file extension. The
Properties page.
109 WriteiPool and The XML Activator Check the configuration file and
Incoming process could not run ensure that the WriteiPool and
directory not because neither the InputDirectory parameters are
specified WriteiPool nor the included and their values are valid.
InputDirectory XML Activator configuration files are
parameters have been stored in the Content
specified in the Server_home/config directory and
configuration file. The have the .xml file extension. The
InputDirectory name of a particular XML Activator
parameter configuration file is specified in the
corresponds to the command line for the process. You
Incoming directory in can view the command line for a
the interface. process on the Specific tab of its
Properties page.
111 Invalid The XML Activator Check the configuration file and
MaximumiPoolC process could not run ensure that the
apacity because MaximumiPoolCapacity
MaximumiPoolCapa parameter is set to a valid number
city has been set to (greater than zero).
an invalid value (zero XML Activator configuration files are
or a negative number) stored in the Content
in the configuration Server_home/config directory and
file. have the .xml file extension. The
Properties page.


113 Invalid LogLevel The XML Activator Check the configuration file and
process could not run ensure that the LogLevel parameter
because LogLevel is set to 1 (default), 2 (verbose), or 3
has been set to an (debug).
invalid value in the XML Activator configuration files are
configuration file. stored in the Content
Properties page.
115 Unable to set up The XML Activator For the number of the port that
the process could not set caused the error, look at the Stop
administration up the administration Message Port field on the Specific
port port. tab of the XML Activator Properties
page. Change the port number to a
number that is valid (from 1024 to
65534) and is not being used by
another process.
119 ReadiPool or TheiPool input Open the configuration file and
Incoming directory is not verify that the readIpool and
Directory not specified or the read StorageDirectory parameters are
specified iPool directory is not included and their values are valid.
specified. Add the missing parameter.
The location of the log file is specified
Properties page.


120 Outgoing The storage directory Open the configuration file, add the
Directory not is not specified. StorageDirectory parameter, and
specified ensure its parameter is valid.
Properties page.
121 WriteiPool not The write iPool Open the configuration file, add the
specified directory is not WriteiPool parameter and ensure
specified. its value is valid.
Properties page.
122 Outgoing The read iPool Open the configuration file, add the
Directory not directory is specified, StorageDirectory parameter, and
specified but there is no storage ensure its value and the readiPool
directory. value are valid.
StorageDirectoryXML Activator
configuration files are stored in the
Content Server_home/config
directory and have the .xml file
XML Activator configuration file is
line for a process on the Specific tab
of its Properties page.


123 ReadiPool not The storage directory Open the configuration file, add the
specified is specified but the parameter, and ensure its value and
read iPool directory the readiPool value are valid.
isn’t specified. XML Activator configuration files are
Properties page.
30.14.4 Document Conversion Process Error Messages

The following table describes the error messages for the Document Conversion
process.

information.
Table 30-26: Error Messages for the Document Conversion Process

10 An internal error The Document Contact OpenText Customer
has occurred Conversion process Support.
has performed an
illegal operation (for
example, it addressed
memory that does not
exist or made illegal
system calls).
11 Unable to The Document Turn on logging by setting the
recognize the Conversion filter following parameter in the
MIME type failed to recognize the [FilterEngine] section of the
MIME type of the file. opentext.ini file:
logfile= <x>where <x> is the
absolute path and file name of the log
file. Look in the log file for more
information, and then contact
12 Unable to find an The Document Contact OpenText Customer
input file Conversion process Support.
expected to read an
input file from the
iPool but none exists.


20 Unable to locate The Document Free some system resources (memory
sufficient system Conversion process and disk space) and then try to run
resources failed because it the process again.
cannot find enough
system resources to
run.
21 Invalid The Document Examine the parameters that are
parameters Conversion process currently specified in the
detected in the failed to start because [FilterEngine] section of the
[FilterEngine the parameters opentext.ini file. Then try to run the
] section of the specified in the Document Conversion process again.
opentext.ini file [FilterEngine] The opentext.ini file is located in the
section of the config directory of your Content
opentext.ini file are Server installation. OpenText
invalid. recommends that you do not modify
the opentext.ini file unless instructed
to do so by OpenText Customer
Support.
22 Invalid command The Document Examine the command line
line arguments Conversion process arguments that are currently
specified failed to start because specified in the otadmin.cfg file,
some of the command and then try to run the Document
line arguments Conversion process again. The
specified in the otadmin.cfg file is located in the
otadmin.cfg file are config directory of your Content
invalid. Server installation. OpenText
recommends that you do not modify
the otadmin.cfg file unless
instructed to do so by OpenText
Customer Support.
23 Invalid input file The Document Try to run the Document Conversion
name specified Conversion process process again. If the problem persists,
attempted to read a consult OpenText Customer Support.
particular file from the
iPool but the file does
not exist.
24 Invalid Sleep The value of the Ensure that the value of the Sleep
parameter Sleep parameter in parameter is a positive integer, and
specified in the the [FilterEngine] then try to run the Document
[FilterEngine section of the Conversion process again.
] section of the opentext.ini file is
opentext.ini file invalid.


30 An internal iPool The Document Turn on Document Conversion
error has Conversion process process logging by setting the
occurred encountered an iPool following parameter in the
error when setting up [FilterEngine] section of the
the iPools. opentext.ini file:
logfile= <x>where <x> is the
absolute path and file name of the log
file. Then stop the data flow and turn
on iPool logging by modifying the
following value in the ipool.cfg file:
<LogLevel>3</LogLevel>
The ipool.cfg file and the iPool log
file itself (iplog.fle) are stored in the
data flow directory. The opentext.ini
file is stored in the config directory of
After logging the activity of the
Document Conversion process,
contact OpenText Customer Support.
error when starting an [FilterEngine] section of the
iPool transaction. opentext.ini file:
logfile= <x>
where <x> is the absolute path and
file name of the log file. Then stop the
data flow and turn on iPool logging
by modifying the following value in
the ipool.cfg file:


32 An internal iPool The Document Ensure that the iPool directory is not
error has Conversion process currently in use. Then turn on
occurred encountered an iPool Document Conversion process
error when ending an logging by setting the following
iPool transaction. parameter in the [FilterEngine]
section of the opentext.ini file:
logfile= <x>
the ipool.cfg file:
<LogLevel>3</LogLevel>.
error when stopping [FilterEngine] section of the
an iPool transaction. opentext.ini file:
logfile= <x>.
the ipool.cfg file:


34 An internal iPool The Document Ensure that the iPool directories are
error has Conversion process not currently in use. Then turn on
occurred encountered an iPool Document Conversion process
error when shutting logging by setting the following
down the iPool parameter in the [FilterEngine]
transport. section of the opentext.ini file:
logfile= <x>
the ipool.cfg file:
35 Unable to process The Document Turn on Document Conversion
an iPool message Conversion process process logging by setting the
could not process a following parameter in the
message when it tried [FilterEngine] section of the
to retrieve the opentext.ini file:
message from an logfile= <x>
iPool. where <x> is the absolute path and
the ipool.cfg file:

30.14.5 Document Conversion Service Error Messages

The following table describes the error messages for the Document Conversion
Service (DCS).

information.
Table 30-27: Error Messages for the Document Conversion Service

100 Unable to read The DCS could not Ensure that the opentext.ini file exists
configuration read the opentext.ini and that the DCS has sufficient access
file supplied on the to read the file.
command line.
101 Unable to write The DCS could not Ensure that the path specified in the
to log file write to the specified Log File field on the Document
logfile parameter. Conversion Service tab on the Admin
Server Properties page is valid.
Check that the DCS has sufficient
access to write to the file.
104 Unable to bind to The DCS could not Ensure that the Admin port number
admin port bind to the specified specified in the Log File field on the
Admin port. Document Conversion Service tab on
the Admin Server Properties page is
a free socket port. To do this, click the
Check port link. If the Admin port is
not available, change the port
number to a number that you know
is free.
105 Admin port not The Admin port is a Check that the Admin port is
specified required setting that specified on the command line
was not specified. argument. For more information
about setting command line
arguments, see “Command Line
Arguments” on page 585.
107 Missing DCS The DCS rulesfile Verify that the Rules File field on the
rules file parameter is a Document Conversion Service tab on
required parameter the Admin Server Properties page
that was not specified. contains the following path:
rulesfile=Content
Server_home/
config/dcsrest.txt.


108 The DCS rules The specified Verify that the Rules File field on the
file could not be rulesfile Document Conversion Service tab on
opened parameter does not the Admin Server Properties page
exist or could not be contains the following path:
read by the DCS. rulesfile=Content
Server_home/
config/dcsrest.txt.
access to read the file.
109 DCS rules file The DCS rulesfile Return the rules file to the version
syntax error parameter has been that was shipped with your current
modified and contains Content Server install.
invalid syntax.
110 DCS rules file is The DCS rulesfile Verify that the Rules File field on the
invalid parameter has been Document Conversion Service tab on
modified and contains the Admin Server Properties page
illegal operations. contains the following path:
rulesfile=Content
Server_home/
config/dcsrest.txt.
access to read the file.
111 Failed to load One of the runtime The DCS log file should identify the
DCS library loaded libraries name of the library that could not be
required by the DCS loaded. For example, “ERROR: Failed
could not be found. to load the library dcssum.dll”.
Ensure that the Content Server_home/
lib and Content Server_home/filters
directories are included in the system
library path environment variables.
On Windows, Content Server_home/
bin should be included in the PATH
variable. On Solaris, Content
Server_home/lib should be included in
the LD_LIBRARY_PATH variable.
For more assistance, contact
112 DCS library is One of the DCS The DCS log file should identify the
missing lib libraries is missing the name of the library that could not be
parameter lib parameter in its loaded. For example, “ERROR: Failed
INI section. to load the library dcssum.dll”.
Verify that the corresponding
conversion filter page of the
opentext.ini file specifies the
name of the required library in the
lib parameter.
Consult the corresponding section of
the “Understanding the opentext.ini
File“ on page 91.


113 DCS library is One of the DCS To identify which library is causing
invalid libraries does not the problem, change the DCS log
conform to the DCS level to the maximum value output
library interface. by configuring the following
parameter in the [DCS] section of the
opentext.ini file:
logLevel=4
After logging the activity of the DCS,
114 DCS library One of the DCS Ensure that the Content Server_home/
could not be libraries encountered config directory and the Content
initialized an error at Server_home/filters directories are
initialization time. included in the system library path
environment variables. On Windows,
Content Server_home/bin should be
included in the PATH variable. On
Solaris, Content Server_home/lib
should be included in the
LD_LIBRARY_PATH variable.
If the problem persists, change the
DCS log level to the maximum value
output by changing the following
opentext.ini file:
logLevel=4
117 DCS library One of the DCS Ensure that the Content Server_home/
could not be libraries encountered config and Content Server_home/filters
initialized an error at directories are included in the system
initialization time. library path environment variables.
On Windows, Content Server_home/
bin should be included in the PATH
opentext.ini file:
logLevel=4


118 Failed to load The DCS iPool library Ensure that the Content Server_home/
DCS request (dcsipool.dll on config and Content Server_home/filters
handler Windows) could not directories are included in the system
be loaded. library path environment variables.
On Windows,Content Server_home/bin
should be included in the PATH
opentext.ini file:
logLevel=4
30.14.6 Update Distributors Error Messages

The following table describes error messages for the Update Distributor process.

information.
Table 30-28: Error Messages for Update Distributors

129 Unable to load The Update Ensure that the jniipool.dll or
JNI library Distributor process libjniipool.so file exists in the bin
cannot load the directory and is readable and
dynamically linked executable. The file should be part of
file jniipool.dll (on your Content Server distribution.
Windows) or If the file does not exist or is empty,
libjniipool.so (on contact OpenText Customer Support.
Solaris).
131 Insufficient The Update Increase the amount of memory
memory space Distributor process allocated to the Update Distributor
available ran out of memory. process.
132 An unknown The Update Contact OpenText Customer
error has Distributor process Support.
occurred encountered an
unknown error.
149 Invalid command There is an error in the Ensure that the command lines in
line for the Update Distributor otadmin.cfg are valid. and
Update process' command line specified in the proper format
Distributor parameters. Content Server generates
otadmin.cfg using its database.


150 URL is invalid The URL used to Ensure that the search.ini file
register and contact parameters are valid and specified in
the Update Distributor the proper format.
process is invalid as
specified in the
search.ini file.
152 Invalid partition The Update Ensure that the partition
specification Distributor process specifications in the search.ini file
specified received an invalid are valid and specified in the proper
partition specification. format.
153 Unable to The Update Ensure that the search.ini file
initialize Distributor process parameters are valid and specified in
failed to start because the proper format.
one or more of the
parameters in the
search.ini file are
invalid.
170 Insufficient The Index Engine Increase the amount of memory
memory space process ran out of allocated to the Index Engine process.
available memory.
171 Unable to contact The Update Restart the Update Distributor and
Index Engine Distributor process is Index Engines.
unable to contact one
or more Index
Engines.
172 Insufficient disk The Index Engine Increase the amount of disk space
space for the process ran out of disk available to the Index Engine and
Index Engine space. Update Distributor.
173 All partitions full All specified partitions Add a new partition to the grid. For
are full. The Update more information about adding
Distributor process is partitions, see “To Add a Partition”
unable to process on page 437.
update or addition
requests.
174 An iPool error The Update Contact OpenText Customer
has occurred Distributor process Support.
encountered an iPool
error.

Note: The search.ini file is the configuration file for Content Server
searching and indexing processes. This file contains settings that are usually set
by default when indexing and searching processes and other system objects,
such as data sources and partitions, are created; conversely, settings are also
deleted when the processes they configure are deleted. You configure these
settings when you configure searching and indexing processes and other
system objects in Content Server. OpenText strongly recommends that you do
not modify the settings in the search.ini file. If you do choose to modify the
settings, contact OpenText Customer Support.
30.14.7 Index Engines Error Messages

The following table describes error messages for the Index Engine process.

information.
Table 30-29: Error Messages for Index Engines

132 An unknown The Index Engine Contact OpenText Customer
occurred an unknown error.
line for the Index Index Engine process' otadmin.cfg are valid. and
Engine command line specified in the proper format
parameters. Content Server generates
the Index Engine is the proper format.
invalid as specified in
the search.ini file.
153 Unable to The Index Engine Ensure that the search.ini file
initialize process failed to start parameters are valid and specified in
because one or more the proper format.
parameters in the
search.ini file are
invalid.
171 Failed to add The Index Engine Contact OpenText Customer
new partition process failed to add a Support.
new partition.
174 Failed to create The Index Engine Contact OpenText Customer
empty index process failed to create Support.
a new, empty index.


175 Failed to read The Index Engine Contact OpenText Customer
existing index process failed to read Support.
an existing index.
176 Failed to restore The Index Engine Contact OpenText Customer
index process failed to Support.
restore an index.
180 Failed to start An Index Engine If there is no Index Engine running,
Index Engine process may already Contact OpenText Customer
be running. Support.
181 Failed to start You cannot start an Wait for the index restore to
Index Engine Index Engine while an complete.
index is being
restored.
30.14.8 Search Federators Error Messages

The following table describes error messages for the Search Federator process.

information.
Table 30-30: Error Messages for Search Federators

132 An unknown The Search Federator Contact OpenText Customer
line for the Search Federator otadmin.cfg are valid. and
Search Federator process' command line specified in the proper format


150 URL is invalid The URL used to Ensure that the search.ini
the Search Federator is the proper format.
153 Unable to The Search Federator Ensure that the search.ini file
parameters in the
search.ini file are
invalid.
30.14.9 Search Engines Error Messages

The following table describes error messages for the Search Engine process.

information.
Table 30-31: Error Messages for Search Engines

132 An unknown The Search Engine Contact OpenText Customer
line for the Search Engine's otadmin.cfg are valid. and
Search Engines command line specified in the proper format
the Search Engine is the proper format.


153 Unable to The Search Engine Ensure that the search.ini file
of the parameters in
the search.ini file are
invalid.
Note: The search.ini file is the configuration file for Content Server searching
and indexing processes. This file contains settings that are usually set by
default when indexing and searching processes and other system objects, such
as data sources and partitions, are created; conversely, settings are also deleted
when the processes they configure are deleted. You configure these settings
when you configure searching and indexing processes and other system objects
in Content Server. OpenText strongly recommends that you do not modify the
settings in the search.ini file. If you do choose to modify the settings, contact

Chapter 31
Administering Prospectors
Prospectors are items that help users locate and use information. They act like filters,
scanning data as Content Server indexes it, to locate information that matches users'
interests.
If a Prospector identifies information that matches a user's interests, it adds the

corresponding item to a result list, where the user can access it. Prospectors run
continuously in the background, so they maintain accurate, up-to-date lists of their
findings. If you want to allow e-mail notifications to be sent to users when
Prospectors are added to result lists, you must configure system object e-mail
delivery and enable Notification. For more information about configuring system
object e-mail delivery, see “Enabling Error-Checking and E-Mail Delivery”
on page 568.
31.1 Adding Prospectors Importer Processes

Prospectors scan and retrieve data by communicating with a Prospectors' importer
process. A Prospectors importer process is a data flow process that scans new data
after it is indexed and identifies items that match a Prospectors' search criteria. In a
typical data flow, the Prospectors importer process exists after the Update
Distributor process. Prospectors importer processes are automatically added to each
data flow that you create using the Content Server index templates. If you want to
add Prospectors importer processes to existing data flows, you must do so manually.
For example, you can create a Prospectors importer process in the Enterprise data
flow to allow users to search the Enterprise slice and the Enterprise [All Versions]
slice.
Notes
• You can only add one Prospectors importer process to each data flow.
• You cannot create Prospectors importer processes in the User Help data
source or the Admin Help data source.
• You can add Prospectors to an OpenText Enterprise Library data flow. Users
can search the Enterprise Library [All Variants] slice. Prospectors ignore the
Enterprise Library [All Versions] slice, and search Enterprise Library [All
Variants] slice.
• Prospecting other Enterprise Library slices will not produce expected results.
• Prospectors do not obey slice definitions. If you specify the name of a slice to
monitor in a Prospector's In field, the slice is ignored and the entire Data
Source slice is monitored instead.

Chapter 31 Administering Prospectors
31.1.1 To Add Prospectors Importer Processes

To add a Prospectors importer process:
1. Click the Open System Object Volume link in the Search Administration
2. On the System Object Volume page, click the <processes_prefix> Data Source
Folder link for the data source that contains the data flow to which you want to
add a Prospectors importer process.
3. Click the <processes_prefix> Data Flow Manager link.
4. Click Importer on the Add Item menu.
5. On the Add: Importer page, type a name for the Prospectors importer process in
the Name field. If you want to add a description of the Prospectors importer
process, type a description in the Description field.
6. In the Host drop-down list, click the shortcut for the Content Server on whose
host you want the Prospectors importer process to run.
8. To specify the directory in which the Prospectors importer process runs, type
the absolute path of the directory in the Start Directory field. If you do not
specify a directory, the Prospectors importer process runs in the
Content_Server_home/bin directory.
9. Click Prospector in the Import Task Definition drop-down list. If you want to
configure the task that the Prospectors importer process performs, click the
Configure button.
10. In the iPool Base Area field of the Interchange Pool Info section, type the
absolute directory path of the data interchange pool (IPool) from which you
want the Prospectors importer process to read data. If the data flow already
contains at least one process, the Process drop-down list appears.
11. Click the process that you want the Prospectors importer process to follow in
the data flow in the Process drop-down list.
Tip: In most data flows, the Prospectors importer process follows the
<processes_prefix> Update Distributor process.
12. In the Start Options section, schedule when the Prospectors importer process
will run. For more information about configuring importer processes, see
“Configuring an Importer Process” on page 548.
14. Click the Regenerate Prospector Query Files link in the Prospector
Administration section on the Administration page.

31.2. Maintaining Prospectors
Note: If the Content Server that hosts the Prospectors importer process differs
from the Content Server that hosts the Index Engine process, you must type the
directory path in the iPool Base Area field of the Interchange Pool Info section
as it is mapped or mounted on the importer host. If you add a Prospectors
importer process to a Directory Walker data flow that monitors a static
directory, you must run maintenance to purge the data flow and reconstruct
the index. This updates the index and allows the prospectors to get results
from the static directory. For more information about purging and reindexing
data flows, see “To Re-index the Enterprise Content” on page 630.
31.2 Maintaining Prospectors

Modifying and Deleting Prospectors Importer Processes
You can modify a Prospectors' importer process to enable or disable system

management, change the Admin server on whose host the process runs, or change
when the Prospectors importer process runs. For more information about editing
importer processes, see “To Configure an Importer Process” on page 550.
Regenerating Prospectors Query Files
You must regenerate the Prospector Query files if the Query files are deleted or
become corrupt.
31.2.1 To Regenerate Prospectors Query Files

To regenerate the Prospectors Query files:
1. Click the Regenerate Prospector Query Files link in the Prospector

Administration section on the Administration page.
2. On the Regenerate To Configure Allowable Prospectors QueriesProspector

Query Files page, click the Regenerate Query Files button.
31.2.2 To Configure Allowable Prospectors Queries

Prospectors are based upon search queries applied in the Index Engines with every
indexing transaction, so when Prospectors run expensive queries with many
possible characters not defined, then indexing performance is affected. OpenText
recommends you restrict users from entering expensive query terms to ensure
indexing performance is not compromised.
To configure allowable Prospectors queries:
1. On the Administration page, in the Prospectors Administration section, click the

Configure Allowable Prospectors Queries link.
2. On the Configure Allowable Prospectors Queries page, in the Left Truncation

Restrictions -- *term section, choose the truncation level from the Status drop-
down list:

Chapter 31 Administering Prospectors
• Disable left truncated searches when searching for text strings, which is the
default.
• No Restriction on truncation, which has the same functionality as selecting 1
character to truncate.
• 1 to 5 characters are left truncated.
3. In the Right Truncation Restrictions -- term* section, choose the truncation

level from the Status drop-down list:
• Disable truncation when searching for text strings.

• No Restriction, which has the same functionality as selecting 1 character to
truncate.
• 1 to 5 characters are right truncated. The default is 4 characters.
4. In the Regular Expression Restrictions -- ^ter[i|m|n|a|l].*s section, choose the

truncation level from the Status drop-down list:
• Disable truncation when searching for text strings, which is the default.
• No Restriction.
• 1 to 5 characters are truncated.
Note: The changes you make on this page are applied to existing and newly
created Prospectors queries.

Chapter 32
Administering Recommender
OpenText Recommender provides users with another way to locate and retrieve
useful information in OpenText Content Server: through system-generated
recommendations that are tailored to each user's browsing habits. It also provides
users with a method to rate the value of the information they find, which then adds
to the accuracy of future recommendations. These two functions are performed by
the recommendations and ratings features respectively.
Administering Recommender includes the following tasks:

• Configuring Recommender components, which display recommendation and
rating information to users
• Configuring Recommender system settings, including maintaining the database
tables of Recommender data
• Enabling search for Recommender, so that users can search for recommendation
and rating information
• Customizing Recommender, including changing the rating images and labels,
and exporting data to XML for use in other applications
32.1 Configuring Recommender Components

Recommendation and rating information is presented to users in Recommender
components, which are sections of related user interface elements that appear on
each user's Recommendations page and the Ratings tab of each item's Properties
page. For example, the What's New component appears on the Recommendations
page and lists the items that were most recently added to Content Server.
Note: The What's New component uses the "New" Indicator server parameter
to determine which items are new. For more information about configuring the
duration of this indicator, see “Configuring Basic Server Parameters”
on page 71.
The following table describes the parameters that you can configure for
Recommender components.

Chapter 32 Administering Recommender
Table 32-1: Configurable Parameters for Recommender Components
Parameter Component Description

Item Types • What's New Specifies the item types that
• Most Active Items can be displayed in the
component.
• Recently Visited Items
Notes
• Not all item types
can be tracked by the
Recommender
module. This page
automatically
displays all item
types that can be
tracked.
• When you install a
module that adds a
new item type to
Content Server, the
new item type
appears in this list.
By default, it is not
selected.
Sample Size • What's New Specifies the sample size for
• Most Active Items the component. The sample
size determines the number
• Top Picks
of items that the system uses
• Documents of Interest when making
recommendations. For
example, if the sample size is
50 and a user has configured
the component to display 10
items, the system displays
the 10 items out of 50 that
best match the component's
criteria. The system will only
display an item if the user
has been assigned the See
permission for that item.
Note: If you set Max.

Number of Items
Show to a value
greater than Sample
Size, the maximum
number of items that
the system can show
will equal the sample
size.

32.1. Configuring Recommender Components

Max. Number of Items • What's New Specifies the maximum
Shown number of items that can be
• Most Active Items displayed in the component.
• Top Picks This setting provides an
upper limit for the Number
• Recently Visited Items of Items Shown element,
• People With Similar which users use to set how
Interests many items a given
Recommender component
• Documents of Interest displays.
Show Images Smaller Than • Synopsis Specifies the maximum size
of images that are displayed
as thumbnails in synopses.
Note: If an image is
larger than the
maximum size, it is
represented by a link in
the synopsis that
informs users of the
image size, and allows
them to view the
thumbnail by clicking
the link.
User-Editable Synopsis • Synopsis Specifies whether users can
edit synopses.
Note: If you select the

User-Editable
Synopsis check box,
users with the Modify
permission for a given
item will be able to edit
its synopsis.
Use Description as Initial • Synopsis Specifies whether to use an
Synopsis item's description (rather
than its summary) as its
initial synopsis.


Auto-Extract Synopsis • Synopsis When an item is added to
Content Server or modified
in some way, the system
extracts it. This process
assigns metadata to the item
and indexes it so that it is
searchable.
This parameter specifies

whether to extract an item's
synopsis upon the first visit
to the Ratings tab of the
item's Properties page.
Synopses are searchable only
after they have been
extracted. If this check box is
cleared, synopses are
extracted only when they are
edited, so unedited synopses
are not searchable.
Note: Extraction is an
expensive operation
when done to many
items within a short
period of time. Setting
Recommender to auto-
extract synopses may
slow down large
Content Server
installations.
Number of Items Shown • Reviews Specifies the number of items
• People Who Viewed This that a given Recommender
Item component displays.
• People Who Viewed This
Item Also Viewed
Rating Image • Reviews Specifies the image set that
the system uses when
depicting the ratings that
have been assigned to items.
For more information, see
“Configuring Recommender
Components” on page 797

32.2. Configuring Recommender System Settings

Rating Drop-Down List • My Review Specifies the text that appears
in the Rating drop-down list
on the Ratings tab of the
item's Properties page. For
more information, see
“Configuring Recommender
Components” on page 797.
You can change the language

used in the Rating list by
entering an Xlate value
instead of plain text.
32.1.1 To Configure a Recommender Component

To configure a Recommender component:
1. On the Administration page, click the Configure Recommender Components

link in the Recommender Administration section.
2. On the Configure Recommender Components page, select the Enable check

box associated with a component to display it on the Recommendations Page
and the Ratings Page by default.
3. Click the Action button to open the Configure page with the user settings for
that component.
4. On the Configure: <component> page:
a. Specify the settings that you want your users to see.

b. Click Update.
5. On the Configure Recommender Components page, click Update.
32.2 Configuring Recommender System Settings

Recommender system settings control the internal operations of the feature, as
opposed to Recommender components, which control the presentation of
Recommender data to users. For more information about Recommender
components, see “Configuring Recommender Components” on page 797.
Recommender system settings allow you to configure the Recommender agent,

which tracks user behavior, and to view and purge data from the agent's database
tables.
Running the Recommender Agent

When the Recommender agent runs, it records in the tracking table the user
behavior that occurred since the agent last ran. It also summarizes the data that was

previously stored in the tracking table and moves it to the summary table. The
system then uses the data in the summary table to make recommendations.
By default, the Recommender agent tracks the behavior of the Admin user as well as
other users. However, if you do not want the Admin user's behavior to influence
recommendations, you can disable this function.
Note: Changes to Admin user tracking are not visible until the Recommender
Agent runs.
The Recommender agent runs every five minutes, depending on how much data it
has to process.
Working with the Summary Table

The summary table contains the data that the system uses to generate
recommendations. The table keeps track of how many times a given operation was
performed by a given user for a given item. The table column that represents this
value is the reference count.
In large tables, the data that influences recommendations the most is the data with
high reference counts. Therefore, when viewing large tables, it is useful to filter the
data by reference count.
For the data in the summary table to remain relevant and up to date, it must be
purged at regular intervals. You can set the system to automatically purge data that
is a given number of days old, or you can purge the entire table manually.
Excluding or Including File Types

The [ExcludedMimeTypes] section in the opentext.ini file specifies which file
types are extracted and indexed in Content Server. The [ExcludedMimeTypes]
section is an exclusion list. This means that you can include or exclude an item from
the Most Active section on the Popular Recommendations tab by editing the list.
Items with file types that are included in the list will not appear in the Most Active
section. Items with file types that are not included in the list will appear in the Most
Active section.
32.2.1 To Configure Recommender System Settings

To configure Recommender system settings:
1. On the Administration page, click the Configure Recommender System

Settings link in the Recommender Administration section.
2. On the Configure Recommender System Settings page, in the Recommender
Agent section:
a. To enable the Recommender agent, select the Enable check box.

b. To have the Recommender agent track the Admin user, select the Track
Admin User check box.

32.3. Customizing Recommender
3. In the Ratings Table section:
a. To configure the Item Types that can be rated, click the Item Types icon.
b. On the Configure: Item Types page, select the item types that you want to
ensure can be rated.
c. Click Update.
4. In the Tracking Table section:
a. To specify the number of operation tracking events to buffer, in memory

per thread, before committing to the database, enter a value between 0 and
1000 in the Items to Buffer text box. Enter 0 to disable buffering. The
default is 25.
b. To specify the maximum number of seconds to buffer operation tracking
events, before committing to the database, enter a value greater than 0 in
the Time to Buffer text box. Enter 0 to disable buffering. The default is 120
(2 minutes).
5. In the Summary Table section:
a. To view the summary table, do one of the following:
• To view the entries in the summary table with a reference count greater
than a certain number, click a number in the Reference Count Greater
Than list, and then click View.
• To view the full contents of the summary table, make no selection in the
Reference Count Greater Than list, then click View.
b. To specify the number of days you want data to remain in the summary
table, select a number from the Automatic list.
c. To purge all data from the summary table, click Purge Now.
6. Click Update.
32.3 Customizing Recommender

Customizing the behavior of the Recommender module includes selecting a rating
image, changing rating labels, and exporting recommendation and rating data to
XML for use in your own applications. You can also add your own rating images.
For more information, see “Adding Rating Images” on page 805.
Selecting a Rating Image

When you select a rating image, you select the image that represents the rating
values that have been assigned to items in Content Server. For example, if you
choose the star image , a rating of 3 would be represented by the image
. There are several default images available.

Changing Rating Labels

When you change a rating label, you change the text that appears in the Rating
drop-down list on the Ratings tab of an item's Properties page. For example, you can
change the label for a rating of 4 from Above Average (the default) to Very Good.
Exporting Data to XML

You export recommendation and rating data to XML when you want to use the data
in your own applications. For example, you could deliver the data to users through a
customized portal interface. For more information, see “Exporting Recommendation
Data to XML” on page 806 and “Exporting Rating Data to XML” on page 813.
32.3.1 To Select a Rating Image

To select a rating image:
1. On the administration page, click the Configure Recommender Components

2. Click the Configure icon for the Reviews component.
3. In the Rating Image section, click the radio button that corresponds to the
rating image that you want to use.
4. Click Update.
32.3.2 To Change the Rating Labels

To change the rating labels:
1. On the administration page, click the Configure Recommender Components

2. Click the Configure icon for the My Review component.
3. On the Configure: My Review page, in each Label field, type the text you want
to appear for the rating labels in the My Review drop-down list on the Ratings
page. You can change the language used by entering an Xlate value instead of
plain text.
4. Click Update.
5. To change the text for a rating label, type text in the corresponding Label field.

32.4. Adding Rating Images
32.4 Adding Rating Images

You add a rating image when you want a customized image to represent the rating
values that have been assigned to items in Content Server. For more information
about rating images, see “Customizing Recommender” on page 803.
Working with Rating Images

Since ratings can range from 0 to 5, including half-point values such as 3.5, you
must include 11 images, one for each rating value. The file names of each image
must follow a specific convention.
Table 32-2: File Names for Rating Images
Image Name Rating Value

<name>0.gif 0
<name>05.gif 0.5
<name>1.gif 1
<name>15.gif 1.5
<name>2.gif 2
<name>25.gif 2.5
<name>3.gif 3
<name>35.gif 3.5
<name>4.gif 4
<name>45.gif 4.5
<name>5.gif 5
Where <name> is the name that you want your rating image to have in the GUI.
The rating image files must be stored in the following two directories:
• <Content Server_home>/support/recommender/ratinggifs/<name>, and

• <Content Server_home>/module/recommender_<version>/
support/ratinggifs/<name>
where:
• <Content Server_home> is the location of your Content Server installation.

• <name> is the name of the rating image file.
• <version> is the version number of the Recommender module. For example,
10_5_0 for version 10.5.0.
The recommended size for each rating image file is 48 pixels wide by 10 pixels high,
and rating images should have a transparent background.

32.5 Exporting Recommendation Data to XML

To export XML data for a user's recommendations, append &outputxml=true to the
end of the Content Server URL for the page, or enter the following URL:
<protocol>://<host>/<URL_prefix>/Content Server.exe?
func=Personal.Recommendations&outputxml=true
where:
• <protocol> is either http or https,

• <host> is your fully qualified host address (for example, Content
Serverhost.mycorp.com), and
• <URL_prefix> is the virtual directory shortcut mapped to the <Content
Server_home>/cgi directory in the HTTP server.
This command outputs the recommendations for the user who is currently logged in
to the Admin server.
The DTD that defines this XML output is included in installations as <Content
Server_home>/module/recommender_<x>_<x>_<x>/
config/recommender_xml_output.dtd, where <x>_<x>_<x> is the version number
of the Recommender module. For example, for Recommender 10.5.0, the file is
located in: <Content Server_home>/
module/recommender_10_5_0/config/recommender_xml_output.dtd.
Understanding XML Output

The first part of the XML output is a header section that defines the XML file and the
type of data that the file contains (in this case, recommendation data). This section
consists of the following XML declaration, which specifies the XML version and the
character encoding used in the file, and the PersonalRecommendations element:
<?xml version="1.0" ?><PersonalRecommendations>
Next, the XML file contains one section for each of the Recommender components
that displays information on the Recommendations page. It defines each section
with a tag.
Table 32-3: XML Tags that Define Recommender Components
Element Component
<whatsnew> What's New
<mostactive> Most Active
<toppicks> Top Picks
<history> Recently Accessed Items
<userslikeme> People With Similar Interests

32.5. Exporting Recommendation Data to XML
Element Component
<docsinterest> Documents of Interest
Each of these tags has a DisplayName attribute, which specifies the name that
appears in the GUI for the element (for example, <whatsnew DisplayName="What's
New">).
The What's New, Most Active, Top Picks, Documents of Interest, and Recently
Accessed Items components consist of tables of items, so they are defined by the
same tags in the XML output. The following table describes the tags, in the order
that they appear.
Note: In this table, several XML tags share the same name (for example,
<dc_link>). This apparent duplication is necessary because the table lists all
the tags that appear, in the order that they appear.
Table 32-4: XML Tags for Item-Based Components
Tag Description
<browseview> Specifies a series of tags that contain the table
of items.
<header> Specifies a series of tags that contain the
header of the table of items.
<column> Specifies a series of tags that contain column
labels that appear in the header of the table.
The order in which the column labels appear
in these tags is the order in which they
appear in the user interface.
<displayname> Specifies the column heading for the table
(for example, Type).
<tagname> Specifies the tag name for the column. The
tag name associates the column heading with
the corresponding column.
<contents> Specifies a series of tags that contain
information that appears in the body of the
table.
<object> Specifies a row in the body of the table.
<dc_subtype> Specifies a series of tags that contain
information about the item type for each
item in the table.
<dc_subtype_img> Specifies a series of tags that contain
information about the image that represents
an item's item type.
<dc_imgpath> Specifies the path of the image that
represents an item's item type.

Tag Description
<dc_imgalt> Specifies the ALT text for an item's item type
image (for example, Document).
<dc_link> Specifies the link for fetching an item.
<dc_name> Specifies a series of tags that contain
information about an item's name.
<dc_displayname> Specifies the name of the item as it is
displayed in the table.
<dc_name_new> Not used in the current version of
Recommender.
<dc_functions> Not used in the current version of
Recommender.
<dc_location> Specifies a series of tags that contain
information about an item's location.
<dc_location_img> Specifies a series of tags that contain
information about the image that
accompanies each item's location.
<dc_imgalt> Specifies the ALT text for the location image
(for example, Enterprise Workspace).
<dc_displayname> Specifies the location of an item as it is
<dc_link> Specifies the link that leads to the location of
an item.
Recommender.
<dc_size> Specifies a series of tags that contain
information about an item's size.
<dc_size_displaysize> Specifies the size of an item as it is displayed
in the table.
<dc_modifydate> Specifies a series of tags that contain
information about an item's modification
date.
<dc_date> Specifies the modification date of an item as
it is displayed in the table.
<recommender_rating> Specifies a series of tags that contain
information about an item's overall rating in
the table.

Tag Description
<recommender_rating_img> Specifies a series of tags that contain
an item's overall rating in the table.
<recommender_imgpath> Specifies the path of the image that
represents an item's overall rating in the
table.
<recommender_imgalt> Specifies the ALT text for the rating image
(for example, Click to rate this item).
<recommender_link> Specifies the link that leads to the Ratings
tab of the item's Properties page in the table.
The People With Similar Interests component consists of a table of users. The
following table describes the tags, in the order that they appear.
Table 32-5: XML Elements for the People With Similar Interests Component
Element Description
<browseview> Specifies a series of tags that contain the table
of users.
header of the table.
(for example, User Name).
<tagname> Specifies the tagname for the column. The
tagname associates the column heading with
table.
<recommender_username> Specifies a series of tags that contain
information about a user in the table.
<recommender_displayname> Specifies the login name of the user as it is
accompanies each user in the table.

Element Description
<recommender_link> Specifies the link that leads to information
about a user in the table.
<recommender_firstname> Specifies the first name of a user in the table.
<recommender_lastname> Specifies the last name of a user in the table.
<recommender_department> Specifies the department of a user in the
table.
Example 32-1: Example File
The following is an example of exported recommendation data. In this case,

the only recommendations are the following: in What's New, the file kf.pdf,
and in People With Similar Interests, the user bdouglas.
<?xml version="1.0" ?>
<PersonalRecommendations>
<whatsnew DisplayName="What's New">


<browseview>
<header>
<column>
<displayname>Type</displayname>
<tagname>dc_subtype</tagname>
</column>
<column>
<displayname>Name</displayname>
<tagname>dc_name</tagname>
</column>
<column>
<displayname>Functions</displayname>
<tagname>dc_functions</tagname>
</column>
<column>
<displayname>Location</displayname>
<tagname>dc_location</tagname>
</column>
<column>
<displayname>Size</displayname>
<tagname>dc_size</tagname>
</column>
<column>
<displayname>Modified Date</displayname>
<tagname>dc_modifydate</tagname>
</column>
<column>
<displayname>Rating</displayname>
<tagname>recommender_rating</tagname>

</column>
</header>
<contents>
<object>
<dc_subtype>
<dc_subtype_img>
<dc_imgpath>/910support/webdoc/apppdf.gif</
dc_imgpath>
<dc_imgalt>Document</dc_imgalt>
<dc_link>/910/.exe/kf.pdf?
func=doc.Fetch&nodeId=4618&docTitle=kf%2Epdf</dc_link>
</dc_subtype_img>
</dc_subtype>
<dc_name>
<dc_displayname>kf.pdf</dc_displayname>
<dc_link>/910/.exe/kf.pdf?
func=doc.Fetch&nodeId=4618&docTitle=kf%2Epdf</dc_link>
<dc_name_new/>
</dc_name>
<dc_functions>
</dc_functions>
<dc_location>
<dc_location_img>
<dc_imgpath>/910support/webdoc/icon_library.gif</
dc_imgpath>
<dc_imgalt>Enterprise Workspace</dc_imgalt>
</dc_location_img>
<dc_displayname>Enterprise</dc_displayname>
<dc_link>/910/.exe?
func=ll&objId=2000&objAction=browse&sort=name</dc_link>
<dc_name_new/>
</dc_location>
<dc_size>
<dc_size_displaysize>60731 KB</dc_size_displaysize>
</dc_size>
<dc_modifydate>
<dc_date>10/08/2002 04:07 PM</dc_date>
</dc_modifydate>
<recommender_rating>
<recommender_rating_img>
<recommender_imgpath>/910support/recommender/
ratinggifs/star/star0.gif</recommender_imgpath>
<recommender_imgalt>Click to rate this item.</
recommender_imgalt>
<recommender_link>?
func=ll&objid=4618&objAction=Ratings</recommender_link>
</recommender_rating_img>
</recommender_rating>
</object>
</contents>
</browseview>

</whatsnew>

<mostactive DisplayName="Most Active">

</mostactive>
<toppicks DisplayName="Top Picks">

</toppicks>
<history DisplayName="Recently Accessed Items">

</history>
<userslikeme DisplayName="People With Similar Interests">


<browseview>
<header>
<column>
<displayname>User Name</displayname>
<tagname>recommender_username</tagname>
</column>
<column>
<displayname>First Name</displayname>
<tagname>recommender_firstname</tagname>
</column>
<column>
<displayname>Last Name</displayname>
<tagname>recommender_lastname</tagname>
</column>
<column>
<displayname>Department</displayname>
<tagname>recommender_department</tagname>
</column>
</header>
<contents>
<object>
<recommender_username>
<recommender_username>
<recommender_displayname>bdouglas</
recommender_displayname>
<recommender_imgpath>/910support/guy.gif</
recommender_imgpath>
<recommender_link><A HREF="#"
onClick="javascript:window.open('?
func=user.userdialog&userID=4613','UserDialog','width=460,heig
ht=365,resizable=yes,scrollbars=yes,menubar=no')">bdouglas</
A></recommender_link>
</recommender_username>
</recommender_username>
<recommender_firstname>
<recommender_firstname>Beverly</
recommender_firstname>
</recommender_firstname>
<recommender_lastname>
<recommender_lastname>Douglas</recommender_lastname>
</recommender_lastname>

32.6. Exporting Rating Data to XML
<recommender_department>
<recommender_department>DefaultGroup</
recommender_department>
</recommender_department>
</object>
</contents>
</browseview>

</userslikeme>
<docsinterest DisplayName="Documents Of Interest">

</docsinterest>
</PersonalRecommendations>
32.6 Exporting Rating Data to XML

To export XML data from the Ratings tab of an item's Properties page, append &
outputxml=true to the end of the URL for the page. For example, enter the
following URL:
<protocol>://<host>/<URL_prefix>/.exe?func=ll&objid=<id>&
objAction=Ratings&outputxml=true
where:
• <protocol> is either http or https,
• <host> is your fully qualified host address (for example, host.mycorp.com),
• <URL_prefix> is the virtual directory shortcut mapped to the <Content
Server_home>/cgi directory in the HTTP server, and
• <id> is the node ID of the item.
This command outputs the Ratings tab of the item's Properties page for the user
who is currently logged in to the server.
The DTD that defines this XML output is included in installations as <Content
Server_home>/module/recommender_<x>_<x>_<x>/
config/recommender_xml_output.dtd, where <x>_<x>_<x> is the version number
of the Recommender module. For example, to view the file for the Recommender
10.5.0 module, see <Content Server_home>/
module/recommender_10_5_0/config/recommender_xml_output.dtd.
Understanding XML Output

The following table describes the XML tags in exported rating data, in the order that
the tags appear.

Note: In this table, several XML tags share the same name (for example,
<dc_link>). This apparent duplication is necessary because the table lists all
the tags that appear, in the order that they appear.
Table 32-6: XML Tags in Exported Rating Data
Tag Description
<?xml version="1.0" ?> Specifies the XML version and the character
encoding used in the file.
<Ratings> Specifies a series of tags for the Ratings tab
of the item's Properties page.
<objID> Specifies the node ID of the item.
<statistics> Specifies a series of tags that contain statistics
information from the Ratings tab of the
item's Properties page. This tag includes the
DisplayName attribute, which is the name
that appears in the user interface for this
element.
<OverallRating> Specifies the overall rating assigned to the
item. This tag includes the following
attributes:
• DisplayName, the name that appears in
the user interface for this element
• Protocol, either http or https
• ServerName, your fully qualified host
address
• iconURL, the URL to the icon that
represents the item's rating
<numRatings> Specifies the number of times the item has
been rated. This tag includes the
element.
<numAccessed> Specifies the number of times the item has
been accessed. This tag includes the
element.
<summary> Contains a synopsis of the item, which
consists of either the system-generated
summary of the item, the description of the
item as specified on the General tab of the
item's Properties page, or the synopsis as
edited by a user. This tag includes the
element.

Tag Description
<hotwords> Specifies the system-generated key phrases
for the item. (Key phrases are recurring
words and word combinations, especially
those involving unusual words.) This tag
includes the DisplayName attribute, which
is the name that appears in the user interface
for this element.
<opinions> Specifies a series of tags that contain the
reviews from the Ratings tab of the item's
Properties page. This tag includes the
element.
<opinion> Specifies a series of tags that define a review
given to the item. This tag includes the
element.
<Rating> Specifies the rating given to an item as part
of a review. This tag includes the following
attributes:
• DisplayName, the name that appears in
the user interface for this element
• Protocol, either http or https
• ServerName, your fully qualified host
address
• iconURL, the URL to the icon that
represents the item's rating
<UserID> Specifies which user reviewed the item. This
tag includes the DisplayName attribute,
which is the name that appears in the user
interface for this element.
<UserComment> Specifies the comment given to an item as
part of a review. This tag includes the
element.
<UserExplanation> Specifies the explanation given to an item as
part of a review. This tag includes the
element.

Tag Description
<Date> Specifies the date on which the review was
completed. This tag includes the Mask
attribute, which defines the format in which
the date appears (for example,
MM/DD/YYYY).
<personalopinion> Specifies a series of tags that contain the
review given to an item by the current user.
This tag includes theDisplayName attribute,
<Rating> Specifies the rating that the current user has
given to an item as part of a review. This tag
for this element.
<UserComment> Specifies the comment that the current user
has given to an item as part of a review. This
tag includes the DisplayName attribute,
<UserExplanation> Specifies the explanation that the current
user has given to an item as part of a review.
This tag includes the DisplayName
attribute, which is the name that appears in
the user interface for this element.
<activeusers> Specifies a series of tags that contain
information that appears in the People Who
Viewed This Item table on the Ratings tab
of the item's Properties page. This tag
for this element.
<browseview> Specifies a series of tags that contain the
People Who Viewed This Item table.
header of the People Who Viewed This Item
table.
(for example, User Name).

Tag Description
table.
<recommender_username> Specifies a series of tags that contain
information about a user in the table.
<recommender_displayname> Specifies the login name of the user as it is
accompanies each user in the table.
<recommender_link> Specifies the link that leads to information
about a user in the table.
<recommender_firstname> Specifies the first name of a user in the table.
<recommender_lastname> Specifies the last name of a user in the table.
<recommender_department> Specifies the department of a user in the
table.
<similardocs> Specifies a series of tags that contain
information that appears in the People Who
Viewed This Item Also Viewed table on the
Ratings tab of the item's Properties page.
This tag includes the DisplayName
attribute, which is the name that appears in
the user interface for this element.
<browseview> Specifies a series of tags that contain the
People Who Viewed This Item Also
Viewed table.
header of the People Who Viewed This Item
Also Viewed table.
(for example, Type).

Tag Description
table.
<dc_subtype> Specifies a series of tags that contain
information about the item type for each
item in the table.
<dc_subtype_img> Specifies a series of tags that contain
an item's item type.
represents an item's item type.
<dc_imgalt> Specifies the ALT text for a item's type image
(for example, Document).
<dc_name> Specifies a series of tags that contain
information about an item's name.
<dc_displayname> Specifies the name of the item as it is
Recommender.
<dc_functions> Not used in the current version of
Recommender.
<dc_location> Specifies a series of tags that contain
information about an item's location.
<dc_location_img> Specifies a series of tags that contain
information about the image that
<dc_imgalt> Specifies the ALT text for the location image
(for example, Enterprise Workspace).
<dc_displayname> Specifies the location of an item as it is
<dc_link> Specifies the link that leads to the location of
an item.
Recommender.
<dc_size> Specifies a series of tags that contain
information about an item's size.

Tag Description
<dc_size_displaysize> Specifies the size of an item as it is displayed
in the table.
<dc_modifydate> Specifies a series of tags that contain
information about an item's modification
date.
<dc_date> Specifies the modification date of an item as
it is displayed in the table.
<recommender_rating> Specifies a series of tags that contain
information about an item's overall rating in
the table.
<recommender_rating_img> Specifies a series of tags that contain
an item's overall rating in the table.
represents an item's overall rating in the
table.
<recommender_imgalt> Specifies the ALT text for the rating image
(for example, Click to enter your
rating).
<recommender_link> Specifies the link that leads to the Ratings
tab of the item's Properties page for an item's
image in the table.

Chapter 33
Administering eLink
The eLink module integrates email functionality into Content Server.
33.1 Administering eLink General and Advanced

Settings
You administer eLink by configuring general and advanced settings. All settings are
saved and loaded in a Kini table.
Administering eLink General Settings

You must administer eLink settings to control eLink behavior in Content Server. The
settings you can configure include the following:
• Enable or Disable eLink

• The email message content format
• Discussion preferences
• Email connection parameters
• Inbound message preferences
Notes
• If the Notification area in the eLink Configuration page is set to Disabled,

you must enable Notification in the Configure Notification page of the
Notification Administration section before you can configure eLink. For
more information about configuring Notifications, see “To Enable
Notifications” on page 831.
• By default, eLink will not display certain characters in filenames, and it will
replace the characters with an “_” for each invalid character.
Specifying the Email Message Content Format
You can specify text or HTML as the default format of email messages that eLink
sends. All email client programs can handle text messages. If your users have
HTML-enabled email clients, the HTML format is recommended because users can
click links to Web pages, discussions and other linkable items embedded in the
email message. If you users do not have HTML-enabled email client software, do not
select the HTML option.

Chapter 33 Administering eLink
Specifying Discussion Preferences
You can specify a setting that allows users to receive an email from eLink for each
discussion topic and reply that they post.
Specifying Email Connection Preferences
You can specify settings that control how eLink sends and receives messages by
specifying Simple Mail Transfer Protocol (SMTP) and Post Office Protocol 3 (POP3)
settings. Also, you can define filters that permit or restrict incoming messages.
Administering eLink Advanced Settings

You can use eLink advanced settings to control the following features:
• Check if eLink is Enabled or Disabled (this displays the current status)
• Email-enabled documents
• Email-enabled discussions
• My Mailbox options
• Corporate signatures
Specifying Email-Enabled Document Options
You can enable users to email documents and control how the requests are handled
by specifying document email options. The options you can specify include:
• Allowing users to email documents as attachments by selecting a command on
the documents Functions menu. If you disable this setting, users can only email
hypertext links to a document through the documents General tab.
• Configuring the system to confirm when a document has been received by a
Folder or Workspace through email. By default, the system sends a message only
when the content fails to be received in an eLink-enabled Folder or Workspace.
• Specifying the type of link included in eLink email messages. By default, the
messages include the Open link.
Specifying Email-Enabled Discussion Options
You can control how users interact with email-enabled discussions. The options you
can specify include:
• Allowing non—Content Server users to participate in discussions. By default,
Content Server allows users without Content Server access to participate in
email-enabled discussions.
• Allowing all Content Server users to post to discussions. By default, Content
Server allows users without Write permission to post to a discussion through
email only.
• Allowing users to unsubscribe from group subscriptions. Users are automatically
subscribed to discussions when a group to which they belong subscribes to a

33.1. Administering eLink General and Advanced Settings
discussion. By default, users are allowed to unsubscribe from a group subscribed

discussion.
• Preventing members of subgroups of a group from receiving discussion topics
and replies. By default, only the immediate members of a group subscribed to a
discussion receive an email message when time a topic or reply is added. to the
discussion.
Specifying Mailbox Preferences
You can specify settings that allow users to access the light email client and override
users Post Office Protocol 3 (POP3) settings.
Specifying a Corporate Signature
You can specify a corporate signature included at the bottom of all eLink messages.
The corporate signature must be text only (HTML is not supported).
33.1.1 To Configure General Parameters

To configure general parameters:
1. In the eLink Administration section on the administration page, click the

Configure eLink link.
2. On the eLink Configuration page, do the following in the Enable eLink

section:
• Select the Enable check box to enable eLink.
Note: Notifications must be enabled for eLink to function.
• Select the Disable check box to disable eLink.
Note: The following functions will be unavailable when eLink is

Disabled:
• E-Mail Enable/Disable will not be in an item function menu.

• eLink In the Properties menu.
• eLink and My Mailbox in the Personal menu.
3. Do the following in the General section:
• Click one of the following in the E-mail Contents list:
• Text, to have eLink send email messages as text only by default. All
email clients can handle this message type.
• HTML, to have eLink send email messages in HTML format by default.

• Select the E-mail me topics/replies that I post check box to enable users to
receive an email from eLink for each discussion topic and reply that is
posted.
• Click one of the following in the Enable alternative style E-mails from
discussions list:
• Disabled, to have eLink display discussion email messages in the

standard format.
• Enabled, to have eLink discussion email messages include the name of
the user who posted the topic or reply in the From field, and reference
the discussion name in brackets in the Subject field before the subject
itself.
• Type an integer in the Undelivered Mail field, indicating the number of
days that eLink should continue to attempt delivery of undelivered
messages before discarding them.
• In the Virtual Hostname field, type the domain name that your mail server
virtually hosts for eLink.
• Select the Verbose Logging check box to enable verbose logging for eLink
transactions in Content Server.
4. In the Attachments section, type the largest attachment size you want to permit
Max Outbound Size field.
5. Do the following in the SMTP section:
• In the Server field, type the name of the mail server through which eLink
sends its outbound email.
• In the Port field, type the port on which the SMTP server listens. The default
port is 25.
• Click the Test Connection button to test the SMTP connection settings for
outgoing email messages.
6. Do the following in the POP3 section:
• In the Server field, type the name of the mail server that stores eLinks
incoming email.
• In the Port field, type the port on which the POP3 server listens. The default
port is 110.
• In the Username field, type the name of the mailbox on the POP3 server to
which eLinks mail is delivered.
• In the Password field, type the password corresponding to eLinks POP3
username.
• Click the Test Connection button to test the POP3 connection settings for
inbound email messages.
7. Do the following in the Inbound Message Filters section:

33.1. Administering eLink General and Advanced Settings
• In the Discard messages containing these X-Headers list box, type headers
found in incoming messages that you want eLink to discard.
• In the Discard messages containing these in the subject list box, type the
Subject text for incoming email messages that you want eLink to discard.
• In the Discard messages from these addresses list box, type the email
addresses or partial addresses of incoming messages that you want eLink to
discard.
• In the Accept messages for the listed domains only, or leave blank for no
restrictions list box, type the domains of messages that you want eLink to
accept. Any domains not listed will be rejected.
• In the Discard attachments of these MIME types or with these file
extensions list box, type the MIME types or file extensions that you want
eLink to discard.
9. Restart the system, and then click the Continue link.
33.1.2 To Configure eLink Advanced Settings

To configure eLink advanced settings:
1. In the eLink Administration section on the administration page, click the eLink
Advanced Settings link.
2. On the eLink Advanced Settings page, in the eLink Status section, the Current
Status section will display one of the following:
• Enable, which displays if eLink is enabled.

• Disable, which displays if eLink is disabled.
3. Do any of the following in the Documents via E-mail section:
• Select the Enable e-mailing documents via function menu check box to
allow users to email documents from the Functions menu.
• Select the Acknowledge receipt of inbound e-mail content check box to
send an email message when content is received by an email-enabled Folder
or Workspace.
• Click one of the following in the E-mail document link option list to choose
the type of link included in messages:
• Open, which opens the document.

• Properties, which opens the documents General tab.
• View, which opens the documents Specific tab.
4. Do any of the following in the Discussions via E-mail section:

• Select the Allow non-Content Server users to post to discussions check box
to allow users who do not have Content Server access to participate in email
enabled discussions.
• Select the Allow users without "Edit" permission to post to discussions
check box to allow users without permission to post in a discussion to post
topics.
• Select the Allow users to opt out of group auto-subscription check box to
enable users in a group to unsubscribe from a discussion.
• Select the Send topic/reply only to the immediate members of a group
check box if you want topics or replies to be sent only to users directly
subscribed to the discussion (but not users subscribed through a group).
5. Do any of the following in the My Mailbox area:
• Select the My Mail Client check box to enable users to access the Content
Server light email client using the My Mailbox option in the Personal menu.
Note: Changing the value of the My Mail Client check box requires
that you restart the server. For more information on restarting the
server, see “Stopping and Starting the Servers” on page 227.
• Specify the connection settings for a POP3 email server to use instead of the
settings configured by users.
• Select the Use Content Server username as POP3 username check box to
require users to sign in to the POP3 server using their Content Server
credentials.
6. In the Corporate Signature section, select the Include Corporate Signature in

outgoing e-mails check box to add a signature to eLink messages, and then type
the signature text in the Corporate Signature field.
8. If you selected the My Mail Client check box, restart the system, and then click
the Continue link.
33.2 Testing the eLink Connection

Open Text recommends testing the email connection settings to ensure that eLink
can properly send and receive messages. When you test the connection, the outgoing
SMTP mail server generates an eLink test message, and then the POP3 mail account
displays the status of messages received. If any of the settings are incorrect, you
receive an error message.
Before you can test the eLink connection, you must configure the SMTP and POP3
for your site. For more information about configuring SMTP and POP3 settings, see
“To Configure General Parameters” on page 823.

33.3. Administering eLink Global Workflow Settings
33.2.1 To Test eLink Connections

To test eLink connections:
1. In the eLink Administration section on the administration page, click the

Configure eLink link.
2. In the SMTP section, click the Test Connection button to test the SMTP
connection settings for outgoing email messages.
3. In the POP3 section, click the Test Connection button to test the POP3
connection settings for inbound email messages.
33.3 Administering eLink Global Workflow Settings

You can configure global eLink settings for workflow events for all users on the
eLink Global Workflow Settings page. Also, you can control whether users can
initiate workflows by sending an email message.
Administering eLink Global Workflow Settings

When you enable an eLink global setting for a workflow event, all users receive
eLink email notification for the workflow event regardless of the eLink settings users
have made for the event on their personal Modify eLink Settings page. When you do
not enable a global setting, the system recognizes the users settings. For example, if
you enable the Workflow I manage has been completed event, users receive an
email message each time a workflow that the users manage is completed, even if the
users have specified not to be notified for the event in their personal eLink settings.
Important
You must configure eLink global workflow settings or users must configure
their local eLink workflow settings in order to receive email messages for
workflow events from email-enabled workflows.
Administering Email Initiation for Workflows

eLink provides Workflow Maps designers the option to establish an eLink email
address for workflows. Users can use the email address to initiate a workflow by
sending an initiation request in an email message.
You can allow users to initiate workflows through email by enabling the workflows
email initiation setting. The setting applies to all Workflow Maps in Content Server.
If you do not enable email initiation of workflows, users can initiate workflows from
within Content Server only.

33.3.1 To Enable an eLink Global Workflow Setting

To enable an eLink global Workflow setting:
Global Workflow Settings link.
2. Select the check box for each workflow event you want to enable.
33.3.2 To Enable Email Initiation of Workflows

To enable email
initiation of
workflows:
Global Workflow Settings link.
2. On the eLink Global Workflow Settings page, select the Enable Workflow
initiation via e-mail check box.
33.4 Using eLink LiveReports

eLink comes with its own LiveReports. eLink LiveReports display the subject
heading of an email attachment added to Content Server, the date it was added, and
the attachments Node ID. These reports can sort by the subject of the email or by
Node ID.
Before you can run an eLink LiveReport, you need to import it.
33.4.1 Importing eLink LiveReports

To import an eLink LiveReport:
1. Click Import LiveReports in the LiveReports Administration section of the

2. Click Browse next to the File box and browse to the <Content_Server_home>/
module/elink_<version_number>/LiveReports/eLinkLiveReports.rpt file,
where <Content_Server_home> is the location of the Content Server installation
folder, and <version_number> is the eLink version you are using.
3. Click Open, and then click Add.

33.4. Using eLink LiveReports
33.4.2 Running eLink LiveReports

To run an eLink LiveReport:
1. From the Personal menu, click Reports.
2. Click the link of one of the following reports:
• All email headers

• Delete all headers
• Delete headers by Node ID
• Email headers by Node ID
Tip: You can also run a LiveReport by clicking the Functions menu, and
then clicking Open.

Chapter 34
Working with Notifications
Notifications enable users to get notified when certain activities or events occur in
Content Server. The administrator can enable or disable Notifications for the entire
Content Server system.
Note: The day and time of notification is based on the time zone and clock
setting of the host on which the RDBMS used by Content Server resides. If
messages are not being sent at the expected times, it may be because the host's
clock is set incorrectly or users have not taken time zone differences into
account.
34.1 Enabling and Disabling Notifications

Notifications are disabled by default. After you enable or disable Notifications, you
must restart the servers for the changes to take effect.
Note: For more information about restarting the servers, see “Stopping and
Starting the Servers” on page 227.
34.1.1 To Enable Notifications

To enable Notifications:
1. In the Notification Administration section of the Content Server

Administration page, click Configure Notification.
2. In the Enable Notifications section of the Configure Notification page, click

the Enable radio button.
3. Click Submit.
4. Restart the server and the Web application server. For more information about
restarting the servers, see “Stopping and Starting the Servers” on page 227.
Note: If you are setting up Notifications for the first time, you must also
configure SMTP, report, and email message settings. For more
information, see To Set SMTP Parameters, To Configure Report Settings,
and To Set Email Message Parameters.

Chapter 34 Working with Notifications
34.1.2 To Disable Notifications

To disable Notifications:
1. On the Content Server Administration page, in the Notification

Administration section, click Configure Notification.
2. On the Configure Notification page, in the Enable Notifications area, click

Disable.
3. Click Submit.
4. Restart the server and the Web application server. For more restarting the
servers, see “Stopping and Starting the Servers” on page 227.
34.2 Clearing Outstanding Events

You can clear scheduled Notification events on the Clear Outstanding Events page.
You can enable or disable events on the Configuring Schedule Activities page. You
set the frequency that Content Server clears these events in the Report Settings area
of the Configure Notification page.
34.2.1 To Clear Scheduled Events

To clear scheduled Notification events:

Administration section, click Clear Outstanding Events.
2. On the Clear Outstanding Events page, click Purge.
34.3 Configuring Notifications

The Configure Notification page allows you to enable and disable Notifications, set
the Content Server home page URL, configure the SMTP settings, set the email
message settings, define the report settings, and define the default Notification
schedule settings.
For information about enabling or disabling Notifications, see “Enabling and

Disabling Notifications” on page 831.
Modifying the Notification Report URL

Notification uses the URL of your server to create HTTP links to Content Server
items in Notification reports. As a result, you must insure that this URL appears
correctly on the Configure Notification page.
It is normally not necessary to modify the URL that appears in the Content Server
Home Page URL box. However, if users report that links in their Notification reports
do not work, the URL may be incorrect.

34.3. Configuring Notifications
When you modify the URL, use the following format:

• <protocol>://<host>:<port>/<URL_prefix>/contentserver.exe if the
server is running on Windows.
• <protocol>://<host>:<port>/<URL_prefix>/contentserver if the server is
running on UNIX.
where:
• <protocol> is either http or https.
• <host> is the fully qualified name of the host on which the HTTP server resides.
For example, contentserverhost.mycorp.com.
• <port> is the port on which the HTTP server listens.
• <URL_prefix> is the URL prefix, or virtual directory alias, mapped to the <Content
Server_home>/cgi directory in the HTTP server.
Using Email to Deliver Notifications

Notification uses email messages to notify users when certain events have occurred
and to notify the administrator when errors have occurred in the Notification
system.
All email addresses must be valid Internet email addresses, in the format
account@domain, where domain is the domain of the email account's mail server
and usually takes the form mycorp.com, myorg.org, or myschool.edu.
Notification supports the Simple Mail Transport Protocol (SMTP) email transport
type. For Notification to function correctly, you must accurately configure the SMTP
settings.
Notification allows you to test the delivery of email messages to email addresses
which appear in the Default From Address, Default Reply To Address, and On
Error Address fields on the Configure Notification page. You can also test email
delivery to alternate email address.
34.3.1 Configuring Default Notification Settings

The settings in the Default Notification <#> sections determine the default names
and delivery schedules of the three Notification reports that are available to Content
Server users. Users can customize their Notification reports by modifying each
report's name and delivery schedule. Until they do, their Notification reports use the
settings that you configure on this page.
By default, the report names are Report 1, Report 2, and Report 3 (or the
equivalent names in each supported language). If you replace a default report name
on the Configure Notification page, it immediately becomes the default report
name for any Content Server users who have not already modified their personal
Notification settings.

It is important to note, however, that the new report names become the default for
every user regardless of the language that they specify in their personal settings. For
example, if you replace the name of Report 1 with Urgent Notifications, this
becomes the default report name for all of your users, regardless of whether they
view Content Server in French, German, or some other language.
Tip: In multilingual deployments, OpenText recommends that you do not

modify the Name box. By leaving the Name box for each report unmodified,
you ensure that certain users do not see a default report name that is not in the
same language as the rest of their Content Server user interface.
34.3.2 To Modify the Content Server URL for Notification

Reports
To modify the Content Server URL used in Notification report links:

2. Type the URL that you use to access Content Server in the Content Server
Home Page URL field.
3. Click Submit.
34.3.3 To Set SMTP Parameters

To set SMTP parameters:

2. Enter the name and port of your SMTP server.
a. In the SMTP Settings region, in the SMTP Server ID field, type the name
of the SMTP server. The default for most SMTP servers is mail.
b. In the SMTP Port field, type the port on which the SMTP server listens. The
default for most SMTP servers is 25.
Tip: When you move your mouse pointer from the SMTP Server ID or
SMTP Port box, Content Server performs a test connection to the SMTP
server. If it is successful, the message Successful connection to mail
server appears beside the SMTP Server ID box. If it is not, the message
Failed connection to mail server appears. You can click the failure
message for additional information on the nature of the connection failure.
3. In the Content Server Host Name field, type the fully qualified DNS name of
the primary Content Server host. For example,
contentserverhost.mycorp.com.
4. Click Submit.

34.3. Configuring Notifications
Note: If you are setting up Notifications for the first time, you must also
enable Notifications, configure email message parameters, and configure
report settings. For more information, see “To Enable Notifications”
on page 831, “To Set Email Message Parameters” on page 835, and “To
Configure Report Settings” on page 836.
34.3.4 To Set Email Message Parameters

To set email message parameters:

2. On the Configure Notification page, in the E-mail Message Settings region,

click one of the following email message types in the Default Message Type
list:
• Plain Text Body Only, which sends reports in plain text format. All email
clients can handle this message type.
• HTML Body Only, which sends reports in HTML format. If your users have
HTML-enabled email clients, this is the most convenient format since they
can click Notification links directly in the email message. If the email
program(s) that your users use cannot display HTML, do not select HTML
Body Only.
• Plain Body with HTML Attachment, which sends the report in plain text
format with an HTML version included as an attachment to the message.
Users can open the HTML attachments in their Web browsers.
3. In the Default Subject field, type the character string that you want Notification
to use in the subject line of outgoing Notification email messages. The default is:
Content Server Notification at %1, where %1 is a variable that inserts the
date and time based on the date and time parameters defined in the server.
4. If you selected Plain Body with HTML Attachment as the Default Message
Type in step 2, type the character string that you want Notification to use for
the name of HTML file attachments in the Default Attachment Filename field.
These are the attachments that appear in email notification messages. The
default is: %y%m%d_%H%M.html, where:
• %y inserts the four-digit year.

• %m inserts the two-digit month.
• %d inserts the two-digit day of the month.
• %H%M is the time in hours and minutes according to the 24-hour clock.
5. In the Default Content Server Database field, type the name of the current
Content Server database. Notification displays this name in the field by default.
Notification displays this database name in the headers of its reports.

6. In the Default From Address field, type the email address that you want to
appear as the sender in Notification email messages. By default, Notification
displays an email address based on the DNS name of the primary Content
Server host, for example, hostname@domain.com.
7. In the Default Reply To Address field, type the email address that you want
Notification to use as the reply to address in outgoing email messages. By
default, Notification displays an email address based on the DNS name of the
primary Content Server host, for example, hostname@domain.com.
8. In the On Error Subject field, type the character string that you want
Notification to use in the subject line of outgoing Notification error messages.
The default is: Content Server Notification Error at %1, where %1 is a variable
that inserts the date and time based on the date and time parameters defined in
the server.
9. In the On Error Address field, type the email address to which you want
Notification to send error messages. By default, Notification displays an email
address based on the DNS name of the primary Content Server host, for
example, hostname@domain.com.
10. Click Submit.
Note: If you are setting up Notification for the first time, you must also
enable Notification, configure SMTP, and configure report settings. For
more information, see “To Enable Notifications” on page 831, “To Set
SMTP Parameters” on page 834, and “To Configure Report Settings”
on page 836.
34.3.5 To Configure Report Settings

To configure Notification report settings:

2. In the Report Settings section of the Configure Notification page, type an
integer in the Maximum Events Per Pass field. This integer represents the
number of events Notification consumes each time it runs.
3. Click the desired default report type in the Default Report Type list. Currently,
Default Notifications Report is the only report type available.
4. Click one of the following display options in the Default Report Options list:
• Alternate Window, which displays the Open a new HTML browser

window when selecting links check box on the user Notification Report
Settings page.
• <None>, which does not allow the Alternate Window option for users.
5. Click a period of time after which Content Server clears notification messages in
the Clear Old Messages list.

34.4. Configuring Scheduled Activities
6. Click a period of time after which Content Server clears scheduled activities in
the Clear Outstanding Events list.
7. In each of the three Default Notification Schedule regions, do the following:
a. Type a new name in the Name field, if desired.
Note: In multilingual deployments, OpenText recommends you do

not modify the Name box. See “Configuring Default Notification
b. Select the check boxes of the days of the week on which you want
Notification to send messages in the On these days section.
c. Select the check boxes of hours during which you want Notification to send
messages on the days selected in the At these hours section.
d. Select the check boxes of times at which you want Notification to send
messages during each hour selected in the At these times section.
8. Click Submit.
Note: If you are setting up Notification for the first time, you must also
enable Notification, configure SMTP, and configure email message
settings. For more information, see “To Enable Notifications” on page 831,
To Set SMTP Parameters, and To Set Email Message Parameters.
34.4 Configuring Scheduled Activities

You can enable, configure, and schedule the following events:
• Midnight Event Producer
Runs routine system events that do not have their own Activity Schedule, and
that are scheduled to run once a day.
There is an API for developers to register handlers with this event in order to run
those handlers each time this event runs. In a default system setup, the handlers
include:
• TaskLate
which generates notifications for tasks that are overdue.
• WorkflowLate
which generates notifications for workflows that are overdue.
• WorkflowStepLate
which generates notifications for workflow steps that are overdue.
• DTreeNotifyPurge
which purges the notification tables if they aren't being used. For example, if
the system is a search-only system, then the notification tables are not being
used.

By default, this event runs at midnight on each weekday. This setting can be
changed in the Activity Schedule section.
• Provider Blob Deletion Failure Retry
If blob storage is used for a storage provider, the blob data may be retained after
a deletion; this event will try to delete any data which should no longer be
retained.
It is also possible that blob data doesn't get moved, in which case, this event will
attempt to complete any outstanding move requests.
By default, this event runs at midnight each day. This setting can be changed in
the Activity Schedule section.
• Drag and Drop Incomplete Items Notification
Notifies users via email when they drag and drop an item into a container that
has a Category with required attributes assigned to it, but have not yet
completed the required attribute information for that item. In other words, this
event sends a notification when an item, which was dragged and dropped to
Content Server, was not fully added to Content Server because of incomplete
data.
Email notifications are sent to users with incomplete items at the times you
specify in the Activity Schedule, unless the item was added within the
Completion Delay time limit. The Completion Delay setting allows users a
specified amount of time to complete items once they are dragged and dropped
into a container, before a Notification is sent out. For example, if the Activity
Schedule is set to check for incomplete items at 1:00 P.M., and the Completion
Delay is set to 30 minutes, items that are added between 12:30 P.M. and 1:00 P.M.
will be included in the next notification time specified in the Activity Schedule.
By default, this event runs every five minutes each day. This setting can be
• Clear Old Messages
Deletes notification messages older than thirty days.
This event runs every five minutes, each day. The schedule is not configurable
for this event.
The old messages will be cleared on the days and times specified on the
Midnight Event Producer's Activity Schedule.
• Failed Log-in Notification
This functionality applies to authentication mechanisms that access Content
Server directly instead of using the Directory Services (OTDS) Log-in page. For
failed log-in attempts in OTDS, please refer to the OpenText Directory Services -
In this section you can notify the administrator if the number of failed log-in
attempts within a configurable time span exceeds a configurable threshold. By
default, this event runs at midnight each day. This setting can be changed in the
Activity Schedule section.

• Consumer Five Minute Agent

This event is the same as the Midnight Event Producer except that it runs on a
different schedule. This event is used when you need to run tasks more often
than once daily.
There is an API for developers to register handlers with this event in order to run
those handlers each time this event runs. In a default system setup, the handlers
include:
• ClearCache
which clears old entries from the LLCache table.
• DistributedAgent Controller
which monitors the worker queues for stale tasks and marks them for retry or
cancel as appropriate.
• PollClosed
which reports on polls that have been closed since the last run.
• Transfer Notification Events
If Notifications is enabled and properly configured, this event moves information
from the NotifyEvents database table to the LLEventQueue table for processing.
This is a step in the processing of Content Server Notifications.
By default, this event runs every five minutes each day. You can change the
default behavior by configuring the Activity Schedule section.
In the Excluded Nodes, you can exclude specific items and their children from
Notifications. This is useful when performing bulk imports to avoid a large
number of Notifications. : A. B. C.
To exclude Node ID from Notifications:
1. On the Content Server Administration page, click Configure Scheduled

Activities in the Notification Administration section.
2. On the Configure Scheduled Activities page, select the Enable Node

Exclusion check box in the Excluded Nodes subsection of the Transfer
Notification Events section.
3. In the Excluded Nodes box, type the data IDs of the items that you want to
exclude from Notification Events. Separate multiple data IDs with commas.
Tip: You can use the data IDs of Folders and the items inside of the
folder will also be excluded from Notification Events.
• Consumer Event Processor
Developers should no longer subclass this process as it is a deprecated agent.

• Node Event Processor

Converts individual node events to message events for each user interested in
that node/event combination. You can define the number of instances of the
Node Event Processor that run concurrently.
An additional option to enable or disable permission checks for notifications to
groups and roles is available. The parameter is enabled by default, which means
permissions are checked every time a scheduled activity occurs. If the parameter
is disabled, the additional permission check only occurs when the interested user
is an individual user; the check is skipped when the interested user is a Role (for
example, for Projects or Communities).
• Disposition Search Events
This event is used to enable Disposition Searches in Records Management. This
event is disabled by default.
• Search Enabled Holds
When this event is enabled, Hold Queries in Records Management will
automatically run according to the days and times you specify in the Activity
Schedule section.
• Security Clearance Defined Rules
When this event is enabled, Security Clearance Defined Rules will be executed on
the days and times you specify for the agent, as long as the item’s Date to
Perform value has been reached. The Date to Perform value is specified when the
Defined Rule is created. When Defined Rules are executed, the item’s
Supplemental Markings and Security Clearance levels are updated according to
Defined Rule.
Note: Users can customize the three default schedules when they configure
their own personal Notification schedule.
34.4.1 To Configure Scheduled Activities

To configure Notifications scheduled activities:

Administration section, click Configure Scheduled Activities.
2. To enable the Midnight Event Producer, in the Midnight Event Producer
section, do the following:
a. In the Status field, click Enable.

b. In the Activity Schedule section, specify the days and times you want to
run the event.
3. To enable the Provider Blob Deletion Failure Retry, in the Provider Blob
Deletion Failure Retry section, do the following:


run the event.
4. To enable the Drag and Drop Incomplete Items Notification, in the Drag and
Drop Incomplete Items Notification section, do the following:

run the event.
c. In the Completion Delay field, from the Minutes list, select the number of
minutes for the delay time.
5. To clear old messages, in the Clear Old Messages section, in the Status field,
click Enable.
6. In the Failed Log-in Notification section, if you want to notify the system
administrator when the number of failed attempts to access Content Server
directly exceeds the maximum number allowed, do the following:

b. In the Activity Schedule section, specify the days and times when the
Administrator is notified.
c. In the Notify Administrator Threshold field, in the first input box, type the
maximum number of failed log-in attempts that can occur before the
Administrator is notified.
d. In the Notify Administrator Threshold field, in the second input box, type
the number of minutes within which those failed log-in attempts occurred
before the Administrator is notified.
7. To enable Consumer Five Minute Agent, in the Consumer Five Minute Agent

b. In the Purge Events field, select the Purge on Submit check box to purge
events.
c. In the Activity Schedule section, specify the days and times you want to
run the event.
8. To transfer Notification events from the NotifyEvents table to the
LLEventQueue, in the Transfer Notification Events section, do the following:

b. In the Activity Schedule section, specify the days and times when the data
is transferred.
9. To enable the Consumer Event Processor, in the Consumer Event Processor

b. In the Purge Events field, select the Purge on Submit check box to purge
events.
c. In the Activity Schedule section, specify the days and times the
Administrator receives a copy of events from the Transfer Notification
Agent.
10. To convert individual node events to message events for each user, in the Node
Event Processor section, do the following:

b. In the Purge Events field, select Purge on Submit to purge node events.
c. In the Activity Schedule section, specify the days and times when node
events are converted to message events.
d. In the Processor Options section, select Additional Permission Checks to
enable additional permission checks for every interested user in an event.
e. In the Number of processors list, select the number of instances of the
NodeEventProcessor agent handler that can run concurrently.
f. Select Process Admin user separately to evenly distribute the number of
users between the number of requested instances.
11. Click Submit.
34.5 Testing Email to Deliver Notifications

If email messages are not being delivered to addresses defined on the Configure
Notification page, you may want to test the ability of Content Server to deliver
messages to these addresses.
If you diagnose a problem, review the following steps:
• Issue the ping <mail_hostname> command at the operating system prompt of

the primary Content Server host to ensure that the host on which the server is
running can properly communicate with the mail server host.
• Review the SMTP Settings on the Configure Notification page for accuracy,
consulting your system administrator. Ensure that the Successful connection
to mail server message appears beside the SMTP Server ID box when you
move your mouse pointer from that box or from the SMTP Port box.
• Verify that the Notification email addresses are valid Internet email addresses.
• If the problem is confined to a particular user, review the user's Notification
interests and schedules for emails.
Testing Delivery to Alternate Email Addresses

The Test Alternate E-mail Settings section of the Test Notification E-mail Delivery
page allows you to test Notification email settings without modifying the Configure
Notification settings fields.

34.5. Testing Email to Deliver Notifications
34.5.1 To Test Email Delivery to the Notification Addresses

To test email delivery to the Notification addresses:

Administration section, click Test E-mail Delivery.
2. Click Send Default Messages to send a test message to the Default From
Address, Default Reply To Address, and On Error Address. The Status
column indicates whether the messages fail or succeed, and the Log column
tracks the steps involved in each message test.
34.5.2 To Test Email Delivery to the Alternate Email Addresses

To test email delivery to the alternate email addresses:

Administration section, click Test E-mail Delivery.
2. In the SMTP Server field, type the name of the SMTP server. The default for
most SMTP servers is mail.
3. In the SMTP Port field, type the port on which the SMTP server listens. The
4. In the From field, type the email address that you want to appear as the sender
in the test email message.
5. In the Reply To field, type an email address.
6. In the Recipient field, type an email address that you want to send the test
message.
7. Optional In the Subject field, type a subject.
8. Optional In the Body Text field, type the message text.
9. Click Send Test Message. The Status column indicates whether the message
fails or succeeds, and the Log column tracks the steps involved in each message
test.

34.6 Viewing Scheduling Statistics

Notification provides statistics relating to its scheduling. These statistics are for
diagnostic purposes only. OpenText Customer Support may request this
information if you call for technical assistance in using Notification.
34.6.1 To View Scheduling Statistics

To view Notifications scheduling statistics:

Administration section, click View Scheduling Statistics.
2. On the Notification Scheduling Statistics page, you will find the scheduling
statistics for Notifications.

Chapter 35
Administering Pulse
The Pulse module integrates collaboration tools, such as activity feeds, messaging,
and extended user profiles into Content Server. You can control these features by
defining maximum post lengths, configuring feed refresh settings, and customizing
user options. Exclusions are useful when individual objects or branches of the
library hierarchy cause a large number of insignificant system-generated updates in
the activity feed. To reduce the system-generated traffic, you can add the DataID for
an object or, more likely, a parent container to the Exclusions list. Changes to the
Exclusions list will affect the creation of new system-generated messages and will
not remove any existing ones. For details, see Excluding Locations or Objects from
Activity Feeds.
You can also define the content and node types that you want to include from
activity feeds. For details, see “Including Content For Activity Feeds” on page 849.
35.1 Configuring Pulse Settings

The following table provides a brief description of the configurable settings for the
Pulse module.
Configurable Settings for Pulse
Setting Description
Enable Pulse To make the Pulse features available to
your Content Server users, select Enabled.
The Pulse module is needed for OpenText
Tempo Box and OpenText ECM
Everywhere, therefore if you do not want
to make the Pulse features available to
your Content Server users when you have
one of these products installed, select
Disabled.
Max Length for Status Msgs/Comments Defines the character length limit of status
messages, comments, and public or
private messages.
Feed Refresh Interval Sets how often to refresh the activity feed
to display newer posts or comments.
Initial # of items to load in the feed Defines how many new posts to retrieve at
one time.
# of items to grow the feed via auto-refresh Sets the maximum number of new posts to
display on the page before doing a
complete page refresh.

Chapter 35 Administering Pulse
# of Recent Connections to Show Sets how many connections you want to

show in the Recent Connections list.
Disable Pulse From Here Removes the Pulse From Here option
from the Content Server Functions menu
for folders.
Allow Users to set Privacy Controls Controls whether or not users can apply
privacy controls to their personal feed
entries.
Disable Profile Photo Caching Turns off browser caching of profile
photos.
Audit Download of Profile Photos Allows auditing of profile photos.
Disable comments in Workflow Volume Removes the ability to add comments or
view comments that were previously
added to a file, when enabled.
Add a DataID to the Exclusion List Adds the DataID or a parent container to
the Exclusion List to reduce the large
number of insignificant system-generated
updates to the activity feed.
35.1.1 To Modify Message and Feed Defaults

To modify message and feed defaults:
1. On the Global Menu bar, from the Admin menu, select Content Server
Administration.
2. On the Content Server Administration page, in the Pulse Administration

section, click the Configure link.
3. On the Pulse Administration page, modify any of the following settings:
To Do this
Define the character length limit of status In the Max Length for Status Msgs /
messages, comments, and public or private Comments box, enter a maximum
messages character length between 140 and
4000 and then click Submit. The
default is 1000.
In an activity feed, all messages and
comments truncate at 250 characters.
Click the more link to see the full
status or comment. Click collapse to
reduce the display to 250 characters.
Set how often to refresh the activity feed to In the Feed Refresh Interval box,
display newer posts or comments enter the number of seconds between
feed refreshes and then click Submit.
The default is 60 seconds.

35.1. Configuring Pulse Settings
To disable automatic feed refresh In the Feed Refresh Interval box,

enter 0 and then click Submit.
Define how many new posts to retrieve at one In the Initial # of items to load in the
time feed box, enter the maximum
number of posts to display with each
auto-refresh of the feed and then click
Submit. The default is 20 posts.
Set the maximum number of new posts to In the # of items to grow the feed via
display on the page before doing a complete auto-refresh box, enter the number of
page refresh new posts to show and then click
Submit. The default is 20.
If the Feed Refresh Interval option is
disabled, the # of items to grow the
feed via auto-refresh value is
ignored. A manual refresh will
retrieve the number of new items
specified in the Initial # of items to
load in the feed option.
Note: If the # of items to grow

the feed via auto-refresh value
is disabled, that is set to 0, the
maximum number of new
posts displayed before a
complete page refresh will be 3
times the number specified in
the Initial # of items to load in
the feed box.
Set how many connections you want to show in In the # of Recent Connections to
the Recent Connections list Show box , enter the maximum
number of connections, between 1
and 200, to display and then click
Submit. The default is 20.
Once the maximum is reached, older
entries are removed from the list.
For information related to this procedure, see “Configuring Pulse Settings”

on page 845.

35.1.2 To Modify Pulse Settings for Users

To modify Pulse settings for users:
Administration.

3. On the Pulse Administration page, modify any of the settings as described in

the following table.
To Do this
Remove the Pulse From Here option from the Select the Disable Pulse From Here
Content Server Functions menu for folders check box and then click Submit.
Control whether or not users can apply privacy Select the Allow Users to set Privacy
controls to their personal feed entries Controls check box and then click
Submit. System performance may
decrease with privacy controls
enabled.

on page 845.
35.1.3 To Use Profile Photo Caching and Photo Audit

To use profile photo caching and photo audit:
Administration.

3. On the Pulse Administration page, modify any of the following settings:
To Do this
Turn off browser caching of profile photos Select the Disable Profile Photo
Caching check box and then click
Submit.
System performance may decrease
when profile photo caching is
disabled.
Allow auditing of profile photos Select the Audit Download of Profile
Photos check box and then click
Submit to track profile photo access.
System performance may decrease
with photo auditing enabled.

35.2. Configuring the Activity Feeds

on page 845.
35.2 Configuring the Activity Feeds

Content Server Pulse provides various activity feeds in both the classic user interface
as well as the new Smart Content Server user interface. As administrator, you can
configure each activity feed in the following ways:
• Which content changes will automatically trigger a content message in an
activity feed. For more information, see “Including Content For Activity Feeds”
on page 849.
• Which objects or locations to exclude from activity feed. For more information,
see “To Exclude Locations or Objects from Activity Feeds” on page 850.
• Which rules to apply to each data source and which message appears in the
activity feed when each rule is triggered. For more information, see “Configuring
Activity Manager Rules ” on page 850.
35.2.1 Including Content For Activity Feeds

You can control which items automatically generate system messages in Pulse
activity feeds by adding items for inclusion. Through the Comments option on an
item's functions menu, users can manually comment on items that do not
automatically generate activity feed entries.
Users only see activity feed updates on items that they have permissions to view.
For any item that is included, a system message is generated when the item is
created or a version is added, assuming the location is not excluded. For information
on excluding locations, see Excluding Locations or Objects from Activity Feeds.
Changes to the list will not affect existing activity feed entries.
Note: Activity feeds are independent of Collaboration features and remain

available even when Collaboration features, such as commenting and likes, are
disabled.

To Define which Item Types Generate Messages in the Activity

Feed
To define which Item Types generate messages in the activity feed:
Administration.
section, click the Include Node Types link.
3. On the Configure: Item Type for System Generated Messages page, in the
Item Types area, click the check boxes for the item types that you want to
trigger system-generated messages. By default, only Documents will trigger
system messages in the activity feed. Select Folder and any other item types that
you want to include in the activity feeds. Only item types that are selected will
automatically generate system messages in the activity feed.
4. Click Update.
35.2.2 To Exclude Locations or Objects from Activity Feeds

To exclude locations or objects from activity feeds:
Administration.
3. Type the DataID of the object or its parent container in the Add a DataID to the
Exclusions list box.
4. Click Exclude.
5. Click Submit.
35.2.3 Configuring Activity Manager Rules

To help manage the rules for the activity feeds, there is now a new activity manager
object type in the Facets volume.
Each new activity manager is associated to an activity data source. Each activity data
source, such as an attribute value, can only have one activity manager. In each
activity manager, you can define multiple rules that apply to the associated data
source.
When an attribute is modified in Content Server, the system checks whether an

activity manager has been defined for that attribute or data source. If an appropriate
activity manager exists, the Activity Rules engine will evaluate the rules in that
activity manager, in the priority order listed and, if there is a match, will display a
customizable activity feed message.

Notes
• Each activity manager evaluates the rules within in it in the order that they
are listed. For information about how to change the order of the rules, see
“To Change the Order of the Rules in an Activity Manager” on page 855.
• The activity feed message support localization and starts with a default
activity string message. Optionally, you can customize the activity string
with substitution placeholders for the attribute value.
Attribute Type Determines Valid Rules Available
Attribute Type Valid Rules

Date Pop-Up or Date Field • New value added
• Value removed
• Value changed
Check box • Value changed
• Value enabled
• Value disabled
Integer Field • New value added
• Value changed
• Value removed
• Value increased
• Value decreased
Integer Pop-Up • Value changed
• Value increased
• Value decreased
Text Pop-Up Value changed
Text Field, Text Multi-Line • New value added
• Value changed
• Value removed
User Field • Value added
• Value changed
• Value removed
Sample placeholders include the following:
Placeholders for the Activity String
Placeholder Description
[ObjName] Object Name
[AttrName] Attribute Name
[OldVal] Old Value

[NewVal] New Value
Example 35-1: Acme Value Activity Manager and Rules
For example, suppose that you have an “ACME” Connected Workspace

template that has an integer type attribute named “Value”. The following
examples, involve creating an “Acme Value” activity manager for the
“Value” attribute and add rules so that if “Value” changes, different
messages will appear in the activity feed.
Example: Rule for new higher value
Rule Increase value

Activity String [ObjName] [AttrName] increased from [OldVal] to [NewVal]
For the Block object, if this value of the distance integer value increased from 10 to 25,
according to the Activity String defined above, the activity feed would include the
following message:
Block distance increased from 10 to 25.
Example: Rule for new lower value
Rule Decrease value

Activity String [ObjName] [AttrName] decreased from [OldVal] to [NewVal]
For the Block object, if this value of the distance integer value decreased from 10 to 5,
following message:
Block distance decreased from 10 to 5.
Example: Rule for new value
Rule New value added

Activity String [ObjName] [AttrName] set to [NewVal].
For the Block object, if the value of the distance integer value increased from 10 to 20,
following message:
Block distance set to 20.
Example: Rule if value deleted
Rule Value removed

Activity String [ObjName] [AttrName] has been deleted.
For the Block object, if the value of the distance integer value was deleted, according to
the Activity String defined above, the activity feed would include the following
message:

Block distance has been deleted.
To Create a New Activity Manager

To create a new activity manager:
2. In the Facets volume, click Add Item and then click Activity Manager.
Tip: You can create folders within the Facets volume, to help organize the
activity manager objects.
3. On the Add: Activity Manager page, do the following:
a. In the Name box, enter a name for the new activity manager.
b. Optional In the Description box, enter a brief description of the rules in the
activity manager.
c. In the Data Source box, click the list to select from the list of available
activity data sources.
Notes
• You can only use each data source once. After you associate a data
source with an activity manager, that data source then becomes
unavailable.
• All rules for that data source will be managed in the same activity
manager.
d. Optional In the Categories box, enter a category for the activity manager.
e. Optional If you want to change the location for the activity manager, in the
Create In box, click Browse Content Server to select a new folder.
4. Click Add.
To Add a New Rule to an Activity Manager

To add a new rule:
2. In the Facets volume, click the activity manager associated with the activity data
source for which you want to add a new rule.
3. On the <ActivityRuleName> page, on the Specific tab, in the Modify column,
click New .
4. On the Add New Rule page, provide the following information:
5. Click Submit.

To Edit a Rule in an Activity Manager

To edit a rule:
source for which you want to edit a rule.

click Edit .
4. Modify one or more of the following:
Field Name Description

Rule Name Enter the descriptive name for the rule.
Rule Criteria Click the rule that you want from the list.
Note: The rules available in the list will

depend on the type of the associated data
source.
Activity String Optionally, if you want to modify the message that
will appear in the activity feed when this rule is
triggered, click Edit . For information about how
to compose the activity string, see “To Customize
the Activity String in a Rule” on page 855.
Object Types Optionally, if you want to restrict the activity feed
events to evaluate against only a specific object
type, in the Included Object Types box, click one
or more object type that you want to exclude from
the activity feed events evaluation and then click
Exclude to move it to the Excluded Object
Types box. For example, you might want to
generate an activity feed post when the
Opportunity:Value changes only a business
workspace object and not for a document.
Note: By default, all object types appear in

the Included Object Types box and will
generate an activity feed event.
Important
Editing of a rule takes effect immediately as a live update and does not
require you to click Save or Submit.

To Customize the Activity String in a Rule

To customize the activity string:
1. On the <ActivityRuleName> page, in the Activity String box, compose the

message that will appear in the activity feed when something triggers the rule.
Use text and the following optional placeholders:
Placeholders for the Activity String
Placeholder Description
[ObjName] Object Name
[AttrName] Attribute Name
[OldVal] Old Value
[NewVal] New Value
2. Click Save.
To Delete a Rule from an Activity Manager

To edit a rule:
source for which you want to delete a rule.
3. On the <ActivityRuleName> page, on the Specific tab, click Delete .
To Change the Order of the Rules in an Activity Manager

To edit a rule:
2. In the Facets volume, click the activity manager associated with the rules that
you want to reorder.

click the Up or Down arrows to move the rules into the order that you
want.

Chapter 36
Configuring Collaboration Settings
The Pulse module also controls the Collaboration features in both the classic UI and
in the new standard UI. The Collaboration features include the following:
• Commenting
In Content Server 16, users can comment on status updates and content items in
both the Classic View and in the new Smart View. Administrators can configure
Content Server to include a custom comments column that will appear in the
Classic View as a new column in the browse view and in the new Smart View as
the Commenting widget. For information about how to configure the custom
comment column, see “To Configure the Custom Comments Column”
on page 861.
• Liking
For Content Server 16, users will have the ability to like a post or content item
from the Classic View. You can click the Like link for each status update, content
message, or content item.
Note: Like functionality is not yet supported in the new Smart View.
On your Pulse page, you can see which items you have liked. You can also see
which items another user has liked, on their Pulse page.
Note: Activity feeds are independent of Collaboration features and remain

available even when Collaboration features, such as commenting and likes, are
disabled.
As administrator, you can use Pulse to configure these Collaboration features for the
supported object types. The supported object types are listed on the Collaboration
Administration page, in the Select Object Type(s) list. The object types in this list
will change dynamically as modules are installed and removed. Examples of
possible object types may include the following:
• ActiveView
• Activity Manager
• Appearance
• Category
• Category Folder
• Channel
• Collaborative Place

Chapter 36 Configuring Collaboration Settings
• Collection
• Column
• Compound Document
• Content Move Job
• Content Move Job Folder
• CS Application Manifest
• Custom View
• Discussion
• Document
• E-mail
• E-mail Folder
• Facet
• Facet Folder
• Facet Tree
• Folder
• Form
• Form Template
• Global Appearance
• IM Place
• LiveReport
• Milestone
• News
• Note
• Poll
• Process Folder
• Project
• Prospector
• Realtime Process Folder
• Reply
• Task
• Task Group
• Task List
• Template Folder

36.1. Configuring System-level Collaboration Features
• Topic
• Transport Package
• URL
• Virtual Folder
• Warehouse Folder
• Web Forms Database Connection
• Web Forms Database Lookup
• WebReport
• Workbench
• Workflow Map
• Workflow Status
• XML DTD
Pulse allows you to configure Collaboration features at the system level as well as at
the level of individual objects.
• “Configuring System-level Collaboration Features” on page 859

• “Configuring Object-level Collaboration Features” on page 863
36.1 Configuring System-level Collaboration Features

Pulse allows you to configure the following system-level Collaboration features:
• “To Configure System-level Collaboration Features” on page 859

• “To Configure the Custom Comments Column” on page 861
36.1.1 To Configure System-level Collaboration Features

To configure system-level Collaboration features:
Administration.

section, click the Collaboration Administration link.
3. On the Collaboration Administration page, in the Add Managed Object Type

area, in the Select Object Type(s) list, select one or more check boxes for the
object type for which you want to manage Collaboration features, and then click
Add Object Type .

Important
When you add an object type, the Collaboration features are disabled by
default. You must explicitly enable the Collaboration features that you
want.
4. In the Manage Collaboration Features area, ensure that the Collaboration

Feature Availability check boxes are selected for the Collaboration features that
you want to enable for the object type.
To Do this
Enable Select the check box in the Comments column.
Commenting
Enable Replies Select the check box in the Comment Replies column.
to Comments
Enable Select the check box in the Document Attachments column.
Document
Attachments
Enable Select the check box in the Content Server Shortcuts column.
Shortcuts to
Content Server
Enable Likes Select the check box in the Likes column.
Important
• A Collaboration feature must first be enabled at the system-setting
level, before you can enable it at the object-type level.
• If an administrator or an end user configured specific Collaboration
feature settings and then ana administrator disables that
collaboration feature at the system level, Pulse will save the
collaboration features settings and reinstate them if the administrator
later re-enables that feature at the system level.
• For those object types that do not support social collaboration feature
modifications by an end user, the object type-level settings made by
the administrator will be in effect.
5. On the <ObjectTypeName> row for the object type that you added in Step 3, select
the Collaboration features that you want to enable for that object type:
To Do this
Enable Select the check box in the Comments column.
Commenting
Enable Replies Select the check box in the Comment Replies column.
to Comments
Enable Select the check box in the Document Attachments column.
Document
Attachments

36.1. Configuring System-level Collaboration Features
Enable Select the check box in the Content Server Shortcuts column.
Shortcuts to
Content Server
Enable Likes Select the check box in the Likes column.
Note: If the check box for the Collaboration feature is unavailable, then the
feature is disabled at the system level. To enable the feature at the object-
type level, you must first enable the feature at the system level in the
Collaboration Feature Availability area.
6. In the User Collaboration Control area, if you want to allow the end user to
enable or disable Collaboration features on individual objects, select the Allow
users to modify collaboration feature settings on individual objects check box.
For more information about how to manage Collaboration features for
individual objects, see “Configuring Object-level Collaboration Features”
on page 863.
Notes
• This applies to individual instances for all supported object types listed
in the Select Object Type(s) listed in Step 3.
• If disabled, end users are not permitted to control Collaboration features
for individual objects, then the adminstrator-set, system-level
configuration will be in effect.
36.1.2 To Configure the Custom Comments Column

To configure the custom Comments column:
1. Make the custom Comment column available by performing the following

steps:
a. On the Global Menu bar, from the Tools menu, select Facets Volume.
b. From the Comments Functions menu, select Properties > Availability.
c. On the Facets > Comments page, in the Column Availability box, select
one of the following options:
• Available everywhere
• Only available in specific locations
d. Click Update.
2. Make the custom Comments column available to be added to the browse view
by performing the following steps:
a. On the Global Menu bar, from the Admin menu, select Content Server
Administration.
b. On the Content Server Administration page, in the Server Configuration
section, click Configure Presentation.

c. On the Configure Presentation page, click Configure Container Options.

d. On the Configure Container Options page, in the Column Customization
area, click the Allow Browse List Column Customization check box.
3. Add the custom Comments column to the Enterprise Workspace by performing

the following steps:
a. On the Global Menu bar, from the Enterprise menu, select Workspace.
b. From the Enterprise Functions menu, select Properties > Columns.
c. On the Enterprise Properties page, in the Columns tab, in the Local
Columns area, in the Available Columns box, click Comments, and then
click Add selected columns to the list of Displayed Columns .
d. Click Update.
4. Optional Now that the custom Comments columns has been added to the
Enterprise Workspaces, you can enable the Comment widget by performing the
following steps:
a. On the Global Menu bar, from the Admin menu, select Content Server
Administratrion.
b. On the Content Server Administration page, in the Pulse Administration
section, click Collaboration Adminstration.
c. On the Configure: Collaboration Adminstration page, in the Select Object
Types to Manage area, in the Select Object Types list, click the check box
for required object type and then click Add Object Type .
d. In the Manage Collaboration Features area, on the row for the object type
added in Step 4.c, select one or more of the following check boxes as
required:
• Enable Commentingico-pencil.gif
• Enable Replies to Comments
• Enable Document Attachments
• Enable Shortcuts to Content Server
• Enable Likes
e. Click Update.
f. On the Global Menu bar, from the Admin menu, select Content Server
Administratrion.
g. On the Content Server Administration page, in the Pulse Administration
section, click Included Node Types.
h. On the Configure: Item Type for System Generated Messages page, in the
Item Types area, click the check boxes for the item types that you want to
trigger system-generated messages.
i. Click Update.

36.2. Configuring Object-level Collaboration Features
36.2 Configuring Object-level Collaboration Features

If you have already enabled system-level Collaboration features, such as the Allow
users to modify collaboration feature settings on individual objects option, Pulse
also allows you to further configure Collaboration features at the level of individual
objects.
Note: Some of the object-level collaboration features only affect the new Smart
View.
36.2.1 Configuring Object-level Collaboration Features

If you have already enabled commenting, replies to comments, document
attachments, and shortcut attachments all at the system level, you can further
configure these commenting features at the individual object level. “Object Level
Collaboration Settings” on page 863 describes the object-level Collaboration
commenting settings and their impact in both the Classic View and in the new Smart
View.
Object Level Collaboration Settings
Name Description
Enable By default, commenting is disabled. After installation, an administrator
Commenting must explicitly enable commenting at the system level. For more
information about how to enable commenting, see “Configuring System-
level Collaboration Features” on page 859.
• Classic View
If enabled, in the browse view, the Comment command appears in the
object Functions menu. End users can open the Pulse page and access
the commenting functionality as defined by the following
Collaboration check boxes. If comments have been added, uses can
also click the Show Comments icon to open the Pulse page for that
object.
If disabled, no link appears, any comments or replies are hidden, and
end users will not have access to any commenting functionality.
• Smart View
If enabled, the Comment icon appears and end users can access
the commenting functionality as defined by the following check boxes.
If disabled, no icon appears and end users will not be able to see any
comments and will not have any access to any commenting
functionality.

Enable Opening • Classic View

of Comments If enabled, end users can click the Comment link and, if any comments
or replies have been added, can also click the Show Comments icon
to open the Pulse page for the object. On the Pulse page, the user
can add their own comments or replies, and can edit their own
comments and replies.
If disabled, end users will still see the Comment link and Show
Comments icon and open the Pulse page for that object to see the
existing comments and replies, but cannot add their own comments or
replies and cannot edit their own comments or replies.
• Smart View
If enabled, end users can click the Comment icon to see existing
comments or replies, add their own comments or replies, or can edit
their own comments and replies.
If disabled, end users can still see existing comments and replies, but
cannot add their own comments or replies or edit their own comments
or replies.

Enable Replies If replies are enabled, only the owner of the reply can delete their own
to Comments reply.
An administrator can delete a comment or reply made by another user.

Also, the owner of the reply can delete their own reply. However, if
someone deletes the object to which the reply is attached, then all
comments and replies are also deleted.
• Classic View
If enabled, on the Pulse page for that object, end users can view replies
and can use the Comment link to add replies to existing comments
and can edit their own replies.
If disabled, end users can still view existing replies, but cannot add
new replies to existing comments and cannot edit any of their own
replies.
Notes
•An administrator cannot delete a comment made by another
user. Only the owner of the comment can delete their own
comment.
• Only the reply owner can delete a reply.
• An administrator or the object owner can delete the object to
which a comment or reply is attached. Deletion of the object
automatically deletes all attached comments and replies.
• Smart View
If enabled, the Reply link appears underneath each Comment and end
users can view replies and can add replies to existing comments and
can edit their own replies.
If disabled, end users can still view existing replies, but cannot add
new replies to existing comments and cannot edit any of their own
replies.
Notes
• An administrator can delete a comment or reply made by
another user. Also, the owner of the reply can delete their own
reply.
• Only the reply owner or an administrator can delete a reply.
• An administrator or the object owner can delete the object to
which a comment or reply is attached. Deletion of the object
automatically deletes all attached comments and replies.

Enable • Classic View

Document If enabled, on the Pulse page for that object, when the user clicks in the
Attachments
Add a Comment box, the Attach Document icon appears. Clicking
Attach Document allows the user to browse their desktop to select a
document to attach.
If disabled, no icon appears. End users can still see existing
attachments, but cannot attach any documents from their desktop
computer to their own comments and replies.
• Smart View
If either attachments, or shortcuts, or both are enabled, the Attachment
icon appears in the Comment box or the Reply box. By clicking
the Attachment icon , the Attach File box opens and a user can
then click From Content Server to attach a shortcut, or click From
Your Desktop to attach a file from their desktop computer.
For existing comments, the Attach File icon appears if the
administrator has enabled either attachments, shortcuts, or both.
If disabled, no icon appears. End users can still see existing
attachments, but cannot attach any documents from their desktop
computer to their own comments or replies.
Enable • Classic View
Shortcuts to If enabled, on the Pulse page for that object, when the user clicks in the
Content Server
Add a Comment box, the Attach Shortcut icon appears. Clicking
Attach Shortcut allows the user to browse Content Server to select a
shortcut to a document.
If disabled, no icon appears. End users can still see existing shortcuts,
but cannot attach any shortcuts from Content Server to their own
comments or replies.
• Smart View
If enabled, when the user clicks the Attachment icon in the

Comment box or the Reply box, the user will not only have the option
of specifying to attach a file from their desktop computer, they will
also have the option to select a shortcut to a document in Content
Server.
If disabled, when specifying an attachment to a comment or a reply,
end users can see existing shortcuts, but will not have the option to
select a shortcut to a document in Content Server.

Enable Likes • Classic View

If enabled, on the Pulse page for the object, the Like link appears at the
end of the row for each comment or reply. Users can click Like to
indicate their approval. If users have previously liked a comment or
reply, the Unlike link appears and users can click Unlike to retract
their approval.
If disabled, no link appears and end users cannot like the object.
• Smart View
Like is not yet supported in the Smart View.
Note: There are a few commenting feature differences between the Smart View
and the Classic View:
• With Pulse in the Classic View, an administrator can only delete their own
comments or replies, in the Smart View, an administrator can delete any
comments or replies from any user.
• An administrator can delete just the attachment or just the shortcut
associated with a comment or a reply.
• If someone deletes the object to which a comment or reply is attached, then
all the attached comments and replies are also deleted.
• With Pulse in the Classic View, users can Like a comment or reply, in the
Smart View, Like functionality is not yet supported.
• In the Smart View, users can edit their own comments and replies. Pulse, in
the Classic View, does not support editing of comments and replies.
To Configure Object-level Collaboration Features

To configure object-level Collaboration features:
1. Navigate to the object in Content Server on which you want to configure object-
level Collaboration features.
2. In the browse view for the object, click the Functions menu, then select
Properties > Collaboration.
3. On the Properties page for the object, on the Collaboration tab, in the Social
Collaboration Functionality area, click the check boxes for the commenting
functionality that you want to enable, as described in “Object Level
Collaboration Settings” on page 863.
4. Click Update.

Chapter 37
Content Server Collaboration Widget Configuration
This section describes the use and configuration for the following Content Server
Collaboration widgets:
• “Activity Feed Widget Configuration” on page 869
To use the Content Server Collaboration widgets, you must include and configure
each widget in a perspective.
37.1 Activity Feed Widget Configuration

The Activity Feed widget can appear at the following locations in the Content Server
Smart View of the UI:
• By default, the Activity Feed widget always appears on the on the Following/
Followers tab of each User Profile.
• Depending on configuration, in the Content Server Smart View, the Activity Feed
widget can optionally appear on a landing page perspective or at the container
level perspective.
• If you have Connected Workspaces installed, you can embed the Activity Feed
widget into the Header widget of Connected Workspaces.
Important
You must have the following prerequisites in place before you can begin to
configure the Activity Feed widget:
• Content Server 16 should be installed and running.

• The Activity Feed widget must be included in a perspective.
After you have included the Activity Feed widget in your perspective, you can
configure the following parameters:
Activity Feed Widget Configuration Parameters
Name Description
Wrapper Class Enter the wrapper class to be applied to the activity feed list. If the
wrapper class is set to the Hero tile view/black theme, then the activity
feed will also be black.

Chapter 37 Content Server Collaboration Widget Configuration
Feed Size Enter the maximum number of feed items or posts to be included in each
feed page.
Default = 20
Important
The minimum feed size must be 10 or higher or else the scroll bar
will not be available and users may not be able to view all feed
items.
Feed Type Optional. Enter the type of feed. Possible values include status, content,
and attribute.
Default = all
Feed Settings Select the following feed setting options:
• Enable Comments – Select whether or not you want to allow comment
and replies on the activity feed posts.
Default = True
• Enable Filters – Select whether or not you want to enable the end user
to filter the activity feed posts that appear on the tile when the tile is
expanded. If set to True, the ActivityFeed widget will show the activity
feed based on the feed source setting with the filter enabled. If set to
False, the ActivityFeed widget will show the feed based on the feed
source without the filter.
Default = False
Honor Feed Select whether or not the widget will consider Pulse as the source of the
Source feed. If set to true, the feed will use the current container or folder and its
descendants as the source. If set to false, the feed will use the source set in
the perspective.
Default = False
Feed Source Specify the non-Pulse source for the feed posts.
• Source – Enter the name of the source of the activity feed to be
displayed on the tile. Possible values include: all, node, and pulsefrom.
• All – Any activity done in Content Server.
• Node – Only the activities of that particular item appear.
• Pulsefrom – The activities of that particular item and all sub-items
appear.
Default = all
• Id – If the Source is configured to be node or pulseform, enter the
object ID of the source of the activity feed to be displayed on the tile.
Updates From Choose the source to be used for the feed.
• From – Possible values include: all, iamfollowing, myfollowers,
following, followers, myupdates, mentions, myfavorites, user, group
Default = all
• Id – If From is set to following, followers, user, or group, then you
must specify the User ID or group ID of the applicable user or group.

37.1. Activity Feed Widget Configuration
Config Settings Specify the widget-instance level configuration settings.

• Activity Feed Auto Refresh Wait – Specify the time interval, in
seconds, between feed auto-refreshes.
Default = 60000
• Maximum Message Length – Specify the number of characters for the
maximum length for a comment or reply to a post. If this value is not
explicitly configured for the widget, then it will default to the same
values as that set on the Pulse Administration page for the Max
Length for Status Msgs /Comments (140–4000 characters)
Default = 1000
Example 37-1:
An example of the configuration code for an Activity Feed widget might

appear as follows:
{"sizes":
{"sm": 6,"md": 6,"lg": 6}
,"widget": {"type": "esoc/widgets/activityfeedwidget",
"options": {
"feedsize": 20,
"feedtype":"status,attribute",
"feedsource":
{"source":"all"}
,
"feedSettings":
{"enableComments":true, "enableFilters" : true}
,
"updatesfrom":
{"from":"myfavorites"}
}}}
]}

Part 9
Document Administration
Chapter 38
Working with Item Templates
The Templates Volume is a container for storing Project Templates and organizing
them in Template Folders. You can copy, move, and delete items, and add
Templates and Folders to the volume and to any Folder within it. These containers
are also configurable.
38.1 Creating Templates

When creating a Project Template, Content Server takes a “snapshot” of the Project
you want to base it on. The snapshot includes all of its contents, such as its
Participants, Tasks, Documents, and Discussions. When you create a Project based
on a Project Template, the Template is copied into the new Project. You can create a
Project Template in the Templates Volume or from an existing Project's Functions
menu. To do this, you must have the Add Item permission on the container where
you add the Project Template.
The Custom View template allows you to add a Custom View file that can be
accessed by users when they are creating a Custom View in a Folder or Workspace.
When you add a Custom View Template to the Templates Volume, users will see it
in the Content Server Templates volume, which is the container that appears by
default when a user adds a Custom View. Only administrators, or users with Admin
rights, can delete Custom View templates from the Templates Volume.
Note: If the permission of the folder in which a Custom View with a saved
Search Form is located is changed, without modifying the permission of the
saved Search Form, a user may not be able to access the folder.
38.1.1 To Add a Template Folder

To create a Project Template Folder:
1. Click the Open the Templates Volume link in the Item Template
Administration section on the Content Server Administration page.
2. Click Template Folder on the Add Item menu.
3. To provide a name other than the default name, type it in the Name field.
4. To add a description of the Folder's contents, type it in the Description field.
5. To modify the Categories or Attributes associated with the Folder, click the Edit
button.
6. To add the Folder to a different container, click the Browse Content Server
button, navigate to the container, and then click its Select link.

Chapter 38 Working with Item Templates
7. Click Add Item.
38.1.2 To Add a Project Template

To add a Project Template:
• Click the Open the Templates Volume link in the Item Template
Administration section on the Content Server Administration page, and
then click Project Template on the Add Item menu.
• Click a Project's Functions icon, and then choose Make Template.
2. To provide a name other than the default name, type it in the Name field.
3. To add a description of the Project Template, type it in the Description field.
4. To create the Template based on an existing Project, do the following:
• Click the Project radio button.

• Click the Browse Content Server button, navigate to the Project, and then
click its Select link.
5. To create the Template based on an XML file, do the following:
• Click the File (*.xml) radio button.

• Click the Browse button, navigate to the XML file, and then click the Open
button.
6. To modify the Categories or Attributes associated with the item, click the Edit
button.
7. To add the Template to a different container, click the Browse Content Server
button, navigate to the container, and then click its Select link.
8. Click Add Item.
38.1.3 To Add a Custom View Template

To add a Custom View Template:
1. Click the Open the Templates Volume link in the Item Template
Administration section on the Content Server Administration page.
2. On the Content Server Templates page, click Custom View Template on the
Add Item menu.
3. On the Add Custom View Templates page, type a name for the template in the
Name field.
4. In the Source area, do one of the following:

38.2. Exporting Item Templates
• Click the Custom View radio button, click the Browse button to navigate to
the customview.html file you want the template created from, and then
click its Select link.
• Click the File radio button, click the Browse button to navigate to the .xml
file you want the template created from, and then click Open
5. Specify any other general item settings.
6. Click Add.
38.2 Exporting Item Templates

You can export Project Templates and Custom View Templates. A copy of the
template is saved as an XML file that can be imported to a Content Server instance
or exported to a different storage medium.
When you export a Custom View or Project template, all data that is stored in
LLNode is exported.
38.2.1 To Export a Template

To export a Template:
1. Click the Functions icon for a Project or Custom View.
2. From the Functions menu, click Export Template.

Chapter 39
Configuring Web Edit Settings
On the Web Edit Administration page, you can specify the editor used when
editing a supported document type, disable automatic installation from the Web, set
the MIME type for supported documents, and specify supported document types for
the Add New functionality.
Setting Editor Precedence
Set the Editor precedence to indicate which editor should be used when editing a
supported document. The editors available for configuration depend on the Content
Server modules in use, but can include OpenText™ Office Editor and OpenText™
WebDAV. When you set the Editor preference, you assign a numeric value to each
editor, assigning higher values to the editors with greater precedence.
Specifying Office Editor Settings
You can specify the name of the repository as you want it to appear in the Location
column in the Office Editor desktop client. If you do not provide a name, Office
Editor will create one using the <host>/<contentserverfolder> format. If there is
more than one repository with the same name, the most recently configured
repository is used, and a number is appended to each of the previous versions. For
example, a duplicate instance would be renamed to Content Server (2).
Note: The repository name that you specify is not used if OpenText™
Enterprise Connect is installed on the client. In this case, the name of the
Enterprise Connect plug-in is used instead.
When you select the Enable Installer Download check box, you enable users to
download and install the Office Editor client from the Content Server Web UI. This
is the default setting. If you clear this check box, users will not be able to download
and install, and you must arrange for any installations or upgrades.
You can control when users upgrade to the most recent version of the Office Editor
client using the options in the When a new version is available list. When users
working with an older version of the Office Editor client try to open or edit a
document, you can specify one of the following options:
• Never prompt users to upgrade by choosing Do not display or prompt for

upgrade. This is the default setting.
• Allow users to either upgrade or continue working by choosing Provide users
with the option to upgrade, or continue using any compatible older version.
Users receive a message prompting them to either upgrade to the most recent
version of the Office Editor client using the link provided, or continue working
with their current version.

Chapter 39 Configuring Web Edit Settings
• Force users to upgrade before they can proceed by choosing Force users to
upgrade. Users receive a message prompting them to upgrade to the most recent
version of the Office Editor client using the link provided.
Notes
• If Enterprise Connect is installed, this setting is ignored and the Office Editor
client installation or upgrade is handled by the Enterprise Connect
installation or upgrade.
• If you select either the Provide users with the option to upgrade, or
continue using any compatible older version or the Force users to upgrade
option, you must also select the Enable Installer Download check box to
allow users to install the Office Editor client.
You can configure how the Open function in Content Server works. You can specify
that all documents are opened using the Content Server default implementation
(doc.Fetch). In this case, Office Editor is not used when users open a document.
Select this option if you want users to be able to open Content Server documents
without having to install Office Editor. Alternatively, you can specify that all
supported MIME types, as determined by the options you specify in the MIME
Types for Office Editor section, are opened using Office Editor. In this case, Office
Editor automatically downloads the document to the document cache and then
opens it from there.
You can enable or disable caching of recently used documents. By default, all
documents are retained in the document cache. If you clear the Enable Document
Caching check box, unused documents are deleted from the cache. For example, if
the check box is cleared, and the user opens, edits, and then closes a document, the
document will be removed from the document cache. Documents that are in a
conflict state remain in the document cache until the conflict is resolved. Also,
documents that are in use remain in the cache until they are closed. This setting only
applies to the following types of documents.
.docx .docm .doc .dotx

.dotm .dot .xlsx .xlsm
.xlsb .xls .xltx .xltm
.xlt .pptx .pptm .ppt
.potx .potm .pot .ppsx
.ppsm .pps .ppam .ppa
.mpp .mpt .vsdx .vssx
.vstx .vsdm .vssm .vstm
.vsd .vdw .vsw .vss
.vst .pdf .wpd

39.1. To Configure Web Edit Settings
Notes
• This setting only applies to documents that are edited from the Content
Server Web UI using Office Editor, where Enterprise Connect is not installed.
You must make additional changes in Enterprise Connect to apply this
setting to documents edited in Enterprise Connect. For more information,
see OpenText Enterprise Connect - Installation Guide (NGDCORE-IGD).
• Users must restart the Office Editor client to apply any changes that you
make to this setting.
Specifying MIME Types
You can specify the MIME types that editors support, to indicate which documents
can be modified when using a specific editor. For the selected editor, you specify the
MIME types that you want to support for Microsoft Word, Excel, PowerPoint,
Project, and Visio documents. For example, you can specify that Office Editor
supports all MIME types or just specified ones. You can edit the list of supported
MIME types as required. If you are using WebDAV as your editor, you can edit the
list of supported MIME types as well.
Specifying Supported New Document Types
You specify the supported document types for the Add New document functionality
by enabling or disabling specific document types. For example, you may want to
allow users to add new Microsoft Word documents, but not PowerPoint documents.
The supported document types that you specify display in the Add New list on the
Add Document page.
Tip: You can modify default documents for the Add New functionality. When
a user chooses to add a new document, the default document that you
specified automatically opens in the associated desktop program. For example,
you can modify a Word 2010 document by replacing the default blank
document in the support\webedit directory of your Content Server
installation with the custom default document that you want to use.
39.1 To Configure Web Edit Settings

To configure Web Edit settings:
1. On the Content Server Administration page, under Web Edit Administration,

click Configure Web Edit Settings.
2. In the Editors area on the Configure Web Edit Settings page, specify the editor
preference by typing a numeric value in the box of each available editor.
Tip: You can make an editor unavailable by specifying a negative value.
3. In the Office Editor Settings area, in theContent Server Display Name box,
provide the name of the repository as you want it to appear in the Office Editor
desktop client.

Chapter 39 Configuring Web Edit Settings
Tip: If you do not provide a name, the <host>/<contentserverfolder>

format is used. For example, intranet.opentext.com/intranet or
localhost:8080/otcs.
4. In the Office Editor Settings area, do one of the following:
• Select the Enable Installer Download check box if you want users to install
the Office Editor client. This is the default setting.
• Clear the Enable Installer Download check box if you do not want users to
be able to install the Office Editor client.
5. In the Office Editor Settings area, in the When a new version is available list,
do one of the following:
• Choose Do not display or prompt for upgrade if you do not want to prompt
users to upgrade to the most recent version of the Office Editor client. This is
the default setting.
• Choose Provide users with the option to upgrade, or continue using any
compatible older version if you want to let users decide if they want to
upgrade to the most recent version of the Office Editor client.
• Choose Force users to upgrade if you want users to immediately upgrade to
the most recent version of the Office Editor client.
Note: If you select either the Provide users with the option to upgrade, or
continue using any compatible older version or the Force users to
upgrade option, you must also select the Enable Installer Download
check box to allow users to install the Office Editor client.
6. In the Use doc.Fetch for All Opens check box, do one of the following:
• Clear the check box to open all configured documents, as you have specified
in the MIME Types for Office Editor section, in their native applications. If
you select this option, Office Editor automatically downloads the document
to the document cache and then opens the document from there. This is the
default setting.
• Select the check box to open all documents using the Content Server default
implementation (doc.Fetch). If you select this option, Office Editor is not
used when users open a document.
7. In the Enable Document Caching check box, do one of the following:
a. Select the check box to keep all recently used versions of documents edited
with Office Editor. This is the default setting.
b. Clear the check box to delete all recently used versions of document edited
with Office Editor.
8. In the MIME Types for Office Editor area, do one of the following:
• Click Support Office Editor for all documents if you want to use Office
Editor to open and edit all types of documents.

39.1. To Configure Web Edit Settings
• Click Support Office Editor for selected MIME types if you want to use
Office Editor to open and edit only the specified document types. You can
edit the list of supported MIME types as required. This is the default setting.
Caution
Although it is possible to add other MIME types to this setting, to
validate this functionality for your environment’s target applications,
you must perform thorough testing on any application you intend to
deploy in a production environment. Any issues found with the
functionality should be raised with OpenText customer support. This
functionality is provided “as is” without warranty of any kind, either
expressed or implied. Issues concerning this functionality will be
evaluated on a case-by-case basis without any guarantee of resolution.
Note: If the WebDAV module is installed, a similar list appears for

supported WebDAV MIME types. You can edit this list as required.
9. In the Add New Documents area, click the document types that you want to
display on the Add Document page in the Add New list.
10. Click Submit.

Chapter 40
Administering and Configuring Renditions
The OpenText Renditions module enables Content Server to generate and maintain
Renditions of Documents. A Rendition is a special kind of item, closely related to a
Document or Version, that has either of the following characteristics:
• It contains the same information as the original Document, but presents the
information in a different file format. For example, a spreadsheet file can be
renditioned in Portable Document Format (PDF), or a graphic in JPEG format
(JPG) can be stored and renditioned in Tagged Image File format (TIF). Content
Server can automatically generate this type of Rendition.
• It is in the same file format as the original Document, but its contents differ. For
example, a Microsoft Powerpoint Document written in English can have a
Rendition that is also a PowerPoint file, but whose content has been translated
into French. This type of Rendition must be created manually.
Renditions works with an external renditioning engine. A renditioning engine is a

third party program that converts a file from one format to another. The conversion
of file formats is known as renditioning. The renditioning logic is configured in the
renditioning engine. The renditioning engine is not supported, configured, or
documented by Content Server and the renditioning engine exchange files by means
of shared directories on the file system. For more information, see “Administering
Renditions” on page 887.
Most Renditions are automatically created when a Document (or a Version) is added
to Content Server or to a particular container in Content Server. This is based on
settings determined by the Content Server Administrator or another privileged user.
Renditions are generated automatically using “Global Renditioning” on page 885,
“Selective Renditioning” on page 886, or “Ad Hoc Renditioning” on page 886.
Global Renditioning
Global renditioning requests a Rendition automatically for every Document or
Version added to Content Server. The Rendition request is based on the MIME type.
When Global renditioning is enabled, a Rendition is requested anytime a Document
or Version is added to Content Server, where the Document or Version has a MIME
identified in the Rendition Rule. Global renditioning must be enabled and there
must be a Rendition Rule applied globally for Global renditioning to work.
For Content Server systems where Renditions are a normal requirement, Global
renditioning is the easiest way to maintain Renditions. However, this option
requires processing overhead and sufficient storage space for the large number of
Renditions generated.

Chapter 40 Administering and Configuring Renditions
Selective Renditioning
Selective renditioning is similar to Global renditioning, but applies only to a specific
Folder or Compound Document, or to Versions added to a specific Document.
Selective Renditions are enabled by subscribing a Document or Container for
renditioning. When a container is subscribed, a Rendition Rule states that any
Document added to that container is sent for renditioning, only if it has a MIME
type identified in the Rendition Rule that applies to the container.
Note: Selective renditioning override Global renditioning.
Ad Hoc Renditioning
Ad Hoc renditioning requests a one-time Rendition of a specific Document,
Documents in a Compound Document, or Folder. Ad Hoc Renditions are generated
based on the available Rendition Rules selected at the time of the request. The user
may select more than one Rendition Rule to apply, so long as there is more than one
Rendition Rule defined for the file type of the Document. The Document will only be
available for renditioning if it has a MIME type identified in a Rendition Rule.
Note: Ad Hoc renditioning and Selective renditioning do not affect each other.
Rendition Rules
Renditions are made according to Rendition Rules that are defined by the Content
Server Administrator. Rendition Rules specify the set of MIME Types that require
Renditions, and whether or not they are to be applied globally. Every time a
Document or Version of the specified MIME type is added, Content Server
immediately schedules it for renditioning. A Rendition Rule designates a specific
shared directory, or directories, as a staging area for files of a specific MIME type
that require Renditions.
For example, if Rendition Rule 1 is configured so that files with the

application/msword MIME type are placed in the shared directory D:\Renditions
\Word_Versions, then all Microsoft Word files that are submitted for renditioning
will be placed in the D:\Renditions\Word_Versions directory for the renditioning
engine to upload. If Rendition Rule 1 is applied globally, then all
application/msword files that are added to Content Server will automatically be
submitted for renditioning, placed in this directory, and eventually uploaded to the
renditioning engine. A Rendition Rule may be configured with more than one
shared directory for load-balancing purposes.
Note: Open Text recommends that separate Rendition Rules not share the
same directory.

40.1. Administering Renditions
The renditioning engine must be configured to know what to do with the files in
each Version Folder. For example, it must be configured to know that the
application/msword files placed in the D:\Renditions\Word_Versions directory
are to be converted to the application/pdf MIME type.
If a Document is subject to more than one Rendition Rule, rules for Selective
renditioning override the rules for Global renditioning.
You can grant other users the privilege to make Ad Hoc Renditions and to subscribe
a Document, Folder, or Compound Document for Selective renditioning. For more
information, see “Administering Permissions“ on page 21.
Rendition Agent
When a request is submitted for a Rendition of a Document, a copy of the latest
Version of the Document is first placed into the rendition queue. The Rendition
Agent uploads Documents from the Rendition Folders into Content Server, deletes
Documents from the rendition queue when appropriate, and moves Documents
from the queue into the appropriate Version Folder.
The Rendition Agent always checks the Rendition Folder for Renditions to upload
into Content Server before placing Documents from the queue into the Version
Folders. Documents are removed from the queue when one of the following has
occurred:
1. The Rendition of the Document is successfully added to Content Server.
2. The maximum number of specified retry attempts is passed.
40.1 Administering Renditions

Content Server requests a Rendition by placing a copy of the Document into a
designated shared directory called a Version Folder. The renditioning engine
periodically scans the Version Folder for new Documents. If it finds one, it converts
the Document into the requested format (for example, PDF) and places the output
file into a different shared directory called a Rendition Folder. Content Server
periodically scans this directory and uploads the Documents it finds there to store
them as Renditions alongside the original Document.
Content Server can detect if a particular requested Rendition does not arrive in its
Rendition Folder. In that case, Content Server logs a retry and requests a Rendition
again at the frequency that you specify on the Rendition Administration page. After
the specified number of unsuccessful retries for a particular Rendition, Content
Server stops requesting Renditions and records an error message in its Renditions
log file. For more information, see “Viewing and Purging the Rendition Log”
on page 892.
Every Rendition Folder you designate must have a specified Rendition type.
Rendition types are used to easily identify a given Rendition. For example, by its file
extension (TXT or PDF). This also is the value used when specifying the preferred

Rendition type to be used for viewing a Document. Users can specify any Rendition
type for Renditions that they add manually.
Tip: . F
The Rendition type appears in the Rendition column of the Rendition

Properties tab of a Version.
The Renditions module maintains an internal queue of Document Versions to be

renditioned. This enables the module to keep track of whether a Rendition request
was satisfied and the number of retries caused by unsuccessful requests. Typically,
Document Versions to be rendered enter the queue when a Document with a MIME
type that matches an enabled Version Folder rule is added to a designated location
in Content Server.
You can also manually queue Versions of existing Documents in your Content
Server database for rendering. This option is useful when you are upgrading the
You administer Rendition activities using the Rendition Administration page. The
settings on this page enable you to:
• Define the status for a Global Rendition. If enabled, any Document or Version
added to Content Server is scheduled for renditioning, subject to the
Renditioning Rules.
• Set the time interval and the number of times Content Server requests a
Rendition of a given Document before giving up. Each attempt is logged in the
Rendition log.
• Manage the Rendition log file. Content Server can detect if a particular requested
Rendition does not arrive in its Rendition Folder. In that case, Content Server
logs a retry and requests a Rendition again at the frequency that you specify.
After the specified number of unsuccessful retries for a particular Rendition,
Content Server stops requesting Renditions and records an error message in the
Rendition log file.
• Define the preferred Rendition types and their relative priority. When a user
views a Document with any preferred Rendition, the Rendition with highest
priority displays. If no Rendition of a preferred type exists for a particular
Document, Content Server converts the Document to HTML if the View as Web
Page function is enabled, or opens the Document in its native application. You
can only view a Rendition for the latest Version of a Document.
Note: The View as Web Page function in Content Server is similar to

viewing a Rendition. Instead of returning the original file, the function
causes Content Server to convert the Document into an HTML file for
display in the user's browser window. However, Content Server handles
this conversion internally, and the resulting HTML Rendition is not stored
in Content Server.
The View as Web Page function is dependent on the presence of a filter
pack for document conversion. In Content Server 10.0.0 and later, a filter

40.2. Adding or Editing a Rendition Folder
pack is installed by default. If it is not available, the Open function opens

the requested Document or Version instead, but clicking the Document link
will divert to a Rendition if an appropriate preferred Rendition type exists.
40.1.1 To Administer Renditions

To administer Renditions:
1. In the Rendition Administration section of the Content Server Administration

page, click the Administer Renditions link.
2. On the Administer Renditions page, click the Enabled button to enable Global
renditioning throughout Content Server.
3. Type an integer in the Hours between retries box to indicate the number of
hours that you want Content Server to wait before resubmitting a request for a
missing Rendition.
4. Click an integer in the Maximum number of retries menu to indicate after how
many retry attempts you want Content Server to stop requesting a particular
Rendition.
Note: OpenText recommends that you maintain the default values for the
Hours between retries and Maximum number of retries boxes.
5. To maximize the detail contained within the Renditions log file, click Errors and
Successes.
6. To define a list of preferred Rendition types, type a list of file extensions,

separated by commas, in the Rendition Type box.
Note: The Rendition types you specify must match the Rendition types
defined in the Rendition Folders. For example, if a Rendition Folder is
defined with a Rendition type of Microsoft Word, you will need to type
Microsoft Word in theRendition Type box. Users can specify any
Rendition type for Renditions that they add manually.
40.2 Adding or Editing a Rendition Folder

A Rendition Folder is an external directory where Content Server receives files
representing the Renditions of Documents or Versions that are returned by the
renditioning engine. Every Rendition Folder you designate must have a Rendition
type specified. Rendition types are used to easily identify a given Rendition, for
example by its file extension. The Rendition type appears in the Rendition column
of the Rendition Properties tab of a Version.

40.2.1 To Add, Edit, or Delete a Rendition Folder

To add, edit, or delete a Rendition Folder:

page, click the Configure Rendition Folders link.
2. On the Configure Rendition Folders page, do the following:
• To add a Rendition Folder, click Add Rendition Folder.

• To modify an existing Rendition Folder, click its Edit link.
Note: The Edit Rendition Folder page displays for either task, except that
all the boxes are blank when adding a new Rendition Folder.
3. In the Directory box, type a path name to the directory from which you want
Content Server to automatically upload Renditions.
• Separate Rendition Folders cannot share the same Directory value. You will
receive an error when you try to save the duplicate Rendition Folders.
• The path and directory must exist before specifying the value here.
4. In the MIME Type list, click the MIME type of the Rendition files.
Note: You must ensure that only files of this MIME type are placed into
the directory specified above. Also, never specify the same directory in
more than one Rendition section on the Rendition Administration page.
Otherwise, Content Server may assign incorrect MIME types to uploaded
Rendition files, potentially causing problems when users view or
download them from Content Server. If this happens, you can select the
correct MIME type of a Rendition on its Rendition Info page.
5. In the Rendition Type box, type a name that describes the MIME type. This
name is usually the file extension of files that are saved to this Rendition Folder.
This also is the value used when specifying the preferred Rendition type for
viewing a Document.
6. Click Submit.
To remove a Rendition Folder
• On the Configure Version Folders page, click the Remove link of the Rendition
Folder.

40.3. Adding or Editing a Version Folder
40.3 Adding or Editing a Version Folder

A Version Folder is an external directory where Content Server places copies of
Document Versions to be renditioned. When you add or edit a Version Folder, you
define a Rendition Rule. A Rendition Rule specifies the set of MIME types that
require Renditions, what directories are used, and whether the rule is applied
globally.
40.3.1 To Add, Edit, or Delete a Version Folder

To add, edit, or delete a Version Folder:

page, click the Configure Version Folders link.
2. On the Configure Version Folders page, do one of the following:
• To add a Version Folder, click Add Version Folder.

• To modify an existing Version Folder, click its Edit link.
Note: The Edit Version Folder page displays for either task, except
that all the boxes are blank when you add a new Rendition Folder.
3. On the Edit Version Folder page, type a name for the Rendition Rule in the
Rule Name box.
The name you specify here is used during Selective and Ad Hoc renditioning to
identify the Renditioning Rule. Therefore, you should choose a name that
accurately identifies either the MIME types or the format to which the files will
be converted.
4. In the Directories area, type a path name of the directory where you want
Content Server to copy Document Versions to be renditioned in the Directories
box.
5. Optional Do one of the following:
• To specify an additional directory, click Add Version Directory next to

the Directories box. If more than one directory is configured for a Version
Folder within a Rendition Rule, Content Server will distribute the incoming
Documents between the directories. This is useful for load distribution.
• To remove a Directory box, click its respective Remove Version Directory
button .
6. In the Available list, click one or more file extensions, and then click Add.
Repeat this step for each MIME type you want to include in the Rendition Rule.
7. To remove a file extension, click its name in the Selected list, and then click
Remove.
8. To apply this Rendition globally, select the Global Rendition check box.

9. Click Submit.
To remove a Version Folder:
• On the Configure Version Folders page, click the Remove link of the Version
Folder.
Note: The Remove link does not appear if the Rendition rule defined in
the Folder is in use. Run the Selective Rendition Report to identify which
Documents, Compound Documents, or Folders are subscribed to the
Renditioning Rule. These items must be unsubscribed before the Version
Folder can be removed.
40.4 Viewing and Purging the Rendition Log

The Renditions module keeps track of its activities in the <Content_Server_Home>/
logs/rendition.log file. The log file records errors and successes each time that an
activity takes place. Samples of these messages include:
• RenditionAdded
• VersionQueued
• VersionRequeued
• ErrorUpdatingVersionInTheRenditionsQueue
• QueueError
• FilterVersionFailed
You should purge the accumulated logging messages periodically to prevent the log
file from getting too large.
40.4.1 To View the Rendition Log

To display the Rendition log:
• In the Rendition Administration section of the Content Server Administration

page, click the View Rendition Log link.

40.5. Viewing the Selective Rendition Report
40.4.2 To Purge the Rendition Log

To purge the Rendition log:

page, click the Purge Rendition Log link.
2. On the Purge Rendition Log page, click Purge.
40.5 Viewing the Selective Rendition Report

The Selective Rendition Report lists all Folders and Compound Documents that are
currently subscribed for renditioning. It includes the type and name of the container,
whether subfolders are included, who subscribed it, and the date it was subscribed.
The report also lists the Rendition Rules applied to each container subscribed.
Note: Ad Hoc Renditions are not included in this report.
40.5.1 To View the Selective Rendition Report

To view the Selective Rendition Report:
• In the Rendition Administration section of the Content Server Administration

page, click the View Selective Rendition Report link.

Chapter 41
Administering Collections
Collections allows you to store pointers to OpenText Content Server items. These
pointers enable you to quickly and easily access the original Content Server items,
and to organize information from various locations in Content Server in a single
location.
For example, you can gather information related to a team project from multiple
locations in Content Server and collect it so that all information is in one easy to
access and maintain location. The Collection can then be used as a central location
for all documents for that project and used by all members of the project.
When administering Collections, you can enable specific Collections options to be

available for use by Content Server Users, configure the ability to make a disk image
of collected items, and maintain the audit records for collected items.
41.1 Enabling Collections Options

By default, Collections is enabled, and all Users have the ability to create Collections
by selecting Collection from the Add Item menu. However, you can restrict which
Users and Groups can access the Collection menu option from the Administer
Object and Usage Privileges page in the administration pages. For example, if there
is a specific Group that is responsible for your Content Server architecture, you can
restrict the right to create Collections to this Group only. For more information on
adding items to a Collection, see OpenText Content Server User Online Help - Using
Collections (LLESCL-H-UGD).
41.1.1 Configuring Collections General Settings

You configure various Collections settings on the Collections General Settings
page, which controls Download As Spreadsheet and other settings.
The following settings can be configured:
Setting Description
Download As Spreadsheet Settings
Item Limit Defines the maximum number of Objects that can be exported
using Download as Spreadsheet. If more objects are selected,
the User is presented with an error message. The default is
250000.
Select the No Limit check box to not restrict the number of

objects that can be exported.

Chapter 41 Administering Collections
To Configure Collections General Settings
To configure Collections general settings:
1. On the administration page, in the Collections Administration section, click the

Collections General Settings link.
2. On the Collections General Settings page, in the Download As Spreadsheet

Settings section, for Item Limit, enter the maximum number of Objects that can
be exported using Download as Spreadsheet. The default is 250000. Or, select
the No Limit check box so the number of exported objects is not restricted.
3. For Compression Threshold, enter the maximum value for the size of
downloaded spreadsheets, in kilobytes (KB. The default is 5120. Or, select the
No Limit check box so converted downloaded spreadsheets are not converted
to ZIP files.
4. For Items per Spreadsheet, enter the maximum number of Objects that can be
placed in a single spreadsheet. The default is 30000. Or, select the No Limit
check box to place all items in a single spreadsheet.
5. In the Collect Folder Settings section, for Item Limit, enter the maximum
number of Objects that can be collected. The default is 1000000. Or, select the
No Limit check box so the number of collected objects is not restricted.
6. In the Searchable Settings section, select the Enable check box to allow your
users to make new Collections be searchable when they create them. The default
is disabled. For more information, see OpenText Content Server User Online Help -
Using Collections (LLESCL-H-UGD).
7. In the Collection Status section, information is displayed about processes that

users have initiated that may take some time to complete for large Collections.
For details, see “Configuring Collections General Settings” on page 895.
• Active – processes that are currently running
• Background – maintenance processes that are queued to run as background

tasks by the Enterprise Data Flow processes, for example, “Queuing a
Collection for Indexing” on page 898, and “Queuing a Collection for
Thumbnail Generation” on page 899.
If needed, click the Abort link to end a Background operation.
Note: Shutting down Content Server will terminate the operations

displayed here. Click the Send E-mail Notice button to send an email
with a warning to notify the initiator of each Collection operation that
their process will be interrupted.
8. Click Save.

41.1. Enabling Collections Options
41.1.2 Restricting access to Collections

Administrators can choose to restrict access to the Collection menu option to
specific users and groups. The Collection menu option is restricted by selecting the
Restrict link next to the Multi-Select Command Usage Type in the Usage Privileges
area of the Administer Object and Usage Privileges page. For more information,
see “Usage Privileges” on page 328
Restricting access to menu options in Collections

You can also control the options that appear in the More Actions list within a
Collection. For example, if Collections is used to collect information for team
projects, and only project managers should be able to move items from one
Collection to another Collection, you can restrict the Move Items to Another
Collection menu option to only those Users or Groups.
You can restrict the options that appear in the More Actions list within a Collection
to specific users and groups with the Usage Type: Collections Command. From the
Content Server administration page, click System Administration, Administer
Object and Usage Privileges, and scroll down to the Usage Privileges area.
You can make all or any of the following options available to all Users and Groups,
or you can restrict these options from appearing on the More Actions list within a
Collection:
• Queue for Indexing
• Queue Thumbnail Generation
• Copy Items
• Move Items
• Delete Items
• Copy Items to Another Collection
• Make Disk Image
• Move Items to Another Collection
• Remove Items from Collection
• Download as Spreadsheet
• Zip & Download Command
• Zip & Email Command
• Print Command
• Apply Categories
• Create Searchable Collection
• Collect All Search Results
• Custody Details in Disk Image

Note: When an administrator creates a Collection from the results of a search,

the Collection can be downloaded as a spreadsheet, or multiple spreadsheets
are created and compressed into a single ZIP file.
Queuing a Collection for Indexing

Users can select Queue for Indexing from their More Actions... menu to update the
index used by the search function by re-indexing specific content in a Collection.
Indexing content in Content Server writes information about that content to an index
used by Content Server search.
You can facilitate Collections re-indexing operations without impacting day-to-day

search indexing updates on the Set Extractor General Settings page. In the
Maximum Items per Extraction setting, for Collections, under Options, from the
drop-down list choose Pause Extraction to throttle Queue for Indexing requests. For
more information, see “Setting Extractor General Settings” on page 485.
Note: Warnings are provided to users that the re-indexing operation should
only be used to correct index errors. Also that “Indexing a Collection should be
used with caution because this is a potentially performance-expensive
operation which may require hours or days to complete.”. For details, see
OpenText Content Server User Online Help - Using Collections (LLESCL-H-UGD).
When a user selects Queue for Indexing, a message is displayed that provides the
following information:
• the day, month, year and time the indexing operation started
• that Collection commands are disabled until the operation completes
• what types of data are being indexed
• name of the user who initiated the indexing operation
• whether the indexing has started
• a link to end the operation, available to users with administrator rights on the
collection
This same information is also provided for administrators in the Collection Status
section of “Configuring Collections General Settings” on page 895. You can click the
Abort link, if needed, to end a Background operation.
Note: If you need to shut down Content Server the operations displayed will
terminate. You can click the Send E-mail Notice button to send an email with a
warning to notify the initiator of each Collection operation that their process
will be interrupted.
The Queue for Indexing option is a maintenance feature that will be

performed by the Enterprise Data Flow processes as a background task. The
Data Flow processes schedule various background tasks, including “Queuing a
Collection for Thumbnail Generation” on page 899. For more information, see

41.1. Enabling Collections Options
Queuing a Collection for Thumbnail Generation

Users can select Queue Thumbnail Generation from their More Actions... menu to
request thumbnails to be generated. For details, see OpenText Content Server User
Online Help - Using Collections (LLESCL-H-UGD)
Thumbnail generation will be requested for the entire collection, regardless of which
items were selected. The default settings in the current release of Content Server will
generate thumbnails for documents and emails in an Enterprise Data Source. For
details, see “Configuring Thumbnail Options” on page 44.
When a user selects Queue Thumbnail Generation, a message is displayed that

provides the following information:
• the day, month, year and time the Queue Thumbnail Generation operation was
initiated
• that Collection commands are disabled until the operation completes
• name of the user who initiated the operation
• whether the Thumbnail Generation operation has started
• a link to end the operation, available to users with administrator rights on the
collection
This same information is also provided for administrators in the Collection Status
section of “Configuring Collections General Settings” on page 895. You can click the
Abort link, if needed, to end a Background operation.
Note: If you need to shut down Content Server the operations displayed will
terminate. You can click the Send E-mail Notice button to send an email with a
warning to notify the initiator of each Collection operation that their process
will be interrupted.
This bulk operation will generate thumbnails for a collection as a background

task, so thumbnails will not be displayed immediately. The Queue Thumbnail
Generation option is a maintenance feature that will be performed by the
Enterprise Data Flow processes. The Data Flow processes schedule various
background tasks, including “Queuing a Collection for Indexing” on page 898.
For more information, see “Administering Data Flows” on page 465.

41.1.3 To Enable or Restrict the Collect Button

To enable or restrict the Collect button:
1. On the administration page, in the System Administration section, click the

Administer Object and Usage Privileges link.
2. On the Administer Object and Usage Privileges page, scroll down to the Usage
Privileges area.
Under the column Usage Type, find Multi-Select Command.
Note: By default, the Usage Name is Collect, the Usage Status is

Unrestricted, and the action available under the Actions column is Restrict.
This means that the multi-select command is available to all users and
groups.
3. Optional To restrict access to the multi-select command to specific users and

groups, under the Actions column, click Restrict next to Multi-Select
Command, then click OK to acknowledge that you need to populate the group.
4. You will now see the Members Info page, titled Edit Group: Collect.
5. Using the list box and input box on the right, enter the name of the user or
group you want to give permission to use the multi-select command. Click
Find.
Note: You will be restricting the use of the multi-select command to only
those users and groups you designate on this page.
6. The name of the person or group will appear. Select the check box Add to group
next to each user or group to whom you want to grant permission to use the
multi-select command. Then click Submit.
7. The user(s) or group(s) names will now appear in the Current Group Members
box on the left. Click Done.
8. To edit your users or groups in the future, click the Edit Restrictions link next
to Multi-Select Command under the Actions column.
Tip: To delete all restrictions and allow all users and groups to use the
multi-select command, click Delete All Restrictions, then click OK.
9. Optional Click other Collections Command options as needed to customize

Collections functions for your Users or Groups.
10. Restart the Admin server and the Web application server on the primary
Content Server host.

41.2. Configuring the Make Disk Image Option
41.2 Configuring the Make Disk Image Option

Once a Collection has been created and items have been collected, you can create a
Disk Image of the Collection. A Disk Image enables you to copy all or specific items
in a Collection to disk. This can be used to share content in a Collection with
individuals or groups outside of the Content Server environment.
Disk Image Manifest File
A Disk Image Manifest File is created when you create a Collection.
The Disk Image includes a generic help file for users when browsing the contents of
the manifest file. A link in the header of the manifest file will open the help file in a
new browser window. You can edit this help file in a text editor, or replace it with
your own customized version, if needed. For details about the information in the
Manifest File, see OpenText Content Server User Online Help - Using Collections
(LLESCL-H-UGD).
When you configure the Disk Image creation settings, you can specify information
about Collections and collected items that can be captured, the disk sizes that can be
chosen, and when email notification should be sent. You can also restrict the Make
Disk Image option to specific Content Server Users and Groups.
Specifying the Disk Image Creation Settings

To configure the Make Disk Image option, you must first configure the parameters
used when writing Collections to disk in the Disk Image Creation Settings area of
the administration pages.
Important
For the Disk Image creation process to work, you must have a Content Server
File Cache, also known as remote admin cache, RAC, configured.
On the Disk Image Creation Settings page, the following settings can be
configured:
Setting Description
Available Disk Sizes Defines the disk sizes available to Users during the Make
Disk Image creation process. and specifies the default value
that should appear. The disk size is the expected size of the
disk output. If the Collection size exceeds the specified size,
an additional Disk Image is created.
Notification Options Defines the point in the Disk Image creation process that
email notification should be sent. For more information
about email notification and the contents of the email
messages, see OpenText Content Server User Online Help -
Using Collections (LLESCL-H-UGD).
Note: By default, when a Disk Image is created, it is removed from the File
Cache one day after creation. You can modify this value by changing the

Expire Time setting on the File Cache tab in the Admin Server Properties
page. You can access this page quickly by clicking the File Cache Settings link
in the Admin Server area on the Disk Image Creation Settings page.
For more information about creating Disk Images, see OpenText Content Server User
Online Help - Using Collections (LLESCL-H-UGD).
Restricting the Make Disk Image Option

The Make Disk Image option appears by default in the More Actions list when
viewing a Collection. You can restrict this option to specific Users or Groups by
updating the Make Disk Image Usage Privilege. For example, if you have a Group
that is responsible for releasing information to third party sources, and you only
want that group to be able to copy information to a Disk Image, you can restrict this
option to only that Group. For more information on how to restrict object usage
privileges, see “Administering Object and Usage Privileges“ on page 327.
41.2.1 To Configure Disk Image Settings

To configure Disk Image settings:

Disk Image Creation Settings link.
2. On the Disk Image Creation Settings page, in the Available Disk Sizes area:
a. Select the Available check box next to each Label type that you want to
appear as an option on the Make Disk Image page.
b. Select the Default radio button next to the Label type that you want to
designate as the default on the Make Disk Image page.
3. Optional In the Collections area:
a. Select the Active check box next to each Also Dump type you want to
include when creating a Disk Image. These types represent different
Collection information to include when creating a Disk Image:
• Attributes – custom metadata attached to the Collection, if it exists

• Audit – the material events that created or modified the Collection
• Classifications – assigned classification metadata generated by the
Classifications module, if it is installed
• Description – if entered in Content Server
b. Select the User Configurable check box next to each Also Dump type you
want to allow Users to be able to configure.
4. Optional In the Content area:
a. Select the Active check box next to each Also Dump type to specify
whether content information about collected items should be included
when creating a Disk Image.

41.2. Configuring the Make Disk Image Option
b. Select the User Configurable check box next to each Also Dump type
whose Content information you want to allow Users to configure:
• Attributes – custom metadata attached to the Collection, if it exists

• Audit – the material events that created or modified the Collection
• Classifications – assigned classification metadata generated by the
Classifications module, if it is installed
• Description – of the collected item, if entered in Content Server
• Content Server Full Path – the path of the collected item's location in
Content Server
5. In the Notification Options area:
a. Select the Available check box next to each type of notification you want to
appear as an option on the Make Disk Image page.
b. Click the Default button to specify the type of notification you want to
appear by default on the Make Disk Image page.
6. Click the Show Max Items per Image check box to allow a User to specify the
maximum number of items per Disk Image.
7. If configured, you may see the Metadata Language Options. In the Metadata
Language Options area:
a. In the Default Language field, make a selection from the list.

b. Select the User Configurable check box to allow the User to configure the
metadata language for the Disk Image.
8. In the Administrator Notify area, to set up notification emails for Disk Image
creation, do the following:
a. Select the Enabled check box.

b. In the Notify Level field, type any positive number. When this number is
reached, notification is sent to the email address indicated in the Email
Address field.
c. In the Email Address field, type the email address of the User or
administrator that should receive Disk Image creation notification.
9. In the Directory Mapping area:
a. Optional To modify the file cache parameters, click the File Cache Settings
link.
In the File Cache tab, edit the information as required then click Update.
b. In the Map Value field, type the URL where Disk Images can be accessed
after creation.
10. Click Update.

41.3 Purging Audit Records for Collected Items

Operations performed on collected items are recorded by Content Server in the
Collection Items Audit. By default, these records are kept until the Collections are
deleted; however, you can remove older entries from these records in the Purge
Collections Items Audit Records area of the administration pages. You can specify
the number indicating how many days of information you want to keep. Any
information older than the number of days specified is deleted.
For more information about the Collection Items Audit, see OpenText Content Server
User Online Help - Using Collections (LLESCL-H-UGD).
41.3.1 To Purge Audit Records for Collected Items

To purge audit records for collected items:

Purge Collections Items Audit Records link.
2. On the Purge Collections Items Audit Records page, type the number of days
to store collected items information in the Purge Data Older Than field.
3. Click Purge.

Chapter 42
Administering the Multi-File Output Module
Multi-File Output makes it simple and fast to:
• Download: compress one or more OpenText Content Server items into a zip file
for download.
• E-mail: compress, download, and attach one or more items to a new email
message or save the resulting zip file back to Content Server and email a
hyperlinked URL.
• Print: download and print one or more Content Server documents.
Multi-File Output works with any supported document type for which the user has
at least See Contents permissions. It can output the contents of Folders, Compound
Documents, or other supported containers in one action. You can use Multi-File
Output with Collections to gather information from anywhere in Content Server and
then output it all at once, one page at a time.
Notes
• Content Server allows major and minor document versions. For Multi-File
Output to work with minor document versions, the user must have Reserve
permissions.
• Containers within Content Server can include other containers, for example,
folders within folders. If any of the items selected is a container that includes
other containers, the Multi-File Output action does not extend to the sub-
containers; only items at the highest level are acted upon. To perform an
action on the contents of a sub-container, you must select that container
explicitly.
• Multi-File Output supports the following container types: Compound
Documents, Folders, Projects, Tasks, and Workflows. Containers added by
optional modules may also be supported.
• Multi-File Output properly compresses documents that have UTF–8
character encoding, but not every third-party file extraction utility is
compatible with UTF-8 encoding. If Multi-File Output compresses a file that
uses UTF-8 character encoding, the name of the file may become corrupted if
it is extracted using a utility that does not properly handle UTF-8 character
encoding.
For example, if a UTF-8-encoded file that Content Server has compressed
using Multi-File Output contains an accented character in its name, the
character will be incorrectly rendered if you extract it using a utility that
does not correctly handle UTF-8 character encoding.

Chapter 42 Administering the Multi-File Output Module
42.1 Working with General Settings

The General Settings page allows you to configure how Content Server handles the
zip and download, email, and print actions, and set the temporary folder that is used
for compressing files.
42.1.1 To Configure General Settings

To configure general settings:
1. In the Multi-File Output Administration on the Content Server Administration

page, click General Settings.
2. On the General Settings page, in the Temporary Directory box, enter the path
to the location that Content Server will use for temporary file compression and
printing activities. By default, the path is <Content_Server_home>\temp
\multifile\.
3. In the SMTP Cache Lifetime field, enter the number of seconds you want the
cache to be valid before Content Server attempts to obtain new settings. By
default, this field is set to 300.
4. In the Maximum E-mail Addresses box, type the maximum number of

recipients that a user can specify when they use a Multi-File Output email
action. By default, the Address Limit is set to 10.
5. In the Attachment Options section, enable one of the following settings:
• Allow the user to choose, which allows the user to choose whether email
attachments are added as files or URLs. This option is enabled by default.
• Use files only, which enables email attachments to be included only as files.
• Use URLs only, which enables email attachments to be included only as
URL references to the file location in Content Server.
6. In the Email Link Options section, enable one of the following settings:
• Properties, which enables email links to go to the Properties page for the
linked file.
• Open, which enables email links to open the linked file.
7. Enter the maximum file size in KB (after file compression) that users are
allowed to download, email, or print in the Bandwidth Limiter boxes. By
default, the maximum files sizes are all set to 5120 KB.
8. In the Multifile Objects Configuration section, enable the object types that
users can download, email, or print using multi-file buttons. By default, only
Documents and Folders are enabled.
9. Click Submit to save your settings.

Chapter 43
Administering OpenText™ WebDAV
You can perform administration tasks necessary to maintain OpenText™ WebDAV

on your Content Server system.
This section covers the following topics:

• “Configuring a Web Server” on page 907
• “Configuring WebDAV Access” on page 911
• “Configuring WebDAV Client Launchers” on page 913
• “Configuring WebDAV Version Management” on page 913
• “Configuring Host Translation” on page 914
• “Specifying a Weblink Coserver Port” on page 915
• “Specifying a Logging Level” on page 915
• “Configuring WebDAV Authentication” on page 916
43.1 Configuring a Web Server

To access WebDAV, the Web server by which it is accessed must be configured with
plug-ins.
If the Web server is local, meaning it is located on the same machine that hosts the
Content Server, you must configure this local Web server. If the Web server is
remote, meaning it is not located on the same machine that hosts the Content Server,
you can configure Microsoft Internet Information Server (IIS) as the remote Web
server, or you can configure a different Web server for Windows or UNIX/Linux.
Important
Before you can configure a remote Web server, you must specify a static port
number for the Weblink Coserver port. For information about specifying a
port number, see “Specifying a Weblink Coserver Port” on page 915.
Configuring a Web Server during a WebDAV Installation

or Upgrade
When you attempt to add the WebDAV module to Content Server, you must
configure the virtual directory that a Web server will use to communicate with
WebDAV. Then, you are prompted to configure a local Web server. To configure a
Microsoft Internet Information Server (IIS) as a local Web server, you must run or
save an installer; to configure a local Web server other than an IIS Web server, you
can download a file that provides you with a description of the modifications that
are required to the specified Web server.

Chapter 43 Administering OpenText™ WebDAV
43.1.1 To configure a local Web server

To configure a local Web server:
1. On the Content Server Administration page, click Configure Web Server.
2. On the Configure Web Server page, click Configure Local Web Server.
3. On the Configure Local Web Server page, click a Web server in the Web Server
list.
• If you specified Microsoft Internet Information Server (IIS) in Step 3, click

Run the Installer to configure the Web server or save the installer to disk.
Note: If you save the installer to disk to run at a later time, do not
rename the file, because the name contains the parameters necessary
for the installer to configure the Web server.
• If you specified a Web server other than IIS in Step 3, click View
Modifications to save a file that contains the modifications required for the
Web server. For information about configuring your Web server based on
this file, see "Configuring the Web Servers and Verifying WebDAV in the
OpenText™ WebDAV Installation and Administration Guide.
43.1.2 To configure Microsoft Internet Information Server (IIS)

as a remote Web server
To configure Microsoft Internet Information Server (IIS) as a remote Web
server:
2. On the Configure Web Server page, click Configure Remote Web Server.
3. On the Configure Remote Web Server page, click Microsoft Internet

Information Server (IIS) in the Web Server drop-down list.
4. Type the Content Server IP address in the IP Address of this Content Server
field.
5. Click Run the Installer to configure the Web server or save the installer to disk.
Notes
• You must run the installer on the same machine that hosts the IIS Web
server.
• If you save the installer to disk to run at a later time, do not rename the
file, because the name contains the parameters necessary for the installer
to configure the Web server.

43.1. Configuring a Web Server
43.1.3 To configure a different remote Web server for Windows

To configure a different remote Web server for Windows:
3. On the Configure Remote Web Server page, click a Web server in the Web
Server list.
4. Type the Content Server IP address in the IP Address of this Content Server
field.
5. Click Windows.
6. Click Run the Installer to configure the Web server or save the installer to disk.
Notes
• You must run the installer on the same machine that hosts the Web
server.
file, because the name contains the parameters necessary for the installer
43.1.4 To configure a different remote Web server for UNIX/

Linux
To configure a different remote Web server for UNIX/Linux:
3. On the Configure Remote Web Server page, click a Web server in the Web
Server list.
4. Type the Content Server IP address in the IP Address of thisContent Server

field.
5. Click UNIX/Linux.
6. Type an install directory name in the Install Directory field.
7. Click Obtain the Plugins.
8. Save the .tar file in the install directory you specified.
9. At the shell prompt, type the following command, and then press the ENTER
key:
tar -xvf weblink351.tar

10. Click View Modifications to save a file that contains the modifications required
for the Web server. For information about configuring your Web server based
on this file, see "Configuring the Web Servers and Verifying Livelink ECM -
WebDAV" in the OpenText™ WebDAV Installation and Administration Guide.
43.1.5 To configure the virtual directory during an install or

upgrade
To configure the virtual directory during an install or upgrade:
1. On the Configure Virtual Directory page, type the name of the virtual directory
alias that a Web server will use to communicate with WebDAV in the Virtual
Directory field.
2. Click Continue.
43.1.6 To configure IIS as a local Web server during an install

or upgrade
To configure IIS as a local Web server during an install or upgrade:
1. On the Configure Local Web Server page, click Microsoft Internet Information
Server (IIS) in the Web Server drop-down list.
2. To configure the IIS Web server, click Run the Installer.
3. During the installation, confirm the Web server, the Content Server service
name, and the virtual directory alias, and then complete the Web server
configuration.
4. On the Configure Local Web Server page, click Continue.
5. Complete the module installation.
Notes
• You must run the installer on the same machine that hosts the IIS Web
server.
file because the name contains the parameters necessary for the installer

43.2. Configuring WebDAV Access
43.1.7 To configure a different local Web server during an

install or upgrade
To configure a different local Web server during an install or upgrade:
1. On the Configure Local Web Server page, click a Web server in the Web Server
list.
2. Click View the Modifications.
3. Save the file that contains a description of the necessary modifications required
for the specified Web server.
4. On the Configure Local Web Server page, click Continue.
5. Complete the module installation.
43.2 Configuring WebDAV Access

When a folder has categories with required attributes, the Content Server user
interface forces users to provide values for these attributes when adding documents
to the folder. Since it is not possible through WebDAV to present the user interfaces
required for this functionality, one of the following non-interactive behaviors must
be used instead:
• If the Content Server installation includes the Personal Staging module, you can
elect to create a document in a personal staging folder. For information about the
Personal Staging module, see the OpenText™ WebDAV Release Notes.
• You can elect to create the document but leave the required attributes blank. The
attributes can be filled in later using the Content Server user interface if
necessary. This is the most convenient option for users, but can defeat the
intended purpose of requiring attributes on those folders in the first place.
• You can allow the documents to be created but have the categories that include
those attributes removed. This is consistent with the capabilities of the Content
Server user interface but makes it more difficult for users to fill in the attributes
later, because they have to find and add the proper categories.
• You can disallow the creation of documents in folders using WebDAV. Although
this causes WebDAV clients to fail and display an error when attempting to
create a new document, existing documents can still be edited.
WebDAV allows you to omit certain items from WebDAV folder listings for users
without system administration rights, according to the needs and expectations of
your user community. You can omit hidden items as well as categories and report
volumes.
Hiding items designated as hidden omits hidden items from folder listings in the
same way that they are omitted from Content Server browse pages. By default, this
option is turned off, allowing the hidden items to be easily authored and edited
using WebDAV clients.

Hiding categories and report volumes removes these items from the WebDAV root
folder. As these locations are rarely used by most users and WebDAV editing is not
usually appropriate for these objects, this option is enabled by default to reduce the
complexity of users' views.
Hiding Content Server items removes them from the WebDAV folder view for all
users.
43.2.1 To specify category inheritance rules

To specify category inheritance rules:
1. On the Content Server Administration page, click Configure WebDAV Access

Parameters in the WebDAV Administration area.
2. On the Configure WebDAV Access page, click an option in the list.
43.2.2 To hide items from the WebDAV view

To hide items from the WebDAV view:
1. On the Content Server Administration page, click Configure WebDAV Access

Parameters in the WebDAV Administration area.
2. On the Configure WebDAV Access page, select one of the following check
boxes:
• Hide items designated as hidden, which hides items designated as hidden

from all users except system administrators
• Hide categories and reports volumes, which hides categories and report
volumes from all users except system administrators
3. Select the check box for each Content Server item you want to hide from all
users in the WebDAV folder view.
Note: You must restart the Content Server for these changes to take effect.

43.3. Configuring WebDAV Client Launchers
43.3 Configuring WebDAV Client Launchers

WebDAV Client Launchers provide a quick way to connect to Content Server using
popular WebDAV clients that may be available to users in your organization. You
can have appropriate client applications launch when users want to edit documents
created in Microsoft Office applications. This feature is available to clients who have
Microsoft Sharepoint Client API, an optional component of Office
2003/2007/2010/2013. You can also have Microsoft Web Folders display the item's
content embedded within the Content Server user interface. In order for this view to
function correctly, users must be using Microsoft Internet Explorer version 5.5 or
later, and must have Microsoft WebFolders installed.
43.3.1 To launch a client application for editing a document

To launch a client application for editing a document:
1. On the Content Server Administration page, click Configure WebDAV Client

Launchers in the WebDAV Administration area.
2. On the WebDAV Client Launcher Configuration page, select Enable WebDAV

Edit action for Microsoft Office Documents.
43.3.2 To enable the Folder view

To enable the Folder view:
1. On the Content Server Administration page, click Configure WebDAV Client

Launchers in the WebDAV Administration area.
2. On the WebDAV Client Launcher Configuration page, select Enable WebDAV

Folder View action.
43.4 Configuring WebDAV Version Management

When a document is edited with an application directly through WebDAV, the
application may save the document several times throughout the editing session.
Every save that is initiated by this application creates a new version of the document
in Content Server, which is usually undesirable because a potentially excessive
number of documents are stored, and most are intermediate versions that the author
does not want to retain. Version management limits the versions kept in WebDAV to
the latest save in an editing session.

43.4.1 To enable or disable version management

To enable or disable version management:
1. On the Content Server Administration page, click Configure WebDAV Version

Management in the WebDAV Administration area.
2. On the WebDAV Version Management Configuration page, select or clear

Enable collapse versions within a single editing session.
43.5 Configuring Host Translation

For load-balancing or security purposes, users sometimes install intermediate
servers between the client and the Web server that runs WebDAV, including reverse
proxies and load balancers. During communication between the Web server and
intermediate server, the URL the client uses to connect is hidden. As a result, any
URL information reported back to the client displays the URL used by the
intermediate server and is, therefore, incorrect. To fix this error in information
transmittal, you can configure the Web server to translate the URL for the
intermediate servers back to the URL used by the client.
The protocol also gets hidden, and incorrect protocol information can be passed to
clients. Therefore, you can specify the correct protocol to be used. Typical protocols
include http, which is the default, and https.
In the following example, the following settings translate an incorrect URL http://
hostname1:8080/livelinkdav, back to a correct URL https://
hostname2/livelinkdav.
Proxy Hostname = hostname1:8080Set Host = hostname2Set Scheme = https
43.5.1 To Configure Host Translations

To configure host translations:
1. On the Content Server Administration page, click Configure Host

Translations in the Weblink Coserver Configuration area.
2. On theConfigure Weblink Coserver Host Translations page, click Add

Translation.
3. Type the name of an intermediate server in the Proxy Hostname field.
4. Type the name of a client server in the Set Host field.

Optionally, type the protocol in the Set Scheme field to specify the protocol the
client server uses.

43.6. Specifying a Weblink Coserver Port
Notes
• If the intermediate server connects on a non-standard port, you can add that
port to the Proxy Hostname field. For example, hostname:443.
• You must restart Content Server for these changes to take effect.
43.6 Specifying a Weblink Coserver Port

The Weblink Coserver relies on a Weblink plug-in for your Web server. The Weblink
plug-in communicates with its Web server using the TCP/IP protocol on a specific
port. By default, this port is chosen dynamically every time the Weblink Coserver
starts. To run the Web server and Content Server on different hosts, you must
choose a fixed, static port number for the plug-in to use.
To connect to a WebDAV instance on a remote server, the remote server must be

configured so that it is listening on a static port.
43.6.1 To Specify a Static Coserver Port

To specify a static coserver port:
1. On the Content Server Administration page, click Specify Coserver Port in the
Weblink Coserver Configuration area.
2. On the Specify Weblink Coserver Port page, click Static in the Port Allocation
list, and then type the port number you want to use in the Port Number field
that opens.
Note: You must restart Content Server for these changes to take effect.
43.7 Specifying a Logging Level

The Specify Logging Level page lets you adjust how much information is written
into the weblink.log and weblinkB.log files in your <Livelink_home>/logs directory.
43.7.1 To Specify the Logging Level

To specify the logging level:
1. On the Content Server Administration page, click Specify Logging Level in

the Weblink Coserver Configuration area.
2. On the Specify Weblink Coserver Logging Level page, click one of the
following logging options in the Logging Level list:
• Fatal errors only

• Errors only

• Errors and warnings

• Full debugging information
• Complete connection dump
Note: You must restart Content Server for these changes to take effect.
43.8 Configuring WebDAV Authentication

Authentication Method
WebDAV supports the following authentication methods:
• “Configuring Basic/Content Server Authentication” on page 917 to authenticate

users with their Content Server credentials or “Configuring Authentication using
the Livelink Directory Services Module” on page 917
• “Configuring Passthrough Authentication” on page 918 to have the Web server
authenticate users whether or not Directory Services authentication is configured
for Content Server;
• “Configuring Kerberos Authentication” on page 919 to authenticate users using
Kerberos and a specific Kerberos server;
• “Configuring Custom Header Authentication” on page 920 to authenticate with
a custom HTTP header, usually supplied by a third-party authentication
product; and
• “Configuring Custom Authentication” on page 921 to specify a custom
authentication plug-in.
The following configuration options are available for all methods:
Realm Trusts
If the Web server authenticates users against a domain (realm), you must configure
WebDAV to accept users from that realm. For information about configuring
WebDAV to accept users from realms, see “Managing Realm Trusts” on page 922.
User Mapping
When a Web server authenticates a user, WebDAV maps the user to a specific
Content Server user. There are several methods available in WebDAV to map
Principal Names (authenticated users) to Content Server users. For more
information about these mapping methods, see “Managing User Mappings”
on page 923.

43.8. Configuring WebDAV Authentication
43.8.1 Configuring Authentication using the Livelink Directory

Services Module
When the Content Server Directory Services module is installed and properly
configured, Content Server depends on the Web server to authenticate users.
To configure WebDAV for authentication using the Content Server Directory

Services module, you must manually configure the Access Control Rules in the
WebDAV virtual directory within your Web server to match the virtual directory for
Content Server. For example, if you access Content Server using a virtual directory
called livelink, and you access WebDAV using a virtual directory called livelinkdav,
you must configure the Access Control Rules of the livelinkdav virtual directory to
match those of the livelink virtual directory.
Note: For detailed information on configuring authentication using the

Content Server Directory Services Module, see "Configuring Authentication
using the Content Server Directory Services Module" in the OpenText™
WebDAV Installation and Administration Guide.
To enable Authentication using the Content Server Directory

Services Module
To enable Authentication using the Content Server Directory Services Module:
1. On the Content Server Administration page, click Specify Weblink

Authentication in the Weblink Coserver area.
2. On the Specify Weblink Authentication page, select Basic/Content Server.
3. Click Save Changes, and then restart Content Server.
43.8.2 Configuring Basic/Content Server Authentication

Basic/Content Server authentication is the default authentication method used by
WebDAV.
With this method, unless directory services authentication is configured for Content
Server, users are authenticated by their Content Server user name and password
using HTTP Basic authentication.
When Content Server is using Directory Services authentication, the Web server
must be configured to authenticate users.
Note: For more information about Basic/Content Server Authentication, see

Internet standard RFC2617.

To enable Basic/Content Server Authentication

To enable Basic/Content Server Authentication:

2. On the Specify Weblink Authentication page, select Basic/Content Server.
43.8.3 Configuring Passthrough Authentication

Passthrough Authentication without Directory Services may be used in
configurations where the Single Sign-On (SSO) capability of Authentication using
the Content Server Directory Services module and Kerberos Authentication is
preferred, but these methods cannot be used for any of the following reasons:
• The Directory Services module is not installed on the Content Server (required
for Authentication using the Content Server Directory Services module).
• The Web server you are using is IIS (not recommended for use with Kerberos
Authentication).
To use the Passthrough Authentication method, your Web server must be

configured to authenticate users on the WebDAV virtual directory.
Note: For detailed information on configuring Passthrough authentication, see

"Configuring Passthrough Authentication" in the OpenText™ WebDAV
Installation and Administration Guide.
To enable Passthrough Authentication

To enable Passthrough Authentication:

2. On the Specify Weblink Authentication page, select Passthrough.

43.8.4 Configuring Kerberos Authentication

Kerberos Authentication is the MIT V5 Kerberos standard. It is the default for
network authentication on systems with Windows 2000 or later installed. It is also
available on UNIX hosts.
Where Basic/Content Server Authentication involves a client sending a user name

and password as part of its HTTP request to a target server, a client that has
Kerberos Authentication enabled sends tokens as part of its request to the target
server. The client communicates with an intermediary (Kerberos server) to obtain its
tokens, while the target server communicates with the Kerberos server to verify the
tokens. Either Windows 2000, 2003 or later Active Directory (Windows Domain
Controller) or another Kerberos server (for example, on a UNIX host) can comprise
the Kerberos server.
Notes
• Kerberos configuration requires that WebDAV be provided with a service
account in the Active Directory, which designates the WebDAV service as
the recipient of HTTP requests sent to its server. On Windows servers, the
computer account for the server itself typically represents this service
account; however, IIS also relies on this account to perform its own
authentication. Therefore, OpenText does not recommend using WebDAV
Kerberos Authentication on Windows servers with IIS. Rather, the Directory
Services should be used.
• WebDAV does not support Kerberos Authentication for configurations with
BEA WebLogic Server, Apache Tomcat Server, or Sun Java System
Application Server. OpenText has determined that the server in this
configuration is deficient in a key function.
With Kerberos Authentication, Microsoft clients such as Internet Explorer can access
WebDAV resources with Single Sign-On (SSO) capability. SSO minimizes the
frequency with which a user must enter their user name and password.
SSO with Microsoft clients requires the following:

• Clients must be running Windows 2000 Professional SP2 or later.
• Internet Explorer must be properly configured.
• All users must be members of an Active Directory domain.
• WebDAV must be provided with an appropriate service account in that same
domain or in a domain it trusts.
To configure WebDAV to authenticate users with Kerberos, you must:

• Configure the Kerberos Server by creating a service account
• Configure Content Server
• Configure Internet Explorer

Note: For detailed information on configuring Kerberos authentication, see

"Configuring Kerberos Authentication" in the OpenText™ WebDAV Installation
and Administration Guide.
To enable Kerberos Authentication
To enable Kerberos Authentication:

2. On the Specify Weblink Authentication page, select Kerberos/NEGOTIATE.

When selected, Service Principal, Kerberos Realm, KDC Server, and Key Tab
File edit fields will appear.
3. Type the name of the Service Principal in the Service Principal field.
4. Type the name of the Kerberos Realm in the Kerberos Realm field.
5. Type the name of the KDC Server in the KDC Server field.
6. Type the name of the Key Tab File in the Key Tab File field.
43.8.5 Configuring Custom Header Authentication

Custom Header authentication can be often used when the Web server is configured
with third-party software for authenticating users. When such a product enforces an
authentication requirement, and passes the name of the authenticated user in an
HTTP header, WebDAV can be configured to accept the user name from this header.
To configure this authentication method, the name of the HTTP header must be
provided. Note that the documentation for your third-party authentication product
might give the name of the equivalent ISAPI or CGI variable, for example
"SOME_HEADER" or "HTTP_SOME_HEADER", instead of the name of the HTTP
header itself, "Some-Header". This authentication method must be configured with
the actual HTTP header name, which may include dashes, but not underscore
characters, and doesn't start with "HTTP".
Caution
Since arbitrary HTTP headers can be included in Web requests, this
authentication method must only be used in conjunction with a third-party
authentication product that enforces authentication and controls the named
header. Allowing Web requests to arbitrarily specify the value of the
header used for authentication would enable unrestricted impersonation of
any Content Server user.

To enable Custom Header Authentication

To enable Custom Header Authentication:

Authentication in the Weblink Coserver.
2. On the Specify Weblink Authentication page, select Custom Header. When

selected, a Header Name field will appear.
3. Type the name of the Header in the Header Name field.

43.8.6 Configuring Custom Authentication

When Custom authentication is specified, WebDAV authenticates using an
Adminstrator specified Java plug-in class, implemented in compliance with the
WebDAV Authentication Plug-in API.
To configure this authentication method, the class name and .jar file for the plug-in
must be provided.
Note: For detailed information on Custom authentication, see "Configuring

Custom Authentication" in the OpenText™ WebDAV Installation and
Administration Guide.
To enable Custom Authentication

To enable Custom Authentication:

2. On the Specify Weblink Authentication page, select Custom. When selected, the
Class Name and Jar File fields will appear.
3. Type the name of the Class in the Class Name field.
4. Type the name of the Jar File in the Jar File field.

43.8.7 Managing Realm Trusts

Whenever a Web server authenticates a user against a realm, the user is usually
identified by a Principal Name (for example, user@THEREALM.NET). The Principal
Name usually includes a realm, that identifies, among other things, the person or
organization providing assurance of the user's identity. In this example, the
Principal Name includes realm "THEREALM".
WebDAV can be configured in one of two ways to accept (trust) Principal Names
based on their realm.
Allow all authenticated users

Principal Names are accepted from all realms.
Accept users from specified realms

Principal Names are accepted from a specified list of realms.
To configure realm trusts

To allow all authenticated users:

2. Select Allow all authenticated users.
To accept users from specified realms:

2. Select Accept users from the following realms.
3. To add a realm, type the name of the realm in the Add Realm field and then
click Add Realm.
4. To delete a realm, select a realm from the Delete field and then click Delete.

43.8.8 Managing User Mappings

When a user logs in to WebDAV with a Principal Name (for example,
user@THEREALM.NET) that successfully authenticates, WebDAV matches the
Principal Name to the Content Server user it represents. WebDAV can be configured
to use one of three methods to perform this mapping; Same Name, Domain and
Name, and User Managed.
Same Name Mapping
The Same Name mapping method causes the Principal Name to map to a Content
Server user name that is identical to the domain log-in name of the Principal Name.
For example, the Principal Name user@THEREALM.NET maps to the Content Server
user user.
Domain and Name Mapping
The Domain and Name mapping method causes the Principal Name to map to a
Content Server Domain user. The Content Server user name is identical to the
domain log-in name of the Principal Name. For example, the Principal Name
user@THEREALM.NET maps to the Content Server user user in the Content Server
Domain THEDOMAIN.
User Managed Mapping
The User Managed mapping method causes the Principal Name to map to a Content
Server user that is defined by a user or by the administrator. Initially, there are no
mappings set. It is up to the Content Server user or administrator to add mappings.
For information about User Managed mapping, see the OpenText™ WebDAV User
Guide.
Directory Services Mapping
When the Content Server Directory Services module is installed and properly
configured, WebDAV can be configured to use either the directory services module
mapping to map a Principal Name to a Content Server User, or one of the above-
identified mapping methods.
To configure the mapping method

To configure the mapping method:

2. On the Specify Weblink Authentication page, click one of the following options
in the Method for mapping Principal names to Content Server users list:
• Same Name
• Domain and Name

• User Managed
3. When the Content Server directory services module is installed and properly
configured, you can elect to use either the directory services module mapping to
map a Principal Name to a Content Server User, or one of the above-identified
mapping methods. To use one of the above-identified mapping methods, select
Override the directory services mapping.

Part 10
Node Attribute and Categories
Administration
Chapter 44
Administering Additional Node Attributes
An attribute is a piece of information about an item. Attributes you define on the

Administering Additional Node Attributes page apply, by default, to all Content
Server items.
Assigning additional node attributes to items helps users locate items in the Content
Server database by allowing them to search for items by one or more specific
attributes and the assigned value, or values, for each.
When you define an attribute as either include or require, items that users add to
Content Server will contain the attribute. Users can set the attribute values for any
item for which they have the Edit Attributes permission.
OpenText recommends that you create, delete, and edit additional node attributes
while few, if any, users are connected to the Content Server database to which you
are making the changes. After you modify additional node attributes, you must
restart the servers and the Web application server. For information about restarting
the servers, see “Stopping and Starting the Servers” on page 227.
Standard Node Attributes

Each Content Server item type has a default set of attributes, which is not necessarily
the same for each item type. The attributes shown for an item on its Properties page
represent its default attributes. For example, the Document item type has the
following set of default attributes:
• Name
• Description
• Last Modified
• Owner
• Create Date
• Reserved
• Reserved By
• Reserved Date
• Version Number
• Version Name
• Version Owner
• Version Modified
• File Name

Chapter 44 Administering Additional Node Attributes
• File Size
• MIME Type
• File Type
44.1 Managing Node Attributes

After you add, modify, or delete any attributes on this page, you must restart the
server and the Web application server for the changes to be applied. For information
about restarting the servers, see “Stopping and Starting the Servers” on page 227.
The attribute name in the Name field is used in the Content Server database table,
DTree, as a column name. To be valid:
• An attribute name must consist of alphanumeric characters and underscores
only.
• If the attribute data type you select is Date, follow Content Server's Input Date
Format and use four digits for the year.
• Attribute names are case-insensitive. For example, the name test1 is the same as
the name Test1.
• Attribute names must not be words that are keywords, such as Length, Size,
Table, or Date, reserved by your RDBMS.
For a complete list of the reserved keywords, refer to the documentation that
accompanies your RDBMS software. You cannot reuse the name of a deleted
attribute.
After you create an attribute, you cannot modify the text length or data type,
although you can modify the interface display type. If you must change either of
these parameters, you must delete the attribute and recreate it using a different
attribute name.
After you add, modify, or delete any attributes on this page, you must restart the
server and the Web application server for the changes to be applied. For information
about restarting the servers, see “Stopping and Starting the Servers” on page 227.
The attribute name in the Name field is used in the Content Server database table,
DTree, as a column name. To be valid:
• An attribute name must consist of alphanumeric characters and underscores
only.
• If the attribute data type you select is Date, follow Content Server's Input Date
Format and use four digits for the year.
• Attribute names are case-insensitive. For example, the name test1 is the same as
the name Test1.
• Attribute names must not be words that are keywords, such as Length, Size,
Table, or Date, reserved by your RDBMS.

44.1. Managing Node Attributes
For a complete list of the reserved keywords, refer to the documentation that
accompanies your RDBMS software. You cannot reuse the name of a deleted
attribute.
After you create an attribute, you cannot modify the text length or data type,
although you can modify the interface display type. If you must change either of
these parameters, you must delete the attribute and recreate it using a different
attribute name.
After you delete an attribute, you cannot recreate it using the same name.
44.1.1 To View a Node Attribute

To view a node attribute:
1. Click the Administer Additional Node Attributes link in the System

Administration section on the administration page.
2. Click an attribute's Edit link.
44.1.2 To Create an Additional Node Attribute

To create an additional node attribute:

2. On the Administer Additional Node Attributes page, click the Add a New
Attribute link.
3. On the Add New Attribute page, type a unique name for the attribute in the
Name field.
4. Click one of the attribute types in the Type list.
5. For the Text: Field, type the maximum number of characters, up to 254, that you
want users to be able to enter for the attribute in the Text Length field.
6. Type the name that you want displayed for this attribute in the user interface in
the Display Name field.
7. For a Popup type attribute, click the Edit button, type each popup value on a
separate line, and then click Continue Editing Attribute.
8. For a Popup attribute type, click the desired default value in the drop-down list.
9. Click the Create Attribute button. Content Server verifies that the default value
that you specified is valid. If you receive an error message, click your Web
browser's Back button to return to the Add New Attribute page and specify a
correct value.

Chapter 44 Administering Additional Node Attributes
44.1.3 To Edit a Node Attribute

To edit an attribute:

2. Click the Edit link of the attribute that you want to edit.
3. Optional Click a new interface display type, if more than one is available, in the
Type list.
4. Optional Type a new name in the Display Name field.
5. For a Popup attribute type, click the Edit button, type any new values in the
Valid Values field, and then click Continue Editing Attribute.
44.1.4 To Delete a Node Attribute

To delete a node attribute:

2. Click the Edit link of the attribute that you want to delete.
3. Click the Delete Attribute button, and then click the OK button in the
confirmation dialog box.
44.2 Managing Attribute Settings

Additional Node Attributes apply to every item in Content Server. On the
Administer Additional Node Attributes page, you can add an additional node
attribute and view, edit, or delete additional node attribute.
Once Additional Node Attributes exist, you set how they are used in Content Server.
After you add, modify, or delete any system attributes on this page, you must restart
the server and the Web application server so that the addition or changes will apply
to the system. For information about restarting the servers, see “Stopping and
Starting the Servers” on page 227.
The Configure Attribute Value Requirement page allows you to specify that for
certain object types, users do not have to define values, even for required attributes
defined on the Administer Additional Node Attributes page.
This feature allows you to reuse attributes while defining different behaviors for
each item type.

44.2. Managing Attribute Settings
44.2.1 To Specify Attribute Settings

To specify attribute settings:

2. For each attribute, click one of the following radio buttons:
• Exclude, which sets the attribute not to appear for Content Server items.
• Include, which sets the attribute to appear for all Content Server items.
• Require, which sets the attribute to appear for all Content Server items, and
must be set to a valid value for each item.
44.2.2 To Configure Attribute Value Requirements

To configure attribute value requirements:
1. Click the Configure Attribute Value Requirement link in the System

2. For each item type, select the Required check box if you want users to define a
value for required attributes.
3. Click Submit.

Chapter 45
Working with the Categories Volume
Content Server provides the ability to define robust categories, each with any
number of single or multi-valued attributes. A category is a collection of attributes
that enables you to classify, group, or search for items defined by that set of
attributes. You define a category by choosing the types of attributes it contains, their
sequence and layout, and any default and valid values for each attribute.
Assigning categories to Content Server items helps users locate items in the database
by searching for items that belong to a particular category or have particular values
assigned to their attributes. Users can associate categories with items they add, and
set their attributes, if they have the See and See Contents permissions for a category.
Categories that you administer are accessible to all users by default.
A Content Server item associated with a category has all the attributes associated
with that category, as well as the default set of attributes defined for the item. When
you create a category, it must include at least one attribute.
Note: When you upgrade Content Server, the categories and attributes from
the previous version will not be functional until you re-export the Enterprise
data. This function re-extracts the data from the Content Server database
without purging the Enterprise index.
45.1 Managing Categories

Administering Categories
Only the administrator or a user with system administration privileges can create
categories. OpenText recommends that you restrict users' privileges to create
categories.
Category Permissions and Privileges
A category is a permissions-based item:
• To create a category, a user must have the Object Creation privilege for the
Category item, and the Add Items permission to the area in which the category
template will be stored. The Categories Volume is the default storage location in
Content Server for category templates. Only the system administrator, by
default, can create and administer categories. However, you could create a
special Category Creator group and add specific users to that group. These users
can then define new categories and add them to the workspaces to which they
have permission. Such users must have system administration rights to add a
category to the Enterprise Workspace or the Categories Volume. Any user can
edit a category if this user has Write permissions to it.

Chapter 45 Working with the Categories Volume
• To associate a category with an item, a user must have at least See and See
Contents, or Read, permission to access the category.
• To change attribute values in a category associated with an item, a user must
have the Edit Attribute permission for the item.
Using Categories
Like any other Content Server item type, such as a Folder or Document, the
Category item type can be indexed and searched, versioned, and audited.
Category version control allows you to create a category and modify it at a later
date. Changes to a category definition, however, can result in loss of data since each
attribute in the category represents a specific piece of information about the Content
Server item with which it is associated. If an attribute is deleted or changed within
the category, for example, a different sequence in the layout, that information would
no longer exist for any item associated with that category. This can adversely affect
database searches and accurate information retrieval.
With version control, previous versions of the category can remain in use and valid
for the items to which they are associated, while other items can use the newer,
modified category version. For example, suppose a document has Category X
assigned to it, and later the administrator, or other authorized user, removes or
resequences one or more of the attributes. Items currently associated with the
category are not affected until, or unless, the administrator upgrades the items with
the new category version. Versioning of attribute data, however, applies only to
Content Server items that are normally versioned, such as documents, compound
documents, and other categories.
Content Server categories can also be audited to track changes to the definition.
Note: The Category Audit page tracks modifications made to Category fields.
In order for auditing to occur on the Category fields, the Category Added
interest must be enabled. For more information about setting auditing
interests, see “Managing Audit Interests” on page 303.
Any Content Server item can be associated with one or more categories, even the
Categories Volume and the Category, in addition to the additional node attributes,
which is automatically associated with all items when added to the Content Server
database.
When a category applies to a container item, such as a Folder, Compound

Document, Task List, Project, Workflow, channel, or Discussion, all the newer sub-
items will inherit the category and its attributes.
When users assign a category to an item, the selection dialog box defaults to the
Categories Volume. Normally, only the administrator or other authorized user can
access this volume, as its link appears only on the administration page. General
users cannot edit the category, unless they have appropriate permission for it. You
can also copy categories from the Categories Volume to another location in Content
Server, such as a folder, and set unique access permissions for it.

45.1. Managing Categories
As the administrator, you can create and edit categories, since categories are
versioned items in Content Server, you can create and modify categories without
having to restart the server.
45.1.1 To Add a Category

To add a Category:
1. Click Category on the Add Item menu.

2. On the Add: Category page, type a name for the Category in the Name field.
If your system has multiple languages installed and enabled, click the click to
edit multilingual values button to edit the names in the other, enabled,
languages.
3. Optional In the Description field, type a description for the LiveReport.
If your system has multiple languages installed and enabled, click the click to
edit multilingual values button to edit the descriptions in the other, enabled,
languages.
4. Optional In the Categories field, click Edit to either select or add a Category to
apply to this Category.
5. To place the item in a location other than that which appears in the Create In
field, click the Browse Content Server... button, navigate to the container where
you want to locate the category, then click its Select link.
6. Click Add.
Note: After you create a Category, you must add attributes to it. For more
information, see “Managing Node Attributes” on page 928.
45.1.2 To Add a Category Folder

To add a Category Folder:
1. Choose Category Folder on the Add Item menu.

You can only save a Category Folder to the Categories Volume or another
Category Folder.
2. Type a name for the Category Folder in the Name field.
3. Optional Type a description of the Category Folder in the Description field.
4. To modify the categories or attributes associated with the category, click the
Edit button.
5. To place the item in a location other than that which appears in the Create In
field, click the Browse Content Server... button, navigate to the container where
you want to locate the category, then click its Select link.
6. Click the Add Item button.

Chapter 45 Working with the Categories Volume
45.1.3 To Edit a Category

To edit a Category:
1. Click a Category's Functions icon, and then choose Edit.
2. On the Category page, add attributes to the Category, or edit its existing
attributes.
3. Click Submit.

Part 11
Server Clusters Administration
Chapter 46
OpenText Content Server Cluster Management
OpenText Content Server Cluster Management manages the application of Content

Server patches, Updates and language packs, on a single instance of Content Server
and throughout a Content Server cluster. Cluster Management automatically
handles patch dependencies and removes superseded patches when a newer or
more complete version of a patch is applied.
Note: The ability to download, stage, and deploy Updates and language packs
is introduced in Service Pack 1 for Content Server 10.5, but cannot be used until
the release of Update 2015–03. The first Update and corresponding language
packs that Cluster Management can install on Content Server 10.5 is Update
2015–03.
Cluster Management can be used to update a standalone installation of Content

Server, but it is designed with clusters in mind to update a Content Server
configuration simply and efficiently across a Content Server cluster.
Using Cluster Management to manage patches, Updates and language packs in a

Content Server cluster involves three main operations:
1. Download
You use Cluster Management to download patches, Updates and language
packs to your Cluster Management Master System.
2. Stage
Cluster Management stages downloaded items in the Content Server database,
so the items are available to every instance in your Content Server cluster.
3. Deploy
You use Cluster Management to install staged items to every instance in your
Content Server cluster.
If Cluster Management is unable to automatically update your entire Content Server

cluster, it rolls back the changes that it is making. If you ever need to manually roll
back the application of a patch, Update or language pack, Cluster Management
provides features and information that facilitate the rollback operation.
In addition, Cluster Management Update Analysis allows you to preview the effects
that a Content Server Update will have on your system so that you can remove
obsolete patches and make appropriate backups before applying an Update.
To begin using Cluster Management, you must first ensure that your Cluster
Settings are set properly. See “Managing Cluster Settings” on page 944.

Chapter 46 OpenText Content Server Cluster Management
46.1 Using Cluster Audit History

Cluster Audit History records events that are performed by Cluster Management.
The Audit History page displays these events for each host in your Content Server
cluster. For each event, the following information appears:
• Event Type is the type of event that occurred. Audited events include Patch
Deployment, Analyze System, and Update Analysis.
• Date is the date and time of the event.
• Result is the outcome of the event. The result is either OK or Error.
Tip: If the result is Error, you may be able to find information on the cause
of the problem in the otclusteragent log file, located in the
<Content_Server_home>/logs/ folder.
• Source is the IP address or domain name of the computer that triggered the
event.
• Details provides additional information about the event. The information varies
according to the Event Type.
Analyze System
Information includes whether the Content Server instance that performed the
analysis is the Master System (Is_master_system: true).
Start (or Stop) Admin Server Service

Information includes the Content Server application folder (OTHome ) and the
startup type (typically Auto).
Start (or Stop) Content Server Service

Information includes the Content Server application folder (OTHome ) and the
startup type (typically Auto).
System Update Preflight Check

Information includes the current Update Level and the items that were to be
installed and removed.
Update Analysis
No additional information is provided.
Update/Patch Deployment
Information includes the current Update Level and the items that were
installed and removed.

46.2. Managing Cluster Agents
46.1.1 To View Cluster Audit History

To view Cluster Audit History:
1. In the Server Configuration section of the Content Server Administration

page, click Cluster Management.
2. On the Cluster Management page, click Cluster Audit History.
3. On the Audit History page, select a Content Server instance in the Hosts list.
4. Click Details to view the event details.
46.2 Managing Cluster Agents

The Cluster Agents page displays information about the hosts and instances in your
Content Server cluster:
• Host is the name of a computer that runs one or more instances of Content
Server. Select a host to view the Content Server instances available on it.
• To view Detailed host information about the Content Server computer, click
online.
Tip: In the Detailed host information dialog box, information on CPU,

memory, or disk usage appears in yellow or red if it exceeds a certain
threshold (by default, 80%). You can adjust the threshold for each of
these items by editing the config.ini file. See “Host Monitoring”
on page 962.
• To remove a host from the Content Server cluster, click remove. (See
“Removing Content Server Hosts and Instances” on page 943.)
• Instances for <Content_Server_host> shows the installations of Content Server on
each host.
• Install Path is the location of the Content Server application folder on the
instance.
• Port is the number of the port that the Content Server instance uses.
• Under Action, you can click Processes or Remove.
• To view detailed information about Content Server processes being run on
an instance, click Processes.
• To remove an instance from Content Server Cluster Management, click
Remove. (See “Removing Content Server Hosts and Instances”
on page 943.)
Note: Clicking Remove causes a Content Server host or instance to be removed

from the cluster for the purposes of Cluster Management. It does not uninstall
Content Server from the host or instance.

46.2.1 Adding and Removing Content Server Hosts and

Instances
The Cluster Agents page allows you to verify the addition of new Content Server
hosts and instances. If it displays any Content Server hosts and instances that are not
actually part of your Content Server cluster, it allows you to remove them from the
listing.
Adding Content Server Hosts and Instances

When an instance of Content Server starts, it registers itself (and its host, if
applicable) in the Cluster Management database. Content Server instances that are
part of your cluster appear on the Cluster Agents page.
Tip: If one of your Content Server hosts or instances does not appear on the
Cluster Agents page, restarting the applicable instance of Content Server may
resolve the problem.
When you add a new instance to your Content Server cluster, you typically need to
bring the new Content Server instance up to the same patch level as the existing
instances in your Cluster. Cluster Management does this automatically for you the
next time that you deploy a patch to your Content Server cluster. When you add the
new patch to the cluster, Cluster Management notes that your new instance is
missing the patches that are present on your other instances, and it automatically
installs the missing patches when it deploys the new patch to the entire cluster.
To add a new Content Server cluster node:
1. Install a new instance of Content Server. Ensure that it is at the same Update
level as your existing instances. Connect the new instance to the same Content
Server database that the other instances use.
For information on installing Content Server, see OpenText Content Server -
Installation Guide (LLESCOR-IGD).
2. Optional After you have completed the installation of the new instance of Content
Server, verify that the host and instance are listed on the Cluster Agents page.
3. Use Cluster Management to deploy a new patch to your cluster, as described in

“Applying Patches, Updates, and Language Packs” on page 947. Before it
deploys the new patch, Cluster Management displays a dialog that warns you
that the new cluster node is missing patches, and asks if you want to continue.
4. Click OK. Cluster Management adds the new patch to every node in the cluster
and brings the new Content Server instance up to date, so that it has all of the
patches that were already present on the other cluster nodes.
5. Optional Verify that the operation completed successfully by looking at the details
of the Update/Patch Deployment event on the Cluster Management Audit
page.

46.2. Managing Cluster Agents
Removing Content Server Hosts and Instances

In some situations, the Cluster Agents page can display a Content Server host or
instance that does not actually exist in your Content Server cluster. This can happen:
• When a Content Server instance is “cloned” (copied from an existing instance,

rather than installed using the Content Server installer).
• When an existing Content Server cluster node is uninstalled.
To stop the host or instance from appearing on the Cluster Agents page, click
remove beside its listing on the Cluster Agents page.
Removing a cluster node in this manner does not affect its Content Server
installation in any way. Its only effect is to remove its registration with Cluster
Management. If, for example, you remove a functioning instance of Content Server,
it does not uninstall that instance of Content Server. It merely removes its
registration with Cluster Management. The instance will register itself again the next
time that it restarts.
46.2.2 Resolving Cluster Agent Communication Errors

If you are unable to access information on the Cluster Agents page, and an error
message appears that states A communication error has occurred or The agent
for the requested host is currently offline, it is possible that the Cluster
Agent is unable to communicate with the database.
Resolving Database Communication Errors

To resolve communication errors, verify that the database connection is available
and review the following issues to see if any of them apply to your deployment.

If you use Microsoft SQL Server for your Content Server database and run it on
a non-default port or do not enable the SQL Server Browser service, see
“Microsoft SQL Server Settings” on page 967 for information on editing the
config.ini file to allow Cluster Management to connect to SQL Server.
Oracle Database
If you use Oracle Database for your Content Server database and run Content
Server on Microsoft Windows, the bin folder of the Oracle Database client must
be included in the Windows Path system environment variable. Otherwise,
Cluster Management might be unable to connect to Oracle Database. See “Oracle
Database Settings” on page 968 for information on editing the config.ini file
to rectify this problem.
Alternatively, the Cluster Agent might be unable to connect to the database because
of problems with name resolution. When you open Content Server to use Cluster
Management, ensure that you are using a fully qualified domain name and not
localhost, a host name, or an IP address.

Configuring Cluster Management to use HTTPS

Cluster Management may encounter communication errors in a Content Server
environment that uses HTTPS. To configure Cluster Management to use HTTPS,
modify the config.ini file of each registered Cluster Agent. Follow the instructions
in “HTTPS Settings” on page 964.
46.3 Managing Cluster Settings

TheCluster Settings page contains the basic settings that Cluster Management
requires to run.
• Manifest URL sets the URL that is used for updating the system manifest. Set the
Manifest URL that applies to your system:
• Windows, http://
mimage.opentext.com/support/ecm/contentserver/16.0/
manifest_win.xml
• Linux, http://
mimage.opentext.com/support/ecm/contentserver/16.0/
manifest_lnx.xml
• Master System is the Content Server instance whose configuration is replicated
to the other instances in the Content Server cluster.
• Patch Staging Folder is the location on the Content Server instance where new
patches, Updates, and language packs are staged for the database. The default
staging folder is <Content_Server_home>/clustermanagement/staging/.
• Enabling Download allows you to automatically download multiple Content
Server items from the OpenText Knowledge Center and stage them directly to
the database. (If you do not enable Download, you can still download Content
Server patches and Updates using your browser, but you must download each
item separately and then move them to the Patch Staging Folder.)
46.3.1 To Manage Cluster Settings

To manage Cluster Settings:
1. Open the Cluster Settings page.
a. In the Server Configuration section of the Content Server Administration

b. On the Cluster Management page, click Manage Cluster Settings.
2. Enter the Manifest URL.
a. Type the URL for updating the manifest in the Manifest URL box.
Note: If you cannot access the manifest file over the Internet, see
“Manifest File Connection Problems” on page 945.

46.3. Managing Cluster Settings
b. Click Check URL to validate the manifest URL.
3. Select a Master System.
a. Click Browse to open the Select a Master System dialog box.
b. Enable the host that you wish to use for your Master System, and then click
OK.
4. Enter the location of the Patch Staging Folder or accept the default location.
Tip: Click Reset to set the Patch Staging Folder to its default setting.
5. Optional Enable Download to configure Cluster Management to automatically

download and stage patches, Updates, and language packs.
Tip: If your Content Server Master System is connected to the Internet,

OpenText recommends that you enable automatic downloads.
6. Click Save Settings.
46.3.2 Manifest File Connection Problems

If Content Server cannot access the manifest.xml file over the Internet, when you
attempt to validate the manifest URL, Cluster Management displays: The platform
listed in the manifest does not match the host operating system. Please
verify the configured manifest URL and try again.
Tip: To test whether you can access the manifest.xml file over the Internet,
copy its URL into your browser address bar. If you can access the file, its
contents appear in your browser.
If this error message appears when you attempt to validate the URL, you can
attempt to resolve the underlying problem (see “Resolving Manifest Connection
Problems” on page 946) or you can host the manifest file locally (see “Hosting the
Manifest File Locally” on page 947). If your Content Server host is configured to
prevent it from accessing the Internet, you must host the manifest locally.

Resolving Manifest Connection Problems

In some environments, the use of a firewall or proxy server can prevent Cluster
Management from connecting to the manifest file.
Proxy
To configure Content Server to use a proxy and allow Cluster Management to
connect to its manifest file, add Java configuration settings to the [javaserver]
section of the opentext.ini file for each Content Server instance that runs the
Cluster Agent.
The Java proxy configuration settings that you add to the [javaserver] section of
the opentext.ini file have the following appearance:
JavaVMOption_<#>=-D<java_option>=<value>
Increment the <#> portion of each JavaVMOption_<#> setting that you add. For
example, if your opentext.ini file contains three JavaVMOption_<#> settings, with
the third one being JavaVMOption_3, the next one that you add should be
JavaVMOption_4.
To permit Cluster Management to connect to its manifest file through a proxy

server, add the following settings to the [javaserver] section of the opentext.ini
file:
• JavaVMOption_<#>=-Dhttp.proxyHost=<ip_of_proxy>. For example,

JavaVMOption_4=-Dhttp.proxyHost=10.2.3.4
• JavaVMOption_<#>=-Dhttp.proxyPort=<port_of_proxy>. For example,
JavaVMOption_5=-Dhttp.proxyPort=80
• JavaVMOption_<#>=-Dhttp.nonProxyHosts=<list_of_hosts>. For example,
JavaVMOption_6=-Dhttp.nonProxyHosts=localhost
The value of JavaVMOption_<#>=-Dhttp.nonProxyHosts can be a single host,

or a list of hosts, each separated by a pipe symbol (|). A wildcard character (*)
can be used for matching. For example, you could add JavaVMOption_6=-
Dhttp.nonProxyHosts=*.example.com|localhost to your opentext.ini file.
To configure Cluster Management to work in an environment with a proxy server,

set the values of JavaVMOption_<#>=-Dhttp.proxyHost and JavaVMOption_<#>=-
Dhttp.proxyPort to whatever is appropriate for your network, and set the value of
JavaVMOption_<#>=-Dhttp.nonProxyHosts to localhost (and any other hosts
whose traffic the proxy should not process).
Note: To enable Cluster Management to download patches, Updates, and

Language Packs automatically, configure your proxy server to allow access to
the Knowledge Center (knowledge.opentext.com).

46.4. Applying Patches, Updates, and Language Packs
Hosting the Manifest File Locally

If Content Server cannot access the manifest file over the Internet, you can host a
copy of it locally on the web server that you use with Content Server. The following
instructions show how to use your Content Server support folder (the img virtual
folder, by default) to host a local copy of the Cluster Management manifest file.
Important
OpenText updates the Cluster Management manifest file daily. If you host
the manifest file locally, be sure to update it before you perform any Cluster
Management functions that use the manifest file.
To host the manifest file locally:
1. Download a copy of the manifest file that is appropriate for your operating
system.
a. Open the address of the manifest file in your browser address bar.
b. Use your browser to save a local copy of the manifest file.
Note: In Firefox, you must open the address of the manifest file and
then click Page Source before you save a copy of the manifest file. If
you do not, Content Server displays the following message when you
click Check URL on the Manage Cluster Settings page:
The provided URL does not contain a valid OpenText signed
manifest file. Please check the URL and try again.
2. Save the manifest file to your <Content_Server_home>\support\ folder.
3. In the Update URL box, enter http://<Content_Server>/

<virtual_folder>/<manifest_file>.
Example: Enter http://

myContentServer.domain.com/img/manifest_win.xml
If the Manifest URL Validated dialog box appears, you have successfully hosted
your manifest file.
46.4 Applying Patches, Updates, and Language Packs

To apply patches, Updates and language packs, open the Manage Updates page.
Notes
• The ability to download, stage, and deploy Updates and language packs is
introduced in Service Pack 1 for Content Server 10.5, but cannot be used
until the release of Update 2015–03. The first Update and corresponding
language packs that Cluster Management can install on Content Server 10.5
is Update 2015–03.

• For information on how to manually reverse the effects of a patch or Update

deployment, see “Rolling Back a Deployment Manually” on page 959 for
details.
46.4.1 The Manage Updates Page

The Manage Updates page lists patches and Updates that are available, staged, or
installed, and it provides tools for downloading, staging, and installing Updates,
language packs and patches.
Note: Language packs do not appear on the Manage Updates page, but
language packs for the languages in your multilingual Content Server
installation are deployed by Cluster Management if they have been staged. See
“Downloading and Staging Patches and Updates” on page 951.
When you open the Manage Updates page, Cluster Management runs an analysis of
your Master System. (If your system has not changed since the last time you opened
this page, the analysis does not run.)
The Analyze Master System dialog box indicates the progress of the Master System
Analysis. Once the analysis completes, an Analysis Report appears showing your
current Update level, installed patches, and installed optional modules. To review
the Analyze Master System output, click More Details. Otherwise, click OK to
display the Manage Updates page.
The Available, Staged, and Installed Views

The Manage Updates page has three views: Available, Staged, and Installed.
• The Available view lists the Updates and patches that are available on the
OpenText Knowledge Center for download. Cluster Management handles
patches for core Content Server and for optional Content Server modules, so the
patches that appear in this view depend on the modules that you have installed
on your Content Server instance.
When you open the Available view, your current Update is selected and only
patches that are applicable to it appear. You can filter the view to show patches
that apply to a specific Update, or search for patches using the Search box.
• The Staged view lists the Updates and patches that you have downloaded and
staged. Staged items are ready to be deployed to your Content Server cluster.
Patches that are deprecated (rendered unnecessary by an Update) appear in red
and cannot be deployed. You can remove a deprecated patch from the Staged
view by clicking Remove in the Action column, or you can remove all of the
deprecated patches in the Staged view by clicking Remove Deprecated.
• The Installed view lists the Updates and patches that are installed, indicating
their status as one of the following:
Error
An item with a status of Error has not been correctly installed. It appears
with a red background.

Unknown
Cluster Management assigns an Unknown status to items that do not appear
in the Cluster Management manifest file. Items with a status of Unknown
appear with a red background. Unknown items may include patches for third-
party or custom modules.
Removal
Items with a status of Removal appear with a yellow background. Cluster
Management removes items that have a status of Removal the next time that
you click Deploy on the Staged view.
Verified
Items with a status of Verified have been successfully installed.
Columns on the Manage Updates Page

On each of the views on the Manage Updates page, information is provided under
the following columns:
<check_boxes>
An unlabeled column containing check boxes appears on the left side of the
Staged view. If you have enabled automatic downloads, it appears in the
Available view too.
• In the Available view, when you enable the check box beside one or more
items and then click Download, you are prompted to provide a valid
OpenText Knowledge Center logon. After you do, Cluster Management
automatically downloads the items from the Knowledge Center and then
stages them.
• In the Staged view, when you enable the check box beside one or more items
and then click Deploy, the items are installed to your Content Server cluster.
Name
The name of the patch.
Description
A brief description of the item. The description may include the change made by
the item, the issue resolved by the item, and an issue number from the OpenText
issue tracking system.
Modules
The module that the item applies to. If None, the patch applies to core Content
Server.
Action
Links that appear in this column allow for various actions:
• Remove appears only on the Staged view. Click Remove to delete a staged
item.

• Details appears on each of the views. Click Details to open a page that
provides information on a patch. (For more information, see “The Details
Page” on page 950.)
• A Download link appears if you have not enabled automatic download on
the Cluster Settings page. Click Download to download an item using your
browser.
The Details Page

The Details page provides the following information on patch or Update:
Name
The name of the item.
Description
A brief description of the item. The description may include the change made by
the item, the issue resolved by the item, and an issue number from the OpenText
issue tracking system.
Impacts
A description of the effect that the item has on your overall Content Server
deployment. If Database Schema, Content in the File Store, or Search Index
appears in this field, it indicates that the named component is changed by
applying the patch.
Important
If any of the above items are listed in the Impacts field, it is particularly
important to take a full backup of your system before applying the patch.
Minimum Update
The Update level required by the item. This section shows the earliest Update
that must be present on your Content Server for the item to be supported. The
item remains supported in every later Update, unless an Update appears in the
Deprecated Update section.
Deprecated Update
The Update level as of which the item is deprecated and must be removed. The
item is deprecated in the indicated Update and in every later Update.
Modules
The module that the item applies to. If None, the item applies to core Content
Server.
Supersedes
A different item that the current item is intended to replace. The superseded
item is automatically removed when you install the current item.
Superseded by
A different item that is intended to replace the current item. Normally, you
should download and install the different item that appears in this field instead
of using the current item.

Tip: If you attempt to download or install a superseded item, Cluster

Management prompts you to download or install the superseding item
instead.
Dependents
Items that are listed in this field are required to be installed with the current
item.
To View Available Items

To view available items:
1. Open the Manage Updates page.

b. On the Cluster Management page, click Manage Updates.
2. On the left, click Available.
Tip: Use the Current Filter menu and Search box to help locate items of
interest.
46.4.2 Downloading and Staging Patches and Updates

Before you can use Cluster Management to stage or install a patch or Update, you
must download the item from the OpenText Knowledge Center. Cluster
Management provides three ways to do this:
• Automatic Method
If you enable automatic downloads on the Cluster Settings page, Cluster
Management downloads and stages patches and Updates automatically. When
you enable an item and click Download, Cluster Management prompts you for a
valid Knowledge Center logon. After you log onto the Knowledge Center,
Cluster Management downloads and stages the selected item.
If you have a multilingual deployment of Content Server, when you use the
automatic method to download and stage an Update, Cluster Management
automatically downloads and stages the language packs for the Update.
Note: Cluster Management downloads language packs only for the

languages that you have implemented in your Content Server deployment,
and does not download module language packs.
• Manual Method
If you do not enable automatic downloads on the Cluster Settings page, Cluster
Management provides a link that you can use to download an item from the
Knowledge Center. After you download the item, you place it in the Patch
Staging Folder, and Cluster Management stages it in the Content Server
database.

If you have a multilingual deployment of Content Server, when you use the
manual method to download and stage an Update, Cluster Management does
not download and stage the language packs for the Update. You must log onto
the OpenText Knowledge Center, download any language packs that you
require, and then place them in the Patch Staging Folder.
• Manual Method Using Drag and Drop
This method is a variation of the manual method. After you manually download
an item, you drag it onto the Staged view of the Manage Updates page. Cluster
Management then automatically stages it in the Content Server database.
Important
If you use Microsoft Internet Information Services, you must set its
Maximum allowed content length (Bytes) Request Filtering setting to
a value that is higher than the size of the Content Server Update in Bytes.
OpenText recommends that you set Maximum allowed content length
(Bytes) to 250,000,000 Bytes to permit large files to be uploaded to or
downloaded from Content Server.
To Automatically Download and Stage Items

If you have enabled automatic downloads on the Manage Cluster Settings page (see
“Managing Cluster Settings” on page 944), check boxes are visible to the left of each
item on the Available view, and you can use the following method to download
items automatically.
To automatically download and stage items:

2. In the Available view, select the check box beside each item that you wish to
download, and then click Download.
Tip: To download every available patch, select the check box in the top
row of the Patches section.
3. When the Confirm Download Package dialog box appears, click OK.
4. When the Knowledge Center Login dialog box appears, enter a valid
Knowledge Center user name and password, and then click OK.
A progress indicator appears showing the progress of each download and the
overall progress. After the progress indicator shows that completion is at 100%, the
indicator disappears and you are returned to the Manage Updates page. Your items
now appear in the Staged view and are ready to be installed.

To Manually Download and Stage Items

If you have not enabled automatic downloads on the Manage Cluster Settings page
(see “Managing Cluster Settings” on page 944), download links appear in the Action
column of each item on the Available view, and you can use the following method
to download items.
To manually download items:

2. In the Available view, click Download beside the item that you want to
download from the OpenText Knowledge Center.
3. Use your browser to save the item on your file system.
4. Stage the item by one of the following methods:
• Drag the file onto the Staged view of the Manage Updates page.
• Move the file into the Patch Staging Folder.
After a short delay, Cluster Management moves your item into the Content Server
database. Your item now appears in the Staged view and is ready to be installed.
To View Staged Items

To view staged items:

2. On the left, click Staged.

To Remove Staged Items

You can remove any staged item from the Staged view by clicking Remove in the
Actions column. Or you can click Remove Deprecated to remove every deprecated
patch in a single operation.
To remove a staged item:

3. In the row of the patch you wish to remove, click Remove in the Action column.
To remove all of the deprecated patches from the Staged view:

3. Click Remove Deprecated.
46.4.3 Installing Patches, Updates and Language Packs

Items that have been staged are ready to be installed to your Content Server cluster.
To install an item, select it and click Deploy. Cluster Management validates
prerequisites, shuts down every instance in the cluster, installs the item on every
instance in the cluster, upgrades the Content Server database (if necessary), and then
restarts every instance in the cluster.
When you deploy an Update, Cluster Management automatically deploys staged

language packs for any languages that you have installed in your Content Server
deployment. In addition, OpenText recommends that you install all of the available
patches for the Update at the same time that you install the Update. For this reason,
you should ensure that you have downloaded and staged all of the available patches
for the Update that you are installation before you deploy the Update.
If Cluster Management encounters an unrecoverable error at any stage of the

deployment, it informs you that it is unable to complete the deployment and offers
to roll back any software changes that it has already made.
Important
Cluster Management rolls back software changes that are made to the
Content Server application folder. It does not roll back changes to the

Content Server database, file store, or search index. If Cluster Management is

unable to complete a deployment that makes changes to one of these items,
you must restore a Content Server backup set.
To Install Items
To install items:

Tip: Click Details to learn more about each item that you intend to install.
Pay particular attention to the information in the Impacts field as this will
dictate the backup items that you require. (See “The Details Page”
on page 950.)
3. Enable the items that you want to install.
Note: Unless an item has a dependency, you can install items in any order.
When there are dependencies, Cluster Management ensures that items are
installed in the necessary order.
• When a patch has a dependency on another patch, the required patch is

installed first.
• When an item that modifies Cluster Management is selected for
installation, it is always installed before any other items.
4. Click Deploy.
5. Review the information in the Confirm Deployment Package dialog box and
then click OK.
6. The Deployment Status dialog box appears and indicates the progress of the
deployment. Upon successful completion of the deployment, the Deployment
Complete dialog box appears. Click OK to return to the Deployment Status
dialog box.
Note: If Cluster Management reports that it has encountered an

unrecoverable error, see “To Roll Back a Deployment” on page 956.
7. Review the information in the Deployment Status dialog box, and then click
OK to return to the Manage Updates page.

To Roll Back a Deployment

If Cluster Management encounters an unrecoverable error during deployment of a
patch, Update or language pack, the Unrecoverable Error dialog box appears. To
learn more about the nature of the error, click More Details.
To roll back a deployment:
1. On the Unrecoverable Error dialog box, click Rollback.
2. The Software Rollback dialog box appears and advises you that a software
rollback only restores changes made by the current deployment and does not
restore your database, file store, or search index. It asks you “Do you still wish
to proceed with the software rollback?”.
Important
If the deployment attempted to make changes to your database, file
store, or search index, you must roll back these changes by restoring a
backup. Cluster Management does not do this.
To proceed with the software rollback, click Yes.

3. If you click Yes, the Deployment Status dialog box appears and shows the
progress of the software rollback. When rollback is complete, the Rollback
Complete dialog box appears and asks you if you want to restart the Content
Server services.
Important
If you need to restore a database, file store, or search index backup, do
not start the services until the backup has been restored.
4. If you click Yes, the Deployment Status dialog appears and indicates that
Cluster Management is restarting your Content Server cluster. When the
services have restarted, Cluster Management displays the Rollback Complete
dialog box indicating that it has completed the software rollback and restarted
the Content Server services. Click OK.
5. When the Deployment Status dialog box appears, click OK to return to the
Manage Updates page.

46.4.4 Viewing Installed Items

You can view a listing of the patches that you have been applied to your Content
Server cluster on the Installed view of the Manage Updates page.
• Patches that appear with no background are successfully installed (Verified) .
• Patches that appear with a red background are either unsuccessfully installed
(Error) or do not appear in the Cluster Management manifest file (Unknown).
(Unknown patches could be for third-party or custom modules.)
• Patches that appear with a yellow background (Removal) will be removed the
next time that you click Deploy on the Staged view of the Manage Updates
page.
Installed Updates and language packs do not appear on the Installed view of the
How can you tell which Update and language packs are applied?
• The current Update can be viewed on the Available view of the Manage
Updates page. It appears by default in the Current Filter box. The same
information is also available in the Current Update (Master) box on the
Cluster Management Update Analysis page.
• To verify successful application of a language pack, open the Cluster
Management Audit History page and look at the Details of the
Update/Patch Deployment event that corresponds to your application of
an Update.
To View Installed Items

To view installed items:

2. On the left, click Installed.

46.5 Analyzing Updates

Update Analysis gives you insight into the changes that a Content Server Update
will make to your system. By using Update Analysis, you can determine whether
any of the existing files in your Content Server deployment need to be preserved
before you apply the Update, and you can identify patches that need to be removed
before you apply the Content Server Update.
46.5.1 Generating an Update Analysis Report

To generate an Update Analysis report:
1. In the Server Configuration section of the Content Server Administration

2. On the Cluster Management page, click Update Analysis.
The Update Analysis page opens. It displays your Current Update (Master) at
the top of the page.
3. In the Destination Update menu, select the Update whose effects you wish to
analyze.
4. In the Hosts section of the page, expand any host and enable one or more
Content Server instances.
5. Click Start Analysis, and then click Yes on the Analysis Confirmation dialog
box.
The Update Analysis commences. The Analysis Status updates as the analysis
progresses.
6. When the Analysis Complete dialog box appears, click OK.
To view the Update Analysis report, expand the host and Instance whose report you
wish to view, and then click View Report.
46.5.2 Interpreting the Content Server Update Delta Report

The Update Analysis Delta Report provides information on the files that will be
replaced by the Content Server Update indicated in the Overview section of the
report. (It is the Update that you selected in “Generating an Update Analysis
Report” on page 958.)
The Summary section of the report provides general information on your Content
Server system. It also lists patches that you should remove before you apply the
Content Server Update.
Tip: You can run Update Analysis at any time to check whether you have
deprecated patches deployed on your Content Server system.
In the Update Analysis Delta Report, each file is categorized as NEW, VERIFIED, or
DIFFERENT.

46.6. Rolling Back a Deployment Manually
NEW
NEW files are files that the Update will add to Content Server. They do not
currently exist in your Content Server installation.
VERIFIED
VERIFIED files are files that the Update will replace and that have a hash value
that matches one in your Cluster Management manifest file. Having a matching
hash value indicates that the file has not been modified since its installation. In
other words, the file to be replaced by the Update is the file that the Update
expects to replace.
DIFFERENT
DIFFERENT files are files that the Update will replace, but whose hash value does
not match one in your Cluster Management manifest file. This indicates that the
file is not the same as when it was first installed. It may have been customized
by the System Administrator, by a third-party integration, or by some other
means. A DIFFERENT file is not the file that the Update expects to replace, and
may contain modifications that you wish to preserve. OpenText recommends
that you back up DIFFERENT files before you apply an Update.
Update Analysis also provides a list of patches that you should remove from
Content Server before you apply the Update.
Important
The list provided by the Update Analyses is as complete as possible, but you
should also review the list of patches to be removed that appears in the
Content Server Release Notes. If additional removable patches are identified
after the release of the Update, the Release Notes will include patches that
are not listed in the Update Analysis Delta Report.
46.6 Rolling Back a Deployment Manually

Note: If Cluster Management encounters an unrecoverable error, it attempts to
roll back the software deployment (see “To Roll Back a Deployment”
on page 956), but there may be times that you need to manually roll back a
Cluster Management deployment yourself. This section provides information
on performing a manual rollback.
Each time you use Cluster Management to install one or more items, Cluster
Management creates a backup folder in the <Content_Server_home>/
clustermanagement/recovery/ folder. The name of the backup folder is based on
the date and time that you installed the patches.
Example: The patchdeployment-2014-03-18-16-10-25 folder corresponds to a

deployment performed on March 18, 2014 at 16:10:25.
A backup folder contains a recovery manifest and a compressed archive containing

Content Server application folders and files.

The Recovery Manifest

The recovery manifest file (recovery_manifest.xml) contains information on the
contents of the backup folder and on the various steps that you must take to roll
back a patch deployment.
The information in the recovery manifest appears in three sections:
recoveryFilesArchive
This section shows the location of the compressed archive containing the
Content Server application folders and files that were changed by the
deployment. The folders are in the state they were in before the items were
applied. Restoring these folders to the <Content_Server_home> folder reverses the
effects of the deployment on the Content Server application files.
removeFiles
This section lists files that you must manually delete to complete the rollback of
the deployment.
impacts
This section lists Content Server components (the Content Server database,
external file store and search index) that could be modified by a patch. A value
of true indicates that the component was changed. If Database Schema, Content
in the File Store, or Search Index has a value of true, you must restore a
Content Server backup set to completely roll back the deployment.
The Compressed Archive

A compressed archive file called recovery_files[.zip] contains backup copies of
the Content Server files and folders that were affected by the deployment. Restoring
these files and folders restores the Content Server application folder to the state it
was in before the deployment.
46.6.1 To Roll Back a Deployment

Perform these steps on each instance in the Content Server cluster. If your
environment includes Secure Extranet Architecture servlet hosts and the
recovery_files[.zip] file includes the support folder, restore the support folder
on each servlet host.
To roll back a patch deployment:
1. Stop the Content Server services.
2. If, in the impacts section of the recovery manifest, Database Schema, Content
in the File Store, or Search Index has a value of true , restore a Content
Server backup set taken before the patch deployment that is being rolled back. If
the backup set that you restore includes the <Content_Server_home> folder, do
not complete steps 3 and 4 of this procedure.

46.7. Editing the Cluster Management config.ini File
Important
A Content Server backup set consists of, at a minimum, the following
items that were backed up simultaneously:
• The <Content_Server_home> folder.
• The Content Server database
• The Content Server External File Store
• One or more Content Server Search Indexes
For more information, see “Backing Up and Restoring Content Server”

on page 230.
3. Extract the contents of the recovery_files[.zip] file to the
<Content_Server_home> folder, overwriting files as necessary.
Note: If there is no recovery_files archive present in the backup folder,

no files were affected by the deployment and there is no need to restore
the <Content_Server_home> folder to a prior state.
4. Browse to the <Content_Server_home>/patch/ folder and delete each file that

is listed in the removeFiles section of the recovery manifest.
5. Start the Content Server services.
Tip: After you have completed the rollback, analyze your Master System (see
“Applying Patches, Updates, and Language Packs” on page 947). The patches
that you removed manually should now appear in the Staged view of the
46.7 Editing the Cluster Management config.ini File

This section describes Cluster Management configurations can only be done in the
Cluster Management config.ini file. The Cluster Management config.ini file is
located in the <Content_Server_home>\config\otclusteragent\ folder.
Stop the Content Server Cluster Agent service before you edit the Cluster
Management config.ini file. Restart the service after you make changes to the
config.ini file.

46.7.1 Access Control

The Access-Control-Allow-Origin setting specifies the hosts that are permitted to
communicate with the Content Server Cluster Agent service. By default, this setting
does not appear in the config.ini file. This is equivalent to Access-Control-
Allow-Origin: * , which means that any host can communicate with the Content
Server Cluster Agent service.
Access-Control-Allow-Origin
• Syntax:
Access-Control-Allow-Origin: <server.domain.com> or <ip_address>
• Values:
A host name or an IP address.
• Example:
Access-Control-Allow-Origin: *.mydomain.com
46.7.2 Cluster Agent Port

The Cluster Agent port is set by the Content Server installer and appears in the
org.osgi.service.http.port setting. By default, the value of this setting is 3099.
You can change the TCP/IP port that the Cluster Agent uses by editing the value of
this setting.
org.osgi.service.http.port
• Syntax:
org.osgi.service.http.port=<port>
• Values:
A TCP/IP port number.
• Example:
org.osgi.service.http.port=3456
46.7.3 Host Monitoring

You can view monitoring information on the Cluster Agent host by clicking online
beside the name of the host on the Cluster Agents administration page.

When resource usage for disk, memory, or CPU exceeds a certain threshold, that
section appears in yellow. If the resource usage for all three of these items exceeds
the configured threshold, the sections all appear in red.
By default, the threshold for each measured item is set at 80%, but you can modify
that threshold by editing the config.ini file. The settings for each item appear
below.
agent.monitor.cpu.threshold.percent
• Syntax:
agent.monitor.cpu.threshold.percent=<percentage>
• Values:
An integer from 0 to 100.
• Example:
agent.monitor.cpu.threshold.percent=75
agent.monitor.memory.threshold.percent
• Syntax:
agent.monitor.memory.threshold.percent=<percentage>
• Values:
• Example:
agent.monitor.memory.threshold.percent=55

agent.monitor.disk.threshold.percent
• Syntax:
agent.monitor.disk.threshold.percent=<percentage>
• Values:
• Example:
agent.monitor.disk.threshold.percent=65
46.7.4 HTTPS Settings

The settings described in this section affect the use of HTTPS and encryption keys.
To configure Cluster Management to work in a Content Server environment that

uses HTTPS, edit the config.ini file so that:
• HTTP is disabled and HTTPS is enabled.
• org.eclipse.equinox.http.jetty.http.enabled=false
• org.eclipse.equinox.http.jetty.https.enabled=true
• The value of the secure port is set to the same value as the Cluster Agent port.
(The default port is shown in the example.)
• org.osgi.service.http.port.secure=3100
• It contains the SSL and keystore passwords, and the location of your keystore.
• org.eclipse.equinox.http.jetty.ssl.password=ssl_password
• org.eclipse.equinox.http.jetty.ssl.keypassword=keystore_passwor
d
• org.eclipse.equinox.http.jetty.ssl.keystore=c:/
opentext/cs/keystore
org.eclipse.equinox.http.jetty.http.enabled
• Syntax:
org.eclipse.equinox.http.jetty.http.enabled=<true|false>
• Values:
true or false
• Example:
org.eclipse.equinox.http.jetty.http.enabled=false
org.eclipse.equinox.http.jetty.https.enabled
• Syntax:

org.eclipse.equinox.http.jetty.https.enabled=<true|false>
• Values:
true or false
• Example:
org.eclipse.equinox.http.jetty.https.enabled=true
org.osgi.service.http.port.secure
The value of org.osgi.service.http.port.secure must be the same as the value
of org.osgi.service.http.port. See “Cluster Agent Port” on page 962.
• Syntax:
org.osgi.service.http.port.secure=<port_number>
• Values:
A TCP/IP port number.
• Example:
org.osgi.service.http.port.secure=3099
org.eclipse.equinox.http.jetty.ssl.keystore
• Syntax:
org.eclipse.equinox.http.jetty.ssl.keystore=<keystore_path>
• Values:
The filename of and path to the keystore.
• Example:
org.eclipse.equinox.http.jetty.ssl.keystore=C:/
opentext/cs/keystore
org.eclipse.equinox.http.jetty.ssl.password
• Syntax:
org.eclipse.equinox.http.jetty.ssl.password=<SSL_password>
• Values:
A password.
• Example:
org.eclipse.equinox.http.jetty.ssl.password=password
org.eclipse.equinox.http.jetty.ssl.keypassword
• Syntax:
org.eclipse.equinox.http.jetty.ssl.keypassword=<keystore_password>

• Values:
A password
• Example:
org.eclipse.equinox.http.jetty.ssl.keypassword=password
46.7.5 Logging
The location of the Cluster Management log file is specified by two settings:
osgi.logfile (OSGi framework logging) and agent.log.file (Cluster
Management logging).
By default:
• The osgi.logfile setting points to the <Content_Server_home>\logs\ folder
(osgi.logfile=../../logs/otclusteragent.log).
• The agent.log.file setting does not appear in the config.ini file. Cluster
Management logging is written to <Content_Server_home>\logs
\otclusteragent.log, which is the same file that the OSGi framework logging
is written to by default.
To change the location of the Cluster Management log file, add the agent.log.file
setting to the Cluster Management config.ini file and set it to the path that you
desire.
Note: OpenText recommends that you specify the same location for
osgi.logfile and agent.log.file. If you add the agent.log.file setting
to your config.ini file, set osgi.logfile to write to the same file as the one
specified by agent.log.file.
agent.log.file
• Syntax:
agent.log.file=<path>
• Values:
An absolute file location, or a location relative to the <Content_Server_home>
\config\otclusteragent\ folder
• Example:
• agent.log.file=../../newfolder/mylogfile.log (Writes to
<Content_Server_home>\newfolder\mylogfile.log.)
• agent.log.file=C:\\ContentServerLogs\\otclusteragent.log
• agent.log.file=C:/ContentServerLogs/otclusteragent.log
osgi.logfile
• Syntax:

osgi.logfile=<path>
• Values:
An absolute file location, or a location relative to the <Content_Server_home>
\config\otclusteragent\ folder
• Example:
• osgi.logfile=../../newfolder/mylogfile.log (Writes to
<Content_Server_home>\newfolder\mylogfile.log.)
• osgi.logfile=C:\\ContentServerLogs\\otclusteragent.log
• osgi.logfile=C:/ContentServerLogs/otclusteragent.log
46.7.6 Microsoft SQL Server Settings

The Content Server Cluster Agent service obtains information on the Content Server
database from the opentext.ini file. In most cases, you do not need to set database
connection information in the Cluster Management config.ini file. However, you
must set database connection information in the Cluster Management config.ini
file if:
• Your Content Server database is stored in Microsoft SQL Server.
• The SQL Server Browser service is disabled.
• Microsoft SQL Server does not run on the default port (1433).
If all of the above conditions are true, set values for the following Cluster
Management config.ini settings:
agent.db.mssql.servername
• Syntax:
agent.db.mssql.servername=<SQL_Server_server_name>
• Values:
The name of the computer running the installation of Microsoft SQL Server that
houses the Content Server database.
• Example:
agent.db.mssql.servername=mySQLServerhost.mydomain.com
agent.db.mssql.instancename
Provide a value for this setting if there are multiple SQL Server instances on the
computer specified in the agent.db.mssql.servername setting.
• Syntax:
agent.db.mssql.instancename=<SQL_Server_instance_name>
• Values:

The name of the SQL Server instance that houses the Content Server database.
• Example:
agent.db.mssql.servername=mySQLServerInstance
agent.db.mssql.port
• Syntax:
agent.db.mssql.port=<SQL_Server_port>
• Values:
The port that SQL Server is configured to use.
• Example:
agent.db.mssql.port=3456
46.7.7 Oracle Database Settings

The Cluster Agent uses the oracle.net.tns_admin property to connect to Oracle
Database.
When the Cluster Agent service starts, it sets the value of this property to the
location of the Oracle tnsnames.ora file. If Content Server is installed on Microsoft
Windows, the Cluster Agent service obtains the location of the tnsnames.ora file
using the Windows Path system environment variable.
By default, When you install the Oracle Database client, the installer adds the Oracle
bin folder to the Windows Path system environment variable, and Cluster
Management uses this information to obtain the location of the tnsnames.ora file. It
is possible, however, to override this default option during the installation of the
Oracle Database client, or to place the tnsnames.ora file somewhere other than the
default location. In such cases, Cluster Management cannot locate the tnsnames.ora
file.
If Cluster Management is unable to locate the tnsnames.ora file, you can add the
oracle.net.tns_admin property to the Cluster Management config.ini file to
enable Cluster Management to connect to the Content Server database.
Important
If you use the Windows Oracle Instant Client, it is always necessary to add
the oracle.net.tns_admin property to the Cluster Management
config.ini file to enable Cluster Management to connect to the Content
Server database.
Note: It is not necessary to set the value of the oracle.net.tns_admin

property if Content Server runs on Solaris or Linux.
• Syntax:
oracle.net.tns_admin=<location_of_tnsnames.ora>

• Value:
The location of the tnsnames.ora file.
• Example:
oracle.net.tns_admin=C:\\oracle\\product\\11.2.0\\dbhome_1\
\NETWORK\\ADMIN

Part 12
Reports Administration
Chapter 47
Administering LiveReports
The Content Server LiveReports Volume initially contains a set of LiveReports

provided by OpenText. You can modify these reports to meet your users' needs. You
can add new LiveReports to the LiveReports Volume using the Add Item menu, or
by importing them into your Content Server system.
Note: If you have upgraded Content Server, the LiveReports Volume might
contain LiveReports that are no longer valid because of changes in Content
Server between major versions. For example, if you have upgraded to Content
Server 16, the Deleted Documents and Deleted Documents By [User] reports
may appear in your LiveReports Volume. These reports pertain to the Undelete
Volume, which is not present in Content Server 16. (Its functionality is
superseded by the Recycle Bin.) The reports do not function and OpenText
recommends that you remove them in Content Server 16 and later.
For more information on the Recycle Bin, see “Recycle Bin Administration“
on page 371.
Because the LiveReports Volume is a type of Content Server container, you can
perform the same tasks in it as you can in other Content Server folders. To perform
certain functions on LiveReports, users must have appropriate permissions and
privileges on the container and the LiveReport. For more information, see
“Understanding Privileges and Permissions for LiveReports” on page 975.
47.1 Running LiveReports

If you run an interactive LiveReport, a new page appears asking you to specify
certain input parameters. If a Browse button appears, click it to select one of the
available choices. If there is no Browse button, you may enter text directly in the
provided input parameter field. In either case, click the Update button to pass the
values on to the LiveReport.
After you run a LiveReport, Content Server displays the report's results. The page
banner contains the title of the LiveReport. The presentation of results in the body of
the page depends on the individual LiveReport. Results appear in a table format, or
as a pie chart, bar chart, or line chart.
If the LiveReport you run has a sub-report attached to it, you can run that sub-report
by clicking on the results or a result's Details action link. For example, a LiveReport
may present Content Server items in a pie chart, with each pie segment representing
the number of items owned by one user. That report could have a sub-report
attached that lists all items owned by a particular user. By clicking one of the pie
segments, you run the sub-report.

Chapter 47 Administering LiveReports
47.1.1 To Open the LiveReports Volume

To open the LiveReports Volume:
1. On the Content Server Administration page, select LiveReports

Administration. Click Open the LiveReports Volume.
2. If prompted, type the password for the admin user in the Admin User
Password field, and then click the Log-in button.
47.1.2 To Run a LiveReport

To run a LiveReport:
1. On the global menu, select Personal. Next, select Reports.
2. On the Manage My Queries page, select the LiveReports tab.
3. Locate the LiveReport you want to run from the list and click on either that
LiveReport's name or its icon.
47.2 Importing and Exporting LiveReports

You can export LiveReports from Content Server to a text file. The exported text files
can then be imported into any Content Server installation.
Instead of creating a LiveReport from scratch, you can import a LiveReport that was
exported from Content Server to a text file. Such an export text file can contain one
or more LiveReports.
47.2.1 To Import a LiveReport

To import a LiveReport from an export text file:
1. Click the Import LiveReports link in the LiveReports Administration section

on the Content Server Administration page.
2. If prompted, type the password for the Admin user in the Admin User
Password field, and then click the Log-in button.
3. Optional Specify a location to store the LiveReport.
a. On the Import LiveReport page, click Browse Content Server if you want
to import the LiveReport to a Content Server location other than the one
displayed in the Create In field.
Note: The default location in the Create In field is the Content Server
LiveReports volume. If you want a LiveReport to appear on the
Status tabs of users' Personal Workspaces, you must store it in the
Content Server LiveReports volume.

47.3. Understanding Privileges and Permissions for LiveReports
b. Browse to the Content Server container to which you want to import the
LiveReport, and then click the container's Select link. The Select Container
to Create In dialog box closes and the selected location's path name
appears in the Create In field.
4. In the File section, click Choose File. Select a LiveReport text file to upload, and
then click Open. The dialog box closes and the selected file's path name appears
in the File field.
5. To have the imported LiveReport replace an existing LiveReport of the same

name, enable Overwrite Existing LiveReport. If you leave the check box clear,
Content Server returns an error message if you attempt to import a LiveReport
that has the same name as an existing LiveReport.
6. In the Action section, click Add.
47.2.2 To Export a LiveReport

To export a LiveReport:
1. Click the Export LiveReports link in the LiveReports Administration section on

the Content Server Administration page.
2. If prompted, type the password for the Admin user in the Administrator
Password box, and then click Log-in.
3. On the Export LiveReport page, select the check boxes of the LiveReports that
you want to export to a single text file.
• If you want to export the selected LiveReports, click the Export button.
• If you want to export and delete the selected LiveReports, click the Export
and Delete button.
5. Save the LiveReport file to a location of your choice.
47.3 Understanding Privileges and Permissions for

LiveReports
The Content Server LiveReports module enables users to create and work with
Content Server items called LiveReports. LiveReports are powerful tools that allow
direct access to the RDBMS underlying Content Server using Structured Query
Language (SQL) statements.
You can set up LiveReports to:

• return lists of items that meet certain criteria
• report statistical information about the database contents such as a pie chart
showing the proportion of items owned by each user

• change information in the database, for example, reassign all tasks of a user who
left the organization
Administering Privileges and Permissions for LiveReports

Because LiveReports allow you to directly modify the information in the Content
Server database, OpenText recommends that you restrict users' privileges to create
LiveReports.
Tip: You can configure Content Server to prevent LiveReports from modifying
the Content Server database. See “Configuring LiveReports Security”
on page 979.
Users who do not have the privilege to create LiveReports can still run them if they
have the necessary permissions. For example, you may want to grant all users the
permission to run reports listing all items they own or have reserved. Users can view
the LiveReports that they have permission to run on the Manage LiveReports page,
which they access by clicking Reports on the Personal global menu.
By restricting the LiveReports creation privilege to a limited number of competent

individuals, you can ensure that LiveReports do not damage the database contents.
At least a basic knowledge of SQL and the Content Server schema is necessary to
edit LiveReports effectively and safely. A user that has the privilege to modify or
create LiveReports can include any kind of SQL statement. Not only can they use the
SELECT statement to retrieve information; they can use the UPDATE and DELETE
statements to modify and destroy information. For information about Content
Server database table and column names, see the System Schema Reference guide.
You can grant a user the following permissions for a LiveReport:

• See
• See Contents
• Modify
• Edit Attributes
• Delete
• Edit Permissions
To edit existing LiveReports, a user must have Modify permission for those reports
and the creation privilege for the LiveReports item type. To run a LiveReport, a user
must have See Contents permission for that report. For more information about
permissions, see OpenText Content Server User Online Help - Getting Started (LLESRT-
H-UGD) and “Administering Permissions“ on page 21.
The following LiveReports do not filter results based on user permissions. Therefore,
all users will view reported results and they may include items that they do not have
See permissions for.
• All Late Workflows.

47.3. Understanding Privileges and Permissions for LiveReports
• All Tasks Due Next Week.

• All Workflows with Comments.
• All Workflows and Managers.
• Deleted Documents.
• Deleted Documents By [User].
• My Tasks Due Next Week.
• Number of Active Steps By [Performer].
• Number of Active Users.
• Number of Active Workflows.
• Number of Active Workflows By [Map ID].
• Number of Auditable Transactions.
• Number of Late Workflows.
• Number of Late Workflows By [Map ID].
• Number of Logins.
• Number of Steps Late.
• Number of Steps Late By [Performer].
• Number of Unique Logins.
• Status For All Workflows.
• Workflow Comments By [ID].
• Workflow Status By [ID].
• Workflow Steps and Status By [ID].
The remaining LiveReports do filter results based on user permissions.

• 25 Largest Documents.
• All Outstanding Tasks.
• All Reserved Items.
• Documents With The Most Versions.
• Item Count By Category.
• Items Reserved By [User].
• Largest Projects (Physical Space).
• Least Active Projects In The Last Week.
• Most Active Projects In The Last Week.
• My Bad Shortcuts.
• My Late Tasks.

• My Outstanding Tasks.
• My Recently Viewed Documents.
• Outstanding Tasks For [User].
• Show All [Type] Items.
• This Week's News.
• Today's News.
• What Happened Last Month?
• What Happened Last Week?
• What Happened Yesterday.
• What's Hot This Week?
• What's Hot Today?
• What's New This Month?
• What's New This Week?
• What's New Today?
Specifying Allowable Object Types for Interactive LiveReports

Some LiveReports are interactive; they allow the user running them to specify
information and select options. One of the input types that you can add to a
LiveReport is the Object input type. When this input type is included in a
LiveReport, it appears in a menu that allows users to select the object type that
interests them. By default, the item types that users can select from the item menu
are:
• Channel
• Discussion
• Document
• Folder
• LiveReport
• Project
• Task
• Task List
• Topic
• URL
You can modify the list of item types that appear in item menus by editing the
objectSubTypes parameter in the [reports] section of the opentext.ini file.
The Content Server LiveReports Volume initially contains a set of LiveReports

provided by OpenText. You can modify these reports to meet your users' needs, and

47.4. Configuring LiveReports Security
you can add new LiveReports to the LiveReports Volume using the Add Item menu
or by importing them into your Content Server system.
Users may store LiveReports anywhere in Content Server, but the Manage
LiveReports page only displays LiveReports from the LiveReports Volume that
users have permission to view.
Because the LiveReports Volume is a type of Content Server folder, you can perform
the same tasks in it that you can in other Content Server folders. You can add new
LiveReports, administer permissions for the volume and its contents, configure the
volume, and so on. For more information about adding, editing, and running
LiveReports, see OpenText Content Server User Online Help - Working with LiveReports
(LLESREP-H-UGD) in Content Server's online help for users.
47.4 Configuring LiveReports Security

To protect the security of your Content Server data, you may wish to make it
impossible for LiveReports to make changes to the Content Server database. You can
permanently prevent all LiveReports from modifying the database by using the
Configure LiveReports Security link in the LiveReports Administrationsection of
the Content Server Administration page.
Important
This action is not reversible. Once you have enabled LiveReports security,
you cannot restore the ability of LiveReports to modify the database.
47.4.1 To Configure LiveReports Security

To Configure LiveReports Security
1. On the Content Server Administration page, in the LiveReports Administration

section, click the Configure LiveReports Security link.
2. On the Configure LiveReports Security page, enable Prevent LiveReports from

modifying the database. Once enabled it cannot be reversed.
3. The Disable Database Modification dialog box appears. Enable I understand

the risk involved by enabling this setting and want to continue, and then click
OK.
4. On the Configure LiveReports Security page, click Save Changes.

47.5 Configuring LiveReports in the opentext.ini File

The administrator can configure the LiveReports options available to users in the
[reports] section of the opentext.ini file. For more information, see “[report]”
on page 194.

Chapter 48
Administering WebReports
Important
WebReports is a separately licensed module under Content Server. In the
event that WebReports is not available, please contact OpenText support for
information on purchasing a license for WebReports.
A WebReports Administration section in the Content Server administration pages

has been provided for some of the unique WebReport functions that require settings.
Definitions of Key Terms

The following terms are used in this documentation:
• End Users: This refers to Content Server consumers who would see the output of
a WebReport.
• Developers: Any users who may be involved in creating new WebReports or
editing existing ones to change the look, feel and behavior of the WebReport. For
any particular WebReport, Developers fall into two categories:
1. those who can edit or add a version to the reportview
2. those who can only fetch or download the reportview
The latter case is useful in terms of enabling Developers to reuse an existing
reportview in a new WebReport, without allowing them to change the original.
• Data source: Any Content Server object used to generate a data set for the
WebReport. This is most commonly a LiveReport but could also be a saved
search query, a form template or a form.
• LiveReport: A Content Server item that enables users to obtain statistical
information about, and potentially modify, the Content Server database. The SQL
statement in a LiveReport communicates directly with the database. The Content
Server administrator may create new LiveReports, and grant other users
permission to run them. The LiveReports for which users have permissions
appear on the LiveReports tab on the Reports page of their Personal Workspace.
• Reportview: The term reportview is used throughout this document to refer to
the document that is stored for each WebReport object. These reportviews
contain traditional Web code, such as HTML, as well as custom tags that are used
to determine where the data source data fields will be inserted in the output Web
page.
• System Administrators: Besides the role of managing WebReport permissions
and access requirements, these users may also have access to the LiveReports,
and / or other data sources, used to supply data to the WebReports. The various

Chapter 48 Administering WebReports
tasks and functions described in this document are intended for these
administrators.
48.1 Restricting Access to WebReports

Beginning with Content Server 10.5.0 2015-09 Patch, access to WebReports is
restricted by default in new installations of Content Server. If you are patching an
existing installation of Content Server with the 2015-09 Patch, the previous open
access to WebReports for all users will continue.
If you are installing a new instance of Content Server using the 2015-09 Patch, a user
must be added to the group that is allowed to create WebReports in order for that
user to see WebReports in the Add Item menu.
48.1.1 To Access WebReports Restricted Users

To access WebReports restricted users:
1. On the Content Server administration page, under the System Administration

heading, click Administer Object and Usage Privileges.
Privileges heading, click the Edit Restrictions link associated with the
WebReport object type.
Note: If you have not applied your WebReports license to your Content
Server installation, you will not see the WebReport object type in the list.
For more information, see “License Key Functions” on page 998.
3. On the Edit Group: WebReports page, follow the instructions found in “To
Modify Object or Usage Privileges” on page 343.
48.2 Using the WebReports Administration Section

The WebReports Administration section has the following settings and options:
• “Flush Cache” on page 983: used to remove all compiled reportviews from the
cache location.
• “Install the Requests.js Library” on page 984: used to provide an interface to
install the Requests Library and associated files to the JavaScript library location.
• “Manage Category Data Source Configuration” on page 985: used to update the
maximum number of categories and attribute display parameters.
• “Manage Destination Media types” on page 985: used to configure the media
types that can be used for WebReports output.
• “Manage Search Query Integration” on page 986: used to manage the ability to
invoke WebReports directly from the search screen.
• “Manage Tags and Sub-Tags” on page 987: used to selectively disable
WebReports tags and sub-tags.

48.2. Using the WebReports Administration Section
• “Manage Trusted Files” on page 988: used to configure a set of trusted external
files for use by WebReports.
• “User/Group WR Trigger Administration” on page 989: used to determine
which User and/or Group can trigger WebReports.
• “Manage WebReports Conversion” on page 990: used to changed the sleep
interval for the conversion agent and to set the input and output directories to
manage PDF conversion.
• “WebReports Scheduling” on page 993: used to changed the sleep interval for
the schedule agent, and to enable, disable, or permanently delete individual
schedules.
• “Manage WebReports Scripting” on page 995: used to enable or disable
scripting of individual WebReports.
• “Restricting WebReports Services” on page 996: used to enable, disable or
restrict the WebReports services feature.
• “WR Trigger Administration” on page 996: used to determine which node
types can trigger WebReports.
• “Miscellaneous WebReports Settings” on page 997: used to set the values of
miscellaneous keys in the WebReports section of the opentext.ini file.
• “License Key Functions” on page 998: used to set or change the WebReports
License Key and display licensing status.
• “Node Administration” on page 999: used to identify and update reportviews
using out-of-date syntax.
• “WebReports Sub-Tag Builder” on page 1000: used to re-build all subtags
including any subtags that have been created in the subtags folder.
48.2.1 Flush Cache

By clicking Flush Cache from the WebReports Administration section on the
Content Server administration page, an administrator can remove all compiled
reportviews from the cache location.
This is useful if you are having problems with certain reportview compilations, as
any removed objects will be re-compiled.
Note: This utility currently only flushes the cache for the server on which
rktengine.flushcache is run.

Flushing the Cache Location

To flush the cache:
1. On the Content Server administration page, under the WebReports

Administration heading, click Flush Cache.
2. On the Flush Cache page, wait until the process has completed. The number of
objects flushed from the cache will be stated. Click Admin Home to return to
the Content Server administration page.
48.2.2 Install the Requests.js Library

Use the Install Requests.js Library page to install the requests.js library and
associated files to the JavaScript library location: /img/webreports/library/
When the page loads it will be pre-populated with default values.
To install the request.js library:
1. If the URL Prefix Setting field is left blank, then the installer will include
JavaScript code to obtain the values using information available in the URL
during loading of the requests.js file into the client.
If the URL Prefix Setting field is specified, be aware that it should match
whichever case will normally be input by users.
For example, if /CS/cs.exe is used, a user who has logged in with /cs/cs.exe
will probably need to be re-logged in, causing issues with any requests that
expect responses. If in doubt, set this field to blank.
2. If the Support Directory Image Path field is left blank, then the installer will
include JavaScript code to obtain the values using information available in the
URL during loading of the requests.js file into the client.
3. From the Available Source Versions list, accept the default, pre-populated
value, or select another version for the requests.js library.
4. In the Themes Location Patch field, accept the default, pre-populated value, or
enter another path.
5. From the Available Themes list, accept the default, pre-populated value, or
select another theme.
6. Click Install to submit the form and install the requests.js library.
Click Reset to clear any changes and restore the default values.
Click Cancel to cancel and return to the main administration page.

48.2.3 Manage Category Data Source Configuration

Important
event that this menu item is not available, please contact OpenText support
for information on purchasing a license for WebReports.
If you have purchased and applied your WebReports license and you still
cannot see this menu item, please restart the Content Server services.
The Manage Category Data Source Configuration feature allows point and click
configuration of reports on Content Server Categories and Attributes. The
administration settings for this feature allow basic control of the output format and
settings which can help set limits on the performance cost of running the report.
To manage category data source configuration:
1. On the Content Server administration page, under WebReports

Administration, select Manage Category Data Source Configuration.
2. On the Manage Category Data Source Configuration page, in the Maximum

Number of Categories field, enter a number to determine how many categories
a user can select to report on.
The larger this number is, the more complex is the query sent to the database in
cases where a user selects the maximum number of categories.
3. In the Number of Attributes to Display Across field, enter a number to

determine how many selectable attributes will be presented per row on the
WebReport data source configuration page (not in the report itself).
4. In the Multi-Valued Attribute Delimiter field, specify the character used to

separate multi-values that are returned by a report.
5. In the Maximum Number of Results field, set a limit to the number of results
returned by all reports using Category as a Data Source, discarding any results
above that number.
6. Click Submit.
48.2.4 Manage Destination Media types

The Manage Destination Media Types page can be used to add, edit, and delete the
destination media types to which a WebReport can be output. Any existing
destination media types will be displayed when the page is loaded. You can change
the name of a media type by amending the data in the Media Type field for any
media type.
To manage destination media types:

Administration, select Manage Destination Media Types.

2. Optional If you want to remove a media type to which a WebReport can be

output, click the “-” button next to the media type you want removed.
3. Optional If you want to add a media type to which a WebReport can be output,
click the “+” button at the bottom of the page. In the text field, type the new
media type.
4. Click Apply.
48.2.5 Manage Search Query Integration

The WebReports module supports a search integration feature that provides the
capability to launch one or more WebReports from the standard Advanced Search
screen.
In order to enable this feature the following actions need to be taken:
1. You need to enable this feature on the Manage Search Query Integration page
and specify an appropriate name for the new search button.
2. You need to restart Content Server after the feature is enabled.
3. You need to set one, or more, WebReports to use “search launch” as a data
source. You set this from the WebReport's Properties page by selecting the
Source tab.
4. From the Manage Search Query Integration page, WebReports with this data
source can be enabled or disabled.
WebReports with this data source have permissions set so that only appropriate
users have access to them.
Given the setup listed above, the Advanced Search screen will include the custom
search button. When selected, this custom search button will launch the search on
the WebReports the user has the permission to run. In the event the user has
permission to run search on multiple WebReports, selecting the custom search
button will display a list of those WebReports and the user can select the one they
want searched.
Technical Notes on Search Integration

Where multiple instances of Content Server are being used, the following points
should be noted:
1. The enable option is server specific and stored in the opentext.ini file. As a
result, this feature could be restricted to a specific Content Server instance.
Conversely, if the same behavior is required for all servers in a cluster, the
feature must be enabled, and the button text set, for all servers. This could also
be achieved by copying the opentext.ini file to each server.
2. The activation or deactivation of individual WebReports is system wide,
therefore any disabled WebReports will not be available on any Content Server
instance.

3. If this page is being viewed on a server where the feature is disabled, the list of
active and/or inactive WebReports is not visible. To make this list available:
To Enable Search Integration

To enable search integration:

Administration, select Manage Search Query Integration.
2. On the Manage Search Query Integration page, select the Search integration is
disabled... box.
3. Click OK to confirm that you will be restarting the Content Server services. This
feature is not activated until Content Server is restarted.
4. In the Search Button Title field, provide a name for the button.
5. Click Apply.
6. Restart the Content Server services.
48.2.6 Manage Tags and Sub-Tags

The Manage Tags and Sub-Tags page lets an administrator selectively disable
WebReports tags and sub-tags.
Disabled tags can no longer be added to a WebReport or ActiveView, and existing

reports that use a disabled tag or sub-tag will not process that tag or sub-tag. You
must restart the Content Server services once any changes are made to this page.
To manage tags and sub-tags:

Administration, select Manage Tags and Sub-Tags.
2. Optional On the Manage Tags and Sub-Tags page, click Toggle to switch the
view between a list of enabled tags and sub-tags and a list of disabled tags and
sub-tags.
3. Optional Select the Disable box next to any tag or sub-tag you want disabled.
4. Once you have made all selections, click Submit.
5. You must restart Content Server services for these change to take effect.

48.2.7 Manage Trusted Files

Administrators can use the Manage Trusted Files page to configure a set of trusted
external files for use by WebReports:
Trusted External Files for Data Sources

• This is a whitelist of external files that are approved for use as a data source for a
WebReport. At runtime, the file path stored on the Source tab of a WebReport
will be validated against this list. If the requested source file path does not match
any entries in this list, the WebReport will return an error message and will not
execute.
• To use an External File as a data source of a WebReport, the requested source file
path must be in this list.
• Filename paths can be entered as a comma-separated list or as one path on each
line.
• This field supports the use of the “*” character in the path, as a wildcard to
minimize the number of entries required.
• Matching is case-sensitive.
Some examples of valid entries include the following:

• C:\WRSourceData\mySourceFile.csv – a path directly to the file.
• C:\WRSourceData\mySource* – any file within C:\WRSourceData whose file
name begins with “mySource” will be allowed as a data source file.
• C:\WRSourceData\* – any file within C:\WRSourceData\ will be allowed as a
data source.
• C:\WRSourceData* – any file within C:\ whose name begins with
“WRSourceData”, or whose file path begins with “WRSourceData” will be
allowed. For example, C:\WRSourceData\mySourceFile.csv and C:
\WRSourceData22\myOtherFile.csv
Important
For security purposes, do not add “C:*” as a valid file path to this whitelist,
as that would make system files available to be used as a data source.

48.2.8 User/Group WR Trigger Administration

Important
Similar to “WR Trigger Administration” on page 996, the User/Group WR Trigger

feature allows events pertaining to users and groups occurring within Content
Server to trigger a WebReport. In order to use this feature, the Enable User/Group
WR Trigger box must be selected. The administration settings allow you to select
different Content Server users and/or groups. For those users and/or groups you
select, you can also select any number of available trigger events. If the trigger event
should occur with any user or group, then select the Global box. When the selected
trigger event occurs for any of the selected users and/or groups, the specified
WebReport will be executed. More than one trigger can be set up by adding rows as
needed.
The option for Inheritance specifies the scope to either Direct Members, or Direct
and Indirect Members.
To enable user/group WR trigger:

Administration, select User/Group WR Trigger.
2. On the User/Group WR Trigger page, select the Enable User/Group WR

Trigger box.
3. Each row in the table allows you to set a separate User/Group WR event to
trigger a WebReport.
Click to add a new WR Trigger, and then:
a. Select the user and/or group to whom this event will be applied. Do one of
the following:
• In the User/Group column, if you want to apply this trigger to a specific

user or group, use the associated button to select those user(s) and/or
group(s).
• In the Global column, if you want to apply this trigger to all users and
groups, select the box.
b. From the Trigger Event column, select the event that will trigger the
WebReport. You can optionally select all the trigger events available.
c. In the Inheritance column, select either Direct Members or Direct and
Indirect Members.

d. In the WebReport Action column, use the Browse Content Server button
to select the folder in which this WebReport will be generated and the type
of action that WebReports will perform.
e. Optional The final column allows you to delete the row you have just added,
or add a new row to the table to enter another trigger event.
48.2.9 Manage WebReports Conversion

Several of the WebReports destinations support document conversion which can be
used to create PDF formatted reports. The destinations are:
• E-mail
• Content Server Node
• Content Server Version
• Server
• Workflow (as an attachment)
In 3.x and earlier versions of WebReports, PDF conversion was supported in a

slightly different form. The user had the option of selecting a PDF MIME type
which, upon selection, caused the reportview to be converted into a PDF format.
This had limitations in that the reportview being converted to PDF could only be in
HTML format.
From WebReports 4.0, the MIME Type and conversion process have been
completely decoupled. This means the user can use WebReports to create a
document of any type, for example WordML or SpreadsheetML, and then perform
the conversion process on this document. This brings much more flexibility to the
look of the document being converted.
If PDF conversion is to be used, the Content Server administrator must configure

options in the Manage WebReports Conversion section in the Content Server
administration pages.
The Manage WebReports Conversion page allows you to add, view, or modify
information about the WebReports conversion directories. These directories are used
in conjunction with a conversion tool, such as Adlib eXpress, to allow WebReports
to perform exports in PDF, or, if required, other formats.
When a user determines they want a WebReport to be formatted in, for example
PDF, the reportview is rendered in the format they have defined in the WebReport
and then delivered to the input folder defined on the Manage WebReports
Conversion page. The conversion tool should be configured to “watch” this
directory. On finding a file, the tool should convert it, place the resultant document
in the output folder and delete the input file. When the converted document appears
in the output folder WebReports sends this to the defined export location and
removes it from the output folder.

Configuring the Conversion Agent

By default, the WebReports conversion agent is configured to run every 5 minutes,
or 300 seconds. In some instances, it might be desirable to have the agent to run in
more frequent intervals. In this case, the agent can be set to run in intervals as short
as 60 seconds. This can be set in the Manage WebReports Conversion page. The top
section of this page contains a form that changes the sleep interval setting for the
WebReports conversion agent.
Adlib eXpress Job Ticket Conversion

From WebReports 4.0.1 full support is provided for Adlib eXpress Job Tickets. When
the checkbox is selected to enable the Job Ticket feature, on the Manage Conversion
Directories page, users can provide detailed processing directives using an XML Job
Ticket file. This XML file can be stored in Content Server with individual
WebReports either sharing a single Job Ticket file or each having their own
processing instructions. See the Adlib website (http://www.adlibsys.com) for more
details on XML Job Tickets.
When the Job Ticket feature is enabled the user is presented with two new
conversion directories:
• Input Directory (when using XML Job Tickets)
• Output Directory (when using XML Job Tickets)
1. For conversion to be enabled at all, the first set of conversion directories

must be specified. The additional set of directories for XML Job Tickets are
optional, and are useful for servers running multiple instances of Content
Server using different conversion methods. Current versions of Adlib
eXpress only support conversion with or without Job Tickets, not both
simultaneously.
2. If only XML Job Ticket conversion is being used, the administrator must
specify the conversion directories in the first two fields.
3. If XML Job Tickets are being used at the same time as standard conversion,
the standard conversion directories must be specified first and the XML Job
Ticket directories specified second.
4. The values entered on this page will be used to replace occurrences of
$DEFAULT_PATH specified in the Job Ticket itself.
5. A basic example of a Job Ticket can be found in the online help:
WebReports: Advanced Information: PDF Conversion.

Technical Notes on PDF Conversion

• WebReports uses the Content Server cache to determine which converted file
goes to which destination. As with any cache, it has a finite life which means,
although unlikely, it is possible for converted files to be in the output folder that
relate to an expired cache. In this case WebReports won't know where to send the
files as the destination information is lost. This situation could occur if users have
been exporting and converting on a system with agents disabled on all servers.
Enabling agents won't clear the backlog of files unless they have a current cache.
As a rule, if anything is in the output folder more than an hour, it should be
manually deleted.
• Content Server agents are used to look at the output folder and check for a
converted file every 5 minutes. This means agents must be enabled for
conversion to function.
• The exact time a file is written to the input folder, how often the conversion tool
checks this folder, the time taken to do the actual conversion and the point this
hits in the cycle of the 5 minute agent above will determine how long it takes for
a file to appear in the export destination. This might vary from nearly
instantaneous to 30 minutes depending on the system.
• Folders at a network location might be specified as a UNC, for example: \
\192.168.255.20\disk1\PDF Conversion\input
• It is possible for an export to occur from any Content Server in a clustered
environment. It is therefore essential that the input directory is defined on every
machine in the cluster. The output folder is only monitored by the Content
Server with the WebReports conversion agent running. It is therefore essential to
specify the output folder on that server. It is, however, good practice to specify it
on all instances of Content Server.
To Configure a Conversion
To configure a conversion:
1. Configure an external conversion engine, for example Adlib eXpress, to watch

an input folder for new files that need conversion.
2. Configure the same conversion engine to store the converted documents in a

specific output folder.
3. Configure the conversion engine to delete the source file from the input folder.
4. Configure the conversion engine so that the destination file extension, for
example .pdf, replaces the source type, for example .html, .doc or .xls, rather
than appends the new extension onto the old one.
5. On the Content Server Administration page, under WebReports

Administration, select Manage WebReports Conversion.
6. Establish the interval for conversion in the Conversion Agent Sleep Interval
field. This will be partly responsible for determining how quickly the converted

file appears back in Content Server. The conversion engine should check the
input folder. The default setting is “300” seconds, or 5 minutes.
7. In the Input Directory field, specify the path of the input folder.
8. In the Output Directory field, specify the path of the output folder.
Important
It is important that the Content Server has the permission to write a file
to the input folder and delete a file from the output folder.
9. Optional If you want to configure Adlib eXpress Job Ticket conversion, select
Check this box....
a. In the Input Directory (when using XML Job Tickets) field, enter the XML
Job Ticket input directory for use when files are converted using XML Job
Tickets.
b. In the Output Directory (when using XML Job Tickets) field, enter the
XML Job Ticket output directory for use when files are converted using
XML Job Tickets.
10. Click Apply.
48.2.10 WebReports Scheduling

The capability to schedule WebReports is provided in each WebReport's
Destination tab of its Properties page. WebReports developers, users with reserve
permission, can set up execution schedules for individual WebReports to run
without user intervention. Scheduled WebReports run in the background and
output their results to a Content Server document node or to e-mail. The schedule
allows for WebReports to run a fixed number of times or forever, starting from a
specific date and time. The time between repeated WebReport runs can be from 5
minutes to 520 weeks. One schedule can be set per user per WebReport.
By default, the WebReports scheduling agent is configured to run every 5 minutes,

or 300 seconds. In some instances, it might be desirable to execute a WebReport in
shorter increments than 5 minutes. In this case, the agent can be set to run in
intervals as short as 60 seconds.
The Sleep Interval setting is entered in seconds, and must be at least 60 seconds or
more. After submitting the form, a restart of Content Server is required so that the
agents are adjusted with the new values. If any agent's Sleep Interval is less than
300 seconds, or 5 minutes, the Destination tab of that WebReport's Properties page
will change with an additional option to manually enter the Minutes value for the
scheduled report. This allows for more granular control of how often the WebReport
will run.
For example, to configure a WebReport to run every 2 minutes, set the Scheduling
Agent Sleep Interval to “120” seconds. Save the changes and restart Content Server.
On the Destination tab of the WebReport's Properties page, the Enter Minutes
(0-59) button is now selectable. This turns the Minutes field into a text field,

allowing manual entry of the value. Enter “2” to have the WebReport execute every
two minutes.
Configuring Content Server for WebReports Scheduling

It is not necessary for Content Server notifications to be enabled for WebReports
scheduling to function. However, Content Server Change Agents must be enabled
on your Content Server instance. The [options] section of the opentext.ini file
for at least one instance of Content Server will contain EnableAgents=TRUE if
Change Agents are enabled. Normally, Change Agents are enabled, but if you are
unsure about how to configure Change Agents for your particular Content Server
instance, please consult OpenText support.
Database Schema
A Content Server database table called WEBREPORTS is created when WebReports is
installed. The purpose of this table is to store WebReports schedule information.
This table has a two column key: USERID and NODEID. NODEID is the nodeid of the
webreport.
An additional table called WEBREPORTSTATS is created when the module is installed

or upgraded.
Note: Uninstalling the WebReports module does not remove these tables. In
order to uninstall these tables, you need to access the WebReports Database
Administration option under the Content Server administration pages prior to
uninstalling the module.
To Configure the Scheduling Agent

To configure the scheduling agent:
1. From the Content Server administration pages, under WebReports

Administration, click Manage WebReports Schedules.
2. In the Scheduling Agent Sleep Interval field, enter the sleep interval setting for
the WebReports scheduling agent. This is the amount of time that the agent will
wait between executions.
3. Click Save Agent Changes.
5. Optional If you have set the Sleep Interval to a value less than 300, you need to
access the WebReport's Properties page:
a. Select the Destination tab.

b. Select the Enter Minutes (0-59) button.
c. In the Minutes field, enter the number of minutes. For example, if you
entered “120” in the Scheduling Agent Sleep Interval field, enter “2” in
the Minutes field to have the WebReport execute every two minutes.

To Manage Schedules
To manage schedules:
1. From the Content Server administration page, under WebReports

Administration, click Manage WebReports Schedules.
2. Each row in the report represents a schedule set by one user for one WebReport.
For each schedule, you can:
a. Optional Disable a schedule by clearing that schedule's Enabled box. The

schedule information will be retained, but the report will not run until it is
re-enabled by the user listed or by the administrator.
b. Optional Delete a schedule by selecting that schedule's Delete Schedule box.
Note: Schedules are automatically deleted by Content Server if the

user that set them is deleted or if the WebReport itself is deleted.
3. Click Apply.
48.2.11 Manage WebReports Scripting

The WebReports Scripting page can be used to review and approve all WebReports
that contain Oscript sections within their reportviews. By default, Oscript is disabled
for a WebReport until a system administrator enables it or adds a new version to the
reportview, in which case it is enabled automatically. It is the responsibility of the
approving system administrator to ensure that the reports are safe; for example that
they cannot result in an infinite loop.
By default, Oscript in WebReports is heavily restricted to make it secure. For

example there is no access to global variables or many of the Builder Packages. What
is allowed and restricted can be altered via settings in the opentext.ini file.
OpenText recommends that all reports containing Oscript are developed and tested
on a development instance of Content Server prior to being added to a production
instance of Content Server.
Each Oscript report can be enabled or disabled individually by selecting or clearing

the checkbox in this report. It is also possible to enable or disable Oscript for an
individual WebReport from that WebReport's Properties page by selecting the Info
tab.
Note: WebReports with Oscript sections that are not enabled will still run, but
all Oscript calls are ignored and not processed.
To manage WebReports scripting:

Administration, select Manage WebReports Scripting.

2. Optional On the Manage WebReports Scripting page, to enable a disabled

Oscript section, select that Oscript section's box.
3. Optional To disable an enabled Oscript section, clear that Oscript section's box.
Tip: It is also possible to enable or disable Oscript for an individual

WebReport from that WebReport's Properties page by selecting the Info
tab.
4. Click Apply.
48.2.12 Restricting WebReports Services

Important
The WebReports Services feature can be enabled and disabled from the Content
Server administration pages.
To enable or disable WebReports services:

Administration, select Manage WebReports Services.
2. On the Manage WebReports Services page:
• If you want to enable WebReports services, ensure the Disable WebReport

Services Feature box is cleared.
• If you want to disable WebReports services, select the Disable WebReport
Services Feature box.
3. Click Apply.
48.2.13 WR Trigger Administration

Important
The WR Trigger feature allows events occurring within Content Server to trigger a
webreport. The administration settings allow different Content Server sub-types to
be enabled or disabled. Enabling the feature for a sub-type will cause the WR

Trigger option to appear on function menus for that node. If this feature is disabled,
not selected, for a particular sub-type, no code associated with WebReports will
execute for nodes of that subtype and the WR Trigger option will not appear in the
node's function menu. If all sub-types are disabled, WR Trigger has no performance
cost associated with it. Following installation or upgrade to a version of WebReports
with this feature all sub-types will be disabled by default.
To manage WR Triggers:

Administration, select Manage WR Triggers.
2. On the Manage WR Triggers page, select the node type(s) to which the WR
Trigger will be applied.
3. Click Apply.
48.2.14 Miscellaneous WebReports Settings

Important
This page is used to set the values of miscellaneous keys in the WebReports section
of the opentext.ini file.
Currently the only key that can be set is EmailAddressMaxCharacters. This key sets
the limit of the number of characters that can be used for the e-mail address string of
a WebReport with a destination of e-mail.
If an attempt is made to change the value to a non-integer value then the default
value of 10000 characters will be used.
To manage miscellaneous WebReports settings:

Administration, select Miscellaneous WebReports Settings.
2. Optional On the Miscellaneous WebReports Settings page, in the text box, enter
the new maximum value allowed for the e-mail address field. You must enter a
positive integer.
3. Click Apply.

48.2.15 License Key Functions

Note: It is not necessary to enter a license key if WebReports is being installed
solely as part of an ActiveView installation and WebReports itself will not be
used. ActiveView shares the same tag processing engine as WebReports.
Since the release of Version 4.0, it is necessary to install a license key before being
able to run or export a WebReport.
A new license key is required for each major version of the module. For example,
upgrading from WebReports 5.1.0 to WebReports 5.2.0 will require a new key.
WebReports 5.1.0 license keys will not work in 5.2.0, 10.0.0 or later.
A new license key is not required for each minor version of the module. For
example, upgrading from WebReports 10.0.0 to WebReports 10.0.1 does not require
a new key.
License Usage Reports

Since the release of Version 3.0, WebReports provides a report that shows the
WebReports licensing status. The report indicates when license usage has exceeded
80% of available licenses. It also indicates when the number of licenses has been
exceeded. This makes it simple to place orders for additional WebReports user
licenses when required. It is advisable to review the report on a regular basis to
ensure that there are sufficient user licenses available.
To view the report:
1. On the Content Server administration page, under the WebReports

Administration section, select WebReports Licensing.
2. On the WebReports Licensing page, click License Management.
3. On the Manage Licenses page, click the License Report tab.
When a Content Server user that has used WebReports is deleted, the license for that
user is released automatically and becomes available for use by another user.
From version 4.0, WebReports also provides warnings to report developers if the
number of users exceeds the number of licenses by 10% or more. These warnings
will appear when editing or performing other configuration actions on a WebReport.
Running reports is not affected.

To Enter the License Key

To enter the license key:
1. On the Content Server Administration page, under WebReports

Administration, select WebReports Licensing.
2. On the WebReports Licensing page, click the License Management link.
3. On the Manage Licenses page, click Browse, browse your system to find, and
select, the WebReports license for your version, then click Open.
4. If the key is valid, apply the license by clicking Apply License File.
5. After Content Server applies your WebReports license to your installation and
shows a confirmation message that a valid key has been provided, restart the
Content Server services.
48.2.16 Node Administration

Important
The WebReports Node Administration page identifies existing WebReports using

syntax which is out-of-date for the current release. WebReports that continue to use
out-of-date syntax might not work as they did in previous releases. Updating the
syntax using this utility will result in the selected WebReports being updated with
the current syntax in order to maintain the same functionality.
Current reasons for upgrade are limited to:

• New variable syntax usage
• Syntax around LLURL:FORMEDIT needs updating for editable parameter
• Syntax for Sort tag has changed

48.2.17 WebReports Sub-Tag Builder

Important
This administrative function is used when a new sub-tag “drop-in” is provided.

WebReports supports the ability to create a new sub-tag or replace an existing sub-
tag, and drop it in the subtags folder in the WebReports installation folder. New or
replacement sub-tags do not take effect until the Build All Sub-tags option is
executed and Content Server services are restarted.
This feature is normally only used under supervision from OpenText. If the message
on the WebReports Sub-tag Builder page shows errors it means that one or more
sub-tags in the WebReports Ospace, or one or more sub-tags in the subtags folder,
are invalid and do not compile.
If this copy of WebReports has not been changed since loading the module, and
errors appear here, then OpenText support should be contacted and informed of
these errors.
Important
You should only perform this function with advice and / or supervision from
OpenText support.
48.3 Content Server Functions Available for

WebReports
In addition to the unique functions provided by WebReports detailed above, basic
Content Server document management functions are provided to allow full version
control and other features for the reportviews.
This means that WebReports are subject to all of the administrative options that
would normally be available for Content Server documents. In particular, any
document administrative options, such as Administer Item Control, will also apply
to reportview files. For more information, see:
• “Enabling Content Server Functions for WebReports” on page 1001
• “Exporting and Importing WebReports to XML” on page 1005
• “Setting Permissions for WebReports Users” on page 1006
• “WebReports Preferences in the opentext.ini File” on page 1008
Reportview files are fully indexed, allowing them to be located via the search
facility, though most users will not have read permissions. For more information
about reportviews, see:

48.3. Content Server Functions Available for WebReports
• “Cached Views” on page 1003

• “Default Reportviews” on page 1004
48.3.1 Enabling Content Server Functions for WebReports

You can enable Content Server functions for WebReports through the main Content
Server administration pages.
• You can restrict the creation of WebReports to a selected group of users.
• You can enable the standard Content Server events for WebReports.
• You can store WebReports in the Content Server Report Volume.
• You can export WebReports to email.
Restricting Add New Item for WebReports

Like most other Content Server objects, WebReport objects can be controlled using
the Content Server “object factory”. This means that an administrator can restrict the
creation of WebReports to a selected group of users.
Administering WebReports Events

Content Server events can be enabled for the WebReports object. Because a
webreport reportview is treated like a normal Content Server document, all of the
standard Content Server events can be enabled and used.
Some WebReports auditing events are enabled by default. To enable those auditing
events that are disabled by default, use the Content Server Set Auditing Interests
page.
In order to write a WebReport's RUN or EXPORT events to the AUDIT log, you need to
enable the Run/Export Audits Enabled option on the Specific tab of each
WebReport's Properties page. This is disabled by default in order to provide
granular control to stop the audit logs from overflowing.
Storing WebReports in the Report Volume

The WebReport object has been set up to behave like a LiveReport for any system
functions that are associated with reports. In particular, WebReports can be saved
under the Reports Volume, using the LiveReports tab, from the Personal or Project
menus.
Exporting to E-Mail
WebReports has the capability to export to multiple locations, including e-mail. For
e-mail exports to work correctly, the following details need to be filled out in the
Configure Notifications page in the Content Server administration pages:
• SMTP Server ID
• SMTP Port

• Content Server Host Name
Note: Although these details need to be filled in, Content Server Notifications
do not need to be enabled.
To Restrict Add New Item for WebReports

To restrict Add New Item for WebReports:
1. On the Content Server administration page, under the System Administration

section, click Administer Object and Usage Privileges.
Privileges section, scroll down until you find WebReport under the Object
Type heading.
By default, the Create Object Status is Unrestricted, and the action available
under the Actions column is Restrict.
3. Optional If you want to restrict the option to add a new item for WebReports,
click the Restrictions link. You will now see the Content Server Group
Members Info page titled Edit Group: WebReport.
4. Using the list box and input box on the right, find the person or group you want
to restrict.
5. The name of the person or group will appear on the right hand side of the page.
Under the Actions column, select the Add to group check box, then click
Submit.
6. The individual or group name will now appear in the Current Group Members
box on the left hand side of the page. Click Done.
Tip: When you want to edit the restricted persons or groups in the future,
click the Edit Restrictions link under Actions on the Administer Object
and Usage Privileges page.
To Enable Events for WebReports

To enable events for WebReports:
1. From the Content Server administration page, under System Administration

section, click Administer Event Auditing.
2. Click Set Auditing Interests and then select WebReports from the list.
3. Check the interests as desired and then click Set Interests.
4. RUN and EXPORT audit events are not enabled for WebReports by default. For
each WebReport for which you want these auditing events to run:
a. Select Properties from that WebReport's Functions menu.

b. On the Properties page, select the Specific tab.

c. Select Run/Export Audits Enabled.

d. Click Update.
To Store WebReports in the Report Volume

To store WebReports in the Report volume:
1. When saving your WebReport, during any of an add, move or copy operation,
in the Create In field, click the select link next to Content Server.
2. Next, click the select link next to Content Server Reports.
Tip: To view your WebReport saved to the Reports Volume, from the
Content Server toolbar, select either the Personal or Project menu. Next,
select Reports. On the My Reports page, select the LiveReports tab.
To Enable Exporting to E-Mail

To enable exporting to e-mail:

2. On the Configure Notification page, in the SMTP Settings region:
a. In the SMTP Server ID field, type the name of the SMTP server. The
default for most SMTP servers is mail.
b. In the SMTP Port field, type the port on which the SMTP server listens. The
c. In the Content Server Host Name field, type the fully qualified DNS name
of the primary Content Server host. For example,
“contentserverhost.mycorp.com”.
Note: Although these details need to be filled in, you do not need to
enable Content Server notifications.
3. Click Submit.
48.3.2 Cached Views

Each time a WebReport is run, a cached file is created for the current version of the
reportview file. This functionality is similar to that used for WebForms. These
cached views can be found at: <Content Server_hom>/
support/webreports/views
Because it is sometimes desirable for users to execute multiple versions of the same
WebReport, all versions of cached files are maintained in this folder. The
administrator can delete the contents of this folder at any time. These files are
created as soon as any user runs a WebReport for the first time.

48.3.3 Default Reportviews

When WebReports developers select the Use a Default Reportview option, one of a
number of standard templates can be chosen instead of browsing for a reportview
on the developer's desktop. These templates are stored as text files in Content Server
in the module directory for WebReports. For example, <Content Server_home>
\module\webreports_x_x_x\defaultreportviews\10_basic_report.txt
The Content Server administrator can change these files and add new ones by
editing them, renaming them, or placing additional files in the defaultreportviews
folder. These files will appear as selectable items on the default reportview drop-
down menu. Default reportview filenames should end in .txt and should start with
<x>_ where <x> is a number that determines the order of the default reportviews in
the menu.
Adapting or adding new default reportviews might typically be done to:

• include standard corporate branding to reports
• provide specific export reportviews for exporting Content Server data to other
applications. For example, CSV or WordML.
Information about the pre-packaged reportviews provided by WebReports can be

found in the on-line help and the user guide.
Sample Reportviews
The WebReports module is packaged with various sample reportviews. Once the
module is installed, these reportviews can be found in Content Server at: <Content
Server_home>\module\webreports_x_x_x\examplereportviews
As these reportviews are useful for all WebReports developers, it may be desirable
to place these reportviews in a standard location that is accessible to the appropriate
communities of users.
For example, an area in Content Server called “WebReport development”,

containing sample WebReports, could be created. These WebReports can be built
using the sample reportviews packaged with the module. Alternatively, the
reportview files could be uploaded to Content Server so they can be retrieved by
developers.

48.3.4 Exporting and Importing WebReports to XML

When exporting and importing WebReports to XML, the following points should be
considered:
• When a target system is being searched for a matching object, if more than one
match exists the import routine will currently use the first match found in the
database. This should normally be the first object which was created.
• The WebReports export and import does not handle the following:
• Any categories or attributes associated with settings to export to a Content

Server node will not be re-linked to new objects on a target system.
• Scheduling data is not currently exported or imported.
Standard Export/Import
Like most Content Server objects, WebReports provides the capability to store all the
WebReport data in an XML file for later importing. The basic functionality uses the
same syntax as other Content Server objects. For example, to export a single
WebReport object the following syntax could be used:
?
func=ll&objId=10879&objAction=xmlexport&nodeinfo&content=base64&versi
oninfo=current&scope=sub
&attributeinfo can be used to include any assigned attributes. &versioninfo=all

can be used if all versions are required.
In this example the objid 10879 refers to a WebReport object. If an entire Content
Server container is being exported (using the &scope=sub parameter) and a
WebReport exists within it, the WebReport will be exported with exactly the same
information. Because WebReports include textual content, the &content=base64
must be used during any export.
To import a WebReport the standard import syntax is used. For example, to import a
file called TestImport.xml which is stored on Content Server's C:\ drive to a folder
in Content Server with the object ID 22222, the following syntax would be used:
?func=admin.xmlimport&filename=C:\TestImport.xml&objid=22222
Note: The file to be imported must be saved/stored in a location where the

Content Server can retrieve it; in the example above, the C:\ drive is on the
Content Server's local disk, not on the C drive for the user who is executing the
command.

Special Import Features

Besides the standard features of export/import, WebReports provide some more
advanced features to aid in re-forming links to any dependencies on the destination
system. This feature is used to resolve the following objects on the target system:
• Datasource IDs
• Any constants set to LivelinkObject
• Any constants set to LivelinkUser
• Any parameter defaults set to ObjectID
• Any parameter defaults set to Custom
• Any parameter defaults set to User
• Any Global Constant IDs
• Any Global Parameter IDs
These objects are resolved using a series of actions to attempt to find the correct
object on the target system. In some cases there may be more than one appropriate
matching object so there is a priority order for matching. The items below show the
order of matching. If any step fails to find a match then the next step is tried.
1. If the object to be matched is being imported as part of the same XML import
operation, then the new ID for the imported object will be used.
2. If the original object ID exists on the target system then the associated node is
tested to ensure that it is the same type of object with the same name and data.
3. If there is no equivalent object ID then the target system is searched (using a DB
query) to find an object with the same name and equivalent data. If a match is
found then the new object ID is added to the WebReport
Content Server user IDs are managed in a similar fashion; however user IDs are not
imported during the XML import so the first matching method doesn't apply.
48.3.5 Setting Permissions for WebReports Users

Because WebReports combine aspects of running a report as well as document
management, there are some unique considerations for setting permissions.
The following table indicates the most common roles for WebReport users and the
recommended permissions settings.
Table 48-1: WebReports Users Common Roles and Permission Settings
WebReport User Role Minimum Permissions Available Commands

General users who are not See Make Shortcut
allowed to run or edit the
WebReport.

WebReport User Role Minimum Permissions Available Commands

End Users allowed to run the See Contents Open, Export and standard
WebReport. This will be the See Contents commands.
main permission setting for Examples of standard See
all End Users of WebReports. Contents commands include
It differs from normal Set Notification and Add to
documents where users Favorites
would need to View, Fetch or
Download. With WebReports
these commands are only
used for the users who
actually create or edit the
reportviews.
WebReport Developers who Modify Copy, Open, Download,
might create or edit other View
WebReports but who are not
allowed or required to have
access to modify this specific
WebReport. This enables
them to take the reportview,
for example using download,
and reuse it in another
WebReport for which they
have Reserve permission.
Note that this may appear
counter-intuitive.
WebReport Developers who Reserve Add Reportview Version,
are responsible for Edit Reportview, Properties:
modifying the reportview, Specific
selecting different data
sources and or creating
scheduled instances of a
report. These are typically
the WebReport owners;
however, they do not
necessarily need to have
Delete or Edit Permissions
access.
Administrative Users As Required. Normal Examples include Delete and
permissions behavior. Permissions.
In addition to permissions for the WebReport itself, any user running the
WebReport must have See Contents permission to the underlying data source. This
data source is selected when the WebReport is first created or later via the
Properties: Source page.
Developers with Reserve permission on the WebReport they are working on do not
necessarily require permission to edit or view the contents of the associated data
source, but they will have permission to change which data source the WebReport
object is associated with.

48.3.6 WebReports Preferences in the opentext.ini File

WebReports has a number of configuration preferences that can be set in the
opentext.ini file. The following table describes the options. Be cautious about
making changes to settings in the opentext.ini file. Content Server must be
restarted before any changes take effect. Always consult OpenText support if in
doubt.
Table 48-2: WebReports Configuration Options in the opentext.ini File
Field Name Type Description

addsearchbutton String or null Describes the label used for
the button to launch a
WebReport from Content
Server search. This should be
set from the Admin pages in
Content Server. Please refer
to the WebReports User
Guide for more detail about
this feature.
searchslice Integer Determines how many
results are retrieved for each
call of the search API.
Changing this setting will
impact the performance of
WebReports that use search
as a data source. In general,
this setting should not be
altered without advice from
OpenText support. Default is
300.
searchHardLimit Integer Determines a maximum limit
on the number of results that
a WebReport using search as
a data source can return.
Default is 50,000.
searchDebug true / false Turns on extra debug
information in the thread log
for executing WebReports
with search as a data source.
False by default.


EnableOscriptReportviews true / false Controls whether Oscript is
permitted within
reportviews. Default is true.
When set to false no oscript
within any reportview will
be compiled or executed.
This turns the scripting
feature off completely on the
Content Server. Please refer
to the WebReports User
Guide for more detail about
this feature. True by default.
OscriptAllowFunction1 List of strings A list of individual oscript
package functions to be
permitted within a
reportview. Please refer to
the WebReports User Guide
for more detail about this
feature.
OscriptAllowWholePkg List of strings A list of oscript packages to
be permitted within a
reportview. Please refer to
the WebReports User Guide
for more detail about this
feature.
MaxNestedSubWebReports Integer Controls the upper limit of
how deep sub-WebReports
may be nested. Default value
is 5 if this field is absent.
VersionInput String dir path Specifies the input directory
for a converter (e.g. AdLib
eXpress). This should be
changed via the Manage
WebReports Conversion
ConversionDir String dir path Specifies the output directory
for a converter (e.g. AdLib
eXpress). This should be
changed via the Manage
WebReports Conversion


additionalSearchColumns List of strings or list of lists Determines the optional
columns available to
WebReports that use search
data sources. Possible values
include: OTHotWords,
OTSummary, parentRecord,
Score, shortOTSummary.
These can be specified as
strings within a list or as a
list of two element lists
where the first element is the
column coming back from
search and the second
column is what you want it
to be called in the output. It
should be noted that these
values are made available via
the search index. If the
underlying structure of the
index were to change in
future releases, these
columns may no longer be
available.
AllowFormCustomview true / false Control whether WebReports
can be added to form
templates as views. This
feature is visible by
navigating to the views tab of
a form template. The options
Add WR Power View will be
present if the feature is
enabled. The feature is
enabled by default.
WRNodeMIMETypes List of strings Determines the list of MIME
types that a WebReport node
itself may be set to.
Effectively this is the MIME
type of the reportview.
Normally WebReports are
assigned the text/plain
MIME type, but sometimes it
may be useful to permit
text/html or other MIME
types.


destinationmimetypes List of strings The is the MIME type of the
output that will be created by
WebReports. Depending on
client settings this can
determine what application
is used to open the resulting
document.
WRTriggerSubtypes List of integers Controls the sub-types that
are able to initiate
WebReports from the WR
Trigger feature. All sub-types
are disabled by default.
DisallowServices true / false Enables or disables the WR
Services feature. WR Services
is enabled by default.
livelinkcategory_maxNumCa Integer Defines the maximum
ts number of categories
selectable via the category as
a data source feature.
livelinkcategory_NumAttrAc Integer Defines the maximum
ross number of attributes that
should be displayed on a
single line from the category
as a data source feature.
livelinkcategory_attrDelimite String This character is used to
r separate multivalue
attributes in the output from
the category as a data source
feature.
livelinkcategory_maxNumRo Integer Controls the maximum
ws number of results that are
retrievable from the category
as a data source feature.
AllowFormCustomview true / false Enables or disables the WR
Power View feature which
allows a WebReport to be
used as a form view.


collectConvDocCache Integer For WebReports that use
certain destinations that
allow for conversion of the
WebReport output before
delivery to its final
destination, the document is
stored in a cache which is
cleared by an agent after 120
minutes by default. This
setting specifies an alternate
expiry time for the cache.


SecureServicesSubtags List of Strings This setting is used to define
any sub-tags that require
special security
considerations when being
used through the WR
Services feature. If any of the
specified sub-tags are
included in a WR Services
request then the software will
expect that a secure token has
also been provided in the
request. For example, ?
func=webreports.runse
rvice&
servicetype=gettagdat
a&tagdata=1000&
subtags=useraction:de
lete would create an error
message unless a valid
security token had
previously been requested (&
servicetype=gettoken)
and added to the request like
this: ?
func=webreports.runse
rvice&
servicetype=gettagdat
a&tagdata=1000&
subtags=useraction:de
lete&
securerequesttoken=12
3456.... This setting is
automatically added with a
default list on new, full
installs but if the software is
installed as an Update the
default setting is added as a
comment. The current set of
sub-tags included by default
are:
SecureServicesSubtags={'CAT
ACTION','NODEACTION','S
CACTION','PERMACTION','
RMACTION',
'USERACTION','WFACTION
','USERINFO','RMINFO','NO
DEINFO','EMAILINFO','WFI
NFO','AUDITINFO',
'VERINFO','SCINFO','POINF
O'}


UpdateNumber Integer This setting is used by the
software to manage software
update versions and should
not be altered without
guidance from support
personnel.
Example 48-1: The following example illustrates a typical arrangement:
[WebReports]
addsearchbutton=Custom Report
VersionInput=C:\AdLib eXpress\Input
ConversionDir=C:\AdLib eXpress\Output
OscriptAllowFunction1={'Scheduler.debugbreak','Web.CRLF','Web.
Escape','Web.Unescape','Web.DecodeForURL','Web.EncodeForURL','
Web.Format','Web.EscapeHTML','Web.EscapeXML'}
OscriptAllowWholePkg={'Assoc','Bytes','Date','List','Math','Pa
ttern','RecArray','Str','String','Boolean','undefined','void',
'integer','real','record'}
EnableOscriptReportviews=true
MaxNestedSubWebReports=10
additionalSearchColumns={{'OTSummary','Summary'},
{'shortOTSummary','shortSummary'},OTHotWords,Score,parentRecor
d}

Chapter 49
Administering Content Server Applications
A Content Server Applications Administration section in the Content Server

administration pages has been provided to manage Content Server applications.
49.1 Applications Management

The Applications Management page can be used to build, rebuild, install, upgrade,
uninstall, and delete applications. It can also be used to define a launch or
initialization component for existing applications.
An application is a collection of Content Server nodes, support files, sub-tag files,

and properties files.
Installed applications will have a folder in the <Content Server_home>

\csapplications directory on the server. Each application folder can contain the
following:
• manifest file: detailing the Content Server nodes and support files that make up
the application.
• XML dump file: containing an export of the Content Server nodes included in the
application. If the application does not contain any Content Server nodes, then it
will not have an XML dump file.
• applicationfiles folder: containing the application's support files. If the
application does not contain any application support files, then it will not have
an applicationfiles folder.
Note: In older applications, this folder was called support.
• supportcollateral folder: containing the support files from other support

paths on Content Server. If the application does not contain such support files,
then it will not have a supportcollateral folder.
• subtags folder: containing the application's sub-tag drop-in files. If the
application does not contain sub-tag drop-in files, then it will not have a subtags
folder.
• properties folder: containing the application's properties files. If the application
does not contain properties files, then it will not have a properties folder.
The Applications Management page will display details of any installed or

installable applications, along with options to perform various actions.
Select any application's name to display more details about that application.

Chapter 49 Administering Content Server Applications
Select Show Application Nodes to display details about the Content Server nodes
associated with an installed application.
Select Click to build a new application to open the Build Application form.
49.1.1 Building or Rebuilding an Application

The following table describes fields found in both the Build Application and the
Rebuild Application pages:
Field Name Mandatory? Description

Application Name Yes You must give your
application a name. Only
alphanumeric characters (A-
Z and 0-9) are allowed. All
non-alphanumeric
characters, such as hyphens,
underscores, and spaces are
not allowed.
Application Description No You can optionally give your
application a description.
Version Number Yes You must give your
application a version
number. For example, “1.0”.
Content Server Source No You can optionally add
Objects Content Server nodes to your
application. In the Content
Server Source Objects field,
use the Browse For Source
Object button to browse to a
Content Server source object.
The Content Server source
object will be exported, and
will be imported into the
target system during the
installation process. If the
Content Server source object
is a container, all children of
the object will also be
included in the application.
Application Files No You can optionally add
application files to your
application. Use the Browse
button to browse for files.

49.1. Applications Management

Support Paths No You can optionally add
support paths to your
application. Enter a support
path in the Support Paths
field. For example:
foldername or
foldername.txt. The path
should be under the
support directory on
Content Server, so if you
enter “foldername”, the /
img/foldername folder
will be included in the
application. Paths can point
to either folders or files. If a
folder is selected then the
folder and all of its contents
will be added to the
application.
Sub-tags No You can optionally add sub-
tag files to your application.
In the Sub-tags field, use the
Browse button to browse for
files. Each sub-tag should
consist of two files, a
subtagname.txt file and a
subtagname.txt.json
file. If the Tick to overwrite
the existing sub-tag if
present box is selected, then,
when the application is
installed, the sub-tag files
attached to the application
will be used. The sub-tag files
will overwrite existing sub-
tags, if they already exist on
the system on which the
application is being installed.
If the box is not selected then
the sub-tag files will not be
installed if the sub-tag
already exists on the target
system. If any sub-tags
are disabled on the target
system, they will be enabled
during the installation
process.


OSpace Dependencies No You can optionally add
OSpace dependencies to your
application. In the OSpace
Dependencies field, enter the
name of an OSpace. For
example, type “WebReports”
in the OSpace Name field.
This will define the name of
an OSpace that must exist on
the target system before the
application can be installed.
You can enter the Version
Number and Update
Number of the OSpace
dependency. If any OSpace
dependencies are missing on
the target system, then an
error will be thrown when
attempting to install the
application.
Tag / Sub-tag Dependencies No You can optionally add tag
and / or sub-tag
dependencies to your
application. In the Tag / Sub-
tag Dependencies field, enter
the name of a tag or sub-tag.
For example,
“LL_WEBREPORT_INSERTJ
SON” or “WFTASKINFO”.
This will define the name of a
WebReports tag or sub-tag
that must exist on the target
system before the application
can be installed. If the tag or
sub-tag exists on the target
system but is disabled, then it
will be enabled during the
installation process. If the tag
or sub-tag is not found then
an error will be thrown when
attempting to install the
application.


ActiveView Override Type No You can optionally add
Dependencies ActiveView override type
dependencies to your
application. In the
ActiveView Override Type
Dependencies field, select an
ActiveView override type
from the list. For example,
select “Folder Browse”. This
will define an ActiveView
override type that must exist
and be enabled on the target
system before the application
can be installed. If the
ActiveView override type
exists on the target system
but is disabled, then it will be
enabled during the
installation process. If the
ActiveView override type is
not found then an error will
be thrown when attempting
to install the application.


INI Settings No You can optionally add INI
settings to your application.
These will be added to the
opentext.ini file on the
target system during the
installation process. In the
INI Settings field, from the
Section list, select a section.
For example, select
“CSApps”. Next, enter both a
Key and a Value. This will
define an INI Setting which
will be written to the
opentext.ini file.
For example, if you select:

• Section=CSApps
• Key=MyKey
• Value=x
MyKey=x will be added to

the [CSApps] section of the
opentext.ini file. If the
INI setting key already exists
on the target system, then its
value will be overwritten by
the application's value
during the installation
process.
Properties Files No You can optionally add
properties files to your
application. An application
can include properties files
for different metadata
languages. The naming
convention of any properties
files must be of the form
<application
name>_<language
code>.properties. For
example,
“myapplication_en_US.prope
rties”. If any properties files
are included, then one of
them must be for en_US.
When you build or rebuild an application, the following actions will occur when you
click Submit:
1. When building a new application, a folder for the application will be created in
the <Content Server_home>\csapplications directory on the server.

2. When rebuilding an existing application, the folder for the application in the
<Content Server_home>\csapplications directory on the server will be
deleted and replaced with a new version reflecting the entries on the Rebuild
Application page.
3. If the application contains application files, then they will be copied to a folder in
the support directory located at <Content Server_home>\support
\csapplications\<application_name>.
4. If the application contains properties files, then they will be copied to a folder in
the support directory located at <Content Server_home>\support
\csapplications\<application_name>\properties.
5. When rebuilding an existing application, the folder for the application in the
support directory on the server will be deleted, if it exists, and replaced with a
new version reflecting the entries on the Rebuild Application page.
To Build or Rebuild an Application

To build or rebuild an application:
1. On the Content Server administration page, under Content Server Applications

Administration, click Applications Management.
2. On the Applications Management page, do one of the following:
• To build a new application, select the Click to build a new application link.
• To rebuild an existing application, select Rebuild next to that application's
name.
The Rebuild Application page will be displayed for the application. The
fields will be pre-populated with data from the existing build of the
application.
3. On the Build Application or Rebuild Application page, in the Application

Name field, enter, or change, the name of this application. Application names
must consist only of alphanumeric characters.
4. Optional In the Application Description field, you can enter or change the
description of this application.
5. In the Version Number field, enter, or change, a version number for this
application. For example, “1.0”.
6. Optional In the Content Server Source Objects field, you can choose to add one
or multiple Content Server nodes to your application.
7. Optional In the Application Files field, you can choose to add one or multiple
application files to your application.
Note: If you are rebuilding an existing application, any application files

that are already present in the application will be listed under Existing
Application Files.

8. Optional In the Support Paths field, you can choose to add one or multiple
support paths to your application.
Note: If you are rebuilding an existing application, any supports paths

Support Paths.
9. Optional In the Sub-tags section, if you want to add one or multiple sub-tag files
to your application:
a. In the first text field, enter a <subtagname>.txt file name.

b. In the second text field, enter a <subtagname>.txt.json file name.
c. Optional If you want to ensure that the sub-tag files attached to the
application overwrite any existing sub-tags, select the Tick to overwrite the
existing sub-tag if present box.
Note: If you are rebuilding an existing application, any sub-tags that are
already present in the application will be listed under Existing Sub-tags.
10. Optional In the OSpace Dependencies field, you can choose to add one or
multiple OSpace dependencies to your application to define the name of an
OSpace that must exist on the target system before the application can be
installed:.
a. In the OSpace Name field, enter the name of an OSpace.

b. In the Version Number field, enter the version number of the OSpace.
c. In the Update Number field, enter the update number of the OSpace.
11. Optional In the Tag / Sub-tag Dependencies field, you can choose to add one or
multiple sub-tag dependencies to your application. In the Tag / Sub-tag
Dependencies field, enter the name of a tag or sub-tag. For example, type
LL_WEBREPORT_INSERTJSON or WFTASKINFO.
If the tag(s) or sub-tag(s) listed here is not found on the target system, the
application will not be installed.
12. Optional In the ActiveView Override Type Dependencies field, you can choose
to add one or multiple ActiveView override type dependencies to your
application. If the ActiveView override type(s) is not found on the target
system, the application will not be installed.
13. Optional In the INI Settings field, you can choose to add one or multiple INI
settings to your application. If the INI setting(s) already exist(s) on the target
system, its/their value will be overwritten by the application's value during the
installation process:
a. From the Section list, select an INI section.

b. In the Key field, type a key name.
c. In the Value field, type a value for the key.

14. Optional In the Properties Files field, you can choose to add one or multiple
properties file(s) to your application. If any properties file is included, then one
of them must be for en_US.
Use the Browse button to browse for properties files.
Note: If you are rebuilding an existing application, any properties files

Properties Files.
15. Click Submit.
49.1.2 Installing an Application

When you install an application, the following actions will occur when you click
Submit:
1. If the application contains Content Server nodes then the application's XML dump
file will be imported, creating the application's Content Server nodes in the
selected target container.
2. If the application contains application files then they will be copied to a folder in
the support directory at <Content Server_home>\support\csapplications
\<application_name>.
3. If the application contains support paths then the files will be copied to
equivalent locations in the support directory. Only files that do not already exist
in the support directory will be copied. Any files that are already present will
not be overwritten with the files included in the application.
4. If the application contains properties files then they will be copied to a folder in
\<application_name>\properties.
5. Other actions will be performed depending on the application definition. Use the
Preview option for more details.
6. The application's manifest file will be replaced with a new version. If the
application contains Content Server nodes then the manifest file will contain the
node IDs that have been created on the target system.
7. The application folder will be moved from <Content Server_home>
\csapplicationsstaging to <Content Server_home>\csapplications.

To Install an Application
To install an application:
1. Copy the application folder to the <Content Server_home>

\csapplicationsstaging directory on the server.

3. On the Applications Management page, select the Install box beside the name
of the application you want to install.
4. On the Install Application page:
a. Optional If the application contains Content Server nodes then the form
contains the Target Container field. Use the Browse For Container button
to browse to a Content Server source object where the application's Content
Server nodes will be installed.
b. Optional Click Preview to see details of actions that will be performed on the
target system by the installation process.
c. Click Submit.
49.1.3 Upgrading an Application

When you upgrade an application, the following actions will occur when you click
Submit:
1. The application folder for the currently-installed version of the application will
be deleted from <Content Server_home>\csapplications.
2. The Content Server nodes for the existing application will be deleted, except for
any nodes that have been specified not to be deleted.
3. If the application contains Content Server nodes then the application's XML dump
file will be imported, creating the application's Content Server nodes in the
selected target container. This will default to the same location in which the
application was originally installed, unless a different location is selected.
Note: This process will fail if the import process attempts to create any
nodes with the same name as nodes that already exist in the target
container.
4. If the application contains application files then they will be copied to a folder in
\<application_name>.
5. If the application contains support paths then the files will be copied to
equivalent locations in the support directory. Only files that do not already exist
in the support directory will be copied. Any files that are already present will
not be overwritten with the files included in the application.

6. If the application contains properties files then they will be copied to a folder in
\<application_name>\properties.
7. Other actions will be performed depending on the application definition. Use the
Preview option for more details.
8. The application's manifest file will be replaced with a new version. If the
application contains Content Server nodes then the manifest file will contain the
node IDs that have been created on the target system.
9. The application folder for the new version of the application will be moved from
<Content Server_home>\csapplicationsstaging to <Content Server_home>
\csapplications.
To Upgrade an Application
To upgrade an application:
1. Copy a higher version of the application folder than is already installed to the
<Content Server_home>\csapplicationsstaging directory on the server.

3. On the Applications Management page, select the Upgrade box beside the
name of the application you want to upgrade.
4. On the Upgrade Application page:
a. Optional If the application contains Content Server nodes that have been
renamed, moved or had a new version added to them since the application
was installed, the nodes will be listed under the Nodes that have been
altered since the application was installed section.
To delete the listed nodes when the application is upgraded, select the
Delete box next to the nodes you want deleted.
b. Optional If the application contains Content Server nodes that have been
unaltered since the application was installed, the nodes will be listed under
the Nodes that have been unaltered since the application was installed
section.
Note: Any Content Server nodes that have been deleted since the
application was installed will be listed under Nodes that have been
deleted since the application was installed.
c. Optional If you want to select a target location for the new version of the
application, select the Tick to install a new version of the application in a
different location box.
If this box is deselected then the application will be installed to the same
location in which the location is currently installed.

d. Optional Click Preview to see details of actions that will be performed on the
target system by the installation part of the upgrade process.
e. Click Submit.
49.1.4 Uninstalling or Deleting an Application

When you uninstall an application, the following actions will occur when you click
Submit:
1. The application folder will be moved from <Content Server_home>

\csapplications to <Content Server_home>\csapplicationsstaging.
2. If a support folder exists for the application, it will be deleted.
3. The Content Server nodes for the application will be deleted, except for any
nodes that have been specified not to be deleted.
When you delete an application, the following actions will occur when you click
Submit:
1. The application folder will be deleted from <Content Server_home>

\csapplications.
2. If a support folder exists for the application, it will be deleted.
3. The Content Server nodes for the application will be deleted, except for any
nodes that have been specified not to be deleted.
To Uninstall or Delete an Application

To uninstall or delete an application:

2. On the Applications Management page:
a. If you want to uninstall an application, which will first uninstall the

application and will then place the application folder for the uninstalled
application into the <Content Server_home>\csapplicationsstaging
directory, then, next to the application you want to uninstall, select the
Uninstall box.
i. Optional On the Uninstall Application page, if the application contains

Content Server nodes that have been renamed, moved or had a new
version added to them since the application was installed, the nodes
will be listed under the Nodes that have been altered since the
application was installed section.
To delete the listed nodes when the application is uninstalled, select
the Delete box next to the nodes you want deleted.
ii. Optional If the application contains Content Server nodes that have been
unaltered since the application was installed, the nodes will be listed

under the Nodes that have been unaltered since the application was
installed section.
application was installed will be listed under Nodes that have
been deleted since the application was installed.
b. If you want to delete an application, which will first uninstall the
application and will then delete the application folder for the uninstalled
application from the <Content Server_home>\csapplicationsstaging
directory, then, next to the application you want to delete, select the Delete
box.
i. Optional On the Delete Application page, if the application contains

Content Server nodes that have been renamed, moved or had a new
version added to them since the application was installed, the nodes
will be listed under the Nodes that have been altered since the
application was installed section.
To delete the listed nodes when the application is uninstalled, select
the Delete box next to the nodes you want deleted.
ii. Optional If the application contains Content Server nodes that have been
unaltered since the application was installed, the nodes will be listed
under the Nodes that have been unaltered since the application was
installed section.
application was installed will be listed under Nodes that have
been deleted since the application was installed.
3. Click Submit.
49.1.5 Define Special Components

The Define Special Components form will list all the WebReports that are part of
the application. The form can be used to:
• Define a default launch component for the application.
• Define an initialize component for the application.
• Assign unique nicknames to WebReports that are part of the application.
Default Launch Component

An application can be launched using the URL: ?func=csapps.launchapp&
appname=<application_name>. Calling this URL will run the WebReport defined as
the default launch component.

Initialize Component
A WebReport defined as the initialize component will be run immediately after the
application is installed.
Unique Nicknames
WebReports can be given unique nicknames within an application and run using the
URL: ?func=csapps.launchapp&appname=<application_name>&
nickname=<unique_nickname>
Form Usage
The form will list all the WebReports that are part of the application:
1. If you want to define a WebReport as the default launch component for the
application, select the radio button to the left of that WebReport.
2. If you don't want to define a launch component for the application, which is the
default option, select the radio button next to No Component selected for this
function.
3. Enter unique nicknames in the field to the right of each WebReport.

The nicknames will be validated on submission of the form. An error will be
generated if a nickname is not unique within the application.
Note: Nickname comparisons are case-insensitive.
4. Click Submit.
49.2 Applications Management Configuration

Use the Applications Management Configuration page to manage which
directories are used by “Applications Management” on page 1015.
Use the Content Server Applications Directory field to set which directory on the
server is used to store folders for installed applications.
Use the Content Server Applications Staging Directory field to set which directory
on the server is used to store folders for applications to be installed or upgraded, or
that have been uninstalled.
The directories specified in the Content Server Applications Directory and Content
Server Applications Staging Directory field should already exist on the server.
Selecting the Submit button will perform validation on the fields to ensure that the
values entered are legitimate directories. Selecting the Reset button will clear any
changes made since the page was last refreshed.

49.3. Applications Volume
49.2.1 To Set Directories Used by Content Server Applications

Management
To set directories used by Content Server applications management:

Administration, click Applications Management Configuration.
2. On the Applications Management Configuration page, in the Content Server

Applications Directory field, type the location of the Content Server
applications.
The default is <Content Server_home>\csapplications\.
3. In the Content Server Applications Staging Directory field, type the staging
location for the Content Server applications.
The default is <Content Server_home>\csapplicationsstaging\.
4. In the Content Server Applications Support Folder Name field, type the folder
name for the Content Server applications.
The default is csapplications.
5. Click Submit.
6. Restart the Content Server services.
49.3 Applications Volume

Use the Content Server Applications page to work with the objects in the
Applications Volume.
The Content Server Applications Volume is the default destination for applications
built or installed using “Applications Management” on page 1015.

Chapter 50
Content Server WebReports Widget Configuration
This section describes the use and configuration for the following WebReports
widgets.
• Nodes List WebReport. For more information, see “Configuring the Nodes List
WebReport Widget” on page 1031.
• HTML WebReport. For more information, see “Configuring the HTML
WebReport Widget” on page 1033.
To use the WebReports widgets, you must include and configure each widget in a
perspective.
50.1 Configuring the Nodes List WebReport Widget

The Nodes List Webreport widget shows an expandable list of data, such as a list of
documents that share a common metatdata tab, based on a specified WebReports
data source. Simliar to the standard Content Server Favorites widget, the Nodes List
WebReport widget supports scrolling and name filtering. This widget uses
WebReports REST API along with the INSERTJSON content control tag and the
@NODESTALEFIELDS directive, the to call the specified Webreport based on the
widgets_nodeslist_nodestable default reportview o return correctly formatted
JSON data. Additional tags within the template support sorting, filtering, and
pagination and respond to parameters passed in by the client. For more information
about the @NODESTABLEFIELDS directive, see OpenText WebReports - OpenText Content
Server User Online Help (LLESWEBR-H-UGD).
End users can expand the tile containing the Nodes List Webreport widget to see a
full table view of the nodes. When expanded, the nodes table shows additional
columns of data, such as Type, Name, Size, and Modified. Similar to the standard
Smart View browse view, the expanded widget allows users to filter on name, sort
by column, and view the properties for each node.
Note: The expanded Nodes List WebReport widget does not replicate all Smart
View browse behavour. For example, the columns shown are only a static
subset of the default: neither the facet bar, nor the multi-action bar is shown.
After you have included the Nodes List WebReport widget in your perspective, you
can configure the following parameters:
Nodes List WebReport Widget Configuration Parameters
Name Description

Chapter 50 Content Server WebReports Widget Configuration
Title Mandatory. Enter the title for the tile. Typically, this would describe the
WebReport that you are rendering.
Icon Class Optional. Provide the CSS class for the icon that you want to appear in the
top left corner. For example: <Content ServerInstallDir>/
support/csui/themes/carbonfiber/icons.css contains icons
such as title-assignments, title-customers, title-
favourites, title-opportunities, title-recentlyaccessed,
title-activityfeed, title-customviewsearch.
Default value = “title-webreports” icon .
Search Optional. Enter a custom string that will appear when the user clicks
Placeholder Search. Default value = “Search NodesList Report.”
WebReport ID Mandatory. Enter the ID for the WebReport that you want to appear on
the tile.
Note: The WebReport provided must be based on the default

WebReports template for widget_nodeslist_nodestable.
WebReports Optional. Enter one or more “name”-“value” pairs for the parameters
Parameters that you want to pass into the WebReport.
50.1.1 To Configure the Nodes List WebReport Widget

To configure the Nodes List WebReport widget:
1. Create a new WebReport node using the widget_nodeslist_nodestable

default reportview. For information about how to create a WebReport, see .
2. On the Source tab, set the data source of the webreport to the database source
that contains a column called DataID, which references valid nodes that you
want to display in the widget. For more information about how to set the data
source, see .
3. On the Content Server Administration > ActiveView Administration page,

click the Open the Perspective Manager link.
4. In the Perspective Manager, create a new perspective.
5. On the Configure tab, do the following:
a. Click to expand the Content Server WebReports widget group and drag the
Nodes List WebReport widget to the page.
b. With the Nodes List WebReport widget selected, in the Options column, in
the WebReport ID box, add the WebReport created in Step 1 and edited in
Step 2.
Note: For more information on the options available for the Nodes
List WebReport widget, see “Nodes List WebReport Widget
Configuration Parameters” on page 1031.

50.2. Configuring the HTML WebReport Widget
6. Browse to the location where the new perspective is applied to see the Nodes
List Webreport widget output.
50.2 Configuring the HTML WebReport Widget

The HTML WebReport widget allows developers to show formatted text and images
in a Smart View widget, using standard HTML and CSS. This widget calls a
specified WebReport using the WebReports Rest API and inserts the HTML output
of the WebReport into the tile at runtime.
Notes
• This widget only supports HTML and CSS, not Javascript. Developers can
only choose an existing Classic View WebReport that only uses HTML and
CSS to use with this widget.
• Be sure to avoid style conflicts with the Content Server Smart View user
interface framework or any other widgets on the page.
The following sample reportview templates provide examples of how to construct

the HTML output of the WebReport content to avoid conflicts. They show how to
use CSS selectors to avoid style conflicts, images and icons, HTML tables and
dynamic data insertion using WebReports tags, including the new
[LL_REPTAG_WIDGETCONTAINERID /] data tag which can be used to obtain the ID
current container. They also include examples of how to make page elements
responsive. It is important to avoid including unresponsive content. For instance,
inserting an image with a fixed width will mean that when the page is resized or
viewed on a mobile device the page flow may not adjust as desired.
• widget_html_report_image_icons_sample
• widget_html_report_responsive_table_sample
Important
Although these templates include examples using the bootstrap library,
OpenText does not officially support this library. If you use this library, you
must consult the published documentation. In addition, the Content Server
Smart View implements a customised version of bootstrap. It is expected that
in some cases the Smart View version of bootstrap will diverge from the
publicly documented behaviour. In a post-Content Server 16 update,
OpenText will provide developer documentation with style guidelines as
well as the Smart View UI SDK.
After you have included the HTML WebReport widget in your perspective, you can
configure the following parameters:
HTML WebReport Widget Configuration Parameters
Name Description

Chapter 50 Content Server WebReports Widget Configuration
Title Optional. Enter the title for the tile. Typically, this would describe the
WebReport that you are rendering.
Default title = HTML WebReport
Icon Class Optional. Provide the CSS class for the icon that you want to appear in the
top left corner. For example:
support/csui/themes/carbonfiber/icons.css contains icons
such as title-assignments, title-customers, title-
favourites, title-opportunities, title-recentlyaccessed,
title-activityfeed, title-customviewsearch.Default value =
WebReports icon.
Note: You can specify a custom icon within the WebReport

template by adding a CSS selector that uses background-image
and then referencing the selector in this option.
Header Optional. Select the option for whether the tile will include a header area
that contains the title and title icon.
Default = True.
Scroll Optional. Select the option for whether users can scroll through the
content on the tile. If scrolling is disabled, content will be truncated.
Default = True.
WebReport ID Mandatory. Enter the ID for the WebReport that you want to appear on
the tile.
Note: The WebReport provided must follow the HTML

construction guidelines and be based on either a blank template or
one of the sample WebReports templates,
widget_html_report_image_icons_sample or
widget_html_report_responsive_table_sample.
WebReports Enter one or more “name”-“value” pairs for the parameters that you
Parameters want to pass into the WebReport.
50.2.1 To Configure the HTML WebReport Widget

To configure the HTML WebReport widget:
1. Create a new WebReport node using the blank reportview, the

widget_html_report_image_icons_sample template, or the
widget_html_report_responsive_table_sample template. For information
about how to create a WebReport, see .
2. Edit the WebReport to contain the desired output using the guidelines and
general practices used in the sample reportviews.
3. On the Content Server Administration > ActiveView Administration page,

click the Open the Perspective Manager link.
4. In the Perspective Manager, create a new perspective.
5. On the Configure tab, do the following:

50.2. Configuring the HTML WebReport Widget
a. Click to expand the Content Server WebReports widget group and drag the
HTML WebReport widget to the page.
b. With the HTML WebReport widget selected, in the column, in the
WebReport ID field, add the WebReport created in Step 1 and edited in
Step 2.
Note: For more information on the options available for the HTML
WebReport widget, see “HTML WebReport Widget Configuration
6. Browse to the location where the new perspective is applied to see the HTML
WebReport widget output.

Part 13
Workflow and Forms Administration
Chapter 51
Administering Workflows
You can control the behavior of workflows by administering workflow features in

the Workflow Administration area on the Content Server Administration page.
You can administer the following workflow features:
• Settings that control how users view workflows.
• Access to the Workflow Agent, which can automatically processes some
workflow steps, and settings that control how it works.
• Access to the Content Server Volume where Documents and other information
used in the workflow are stored.
51.1 Administering Workflow User Settings

You can administer the following settings for workflow users:
• Workflow audit information.
• Allow users to delegate workflow assignments.
• Specify the number and order in which initiated workflows appear on users' My
Workflows and Workflow Status pages.
• Specify whether users can configure their own workflow display settings.
Using the Expression Builder

The Expression Builder allows you to build complex conditional expressions to limit
the workflows that appear on the My Workflows and Workflow Status pages. The
Expression Builder is accessible on the Configure Workflow Parameters page by
selecting the Edit Expression icon, , in the Workflow Statuses Show area.
Add New Row Options

The following options appear in the Expression Builder's Add New Row list:
• Status, which allows you to display workflows by their status. If you choose this
criterion, the available values are:
• Executing
• OK
• Late
• Milestone Late
• Step Late
• Workflow Late
• Completed

Chapter 51 Administering Workflows
• Stopped
• Suspended
The Status option only appears in the Expression Builder for non-archived
workflows.
• Name, which refers to the workflow's name.
• Initiator, which allows you to choose the name of a user to limit the display of
workflows.
• Date, which allows you to click a date in a list.
• Paren Left and Paren Right, which allow you to construct complex criteria, such
as (“Status = OK” OR “Status = Completed”) AND “Due Date > 07/05/2013”.
51.1.1 To Specify Workflow User Settings

To specify workflow user settings:
1. In the Workflow Administration section of the Content Server Administration

page, click the Configure Workflow Parameters link.
2. In the Audit Trail area, select the Don't include user names check box to
exclude users' names from the audit logs of workflows. The value <None> is
displayed in the User column on the Audit page. Clear the check box to include
users' names in the audit logs of workflows.
3. In the Proxies area, select the Allow user proxies check box to grant users the
ability to assign another user the permission to complete their workflow steps in
their absence. Clear the check box to require users to complete workflow steps
themselves.
4. In the Workflow Statuses area, click one of the following in the Show list to
determine which initiated workflows and process instances appear by default
when a user accesses the My Workflows or Workflow Status pages:
• All, if you want to display all initiated workflows and process instances
with See permission.
• Initiated, if you want to display only workflows and process instances
initiated by the user.
• Managed, if you want to display only workflows and process instances
managed by the user.
5. In the Workflow Statuses Show area, click the Not Archived or Archived radio
button to determine which type of workflow appears by default when users
access the My Workflows or Workflow Status pages.
6. In the Workflow Statuses Show area, click the Edit Expression icon, , to
build complex arguments and further limit the workflows that appear. For
example, ("Status = OK" OR "Status = Completed") AND "Due Date >

51.2. Administering Workflow Agent Parameters
07/05/2013". For details, see “Administering Workflow User Settings”

on page 1039.
7. In the Workflow Statuses Sort Order area, click the default method you want
Content Server to use to sort workflows on the My Workflows or Workflow
Status pages. The options correspond to columns on the pages.
8. In the Maximum Items Per Page area, type the default number of workflows
and assignments that will display on the My Workflows or Workflow Status
pages.
9. In the Maximum Items Per Page area, select the Allow users to change
individual setting check box to permit individual users to change the
Maximum Items Per Page setting on their My Workflow Settings page. Clear
the check box to apply the limit set in the Maximum Items Per Page field to all
users.
10. In the Set Recipient for Workflow Error E-mails area, click one of the following
buttons:
• All Managers, which sends a notification to all managers whenever a

Workflow error occurs.
• Master Manager, which sends a notification to the initiator, performer and
owner of the Workflow instance.
12. Restart Content Server and Web application server.
Note: If users have modified the default values of the workflow relationships,
Sort Order and Maximum Items Per Page fields, the default values you
specify do not override their settings.
For information related to this procedure, see “Administering Workflow User

51.2 Administering Workflow Agent Parameters

The Configure Workflow Agent Parameters page allows you to specify the
intervals when the Workflow Agent runs, enable error notification, and set the task
processing order. For more information on the Workflow Agent, see OpenText
Content Server User Online Help - Implementing a Business Process as a Workflow
(LLESWFP-H-UGD).
When the Workflow Agent starts, it searches the Content Server database for all
tasks with the status Ready for the Workflow Agent. After the Workflow Agent
finishes its run, it stops until the next scheduled start interval.
Tasks are processed by the Workflow Agent or the Distributed Agent. How the tasks
are processed depends on the selected processing order. If first in, first out (FIFO)

order is enabled, the Workflow Agent processes the tasks. If FIFO is disabled, then
the Workflow Agent uses Distributed Agents for parallel processing of the tasks.
Enabling Error Notification

You must enable Workflow Agent error notification to ensure that error messages
are sent when processing fails. If you disable error notification, no user is notified if
processing fails.
If the Workflow Agent encounters an error, it attempts to send an email message.

The recipients of the notification receive requests to correct the error. The
notification recipients are specified in the Workflow User settings.
In order to send error messages, the Workflow Agent requires the following:
• The email server's SMTP settings and the sender's email address must be
specified.
• Workflow managers and step assignees must specify their email address in their
profiles.
You must specify the email server's SMTP settings in the following sections:
• SMTP Settings, where you can set the SMTP email server parameters.
• Email Message Settings, where you can set the sender's email address.
In addition, you can test your settings.
Specifying Processing Order

You can specify that the Workflow Agent must process tasks in first in, first out
(FIFO) order (that is, the order in which they are received) or in order by the results
of a database query (which may vary with each query). If you have a small number
of tasks to be processed, the setting may not make a difference.
If you disable FIFO processing, the Workflow Agent does not sort tasks after it
searches the database for all tasks to be processed; it completes the tasks in the order
they appear in the search result. For increased throughput, disable the FIFO order.
51.2.1 To Schedule the Workflow Agent

To schedule the Workflow Agent:
1. Click the Configure Workflow Agent Parameters link in the Workflow

Administration area.
2. Specify when you want the Workflow Agent to run by doing one of the
following:
• Schedule the times when the Workflow Agent runs by specifying the start
times in the following fields:

51.3. Administering Access to the Workflow Volume
• In the On These Days section, select the check boxes of the days of the
week on which you want the Workflow Agent to run.
• In the At These Hours section, select the check boxes of the hours on
which you want the Workflow Agent to run.
• In the At These Times section, select the check boxes of the minute
intervals on which you want the Workflow Agent to run.
• In the Sleep Interval field, specify the number of seconds Content Server
waits before running the Workflow Agent again after starting or running the
Workflow Agent. For example, if you want the Workflow Agent to run
every three minutes indefinitely, specify 180 in the Sleep Interval field.
Note: You must schedule start times or specify a sleep interval. If you
schedule start times and specify a sleep interval, the sleep interval is
ignored.
3. In the Send E-mail On Errors section, select if you want the master manager of
the workflow to receive an email whenever a workflow error occurs.
4. In the Process Tasks in FIFO Order section, select if you want the Workflow
Agent to process tasks in first in, first out (FIFO) order. For more information,
see “Specifying Processing Order” on page 1042.
6. Restart Content Server and Web application server.
For information related to this procedure, see “Administering Workflow Agent

51.3 Administering Access to the Workflow Volume

The Workflow Volume page allows you to view the contents of the workflow
volume. You can also set permissions on workflows and attachments copied to the
workflow volume. When an item is added as a workflow attachment, it inherits the
permissions of the workflow attachments folder, which by default is full
permissions. All users can search on workflow attachments even if they do not have
permissions on the workflow.
If Public Access is not configured for a workflow, users cannot initiate it, because
Content Server stores attachments added to the workflow attachments folder in the
workflow volume. Using the Workflow Volume page, you can assign users
privileges to view and add attachments. Also, if your Content Server site supports
Content Server Domains, you can use this page to control which domains can
initiate the workflow.
Preventing Users from Searching Workflow Attachments

If you want to prevent users from being able to search workflow attachments
without changing permissions on the workflow or attachments, you can manually

exclude the workflow volume from the Content Server search index, and then
rebuild the Content Server search index.
51.3.1 To Prevent Users from Searching the Workflow Volume

To prevent users from searching the workflow volume:
1. Make a backup copy of the Content Server initialization file, <Content

Server_home>\config\opentext.ini.
2. Edit opentext.ini and locate the [LivelinkExtractor] section.
3. Exclude the workflow volume (161) from the search index by adding it to the
ExcludedVolumeTypes parameter as follows: ExcludedVolumeTypes={ 162,
161 }.
4. Save your changes to file.
5. Restart Content Server, the Content Server Admin Server, and the Web
application server.
6. On the Content Server Administration page, click the Open the System Object
Volume link in the Search Administration area.
7. Click the Functions icon for the Enterprise Data Source Folder, and then
choose Maintenance.
8. On the Data Source Maintenance page, click the Purge the data flow,
reconstruct the index, and then extract the data from the source radio button.
9. Click OK, and then click OK again.
10. When complete, click Continue.
For information related to this procedure, see “Administering Access to the

Workflow Volume” on page 1043.
51.4 Administer Access to the Workflow Agent and

Item Handler Step
The administrator can use the Administer Object and Usage Privileges page in the
System Administration section to control usage privileges for the Item Handler
step and Workflow Agent. The Item Handler step and Workflow Agent are
powerful features that users can configure to automatically create, modify, and
delete data in Content Server and affect system processing. To help you control
which users can access these workflow features, Content Server makes each feature
available as an object that can be restricted for use by specific users or groups.
The following table explains the workflow feature objects that can be restricted and
their functionality.

51.4. Administer Access to the Workflow Agent and Item Handler Step
Usage Name Workflow Agent or Item Function

Handler Step Element
Item Handler Item Handler step icon Allows user to add an Item
displayed on the Step Palette Handler step to a workflow.
Versioning The Item Handler step's Allows user to configure the
Versioning tab step to perform operations on
documents and compound
documents.
Move/Copy The Item Handler step's Allows user to configure the
Move/Copy tab step to move or copy items.
Categories The Item Handler step's Allows user to configure the
Categories tab step to add, modify, or
remove categories from
workflow attachments or
items.
Folder Definitions The Item Handler step's Allows user to configure the
Folder Definitions tab step to create folder
hierarchies or the workflow
volume.
Agent Performers The Assignee field on the Controls which users are
Item Handler step's General allowed to have the
tab Workflow Agent process
Item Handler steps assigned
to them. If the Workflow
Agent determines that it
cannot process an Item
Handler step because the
assigned user does not have
permission to use the
Workflow Agent, it reassigns
the step so that the user must
execute it manually.
Assign to Workflow Agent Execute Using Workflow Indicates that step processing
Agent check box on the Item will be handled
Handler step's General tab automatically in the
background.

Chapter 52
Planning Forms Usage
Use the following questions to help you decide how to administer Forms for your
system:
• Do you want to permit all users to add new tables to the Content Server
database? If so, you must educate all users about the Content Server schema to
ensure the integrity of your database. Consider restricting the Form Template
creation privilege. For more information on Form Template creation privileges,
see “Administering Creation Privileges” on page 1047.
• Do you want to permit all users to store Form data in tables that may exist for the
templates they select when creating Forms? If not, restrict the “Administering
Usage Privileges” on page 1048.
• Do you want to permit all users to add Forms to your system? If so, you must
educate all users about revision and submission mechanisms. Even if you restrict
the Form creation privilege, users can still fill out stationery Forms. This
approach cuts down on user training time. For more information on Form
creation privileges, see “Administering Creation Privileges” on page 1047.
Note: If you choose this option, OpenText recommends that you provide a
designated directory for Form Templates. This will make it easier for users
to locate the templates they need in order to add Forms to the system.
• What do you plan to do with submitted Form data? If you want to compile
statistics or have an external application access the data, associate database tables
with your Form Templates. This makes the SQL Table option available for
revision and submission mechanisms. For more information, see OpenText
Content Server User Online Help - Using Forms (LLESFRM-H-UGD).
52.1 Administering Creation Privileges

Every user who has the Form creation privilege can add new Forms to the system.
Once a Form exists, users can grant permission to the Form similar to those for other
items.
What distinguishes Forms from most other items is that you must base every Form
on a Form Template. A user needs the Form Template creation privilege to add new
Form Templates. You control the use of individual templates by granting users
permissions for them.

Chapter 52 Planning Forms Usage
52.1.1 The Form Creation Privilege

By default, the Form creation privilege is unrestricted, meaning that all users can
add Forms. You administer the privilege to create Forms like all other objects. For
more information on the administering object and usage privileges, see
52.1.2 The Form Template Creation Privilege

The privilege to create Form Templates implies the ability to create new tables in the
Content Server database when uploading the templates. A database table for a
certain Form Template can store data entered in Forms that are based on that
template. You may therefore want to restrict the Form Template creation privilege to
a small number of users who have a knowledge of the Content Server schema. This
ensures the integrity of your Content Server database.
By default, the Form Template creation privilege is unrestricted. This means that, by
default, all users can add templates to Content Server. You administer the privilege
to create templates like all other objects. For more information on the administering
object and usage privileges, see “Administering Object and Usage Privileges“
on page 327.
52.2 Administering Usage Privileges

There are two usage privileges involving Forms: Form Revisable Storage and Form
Submittable Storage. The Form usage privileges have an effect only if a database
table is associated with the template on which a user bases a Form.
The process of assigning Form usage privileges is exactly the same as that for other
item creation privileges. To facilitate administration of Form usage privileges,
consider creating two groups to which you grant the respective usage privileges.
52.2.1 Form Revisable Storage

Users need the Form Revisable Storage privilege to be able to select the SQL Table
revision mechanism when they create a Form and select a template for which a
database table exists. By default, the Form Revisable Storage privilege is
unrestricted, meaning that all users can store their Forms' revision data directly in
the database, provided that a table exists for the template that they select.
Consider restricting the Form Revisable Storage privilege if database space is a

concern in your system. Note that even users who cannot themselves create Forms
with SQL Table storage for revisions can be granted permission to use such Forms
created by other users. Regardless of the Form Revisable Storage privilege, a user
creating a Form always has the option to store intermediate Form data as versions of
a Content Server node.

52.2. Administering Usage Privileges
52.2.2 Form Submittable Storage

Users need the Form Submittable Storage privilege to be able to select the SQL Table
submission mechanism when they create a Form and select a template for which a
database table exists.
By default, the Form Submittable Storage privilege is unrestricted, meaning that all
users can store their Forms' submitted data directly in the database, provided a table
exists for the template that they select.
Consider restricting the Form Submittable Storage privilege if database space is a

concern in your system. Note that even users who cannot themselves create Forms
that store submitted data directly in the database can be granted permission to use
such Forms created by other users. Regardless of the Form Submittable Storage
privilege, a user creating a Form always has the option to store the data they submit
as versions of a Content Server node.

Chapter 53
Administering Web Forms
The Web Forms module allows users to work with HTML Forms in Content Server.
One way to enhance the usability of HTML Forms is with Web Forms Database
Lookups.
53.1 Managing Secure Database Connections

Web Forms database lookups are executed by using JavaScript in the HTML
template view and consist of a secure database connection and a secure database
lookup. Before you can create a secure database lookup, you must create a secure
database connection that provides a connection to the database that contains the
information to be looked up.
Manage Secure Database Connections

The Manage Secure Database Connections link in the Web Forms Database
Lookup Administration section allows you to view, modify, and create database
connections. A Web Forms database connection allows you to connect to Content
Server or an external SQL database for use in a secure database lookup in an HTML
view of a Form Template. You cannot delete a database connection if any secure
database lookups use that connection.
By default, only the administrator can create secure database connections and secure
database lookups. Any user can execute lookups. Web Form users who attempt to
perform a database lookup request without permission to use the database lookup
function will encounter an error.
All new and existing database connections encrypt their passwords when you create
a connection encryption key. Changing the key updates all of the connection objects.
Only the password is encrypted.
Note: If you want to grant permission to users who want to be able to create
database connections and lookups, or if you want to restrict which users can
execute Web Forms database lookups, you must modify the user restrictions
for these functions on the Administer Object and Usage Privileges page in the
System Administration section. For more information about configuring
restrictions for either executing the Web Forms Database Lookup function or
creating connections or lookups, see “Administering Object and Usage
Privileges“ on page 327.

Chapter 53 Administering Web Forms
53.1.1 To Create a Secure Database Connection

To create a secure database connection:
1. In the Web Forms Database Lookup Administration section, click the Manage
Secure Database Connections link.
2. On the Web Forms Connections page, click the Add Item menu and then Web
Forms Database Connection.
3. On the Add: Web Forms Database Connection page, click the type of relational
database you wish to connect to on the RDBMS Server Type list.
Note: Microsoft SQL Server will only be available as a choice on the

RDBMS Server Type menu if Content Server is running on a Microsoft
Windows server.
Based on whether you select the Oracle or Microsoft SQL database system
from the RDBMS Server Type list, different fields display in the Add:
Web Forms Database Connection page.
• For Microsoft SQL Server, you must specify the User Name and Password of
a Microsoft SQL Server user account with permission to access the database,
along with the SQL Server Database Name and SQL Server Name to which
the connection is made.
• For Oracle Server, you must specify the User Name and Password used to
connect to the Oracle server, and the Service Name, which is the connect
string for the database service to which the connection is made.
• For HANA Server, you must specify the User Name and Password used to
connect to the HANA server, the HANA Server, which is the connect string
for the database service to which the connection is made, along with the
HANA Schema.
• For PostgreSQL Server, you must specify the User Name and Password of a
PostgreSQL Server user account with permission to access the database,
along with the PostgreSQL Server Name and PostgreSQL Database to which
the connection is made.
4. The Dependent Lookups box displays regardless of the database system you
select. You cannot modify this field while creating a database connection.
5. Specify Name, Description, Categories and Create In parameters as you would

when adding any item to Content Server.
Note: The Name you specify for the database connection must be unique
among all database connections.
6. Click Add.
For information related to this procedure, see “Managing Secure Database

Connections” on page 1051.

53.2. Managing Secure Database Lookups
53.1.2 To Modify Database Connection Properties

To modify database connection properties:
1. On the Web Forms Connections page, click the database name link to view and
modify the database connection's properties.
2. Click Add Version.
Notes
• Once a database connection is created, you cannot change the RDBMS Server
type.
• The Dependent Lookups field displays regardless of the database system
you select. You can view names of all current Database Lookups that require
the current database connection. You cannot modify any Database Lookups
on this page. If you want to modify a Database Lookup see, “To Modify Web
Forms Lookup Properties” on page 1055.

53.1.3 To Create a Connection Encryption Key

To create a connection encryption key:
1. In the Web Forms Database Lookup Administration section, click the

Connection Encryption Key link.
2. In the Connection Encryption Key box, enter a key.
3. Click Submit.

53.2 Managing Secure Database Lookups

You can use Secure Database Lookups to create the SQL statement that can be
executed in response to a user action on a Web Form HTML view.
A lookup requires a Web Forms Secure Database Connection. This connection

defines which database the SQL statement is executed. The Secure Database
Connection must be created first.
The SQL statement to execute defines the SQL statement that will be executed
against the specified database connection and may optionally accept parameters
passed from the Web Form HTML. To bind the values passed in from the form to
the SQL statement, use the standard SQL bind syntax, adding :A<n> to the SQL
statement to represent the parameter. For example, :A1 would be replaced by the

value of the first parameter, and :A-2 would be replaced by the value of the second
parameter.
Configuring secure database lookups are performed in the Managing Secure

Database Lookups page of the Web Forms Database Lookup Administration
section by adding a Web Forms Database Lookup item. If you select the Filter
Output Based On Permissions check box, then the SQL statement to execute must
include the DataID, OwnerID, and PermID columns from the DTree table in a
Content Server database. With these three columns, the lookup executes, and only
rows that the current user has See access to are returned in the output data. Rows
that the current user does not have See access to are removed from the output data.
The Name must be unique, and the Name value must be specified in the Web Form
HTML view JavaScript to specify which lookup is executed. Name, Description,
Categories, and Create In are standard parameters that can be used whenever you
add any item in Content Server.
53.2.1 To Create a Database Lookup

To create a database lookup:
1. In the Web Forms Database Lookup Administration, click the Manage Secure
Database Lookups link.
2. On the Web Forms Lookups page, click Web Forms Database Lookup on the
Add Item menu.
3. On the Add: Web Forms Database Lookup page, specify the following
information:
• Web Form Database Connection, which is the name of the connection object
representing the database system to which you want to connect.
• SQL statement to execute, which is the SQL statement that is executed
against the specified database connection.
• Filter Output Based On Permissions, which is whether the results of the
lookup should be limited by the permissions of the user. If selected, you
must specify DataID, OwnerID, and PermID columns from the DTree table
in the SQL statement to execute field.
4. Specify Name, Description, Categories, and Create In parameters as you

would when adding any item to Content Server.
5. Click Add.
For information related to this procedure, see “Managing Secure Database Lookups”
on page 1053.

53.3. Adding JavaScript File to All Templates Exported as HTML
53.2.2 To Modify Web Forms Lookup Properties

To modify Web Forms lookup properties:
1. On the Web Forms Lookups page, click the lookup name link to view and
modify the properties of the Web Forms Lookup.
2. Click Add Version.
For information related to this procedure, see “Managing Secure Database Lookups”
on page 1053.
53.3 Adding JavaScript File to All Templates Exported

as HTML
You can specify a custom JavaScript include file for every form template you export
to the HTML format. Your web server must have read permissions for the custom
JavaScript include file or else the HTML template views will not be able to include
the JavaScript file.
53.3.1 To Add the JavaScript Include File

To add the JavaScript include file:
1. In the Web Forms Database Lookup Administration, click the Add Custom
JavaScript File to All Templates Exported as HTML link.
2. In the Path and name of include file box, add the custom JavaScript include
file.
Note: The path must be relative to the support prefix for the Content
Server. The support prefix is shown on the Custom JavaScript include file
page.
3. Click Submit.
For information related to this procedure, see “Adding JavaScript File to All
Templates Exported as HTML” on page 1055.

53.4 Database Connection Information from Previous

Releases
Since Web Forms database lookups from previous releases expose a risk for SQL
injection attacks, therefore old database connections and lookups are disabled by
default and can only be enabled by adding the following entry into opentext.ini:
[HForm]
AllowUnsafeDatabaseLookups=true
The List Database Connection Information From Previous Releases link in the
Web Forms Database Lookup Administration section lists your Web Forms
database connections created in previous releases of the Web Forms module.
The following table explains the information displayed for each connection.
Column Contains
Name The database name
Type The database type
User Name The user name of the account used to access
the database
Note: New database connections can only be created using the Manage Secure
Database Connections link in the Web Forms Database Lookup
Administration section.

Part 14
Enterprise Connect Administration
Chapter 54
Configuring OpenText Enterprise Connect
Advanced Settings
You can perform the following tasks on the Configure Advanced Settings page:
• Specify how Microsoft Office documents open when users double-click them in
Enterprise Connect.
• Specify how Compound Emails open when users double-click them in Enterprise
Connect.
• Specify settings for the Enterprise Connect from Here feature.
• Specify the naming convention used for Content Server Shortcuts.
• Specify when users are prompted to enter metadata when they add items to
Content Server.
• Customize the subtype applied when dragging certain folder types.
• Map specific file extensions to custom subtypes.
Important
Users must initiate a new Enterprise Connect session in order to access any
administrative changes that you make.
54.1 Configuring Double-click Actions for Microsoft

Office Documents
You can configure how Microsoft Office documents open when users double-click
them in Enterprise Connect, in either Windows Explorer or Microsoft Outlook. This
setting also applies to Shortcuts that point to Office documents. The Always open
document as read-only option is the default setting, and you can use this option if
you want users to open a read-only version when they double-click a Word, Excel,
PowerPoint, Project, or Visio document. Use the Open document for editing if
permissions allow setting if you want users to be able to immediately edit Office
documents that they open by double-clicking.
Note: Users can only edit documents for which they have Modify and Reserve
permissions.

Chapter 54 Configuring OpenText Enterprise Connect Advanced Settings
54.1.1 To Configure Double-click Actions for Microsoft Office

Documents
To configure double-click actions for Microsoft Office documents:
1. On the Content Server Administration page, click Enterprise Connect

Administration, and then click the Configure Enterprise Connect Advanced
Settings link.
2. In the Action Configuration area, click one of the following options in the
When double-clicking a Microsoft Office document list:
• Click Always open document as read-only if you want a read-only version

of the document to open.
• Click Open document for editing if permissions allow if you want users to
be able to edit documents.
3. When you have made your selection, do one of the following:
• Click Submit to apply the changes.

• Click Reset to return to the last saved configuration.
• Click Set Default to return to the default configuration, and then click OK to
apply the default settings.
54.2 Configuring Double-click Actions for Compound

Emails
You can configure how Compound Emails open when users double-click them in
Enterprise Connect, in either Windows Explorer or Microsoft Outlook. Open
Compound Email’s message is the default setting, and you can use this option if
you want the Compound Email to open in Outlook when users double-click it. Use
the Open Compound Email’s sub-items setting if you want a separate web panel
that lists the email and the attachments to open when users double-click a
Compound Email. From the web panel, users can edit, open, or download the email
or the attachments, depending on their permissions. This panel offers the same
functionality as the Sub-Items tab in the Preview Pane. These settings apply to
Compound Emails that users browse to and to Compound Emails returned in search
result lists.

54.3. Making Enterprise Connect Accessible from the Content Server Web Interface
54.2.1 To Configure Double-click Actions for Compound

Emails
To configure double-click actions for Compound Emails:

Settings link.
2. In the Action Configuration area, click one of the following options in the
When double-clicking a Compound Email list:
• Open Compound Email’s message to open the selected email in Outlook.

This is the default value.
• Open Compound Email’s sub-items to launch a separate web panel.

54.3 Making Enterprise Connect Accessible from the

Content Server Web Interface
You can enable users to access Enterprise Connect when they are working with
specified content types in the Content Server Web Interface. When this feature is
available, users can access the Function menu for a supported item, choose
Enterprise Connect from Here, and the selected item appears in a new Windows
Explorer instance. As administrator, you determine which subtypes this feature is
available for. By default, this action is labelled Enterprise Connect from Here. You
can rename this label if required.
Note: This feature is only available in Internet Explorer. In addition, it is only

available in the Content Server Web Interface for the items that you specify.

54.3.1 To Make Enterprise Connect Accessible from the

Content Server Web Interface
To make Enterprise Connect accessible from the Content Server web
interface:

Settings link.
2. In the Action Configuration area, do the following:
• In the Label for "Enterprise Connect from Here" box, enter the label that
you want to appear in the context menu. By default, Enterprise Connect
from Here is used.
• In the Subtypes for "Enterprise Connect from Here" box, add or remove the
subtypes for which you want to make this feature available. By default, the
following subtypes support this feature:
• Folders (0)
• Enterprise Workspaces (141)
• Personal Workspaces (142)
• Projects (202)
• Email Folders (751)
• Virtual Folders (899)


54.4. Controlling the Name of Content Server Shortcuts Created by Dragging
54.4 Controlling the Name of Content Server

Shortcuts Created by Dragging
Users can create a Content Server Shortcut to an item in Enterprise Connect by right-
clicking and dragging an item to another location in Enterprise Connect. By default,
the Shortcut is automatically given a name that consists of the prefix Shortcut
followed by the name of the item. The Include "Shortcut" prefix when creating
Content Server shortcuts using drag & drop setting allows you to specify if the
prefix is used. When you clear this check box, the Shortcut name will consist of the
name of the item. This setting only applies to Shortcuts created by dragging items
when working in Windows Explorer. If users have sufficient permissions, they can
rename the Shortcut after they have created it.
54.4.1 To Control the Name of Content Server Shortcuts

Created by Dragging
To control the name of Content Server Shortcuts created by dragging:

Settings link.
2. In the Action Configuration area, do one of the following:
• Select the Include ‘Shortcut’ prefix when creating Content Server shortcuts
using drag & drop check box to use the Shortcut prefix in Shortcut names.
This is the default setting.
• Clear the Include ‘Shortcut’ prefix when creating Content Server shortcuts
using drag & drop check box if you want to omit the Shortcut prefix from
Shortcut names.


54.5 Configuring Content Capture Options

You can specify when users are prompted to enter metadata about items they add to
Content Server. You can configure the settings to prompt users to provide metadata
only if an attribute or other information is required, or to provide metadata for each
item they add to Content Server.
If you have other Content Server modules such as Records Management installed in
your environment, by default, your users will always be prompted to provide
metadata when they copy or move items within an instance of Content Server.
However, you can specify that users are only prompted to provide metadata when
copying or moving items within an instance of Content Server when the source and
destinations have different category requirements. For example, consider an
environment with Enterprise Connect and Records Management installed. If you use
the Always setting, users will be prompted to provide metadata each time they copy
or move a Document within the instance of Content Server, regardless of the
metadata requirements of the source and destination. If you use the Never setting,
users will be prompted to provide metadata when the destination requires users to
provide no metadata, but the source has categories and attributes enabled. If the
metadata requirements of the source and destination are the same, users will not be
prompted for metadata.
Choose the options that suit your best practices for capturing metadata.
54.5.1 To Configure Content Capture Settings

To configure content capture settings:

Settings link.
2. In the Metadata Capture Configuration area, do one of the following in the

Prompt for metadata when content is added list to specify when users should
be prompted to provide metadata for items that they add to Content Server:
• Click Only when required to prompt users to provide metadata only if the
metadata is marked as required for the destination Content Server folder.
This is the default setting.
• Click Always to prompt users to provide metadata for each item they add to
Content Server.
3. In the Metadata Capture Configuration area, do one of the following in the

Prompt for metadata from additional modules when content is moved/copied
within Content Server list to specify when users should be prompted to
provide metadata when other Content Server modules are installed in your
environment:

54.6. Specifying Link Paths
• Click Always if you want users to always be prompted to provide metadata

each time they copy or move items within Content Server. This is the default
setting.
• Click Never if you want users to only be prompted to provide metadata
when they copy or move items within Content Server when the source and
destination have different category requirements.

54.6 Specifying Link Paths

If you are using Remote Cache servers in your environment, you can specify the
destination that is copied to the Clipboard when users use the Copy Link to
Clipboard or Send To > Mail Recipient as Link options. It also applies when users
insert a link to a document in Office applications.
If you select User’s Remote Cache Server, the links will to point to the current user's
Remote Cache server. Choose this option, which is the default setting, if the users
who will access the links are all using this same Remote Cache server. However, if
users on different Remote Cache servers might access the links, you could select
Primary Server. This option causes all links to point to the Primary server.
Note: This setting is only available if Remote Cache servers are part of your
environment.
54.6.1 To Specify Link Paths

To specify link paths:

Settings link.
2. In the Document and Folder Link Configuration area, do one of the following:
• Click Primary Server if you want links to point to the Primary server.
• Click User’s Remote Cache Server if you want links to point the user’s
Remote Cache server. This is the default setting.


54.7 Configuring Object Types When Dragging

Folders
You may want to specify the type of object that is created when users drag certain
types of folders from their file system to Content Server. To do this, you specify that
folders with certain extensions in their names become either Email Folders or
Compound Documents when users drag them into Content Server. This feature is
not available in Microsoft Outlook.
By default, no values are provided. If you specify multiple extensions, use commas
to separate them.
For example, a user drags a folder called test.cd from their file system to Content
Server, and you have specified that folders with the CD extension should be treated
as a Compound Document. The CD extension is removed from the name of the
folder and a new Compound Document is created in the destination. All items
residing in the folder are included in the action, and users will be prompted to
provide metadata according to the settings you have specified. Subfolders that
reside in the main folder are not included in the action. If there already is an item
with the same name in the destination, the naming conflict resolution rules that you
have specified will be applied. If the folder contains a type of item that is not
permitted, then the action will be abandoned.
54.7.1 To Configure Object Types When Dragging Folders

To configure object types when dragging folders:

Settings link.
2. In the Custom Drag and Drop Configuration area, do one of the following:
• In the Compound Document box, specify the extensions that you want to
use to identify folders that should be treated as Compound Documents, for
example, CD. By default, the box is empty.
• In the Email Folder box, specify the extensions that you want to use to
identify folders that should be treated as Email Folders, for example, EM. By
default, the box is empty.
Note: If you are specifying multiple extensions, use commas to separate

the names. Do not leave spaces between the names.

54.8. Mapping Custom Subtypes to File Extensions

54.8 Mapping Custom Subtypes to File Extensions

Use this optional setting only if you have created custom subtypes and you want to
map specific file extensions to them.
The mappings that you specify only apply when users drag files to Enterprise
Connect. If you enable this feature, when a user drags an item with a specific file
extension to Enterprise Connect, the custom subtype that you mapped to that file
extension is applied to that item.
For example, assume that you have created a custom subtype with the value of
12345. In the Associate subtypes with file extensions box, you could specify that
any items with the docx file extension are saved with that custom subtype.
Use the <file extension>=<subtype number>format when specifying the mappings. For
this example, the setting would be docx=12345.
54.8.1 To Map a Custom Subtype to a File Extension

To map a custom subtype to a file extension:

Settings link.
2. In the Custom Drag and Drop File Configuration area, type the subtype that
you want to map in the Associate subtypes with file extensions box. Use the
<file extension>=<subtype number> format.
Tips
• For multiple mappings, place each mapping on a separate line.

• Any subtypes that you specify must be able to accept versions.
• If you provide an invalid mapping, it will be ignored.
• By default, the Associate subtypes with file extensions box is empty.


Chapter 55
Configuring OpenText Enterprise Connect Browse
View Columns Settings
For each container type, you can perform the following tasks on the Configure
Browse View Columns Settings page:
• Specify which columns are available to Enterprise Connect users.
• Specify which columns users can see by default.
• Set the order in which the columns appear.
• Set a custom width for each column.
Important
55.1 Configuring Column Displays

You can specify column behavior when users are browsing in Enterprise Connect.
For Content Server containers, such as Folders, Compound Folders, and Milestones,
you can specify which columns users can see by default, as well as which columns
users can add or remove when they are working in Outlook and Windows Explorer.
You can also specify the order that the selected columns appear in and custom
widths for columns. You can use the Other option to specify these settings for
container types that are not included in the container list, such as Workflows or
Projects.
The columns available will vary depending on the type of container, but can include
the default columns for Enterprise Connect, columns specific to Content Server
modules such as Records Management, and Content Server dynamic global
columns. Because Content Server dynamic local columns are unique for each folder,
they do not appear in this page. However, they are available to users in the Explorer
and Outlook column choosers.
Users can add, remove, or reorganize the column settings to suit their preferences in
the Enterprise Connect client. If a user has customized the default column display on
their client, any changes that you make on this page are only applied if the user
resets their column display to the default setting or adds the individual columns
using the Explorer or Outlook column choosers. If you specify that a column is not
available, it will be automatically removed from the client UI.

Chapter 55 Configuring OpenText Enterprise Connect Browse View Columns Settings
55.1.1 To Configure Column Displays

To configure column displays:

Administration, and then click the Configure Enterprise Connect Browse
View Columns Settings link.
2. On the Configure Browse View Column Settings page, click Edit

Configuration for the container that you want to configure.
Note: In the Enterprise Connect client, users can add, remove, and
reorganize columns for containers according to their preferences. For more
information about working with columns, see OpenText Enterprise Connect
- User Getting Started Guide (NGDCORE-UGD).
3. In the configuration page for the selected container, do the following for each of
the listed columns:
a. In the Available column, clear the check box of any column that you do not
want to make available to users. By default, some columns may be selected,
which means that you must clear the check box of any columns that you
want to hide from users.
Tip: Click the check box at the top of the Available column to clear or
select all columns.
b. In the Display by Default column, select the check box of any column that
you want users to see by default.
Tip: Click the check box at the top of the Display by Defaultcolumn
to clear or select all columns.
c. In the Column Width column, specify the width, in pixels, that you want to
apply to specific columns.
Note: If you do not apply a value, Enterprise Connect will

automatically size the column.
d. In the Display Order column, use Up and Down to place the

selected column in the appropriate location.
4. When you have completed the configuration, do one of the following:


Chapter 56
Configuring Enterprise Connect Display Settings
You can perform the following tasks on the Configure Display Settings page:
• Configure the Enterprise Connect Tree Structure and List Pane.

• Select which viewer to use in the Enterprise Connect client Reading Pane.
• Specify if hidden items are displayed in Enterprise Connect.
Important
56.1 Configuring the Enterprise Connect Tree

Structure and List Pane
You can select which nodes appear under the Server Node in the Enterprise Connect
Tree Structure. You can also add items to the Volumes folder and the Other Items
folder. In addition, you can change the order in which the items appear in the Tree
Structure. A default configuration is provided, but you can modify this if required.
Note: If you are using Domain Workspaces, you must move it from the
Available Items list to the Server Node list to make it available to users. The
Domain Workspace then becomes visible to the Enterprise Client tree and is for
the Domain that the user is a member of.
If you want Enterprise Connect users to be able to access the Public Email Volume,
their Personal Email Volume, and any delegated Email Volumes in the Enterprise
Connect tree, move the Email Volume node from the Available Items list to the
Server Node list. The Email Volume node only appears in the list of Available
Items if you have successfully installed and configured support for Email Archiving.
Note: Enterprise Connect users with administrative privileges will also be able
to access the System Email Volume.
You can also specify which items appear under the Personal node in the Enterprise
Connect Tree Structure. Some items appear by default, and you can add or remove
items if required. Available items include those that appear in the Web UI Personal
menu. However, the available items may vary depending on the Content Server
modules installed in your environment. For some items, you may see a Web UI
view.

Chapter 56 Configuring Enterprise Connect Display Settings
56.1.1 To Configure the Tree Structure and List Pane

To configure the Tree Structure and List Pane:

Administration, and then click the Configure Enterprise Connect Display
Settings link.
2. In the Tree, List and Reading Pane Configuration area, in the Server area, do
the following to specify which items appear under the Server Node:
• In the Available Items list, select the item that you want to display under
the Server Node, and click Move Left to move the item to the Server
Node list. Include Volumes Node and Other Items in this list if you want to
expose these items and their contents under the Server Node. Any items
remaining in the Available Items list are not displayed.
• Select the item that you want to appear under Volumes Node or Other
Items, and click Move Left or Move Right to move the item to the
appropriate list. Include Volumes Node and Other Items in the Server
Node list if you want to expose these items and their contents under the
Server Node.
• To change the order of a list, select the item that you want to move, and then
click Up or Down .
3. To select which items appear under the Personal Items node, go to the Personal
Node area and do the following:
• Select the item that you want to appear under the Personal Items node, and
click Move Right to move the item to the Items to use list. Any items
remaining in the Available Items list are not displayed.
• To change the order of a list, select the item that you want to move, and then
click Up or Down .
Note: The My Settings item enables Enterprise Connect users to launch

the My Enterprise Connect Settings page, where they can control settings
for generating email names. This page includes all settings that are
available in the Name Generation for Emails area in the Enterprise
Connect Configure Email Settings page. Users will be able to override
any settings that you have applied. By default, this item is in the Items to
use list. If you do not want users to access this page, move it to the
Available Items list. For more information about email naming rules, see
“Defining Email Naming Conventions” on page 1081.
4. When you have made your selections, do one of the following:

56.2. Selecting a Viewer for the Reading Pane

56.2 Selecting a Viewer for the Reading Pane

The Enterprise Connect Viewer enables users to view items in supported formats
using the View tab in the Reading Pane, even if the native application is not
installed. For example, a user can view an item that was created in Microsoft Project,
even if the user does not have Project installed. The Enterprise Connect Viewer
enables users to print, search, copy, and adjust the view of the selected item. The
Enterprise Connect Viewer is installed automatically with Enterprise Connect and
no additional configuration is required.
56.2.1 To Select a Viewer

To select a viewer:

Settings link.
2. In the Viewer Technology area, click one of the following to specify which
viewer you want to use to view items in the View tab in the Reading Pane:
• Enterprise Connect Viewer

56.3 Displaying Hidden Items in Enterprise Connect

You can control if items that have been marked as hidden in Content Server appear
in Enterprise Connect. If you select the Display hidden items check box, hidden
items, such as Folders, Documents, or Task Lists are fully accessible in the Enterprise
Connect tree. Users can view hidden items in the List Pane for both Outlook and
Explorer and they are included in search results.

Chapter 56 Configuring Enterprise Connect Display Settings
56.3.1 To Display Hidden Items in Enterprise Connect

To display hidden items in Enterprise Connect:

Settings link.
2. In the Hidden Items Configuration area, do one of the following:
• Select the Display hidden items check box to display all hidden items in
Enterprise Connect.
• Clear the Display hidden items check box if you do not want to display
hidden items in Enterprise Connect. This is the default setting.


Chapter 57
Configuring Enterprise Connect Email Settings
You can perform the following tasks on the Configure Email Settings page:
• Configure email archiving settings.
• Specify how emails and attachments are handled when users add them to
Content Server.
• Specify which format is used when exporting emails from IBM Notes to Content
Server.
• Specify the naming conventions and rules used for emails that are added to
Content Server using Enterprise Connect.
• Specify how duplicate email attachment names are handled.
Important
57.1 Configuring Email Archiving

This setting allows you to specify if emails and their attachments should be archived
when users add them to Content Server from their Inbox. By default, email archiving
is not enabled. For more information about how to enable email archiving, and how
users can archive emails using Enterprise Connect, see OpenText Email Archiving for
Microsoft Exchange - Administration Guide (EA-AGD).
Note: If you enable email archiving, all of the other email settings on the
Configure Enterprise Connect Email Settings page do not apply to emails that
are archived. Instead, when emails and their attachments are archived, the
settings you specified as part of the Email Management Services module
configuration are applied.
To enable email archiving, you will first need to specify how the appropriate order
mailbox is determined for each user. By default, the order mailbox is determined
based on the server or administrative group that the user belongs to. You could also
use an Active Directory user property, which is defined as a hex value. For more
information, see OpenText Email Archiving for Microsoft Exchange - Administration
Guide (EA-AGD).
Note: This value must be the same as the value specified in the Email
Management Services module configuration. Microsoft Exchange 2013 requires
property-based order mailbox resolution.
You will also need to specify if archiving orders are posted directly to the order
mailbox, or if they are sent by email. By default, the Post orders to order mailbox

Chapter 57 Configuring Enterprise Connect Email Settings
check box is selected. This is generally the most efficient method for posting
archiving orders. However, you will need modify permissions on the order mailbox
to enable this. For more information, see OpenText Email Archiving for Microsoft
Exchange - Administration Guide (EA-AGD).
Note: You must have the appropriate version of the Email Management
module installed to be able to use the email archiving functionality. An error
message in the Email Archiving Configuration section will indicate if you
need to upgrade.
57.1.1 To Configure Email Archiving Settings

To configure Email Archiving settings:

Administration, and then click the Configure Enterprise Connect Email
Settings link.
2. In the Email Archiving Configuration area, do one of the following:
• Select the Enable Email Archiving for Enterprise Connect. This applies to
e-mails added to Content Server from the inbox check box if you want to
enable email archiving using Enterprise Connect.
• Clear the Enable Email Archiving for Enterprise Connect. This applies to
e-mails added to Content Server from the inbox check box if you do not
want to enable email archiving using Enterprise Connect. Instead, emails are
saved to the selected Content Server container and are not archived. By
default, the check box is cleared.
3. In the Order mailbox resolution area, do one of the following to specify how
the order mailbox is determined:
• Click Based on server or administrative group to select the order mailbox

using server or administrative group settings. This is the default setting.
• Click Based on property with value and then type the appropriate property
value in hexadecimal form in the hex box to select the order mailbox using a
property.
Caution
You must use the same values in the Enterprise Connect configuration
as you used when configuring the Email Management Services
module.
• Select the Post orders to order mailbox check box to post archive orders
directly to the order mailbox. This is the default setting.
• Clear the Post orders to order mailbox check box if you want to send
archive orders to the mailbox by email.

57.2. Configuring Settings for Capturing Email Attachments, Duplicate Emails, and Email
Subtypes
Caution
You must use the same values in the Enterprise Connect configuration
as you used when configuring the Email Management Services
module.

57.2 Configuring Settings for Capturing Email

Attachments, Duplicate Emails, and Email
Subtypes
You can specify which subtype should be applied to saved emails and how
attachments should be handled when users add emails with attachments to Content
Server. You can also specify how duplicate emails are identified and if users should
be notified each time they add a duplicate email to a folder, or if duplicates should
be ignored. The methods you select depend on your corporate processes for saving
emails and attachments.
Email Subtype
The email subtype option applies the email subtype (749) to all emails that users add
to Content Server. By default, all emails are saved as the email subtype. You can
then specify how attachments are handled. You can choose to not store separate
copies of email attachments, or you can choose to add separate copies of the
attachments as individual documents, in addition to the original email and
attachments. If appropriate, you can permit users to decide, for each email, whether
to add separate copies of the attachments, or to save the email and attachments as a
single item.
Tip: You can link emails and attachments using Cross-References if you have
installed the OpenText Records Management module and have enabled this
feature. For more information, see OpenText Enterprise Connect - Installation
Guide (NGDCORE-IGD).
Duplicate Emails in Microsoft Outlook
By default, duplicate emails are detected by comparing the name of emails that are
added to Content Server with emails that already reside in that folder. When you
choose this option, users are notified each time Enterprise Connect identifies a
duplicate email in the destination. Depending on the configuration, users may be
asked to rename duplicate emails or provide metadata.

For example, assume you are using the default name comparison to identify
duplicate emails. If a user has previously added an email to a folder, and then adds
an email with the same name but different content to the same folder, it will be
identified as a duplicate. Depending on your configuration, the user may be
prompted to rename the email and provide metadata.
Optionally, you can specify that duplicate emails are detected by comparing the
message ID that has been assigned to the email that users add to Content Server
with emails that already reside in that folder. The message ID is different for each
recipient. For example, if the same email is sent to two different users, each copy of
the email has a unique ID. As a further option, you can specify that duplicate emails
are detected by comparing the external message ID of the email that users are
adding to Content Server with the external ID of emails that already reside in the
folder. The external message ID applies only to emails that are received from outside
of the user’s domain. When you choose the message ID comparison options,
duplicate emails are not copied or moved to the destination, and users do not
receive notification about duplicate emails. Only new emails are added and
depending on your configuration, users may be prompted for metadata.
For example, assume that you have selected the Use message id to check for
duplicate emails check box. A user adds a batch of emails to a folder, and one of the
emails already in that folder has the same message ID as one of the emails in the
batch. The user will not receive a duplicate email notification about the duplicate
email. Depending on the configuration, users may be asked to provide metadata for
all of the new emails. In another case, assume that two users receive an email from
the same sender. If both users copy the email to the same folder, the emails would
not be considered duplicates because they have different IDs.
For example, assume that you selected the Use external message id to check for
duplicate emails check box. A user adds an email received from an external source
to a folder. If a colleague who received the same email adds their copy of that email
to the same folder, it will be identified as a duplicate and it will not be added. The
user will not receive a duplicate email notification.
Important
It is important that as administrator, you decide how duplicate emails are
identified when you are first setting up Enterprise Connect. Changing these
settings after users have started to work with emails may cause problems.
Notes
• This functionality only applies to Microsoft Outlook.
• This feature does not affect Compound Emails.
Compound Email Subtype
The Compound Email option is only intended for OpenText Explorer users who are
migrating to Enterprise Connect and who have been using the Compound Email
subtype (subtype 557). When you select this option, all emails and associated
attachments are added to Content Server as Compound Emails. A Compound Email

57.2. Configuring Settings for Capturing Email Attachments, Duplicate Emails, and Email
Subtypes
combines the email message and any associated attachments into a single folder.
Compound Emails only appear in the List Pane in Enterprise Connect and in the
Easy Access pane, if it has been configured to display Documents. They are not
visible in the Microsoft Outlook or Explorer Tree Pane, or in the Microsoft Office
File Open dialog box. Users can view Compound Emails in the Reading Pane. If you
want users to be able to take Compound Emails offline, you must add the
Compound Email subtype to the list of subtypes that can be taken offline. For more
information, see “Specifying Which Subtypes Can Be Taken Offline” on page 1096.
Important
The storage space required for Compound Emails is substantially larger than
that required for the standard email subtype. Ensure that you have adequate
disk space to accommodate this requirement if you apply the Compound
Email subtype.
57.2.1 To Configure Settings for Capturing Email Attachments

To configure settings for capturing email attachments:

Settings link.
2. Navigate to the Email Capture Configuration section.
3. If you want to work with email subtypes, click Save emails as email subtype to
apply the email subtype (749) to emails. This is the default setting. Choose one
of the following options from the When adding email with attachments list to
specify how you want to save attachments:
• Click Do not add separate copies of the attachments if you want to save the
email and attachments as a single item. This is the default setting.
• Click Add separate copies of the attachments if you want to save the email
and attachments as a single item, and in addition, save all attachments as
separate items.
• Click Ask the user to decide if you want to allow users to decide how they
save attachments. They can either save the email and attachment as a single
record, or save the email and attachment together, and then save an
additional copy of the attachment separately.
4. If you want to specify how duplicate emails are identified, do the following:
• Select the Use message id to check for duplicate emails check box if you
want Enterprise Connect to identify duplicate emails using message ID
comparison. By default, this check box is cleared and only name comparison
is used.
• Optionally, select the Use external message id to check for duplicate emails
check box if you want Enterprise Connect to identify duplicate emails using
an external ID comparison. By default, this check box is cleared.

Note: You can only select this option if you have selected the Use
message id to check for duplicate emails check box.
5. If you want to work with Compound Email subtypes, click Save emails, with or
without attachments, as compound emails to apply the Compound Email
subtype (557).

57.3 Specifying a Format for IBM Notes Emails

You can specify which email format is used when users save an email to Content
Server when they are working in IBM Notes. By default, DXL is used. Depending on
your requirements, you have the option of using EML.
57.3.1 To Specify a Format for IBM Notes Emails

To specify a format for IBM Notes emails:

Settings link.
2. In the Email Capture Configuration area, go to the Additional email export

options area. Select one of the following options in the When saving an email
from IBM Notes to Content Server, use this format list:
• DXL. This is the default setting.

• EML.


57.4. Defining Email Naming Conventions
57.4 Defining Email Naming Conventions

When users add emails to Content Server using Enterprise Connect, naming
conventions are applied to the email. The default naming convention uses the
subject of the email as the email name, with no separators or exclusions. You can
customize the naming conventions in the following ways:
• Define which message properties to use in email names.
• Define the separator string to be used between the individual message properties
that make up the name of the email.
• Specify strings that you want removed from the name of the email.
• Specify the format for the date in the email.
• Specify how to handle emails with the same name.
• Specify naming conventions used when adding emails from Windows Explorer.
Notes
• Although Enterprise Connect applies the specified naming conventions
when users add emails to Content Server, users can rename the emails if
desired.
• If you make the My Settings page available to Enterprise Connect users,
they will be able to configure these email naming conventions to their own
preferences. For more information, see “To Configure the Tree Structure and
List Pane” on page 1072.
• If Enterprise Connect generates a name for the email that has already been
used in the Content Server container, users will either be prompted to
resolve the naming conflict before the email can be added, or Enterprise
Connect will generate a new name for the email, with a suffix to distinguish
it from the email already in the target destination. The option available to
users depends on your administrative settings.
• However, if you are saving emails as email subtypes and you are identifying
duplicates by matching message IDs, duplicate emails are not added to the
target and users are never notified that there is a duplicate. Note that you
will be prompted to determine how duplicate Compound Emails are
handled, because they are excluded from this rule.

57.4.1 To Define The Message Properties to Use in Email

Names
To define the message properties to use in email names:

Settings link.
2. Go to the Name Generation for E-mails area, and then to the Properties area.
3. Click the message property that you want to use from the Available Properties
list, and then click Move Right to move it to the Selected Properties list.
Subject is the default value.
4. To set the order in which the message properties appear in the email name, click
a message property in the Selected Properties list, and then click Up or
Down .

57.4.2 To Define the Separator Strings Between Message

Properties
To define the separator strings between message properties:

Settings link.
2. Go to the Name Generation for E-mails area.
3. In the Separator string box, enter an appropriate value, such as & or -. If you do
not specify a value, a single space is used to separate the message properties in
the email name.
Important
?, *, /, \, <, >, |, ., :, and " cannot be used as separator values.


57.4.3 To Remove Strings From Email Names

To remove strings from email names:

Settings link.
2. Go to the Name Generation for Emails area.
3. In the Strings to Remove area, enter the name of the string to be excluded from
email names in the New String box, and then click Move Right to move the
string to the Selected Strings list. Click Delete to delete a selected string
from this list.
Example: If you want to specify that RE: will not appear in email names, enter RE: in
the New String field, and then click Move Right to add RE: to the Selected Strings
list. RE: will not appear in the email names. To allow RE: to appear in email names,
select RE: and click Delete . RE: will be removed from the Selected Strings list.

57.4.4 To Specify the Date and Time Formats in Email Names

To specify the date and time formats in email names:

Settings link.
3. In the Date format string box, specify the format for the date and time that you
want to use, leaving spaces between the values if required. You can use any
combination of values in any order. The default values are %m/%d/%Y %I:%M %p,
which results in 08/16/2011 12:50 PM. The following table lists the available
values.
Value Description

%a Abbreviated name of the day. For

example, Tue for Tuesday.
%A Full name of the day.
%b Abbreviated name of the month. For
example, Aug for August.
%B Full name of the month.
%c The full date and time for your location.
For example, Tuesday, August 16,
2011 12:36:04 PM.
%d Day of the month expressed as a numeric
value. For example, 16 for the 16th day of
August.
%H Hour expressed in 24–hour clock format.
%I Hour expressed in 12–hour clock format.
%j Day of the year expressed as a numeric
value. For example, 228 for the 16th day
of August.
%m Month expressed as a numeric value. For
example, 08 for August.
%M Minute expressed as a numeric value. For
example, 39 if the time was 8:39.
%p AM and PM.
%S Seconds expressed as a numeric value. For
example, 06 if the time was 12:35:06.
%U Week of the year expressed as a numeric
value, with Sunday as the first day of the
week. Values range from 00 to 53. For
example, the week of August 14th would
be week 33.
%w Day of the week expressed as a numeric
value, with Sunday as day 0. For example,
Tuesday would be day 3.
%W Week of the year expressed as a numeric
value, with Monday as the first day of the
week. Values range from 00 to 53. For
example, the week of August 14th would
be week 33.
%x Date for the current location. For example,
Tuesday, August 16, 2011.
%X Time for the current location. For example,
12:44:14 PM.

%y Year without the century, expressed as

numeric value. For example, 11 for 2011.
%Y Year with the century, expressed as a
numeric value. For example, 2011.
% Percentage symbol.
4. Click Test Date Format to view a sample of the format you have specified,
using the current date and time.

57.4.5 To Handle Emails with the Same Name

To handle emails with the same name:

Settings link.
3. In the When an email with the same name is added to a folder list, do one of
the following:
• Click Generate a name with a suffix if you want Enterprise Connect to

automatically generate a new name for the duplicate email. A new instance
of the email, with a suffix to distinguish it from the instance that already
resides in the destination, will be added to the destination. In the adjacent
list, you must then select one of the following options:
• Select Ask the user to decide if you want Enterprise Connect to ask users
if they want to add the email that was automatically renamed to the
destination location. This is the default setting.
• Select Generate name automatically if you want Enterprise Connect to
automatically generate a new name for the duplicate email without first
confirming with the user. The user will not be prompted to resolve the
naming conflict.
• Click Allow the user to enter a new name if you want users to be able to
enter a new name for the duplicate email.


Note: These settings apply to emails, Compound Emails, and email stubs when
working with Windows Explorer, Microsoft Outlook, and IBM Notes.
57.4.6 To Specify Naming Conventions Used When Adding

Emails from Windows Explorer
To specify naming conventions used when adding emails from Windows
Explorer:

Settings link.
2. In the Name Generation for E-mails area, do one of the following:
• Select the Disable email name generation when adding emails from
Windows Explorer check box to ignore the specified email naming
conventions and use the current name of the email. For example, a user
copies an email from Outlook to their desktop, and renames the email to
Contract1. The user then drags the renamed email to a folder in Enterprise
Connect. The email will be added to the folder using the current name. Any
email naming conventions that have been specified elsewhere are not
applied.
• Clear the Disable email name generation when adding emails from
Windows Explorer check box to rename the email using the specified email
naming conventions. This is the default setting. For example, a user copies
an email from Outlook to their desktop, and renames the email. The user
then drags the renamed email to a folder in Enterprise Connect. The email
will be added to the folder following any email naming conventions that
have been specified.
Note: If there is an email in the destination folder with the same name,
duplicate name settings are still applied, regardless of your selection.

57.5. Handling Email Attachments With the Same Name
57.5 Handling Email Attachments With the Same

Name
When users try to add an email with attachments to a destination, they may find
that an attachment with the same name already resides in the folder. You can specify
how Enterprise Connect handles email attachments with the same name.
Note: If you make the My Settings page available to Enterprise Connect users,
they will be able to configure these conventions to their own preferences. By
default, the settings you specify here are applied. For more information, see
“To Configure the Tree Structure and List Pane” on page 1072.
You can ask users if they want to add the attachment with the duplicate name as a
new version of the existing document. You can also specify that this happens
automatically, any time that Enterprise Connect detects a document with the same
name. You can also ask users if they want to add the attachment with the duplicate
name as a new document. In this case, the duplicate document will keep its name,
but a numeric suffix is added to distinguish it from the original document. For
example, taxform(2).doc. You can also specify that this happens automatically, any
time that Enterprise Connect detects a document with the same name.
Note: This setting only applies to emails that are saved as email subtypes (749).
If you have Records Management (RM) installed, and you create a cross-reference
for email attachments, users will see cross-references to the appropriate instance of
the attachment. For example, a user moves an email with an attachment called
legalform.doc to a folder in Content Server, and a document with the same name
already resides in that folder. You have selected Automatically add attachments as
a new document version. With cross-references enabled, a new version of
legalform.doc will be added to the existing document. When the user opens the
email from the new location, there will be a link to the appropriate instance of
legalform.doc. In this case, it would be the second version of legalform.doc. For
more information about setting up RM cross-references, see OpenText Records
Management - Installation and Administration Guide (LLESRCM-IGD).
57.5.1 To Configure How Enterprise Connect Handles Email

Attachments With the Same Name
To configure how Enterprise Connect handles email attachments with the
same name:

Settings link.
2. In the Name generation for Email Attachments area, in the When an email
attachment with the same name is added to a folder list, do one of the
following:

• Choose Prompt user to add attachment as a new document version to let

users choose if they want to add attachments that have the same name as an
existing document in the destination as a new version of the existing
document. This is the default setting.
• Choose Prompt user to add attachments as a new document with a unique
suffix to let users choose if they want to add attachments that have the same
name as an existing document in the destination. The new document will
have the same name and a numeric suffix to distinguish it from the existing
document.
• Choose Automatically add attachment as a new document version to
automatically add attachments that have the same name as an existing
document in the destination as a new version of the existing document.
• Choose Automatically add attachments as a new document with a unique
suffix to automatically add attachments that have the same name as an
existing document in the destination as a new document with the same
name and a numeric suffix to distinguish it from the existing document.


Chapter 58
Configuring OpenText Enterprise Connect Menu
Settings
You can perform the following tasks on the Configure Menu Settings page:
• Specify which Enterprise Connect context menu commands are available to
users.
• Specify which context menu commands appear in the main context menu.
• Specify which commands are available in the context menu.
• Specify which context menu commands launch in a full browser.
• Specify which types of folders users can take offline.
• Specify which types of items users can send to their desktop.
• Specify where users can access the Copy/Move command.
Important
58.1 Configuring Enterprise Connect Context Menu

Items
Using the Show or hide Enterprise Connect menu items lists, you can specify
which Enterprise Connect context menu items are available to your users. This
setting also applies to those context menu items that appear in the Enterprise
Connect ribbon in Office and Outlook, such as Properties. By default, all Enterprise
Connect context items commands are available.
58.1.1 To Show or Hide Enterprise Connect Context Menu

Items
To show or hide Enterprise Connect context menu commands:

Administration, and then click the Configure Enterprise Connect Menu
Settings link.
2. In the Show or hide Enterprise Connect menu items area, do one of the
following:
• Select the context menu item that you want to hide in the Shown list and
click .

Chapter 58 Configuring OpenText Enterprise Connect Menu Settings
• Select the context menu item that you want to show in the Hidden list and
click .
3. When you have specified the appropriate options, do one of the following:

58.2 Configuring the Advanced Context Menu

By default, some Content Server context menu commands are available in the
Advanced context submenu. You can move selected commands to the top level of
the context menu using the Promote these actions in Advanced context menu to
Top Level box. Promoted commands are automatically grouped together in the top-
level context menu. For example, the Zip and Download command is located on the
Advanced context submenu. If your users frequently use this command, you can
add ZipDwnld to the box and this command will be promoted to the top level of the
context menu.
The following table lists the command IDs for some commonly used context menu
items.
Command Command ID
Add Item AddItem
Add to Favorites MakeFavorite
Add Version AddVersion
Browse from Here BrowsefromHere
Collect Collect
Configure EditConfig
Copy Copy
Copy Link to Clipboard CopyLinktoClipboard
Delete Delete
Download Download
Edit (Poll) EditPoll
Find Similar OTCIndexResultFindSimilar
Go to Original Location Gotooriginallocation
Launch in Browser LaunchInBrowser
Make Generation CreateGeneration

58.2. Configuring the Advanced Context Menu
Make News CreateNewsAndAttach

Make Shortcut CreateAlias
Move Move
New CreateChild
Overview Overview
Permissions Permissions
Print Print
Properties Properties
Rate It RateIt
Remove from Collection Removefromcollection
Rename Rename
Reserve (Documents) ReserveDoc
Reserve (Compound Documents) Reserve
Set as Exemplar SetExemplar
Set Notification SetNotification
Unreserve (Documents) Unreservedoc
Unreserve (Compound Documents) Unreserve
Zip and Download ZipDwnld
Zip and Email ZipEmail
58.2.1 To Configure the Advanced Context Menu

To configure the Advanced context menu:

Settings link.
2. In the Modify behavior of Content Server commands displayed in Enterprise

Connect menu items area, in the Promote these actions in Advanced context
menu to Top Level box, enter the appropriate command IDs.
Notes
• Use a comma to separate the command IDs.
• Do not use spaces between the commas and the command IDs.
• Command ID values are not case sensitive.


58.3 Configuring Context Menu Actions

By default, almost all Content Server context menu items or commands are available
to Enterprise Connect users. You can remove a context menu item by entering its ID
in the Exclude these actions from the context menu box, in the Menu
Configuration page.
For example, if you do not want users to access the Zip and Download command
from the context menu, add ZipDwnld to the excluded item list, and this command
will no longer appear in the context menu. The following table lists the command
IDs for some commonly used context menu items.
Note: By default, the Download command is excluded from the Content

Server context menu. If required, you can remove it from the excluded item list
to make it available to Enterprise Connect users.
Command Command ID
Add Item AddItem
Collect Collect
Copy Copy
Delete Delete
Download Download
Move Move

58.3. Configuring Context Menu Actions
New CreateChild
Overview Overview
Print Print
Rate It RateIt
Important
• OpenText recommends that you do not remove the Open context menu
item.
• The Printer Friendly View, WebDAV Folder View, and Copy/Move
context menu commands for non-container items are never available to
Enterprise Connect users.
58.3.1 To Configure the Context Menu

To configure the context menu:

Settings link.

Connect menu items area, in the Exclude these actions from the context menu
box, enter the command ID of any additional context menu items that you do
not want Enterprise Connect users to access.
Notes


58.4 Launching Context Menu Commands in a Full

Browser
You can specify if you want certain context menu commands to launch in a full
browser by entering their IDs in the Launch these context menu actions in a full
browser box, in the Menu Configuration page. By default, no commands are
specified.
For example, enter the Rename command. When users select an item and then choose
this context menu command, a new browser will launch, where users can rename
the selected item.
The following table lists the command IDs for some commonly used context menu
items.
Command Command ID
Add Item AddItem
Collect Collect
Copy Copy
Delete Delete
Download Download

58.4. Launching Context Menu Commands in a Full Browser
Move Move
New CreateChild
Overview Overview
Print Print
Rate It RateIt
Rename Rename
58.4.1 To Launch Context Menu Commands in a Full Browser

To launch context menu commands in a full browser:

Settings link.

Connect menu items area, in the Launch these context menu actions in a full
browser box, enter the appropriate command IDs.
Notes



58.5 Specifying Which Subtypes Can Be Taken Offline

You must specify which subtypes Enterprise Connect users can take offline. If users
right-click an item of a subtype that you have not made available for offline use, the
Download Offline Version option will not be available. If users select multiple
items and one of the items has been excluded from offline use, the download for
offline use option will not be available in the context menu.
By default Folders, Compound Documents, Documents, Projects, Collections,

Favorites, Email, and Email Folders subtypes can be downloaded for offline use. The
IDs for these subtypes automatically appear in the Include Subtypes for Download
Offline box. You can add or remove subtypes as required. For more information
about other subtype values, see “Node Type Number to Name Mappings”
on page 92.
58.5.1 To Specify Which Subtypes Can Be Taken Offline

To specify which subtypes can be taken offline:

Settings link.
2. In the Include or exclude subtypes for individual menu items area, in the
Include subtypes for Download Offline box, enter the values of any additional
subtypes that you want users to be able to take offline. Use a comma to separate
the values. The following values are provided by default, and you can remove
them as required:
• 0 for Folders.
• 136 for Compound Documents.
• 144 for Documents.
• 202 for Projects.
• 298 for Collections.
• 628 for Favorites.
• 749 for Email.
• 751 for Email Folders.
Notes
• You cannot download Channels for offline use.
• To enable users to take Compound Emails offline, add subtype 557.

58.6. Specifying Which Subtypes Can Be Sent to the Desktop

58.6 Specifying Which Subtypes Can Be Sent to the

Desktop
The Send to Desktop Location option is only available for those subtypes that you
make available to users. If users select multiple items and one of those items does
not support the Send to Desktop Location feature, the Send to Desktop Location
option will not be available in the context menu.
By default Folders, Compound Documents, Documents, Projects, Collections,

Favorites, Email, and Email Folders subtypes can be sent to the desktop. The IDs for
these subtypes automatically appear in the Include subtypes for Send to Desktop
Location box. You can add or remove subtypes as required. For more information
about other subtype values, see “Node Type Number to Name Mappings”
on page 92. For more information about using the Send to Desktop feature, see
OpenText Enterprise Connect - User Getting Started Guide (NGDCORE-UGD).
Note: If users download Compound Emails to their desktops, they will appear
as a single email binary.
58.6.1 To Specify Which Subtypes Can Be Sent to the Desktop

To specify which subtypes can be sent to the desktop:

Settings link.
Include subtypes for Send to Desktop Location box, enter the values of any
additional subtypes that you want users to be able to send to their desktop. Use
a comma to separate the values. The following values are provided by default,
and you can remove them as required:
• 0 for Folders.
• 136 for Compound Documents.
• 144 for Documents.
• 202 for Projects.
• 298 for Collections.
• 557 for Compound Emails.

• 749 for Email.
• 751 for Email Folders.

58.7 Configuring the Copy/Move Command

By default, the Copy/Move context menu command is available for all objects except
for the Favorites, your personal Workspace, and Enterprise folders. You can remove
this command from the context menu of other objects by adding their subtype to the
Exclude Subtypes list in the Copy Move to Configuration area. For example, if you
wanted to make this command unavailable for Folders, Tasks, and Discussions,
you would add the value 0, 206, and 215 to the list of excluded subtypes. You can
make the command available by removing the appropriate subtype from the
excluded items list.
Note: The Copy/Move context menu command is never available for virtual
items such as the Personal, Other Items, and Volumes nodes.
58.7.1 To Specify Where Users Can Access the Copy/Move

Command
To specify where users can access the Copy/Move command:

Settings link.
Exclude subtypes for Copy Move box, add or remove the appropriate subtypes
as required. Use a comma to separate the values. The following subtypes are
provided by default:
• 141 for Enterprise.
• 142 for My Workspace.


58.7. Configuring the Copy/Move Command

Chapter 59
Configuring OpenText Enterprise Connect Search
Settings
You can perform the following tasks on the Configure Enterprise Connect Search
Settings page:
• Configure search profiles.
• Specify the number of returned items displayed on each page when users
perform a search.
• Include Shortcuts and Cross-References in search results.
• Configure how the Advanced Search location is populated.
Important
59.1 Configuring Search Profiles

You can create search profiles to enable users to apply predefined search criteria
when they perform searches in the Enterprise Connect Easy Access pane. In the
Search Profile Configuration area, you can create, update, and delete search
profiles. You can also set the order in which search profiles are matched against the
email subject.
The search profile consists of a location and search slice, as well as a name.
Optionally, you can include pattern-matching criteria that can extract search terms
that can in turn be used to form search criteria. You can also use prefixes and
suffixes to further refine the extracted search criteria.
Users can work with search profiles in several ways. In the Easy Access pane, users
can select a search profile from the Search Profile list, enter a search term in the
Search box, and then launch a search. Another way to use search profiles is to
generate search criteria by matching an email subject to a search profile and then
optionally adding a prefix or suffix to enhance the search. For example, consider a
situation where a user has an email in their Inbox that they would like to copy to
Enterprise Connect. However, they are not sure which folder to copy it to. If the user
clicks the email, Enterprise Connect will find a search profile that matches the
subject, extracts search criteria, and adds it to the Search box in the Easy Access
pane. If you are using a suffix or prefix, this is also added to the search criteria in the
Search box, with the extracted text. When the search is complete, the user can
review the search result list for a suitable location, and copy or move the email as
required. For more information about using search profiles in the Easy Access pane,
see OpenText Enterprise Connect - User Getting Started Guide (NGDCORE-UGD).

Chapter 59 Configuring OpenText Enterprise Connect Search Settings
To set up search profiles, you may be able to use existing search slices, or you may
need to set up search slices in Content Server. For more information about working
with search slices, see “Creating Slices” on page 701. You should also be comfortable
working with regular expressions (regex). Your search profiles will be unique to
your organization, and there are many ways to set them up. The following examples
demonstrate some simple regular expressions.
Creating Regular Expressions
This example demonstrates how to set up a regular expression when there is a

constant string that identifies possible matches, followed by variable text that you
want to return. Assume that you have emails with the following subject lines:
• Reference Active 69582: Smith Contract Negotiation Meeting Notes
• Reference Archive 958: Jones Contract Termination Notes
You could create the following regular expressions:

• Reference\s?([a-z]+\s\d+) would return both examples, because it matches
the constant reference and the variables archive and active.
• Reference\s?(active+\s\d+) would only return the first example, because it
matches the constant reference and the variable active.
Note: Only the text that matches the part of the expression that resides inside
the parentheses is added to the Search box in the Easy Access Pane. If you do
not use parentheses in the regular expression, all of the matched text is added
to the Search box.
This example demonstrates a case where there are no constant strings used to
identify matches, and you are only using variable text only. For example, assume
that you have emails with the following subject lines:
• Reference 69582: Smith Contract Negotiation Meeting Notes
• Invoice 958: Jones Contract Termination Notes
You could create the following regular expressions:

• [a-z]\s?\d+ would return both examples, because it matches both reference and
invoice, as well as the numeric ID.
• Reference\s?\d+ would return only the first example, because it matches
reference.
Note: In this case, including parentheses around Reference\s?\d+ is

optional.
Working with Prefixes and Suffixes
Optionally, you can add a prefix or suffix to a search profile to further refine the
search. If specified, the prefix or suffix is added to the Search box with the extracted

59.1. Configuring Search Profiles
search term. When a user performs the search, the results reflect the extracted search
term as well as the prefix or suffix.
For example, assume that you have selected an email with the subject line "Reference
Active 69582: Smith Contract Negotiation Meeting Notes". If you have a search
profile that consists of a regular expression of Active\s?(\d+:\s?[a-z]+), and a
prefix of Customer and a suffix of Notes, the Search box will be populated with the
search term Customer 69582:Smith Notes. By further refining the search criteria in
this way, the search results will be more precise.
59.1.1 To Configure Search Profiles

To configure search profiles:

Administration, and then click the Configure Enterprise Connect Search
Settings link.
2. In the Search Profile Configuration area, click Add Search Profile, and then do
the following:
• In the Display Name box, enter the name of the search profile. This name
appears the search box in the Easy Access pane.
Tip: Make sure that the display name that you select describes the
search to help users understand what the search profile does. If you
have multiple search profiles, this will help users determine which
search profile they should use.
• In the Select Location box, do one of the following to define where the
search is performed:
• Click Use current location to search the location selected by the user in
the Easy Access pane.
• Click Choose a specific location, and then in the Browse to a Location
dialog box, navigate to and then select the appropriate location.
• In the Slice box, define which slice will be used in the search.
3. In the Actions column, specify the order of the search profiles by clicking the
Up or Down arrows. Enterprise Connect matches the list of available
search profiles to the email subject in the order that you specify. This is also the
order that search profiles appear in the Search Profile box in the Easy Access
pane.
4. Optional If you want to use pattern matching, do the following:
• In the Pattern Match box, define the pattern, in regular expression (regex)
form, that is used to extract a search term from the subject line of a selected
email.

Note: Regex values are not case-sensitive.
• In the Search Prefix box, define the string that is added to the beginning of
the search term that was extracted using the pattern match values.
• In the Search Suffix box, define the string that is added to the end of the
search term that was extracted using the pattern match values.

Tips
• To edit an existing search profile, make changes to the appropriate search
profile definitions, and then click Submit.
•
To delete a search profile, click beside the appropriate search profile,
and then click Submit.
59.2 Specifying the Number of Search Results on

Each Page
Using this setting, you can specify the number of search results that appear on each
page when a user performs a search using Enterprise Connect.
59.2.1 To Specify the Number of Search Results On Each Page

To specify the number of search results on each page:

Settings link.
2. In the Search Result Configuration area, select the appropriate number of

search results to display on each page in the Search Page Size list. The default
value is 25.


59.3. Enabling Searching for Shortcuts and Cross-References
59.3 Enabling Searching for Shortcuts and Cross-

References
Important
To include Shortcuts in search results, you must use Content Server 10 with
update 7 or later. To include Cross-References in search results, you must use
OpenText Records Management (RM) 10.2.0 patch 1 or later. If you are using
older versions of Content Server and RM, this check box is not visible.
Enterprise Connect supports searching for Shortcuts and Cross References. To make
this feature available, you must have the required versions of Enterprise Connect,
Content Server, and RM installed on your system. You must also configure Content
Server to enable this feature. For more information about working with RM, see
OpenText Records Management - Installation and Administration Guide (LLESRCM-IGD).
When you enable this feature, users will be able to include Shortcuts and Cross-
References in both their Enterprise Connect Quick Searches and Advanced Searches.
For example, if a Folder included in a search contains Shortcuts or Cross-References
to other Folders, those referenced Folders will be included in the search results.
59.3.1 To Include Shortcuts and Cross-References in Search

Results
To include Shortcuts and Cross-References in search results:

Settings link.
2. In the Search Result Configuration area, do one of the following:
• Select the Quick search will follow all link types check box if you want to
enable searching for Shortcuts and Cross-References.
• Clear the Quick search will follow all link types check box if you do not
want to enable this feature. This is the default setting.


59.4 Specifying the Default Advanced Search

Location
By default, when a user selects a folder and then launches an Advanced Search
using the Advanced Search button on the toolbar, the Location box will contain the
location specified by the user. However, you can change this behavior. By clearing
the Enable Advanced Search From Here check box, the Location box will not be
prepopulated with the currently selected location
Note: This setting only applies to advanced searches that users launch using
the Advanced Search button on the toolbar. It does not apply to advanced
searches launched using the Search a Repository command on the Enterprise
Connect menu or tab. In this case, users must always specify a location.
For example, you may want to change the default behavior if your users are working
with search templates. When users launch an Advanced Search, you might want the
location to be that specified by the template rather than the users’ current location.
59.4.1 To Specify the Default Advanced Search Location

To specify the default Advanced Search location:

Settings link.
2. In the Search Result Configuration area, do one of the following:
• Select the Enable Advanced Search From Here check box if you want
Enterprise Connect to populate the Location box in the Advanced Search
dialog box with the current location selected by the user. This is the default
setting.
• Clear the Enable Advanced Search From Here check box if you do not want
the Location box to be populated with the current user location.


Chapter 60
Configuring OpenText Enterprise Connect System
Settings
You can perform the following tasks on the Configure System Settings page:
• Force users to upgrade to the most recent version of the Enterprise Connect
client.
• Specify how user credentials are stored.
• Access the administration pages for modules that you must configure to support
Enterprise Connect.
Important
60.1 Supporting Previous Versions of Enterprise

Connect Framework
By default, users are permitted to use previous versions of the Enterprise Connect
Framework to connect to Content Server. However, you can force users to upgrade
to the most recent version of the Enterprise Connect Framework. If you enable this
function, users receive a message prompting them to upgrade to the most recent
version of the Enterprise Connect Framework when they initiate a new session. They
will not be permitted to sign in until they have successfully completed the upgrade.
Default text is provided for the message, but you can create a custom message if
required. For example, you could provide information about who to contact
regarding the upgrade or a link to an upgrade procedure.
For more information about upgrading the Enterprise Connect Framework and
module, see OpenText Enterprise Connect - Installation Guide (NGDCORE-IGD).

Chapter 60 Configuring OpenText Enterprise Connect System Settings
60.1.1 To Configure Supported Versions of the Enterprise

Connect Framework
To configure supported versions of the Enterprise Connect Framework:

Administration, and then click the Configure Enterprise Connect System
Settings link.
2. In the Backwards Compatibility Support Configuration area, do one of the

following:
• Select Prevent backwards compatibility with older versions of the

Enterprise Connect client if you want to force users to immediately upgrade
their instance of Enterprise Connect Framework. You can update the
message if required.
• Clear Prevent backwards compatibility with older versions of the

Enterprise Connect client if you want to permit users to use their current
version of the Enterprise Connect Framework.
• If required, customize the upgrade message.

60.2 Configuring Version Management Settings

When users are working with a document, a new version is created in Content
Server each time they save their work. Depending on your processes, these versions
of the work in progress may not be required. As administrator, you can specify how
these intermediate versions are handled. By default, only the final version of the
document from the editing session is retained. You can also specify that a new
version is created in Content Server each time users save their work. If enabled, the
Enterprise Connect-Version Supersede auditing event reports the intermediate
versions.
Note: This setting only applies to Enterprise Connect Framework version

10.5.1 or earlier.

60.3. Configuring Storage of Enterprise Connect Credentials
60.2.1 To Configure Version Management Settings

To configure version management settings:

Settings link.
2. In the Version Management Configuration area, click one of the following

options in the When documents are saved during an edit session list:
• Keep only the last version if you want to retain only the final version that
users create during an edit session.
• Keep all versions if you want to retain every version that users create
during an editing session.

60.3 Configuring Storage of Enterprise Connect

Credentials
The Allow Enterprise Connect client to store user credentials on disk check box
enables you to control how Enterprise Connect credentials are stored, and to push
this configuration out to all Enterprise Connect users accessing this instance of
Content Server. By default, when users sign into Enterprise Connect, their
credentials are stored on the local file system, in an encrypted format. This means
that users are not prompted to provide their credentials each time they start a new
Enterprise Connect session, unless their stored credentials become invalid. If
required, you can specify that user credentials are not stored, which means users
will be prompted to provide their credentials each time that they start a new
Enterprise Connect session.
Note: Your selection in this check box takes precedence over the option
specified in the DontStoreCredentialsLocally registry setting. For example,
if you clear this check box, credentials are never stored locally, regardless of
the registry setting. For more information, see OpenText Enterprise Connect -
Installation Guide (NGDCORE-IGD).

Chapter 60 Configuring OpenText Enterprise Connect System Settings
60.3.1 To Configure How Enterprise Connect Credentials Are

Stored
To configure how Enterprise Connect credentials are stored:

Settings link.
2. In the Credentials Management Configuration area, do one of the following:
• Select the Allow Enterprise Connect client to store user credentials on disk
check box if you want to store user credentials locally. By default, the check
box is selected.
• Clear the Allow Enterprise Connect client to store user credentials on disk
check box if you do not want to store user credentials locally.

60.4 Accessing Administrative Pages for External

Modules
You will need to configure the administrative settings for some Content Server
modules, such as Email Services, to be able to use Enterprise Connect. Click the links
in the External Module Settings area to go directly to the appropriate
administrative page. A message indicates if you need to install a required module.
For more information about installing and configuring the required modules, see
OpenText Enterprise Connect - Installation Guide (NGDCORE-IGD).

Chapter 61
Administering the CAP Connector Module
The CAP Connector module connects OpenText Content Server to the Runtime and
Core Web Services authentication service. If you are integratingOpenText Enterprise
Connect with Content Server, you must configure this module to ensure Enterprise
Connect users can be properly authenticated.
Configuring the Web Service Connection

The CAP Connector module uses a Web service to communicate with Runtime and
Core Web Services. You must specify a URL and service name for the Web service.
The URL includes the name and Web port number of the Runtime and Core Web
Services server. You can specify the URL in the following format:
http://<server name>:<port>/ot-auth/services/Authentication
The Web service name takes the following default value:
{urn:auth.services.ecm.opentext.com/}AuthenticationService
Mapping the User ID

Runtime and Core Web Services uses an internal ID to identify authenticated users.
You can specify whether this ID corresponds to the Content Server user name or full
user ID. Typically, the ID must correspond to the user name, which is the default
setting.
61.1 To Configure the Web Service Connection

To configure the Web service connection:
1. In the CAP Connector Administration section of the Content Server

Administration page, click the Configure CAP Web Service parameters link.
2. On the Configure CAP Web Service parameters page, specify a URL in the CAP
Web Service URL field in the following format:
http://<server name>:<port>/ot-auth/services/Authentication
3. In the CAP Web Service Name field, specify a Web service name. Typically,
this must be the following value:
{urn:auth.services.ecm.opentext.com/}AuthenticationService

Chapter 61 Administering the CAP Connector Module
61.2 To Map the User ID

To map the user ID:
1. In the CAP Connector Administration section of the Content Server

Administration page, click the Set CAP ID to Livelink user mapping link.
2. On the Set CAP ID to Livelink user mapping page, click one of the following
radio buttons:
• Content Server user ID

• Content Server user Name
Typically, you must map the CAP ID to the user name.

Part 15
Enterprise Archive Administration
Chapter 62
Working with Archive Storage Provider
Introduction Archive Storage Provider is an OpenText Content Server core module that makes it
possible to archive documents and emails created in Content Server in Archive
Server, and to display archived documents in Content Server.
Note: This module is meant for use by administrators only.
Storage For general information about the configuration of storage providers, see “Storage
providers Providers and Storage Management“ on page 351.
Multiple Archive Using the known server concept of Archive Center, Content Server can access multiple
Centers Archive Centers. For more information, see Section 12 “Adding and modifying
known servers” in OpenText Archive Center - Administration Guide (AR-ACN).
62.1 Configuring Archive Storage Provider

62.1.1 Configuring general settings
To configure general settings of Archive Storage Provider:
1. In the Archive Storage Provider Administration section of the Content Server

Administration page, click the Configure Archive Storage Provider link.
2. Configure the connection to the Archive Storage Provider.
• Archive Server
Enter the name of the computer hosting Archive Server.
• HTTP Port for Single Instance Email Archiving Service
• Timeout for Single Instance Email Archiving Service

The configuration changes are saved and, conditional on the option Upload
Certificate Automatically, the certificate is uploaded. Depending on the status
of the upload, different pages are shown.
• If the status indicates that the certificate was already uploaded to the
Archive Server before saving, you return to the Content Server
Administration page (for example, if you changed other settings like the
port).
• If you selected Upload Certificate Automatically and the certificate was
uploaded successfully after saving the changed configuration, the next page
informs you about the successful upload. Click OK.

Chapter 62 Working with Archive Storage Provider
You return to the Content Server Administration page.

• If you did not select Upload Certificate Automatically orif the upload of the
certificate failed, the next page offers the following options:
Upload Certificate to Choose this to upload the certificate manually or to try

Archive Server another upload.
If the upload succeeds, you return to the Content Server
Mark Certificate as Choose this if the certificate is already imported into the
Uploaded Archive Server but this fact is not yet known to Archive
Storage Provider.
You return to the Content Server Administration page.
Cancel Choose this to return to the Content Server
Administration page directly.
The configuration of the general settings is completed.

Chapter 63
Archive Storage Provider logging settings
By default, only errors are written to the log file. If you encounter problems, increase
the log level for troubleshooting.
Note: All logging settings are specific to the Content Server instance.
To set logging parameters:
1. In the Archive Storage Provider Administration section of the Content Server

Administration page, click the Configure logging for Archive Storage
Provider link.
2. Define the new logging settings:
Name of Logfile
The name and location of the logfile is displayed.
Size of Logfile
Enter the maximum log file size in bytes. If this value is exceeded, another
logfile easp_dsh.log.old is created for the older logging content.
Loglevel Debug
Select the list box entry on to log all debug messages.
Loglevel Entry
Select the list box entry on to log all entries.
Loglevel Info
Select the list box entry on to log all information messages.
Loglevel Warning
Select the list box entry on to log all warning messages.
Loglevel Dsh
Select the list box entry on to log all dsh messages.
3. Click the Save Changes button. The new logging settings are stored.

Chapter 64
Understanding Content Move
Introduction Content Move is an OpenText Content Server core module that allows
administrators to move large amounts of document content from an Content
Server’s external file store to OpenText™ Archive Center. Furthermore, document
content can be transferred from one storage provider to another. Move operations
are performed automatically, in fixed time intervals and according to specific rules,
for example, after changes in OpenText Records Management classifications.
Note: This module is meant for use by administrators only.
Prerequisite: storage providers

When you define storage providers, you can set individual rules and create an
ordered association between the rules and providers to determine where documents
are stored. Whenever a document is added to the Content Server, the system
determines which storage provider to place the document in, based on the defined
rules. If the document does not meet any of the defined rules, it is stored in the
default storage provider, which always appears last on the list and cannot be
configured or deleted.
Content Move rules

The Content Move module allows you to apply defined rules to existing documents,
in order to move document content from an Content Server’s external file store to
Archive Server, or from one storage provider to another. The Content Move module
provides additional rules to allow more specific evaluation than the standard
Content Server rules.
The Content Move rules include AND, OR, NOT operations, as well as definitions of
specific creation or modification dates, and others. You can use these rules
independently from the Content Move context, for example when maintaining
storage providers.
You define when to apply the rules and on which documents in move jobs, which can
be scheduled to be executed regularly or only once.
Scheduling
Enabled jobs start automatically at the scheduled date and time. You can schedule
the job to run more than once per day, or at varying times on different days, or
periodically at recurring times. Thus, you can keep the documents consistent to the
defined rules automatically.
Starting from the specified folder, volume, project, storage provider, or requested
nodes, the move job evaluates and processes all documents contained therein,

Chapter 64 Understanding Content Move
according to the defined rules. If a rule applies to a document, the document is

moved to the storage provider assigned to the rule.
You can define a maximum duration of the job; if this time limit elapses, the job
stops. This is useful, for instance, to avoid interfering with regular daytime business
transactions on the server.
The move jobs are processed in the order of definition. Once the first job finishes, the
next job starts, and so on. Defining a new move job automatically defines an order.
However, you can change the order manually.
Generally, enabled move jobs start automatically at the scheduled time, and stop
when they are completed. If another job with a higher priority is found during
execution, the first job stops temporarily until the more important job finishes. The
first job is rescheduled, that means, if it is still within its maximum time range
(duration) when the interrupting job finishes, the first job resumes. Otherwise, it
resumes at the next scheduled start time.
However, you can also control the execution of a job manually. This is useful, for
example, for test purposes, or if unexpected maintenance of the system prohibits
execution temporarily.
Status and protocols

The overview on the Content Move Administration page displays the current status
of the scheduled move jobs. You can determine when a job was executed last and
how long it ran on the Content Move Job Properties page. The protocol tracks
actions regarding the execution of a scheduled job, such as starting, stopping, or
cancelling for each job.

Chapter 65
Configuring Content Move
For general information about the configuration of storage providers, see “Storage
Providers and Storage Management“ on page 351.
65.1 Configuring move jobs

With move jobs, you define when to apply the rules and on which documents. You
can schedule jobs to be executed regularly or only once. You configure move jobs on
the Content Move Administration page.
To open the Content Move Administration page:
• In the Content Move Administration section of the Content Server

Administration page, click on the Configure Content Move Jobs link.
The overview of the existing jobs on the Content Move Administration page
displays the following information:
Field Description
Type Node type: Content Move job
Order Order in which the jobs are processed
Name Job name
Note: Clicking the View Protocol link displays the job protocol. See
“Displaying the job protocol” on page 1130.

Chapter 65 Configuring Content Move
Field Description
Status Possible statuses:
• New: Job has not yet been processed.
• Running: Job was started automatically at the scheduled time.
• Started: Job was started manually by a user; will run, regardless of the
scheduling information, until completed.
• Completed: Job was completed.
• Cancelled: Job was cancelled manually by a user, i.e. the job is ignored until
the next scheduled starting time.
• Stopped: Job was stopped temporarily by the application, due to another
job that was scheduled with a higher priority, and will be continued
automatically.
In addition, the status lights indicate the following:
• green light: - OK, no errors
• red light: - Error occurred
Activity Enabled or disabled; only enabled jobs are processed at the scheduled time
Size Currently not relevant
Modified Last modification date
65.1.1 Defining move jobs

With move jobs, you define when to apply the rules and on which documents. You
can schedule jobs to be executed regularly or only once. By scheduling the jobs to
run at nighttime, for example, you can avoid interference with regular business
transactions on the server during the day.
Avoiding conflicts on Archive Center
Avoid to schedule content move jobs while documents are transferred from
the disk buffer to their final storage and then purged from the disk buffer on
Archive Center. Move content to a new destination only when the content
has reached a stable state, being either removed from the disk buffer or not
removed from the disk buffer during the move.
Best practice is to schedule and run write or purge jobs for the logical archives on
Archive Center only when no move jobs are scheduled. Additionally, ensure to run
move jobs manually only if no conflicting write or purge job is running on Archive
Center.
Further, OpenText advises against running move jobs that change the archive IDs
when using OpenText™ Email Archiving for Microsoft® Exchange or for Lotus®
Notes. These products can create replacements (“stubs”) in the leading application
that contain a link to the archived object. The archive ID is part of this link. If the
archive ID is changed by Content Move then the stub will not work any longer.

65.1. Configuring move jobs
To define a new job to move document content:
1. Open the Content Move Administration page as described in “Configuring

move jobs” on page 1121.
2. Click on Add Content Move Job above the list of existing jobs.
The Add: Content Move Job page is displayed.
3. Define the job settings:
Field Description
Name Job name
Description Description as shown in job list
Condition Starting point that determines which documents to
evaluate:
• Folder - In the Folder field, browse for the folder to start
evaluation from.
• Project - In the Project field, select the project to start
evaluation from.
• Storage Provider - In the Storage Provider field, select
the storage provider to start evaluation from.
• Requested Nodes - Select this option to evaluate the
records defined by the application that performs this job
via the API, for instance OpenText Records
Management.
• Volume - In the Volume field, select the volume to start
evaluation from.
Recurrence The job is performed periodically on the days selected in the
Scheduling area.

Field Description
Scheduling: Recurrence For recurrent jobs only: Week days to perform the job on a
Week Days regular basis
Scheduling: Start Time Time the job is started on the scheduled days
Scheduling: Duration Maximum duration of the job in hours and minutes; if this
time limit elapses, the job stops.
Start Date Date of the first job
End Date For recurrent jobs only: Last date the job is repeated
Enabled The job is executed at the specified date and time.
4. You can schedule the job to run more than once per day or at varying times on
different days. Click on Add a new scheduled time ( ) to insert another row
for scheduling.
To delete a scheduled time, click on Delete this scheduled time ( ) next to the
entry.
5. Click Add.
Content Server stores the settings.
If the job is Enabled, it is started at the scheduled date and time. If defined, the job is
repeated periodically in order to keep the documents consistent to the defined rules
automatically. Starting from the specified folder, volume, project, storage provider,
or requested nodes, all documents contained therein are evaluated and processed
according to the defined rules. If a rule applies to a document, the document is
moved to the storage provider assigned to the rule. The protocol for a job tracks the
transfer of each node from its previous location to the new location; see “Displaying
the job protocol” on page 1130.
Notes
• The move jobs are processed in the order of definition. Once the first job is
finished, the next job is started, and so on. You can edit the automatically
defined order; see “Reorganizing move jobs” on page 1129.
• Document versions and renditions are checked individually; if a rule applies
to a version or rendition, only the content of this version or rendition is
moved.
• From the Content Move Administration page, you can view the job protocol
for the last execution by clicking on View Protocol for the job entry; see also
“Displaying the job protocol” on page 1130.
• From the Content Move Job Properties page, you can perform a simulation
or data count in order to estimate the complexity of the defined job; see
“Performing a data count or simulation of a move job” on page 1127.

65.1.2 Editing move jobs

You edit defined move jobs and determine the time and status of the last job
execution on the Content Move Job Properties page.
To edit a move job:

2. Click on the name of the job you want to edit. The Content Move Job
Properties page is displayed.
3. Edit the job settings:
Field Description
Condition Starting point that determines which documents to
evaluate:
• Folder - In the Folder field, browse for the folder to start
evaluation from.
• Project - In the Project field, select the project to start
evaluation from.
• Storage Provider - In the Storage Provider field, select
the storage provider to start evaluation from.
• Requested Nodes - Select this option to evaluate the
records defined by the application that performs this job
via the API, for instance OpenText Records
Management.
• Volume - In the Volume field, select the volume to start
evaluation from.
Recurrence The job is performed periodically on the days selected in the
Scheduling area.

Field Description
Scheduling: Recurrence For recurrent jobs only: Week days to perform the job on a
Week Days regular basis
Scheduling: Start Time Time the job is started on the scheduled days
Scheduling: Duration Maximum duration of the job in hours and minutes; if this
time limit elapses, the job stops.
Start Date Date of the first job
End Date For recurrent jobs only: Last date the job is repeated
Enabled The job is executed at the specified date and time.
The following data is displayed for information only.
Field Description
Last Started At Time the last data count, simulation, or scheduled job was
started
Last Ended At Time the last data count, simulation, or scheduled job
finished execution
Status Status of the last data count, simulation, or scheduled job
Statistics Calculated and estimated file numbers and sizes from the
last data count, simulation, or scheduled job (see Table 65-1
on page 1128).
4. You can schedule the job to run more than once per day or at varying times on
different days. Click on Add a new scheduled time ( ) to insert another row
for scheduling.
To delete a scheduled time, click on Delete this scheduled time ( ) next to the
entry.
5. Click on Update.
Content Server stores the settings.
Tip: From the Content Move Job Properties page, you can perform the
following tasks:
• View the job protocol for the last job execution by clicking on View
Protocol; see also “Displaying the job protocol” on page 1130.
• Start, cancel and reschedule a job manually by selecting Start Job,
Reschedule Job or Cancel Job from the job's Functions menu; see “Starting,
cancelling, and rescheduling move jobs” on page 1130.
• Perform a data count or simulation for a defined job by selecting Count Job
or Simulate Job from the job's Functions menu; see “Performing a data
count or simulation of a move job” on page 1127.

65.1.3 Performing a data count or simulation of a move job

To give you an idea of the approximate complexity and duration of the job, some
statistics on previous jobs and the scheduled job are shown. After the job has been
performed once, the number of moved files and bytes from the performed job is
displayed. Additionally, you can perform a data count to determine the total
number of files and bytes to which the rules apply, or a simulation of the job. The
simulation determines the amount of document versions, renditions, and bytes to
move, according to the applied rules.
To perform a data count for a defined job:

2. From the Functions menu of a move job, select Count Job.
Tip: The count job is also available in the move job's Functions menu on
the Content Move Job Properties page.
The count job counts the number of bytes and files to which the rules for the
move job apply.
To perform a simulation of a defined job:

2. From the Functions menu of a move job, select Simulate Job.
Tip: The simulation job is also available in the Functions menu of the
move job on the Content Move Job Properties page.
The simulation job counts the number of bytes, document versions, and
renditions to which the rules for the move job apply, and which would thus be
moved.
The following statistics are shown for the move job.
Note: The Statistics table contains a maximum of 10 entries for performed jobs,
including a maximum of two simulation or data count jobs.

Table 65-1: Statistics shown after performing a data count or simulation of a

move job
Field Description
Run Mode Indicates which type of job execution the statistical data originates from:
• Running: Job was started automatically at the scheduled time.
• Started: Job was started manually by a user.
• Counting: Data count job was started manually by a user.
• Simulate: Simulate job was started manually by a user.
Total Count Number of files to which the rules were applied or would currently have
to be applied
Total Bytes Number of bytes to which the rules were applied or would currently have
to be applied
Moved Count Number of files that were moved due to the specified rules, or which
would currently be moved
Moved Bytes Number of bytes which were moved due to the specified rules, or which
would currently be moved
Started At Date and time the job was started
Ended At Date and time the job was completed
Duration Duration of the job
End State Status of the job when it ended
Actions View protocol for each job. See “Displaying the job protocol”
on page 1130.
Using LiveReport to count versions and renditions

You find the LiveReport StorageProviderUsage.rpt in the reports subfolder of
the Content Move module folder. You can import it using Import LiveReports from
the Content Server Administration page. See “Administering LiveReports“
on page 973 for details.
After importing the LiveReport, you can execute it by clicking Open the
LiveReports Volume and then clicking Storage Provider Usage. The LiveReport:
Storage Provider Usage page shows the total amount of versions and renditions per
storage provider.

Note: Performing this LiveReport for large databases may take some time!
65.1.4 Reorganizing move jobs

The move jobs are processed in the order of definition. Once the first job is finished,
the next job is started, and so on. When you define a new move job, an order is
automatically defined. To set the priority of the move jobs, you can change the order
manually.
To reorganize move jobs:

2. From the Functions menu of the Content Move Administration folder, select
Reorganize.
3. Define an order number for each job; they are processed in ascending order.
4. Click on Sequential Renumbering to automatically renumber the jobs using

sequential numbers, while maintaining the defined order. This option is useful,
for instance, after you have deleted several jobs and would like to eliminate
missing numbers in the order.

65.1.5 Starting, cancelling, and rescheduling move jobs

Generally, enabled move jobs start automatically at the scheduled time, and end
when they are completed. If another job with a higher priority is found during
execution, the first job is stopped temporarily until the more important job finishes.
The first job is rescheduled. If it is still within its maximum time range (duration)
when the interrupting job finishes, the first job resumes. Otherwise, it resumes at the
next scheduled start time; see also “Understanding Content Move“ on page 1119.
When a job exceeds its maximum duration, it is also stopped and continued at the
next scheduled start time. However, you can also control the execution of a job
manually, by selecting one of the following options from the job's Functions menu.
• Start Job - To start execution immediately, for example for test purposes; the
scheduling information is ignored and the job is executed without interruption
until it is completed. Afterwards, the scheduling information is reactivated.
• Cancel Job - To stop the current execution of the job and cancel the scheduled
time range (duration); execution is continued at the next scheduled date and
time. Useful, for example, if unexpected maintenance of the system does not
allow execution temporarily.
• Reschedule Job - To start execution of the job immediately within its current
time range, or at the next scheduled time; corresponds with behavior of stopped
jobs.
Troubleshooting
If a job status is green, indicating that processing should be OK, although it is

either not scheduled to be running or no actual job activity is taking place, try
the following measures:
1. Check the thread logs to see if the job is still working.
2. Cancel the job.
3. Check the job protocol for the cancelled job on the Content Move Job
Properties page to see which errors occurred.
65.1.6 Displaying the job protocol

The protocol for each job tracks actions, such as starting and stopping the job, as well
as transferring each node from its previous location to the new location, and any
errors that may occur. You can define which actions are tracked in the protocol; see
“Changing job protocol levels” on page 1132.
By default, the protocol files are located in the <Content_Server_install_root>/

temp folder. You can define a different storage location in the opentext.ini file; see
“Configuring customer-specific settings in the opentext.ini file” on page 1136. The
actual file name is displayed at the top of the protocol page. Delete the protocol files
regularly to avoid unnecessary data flooding.

Note: Do not mistake the protocol file for the log file. The protocol file tracks
the old and new locations of the content that was moved during a specific job.
The log file logs the processes and status changes performed during job
execution. Furthermore, an audit file exists for each document, which tracks
the processing of an individual document.
Tip: Alternatively, display the protocol from the Content Move Job Properties
page.
Information displayed in the job protocol

• Date and time the job was started (None indicates job was not yet executed)
• File name of the job protocol (only exists after job was executed)
• Node ID, version, rendition, and size of the moved content
• Information on the source and target storage providers for each processed node
• Messages and errors
Available actions in the job protocol

• Job details - Click on the job ID in the table header to switch to the Content
Move Job Properties page.
• Node details - Click on the node ID in the table to view the node properties.
• Version details - Click on the corresponding link in the Version column to view
the version properties.
• Rendition details - Click on the corresponding link in the Renditions column to
view the rendition properties.
• Message and error details - Click on the Details link in the Message column to
see the details of a message or click on the Error link in the Message column if an
error occurred to see the error details.
• Browsing through the protocol - Click on the navigation icons below the table to
browse through the protocol entries.
Note: To improve performance, the job protocol pages are displayed byte-
wise, not page-wise, as the list may be very large. You can define how
many lines per page are displayed in the opentext.ini file; see
“Configuring customer-specific settings in the opentext.ini file”
on page 1136.

65.1.7 Changing job protocol levels

As a default setting, only errors and moved versions are logged in the job protocol.
However, for detecting problems and verifying jobs, it is useful to get more
information. Therefore, you can modify the job protocol levels on the Content Move
To change job protocol levels:

2. From the Functions menu, click Properties > Specific.
3. Change the Log settings according to your needs.
Entries in the job protocol

Define which entries are included in the job protocol; see “Displaying the
job protocol” on page 1130.
Set the following parameters to On if you want to include the entries of that
type.
Parameter Description
Log Error Error messages (default)
Log Moved Node moved from one storage provider to another (default)
Log No Versions No content versions or renditions available
Log Ok Content was already up-to-date, no moving necessary
Log Skipped Content was tried to move out of an archive with deactivated
“Allow Content Move” flag

65.2. Configuring storage provider rules
Parameter Description
Log Visited Node was evaluated by job
Example: If you want error entries, not moved node entries and moved node
entries to be written, set the following parameters to On: Log Error, Log Moved
and Log Ok.
By default, only the entries for errors and moved nodes are written.
4. Click the Update button to confirm the changed settings.
65.2 Configuring storage provider rules

When you define storage providers, you can set individual rules and create an
ordered association between the rules and providers to determine where documents
are stored. Whenever a document is added to the Content Server, the system
determines which storage provider to use, based on the defined rules. If the
document does not meet any of the defined rules, it is stored in the default storage
provider, which always appears last on the list and cannot be configured or deleted.
The Content Move module allows you to apply these rules to existing documents, in
order to move large amounts of document content from an Content Server’s external
file store to Archive Server, or from one storage provider to another.
The standard Content Server rules allow you to move data depending on its size,
name, type, attributes, or possibly a specific Records Management classification.
Additionally, the Content Move module provides rules to allow a more specific
evaluation of document properties.
You configure storage rules in the Content Server Administration, on the

Configure Storage Rules page. This page gives you an overview of all defined rules,
and the associated storage provider for each. The order of the rule definitions in this
list determines the order in which the rules are applied to the nodes. For details, see
“Storage Providers and Storage Management“ on page 351.
Table 65-2: Storage provider rules in the Content Move module
Rule Parameter (value) Result

Project '?' Project name True if the added or evaluated version or
rendition is assigned to the project.
Click the Browse Content Server button to
search for the project name. In the Select
project window, navigate to the project and
click the corresponding Select link.
Newest Version True or False True if the added or evaluated version or
'?' rendition is the newest version of each
document
False: all versions except the newest

Rule Parameter (value) Result

Creation time or time range; True if the creation/modification date of the
Date/Modificatio possible options: node (not the version and not the rendition)
n Date '?' earlier, later, satisfies the given condition (i.e. the node
equal, between, was created or modified at the specified time
exactly, more, or within the specified time range).
less Tip: Select the year first, then the current date
is preset.
Volume '?' Volume True if the added or evaluated version or
rendition is assigned to this volume.
Object type in ? Subtypes True if the added or evaluated document is
of this subtype (these subtypes).
Select one or more subtypes.
Stored below ? Container True if the added or evaluated document is
stored in this container.
Click the Browse Content Server button to
search for the container location. In the
Stored below rule window, navigate to the
container and click the corresponding Select
link.
Stored below Container Types True if the added or evaluated document is
Container Type ? stored in a container of this type (these
types).
Select one or more Container Types.
Stored in – True if the added or evaluated document is
Personal stored in a Personal Workspace area.
Workspace (value
is ignored)
NOT '?' Rule, Value All content to which the rule does not apply
AND '?' Description, Rule, All content to which all rules apply; see also
Value “To combine several rules with AND, OR
operators:“ on page 1135
OR '?' Description, Rule, All content to which any of the rules apply;
Value see also “To combine several rules with
AND, OR operators:“ on page 1135
Note: The Content Move-specific rule Version Category Attribute '?' is

obsolete since Content Move 1.1.0. It is replaced by the Content Server core
rule Non-specific attribute ? value is ?.
Combining Generally, all defined rules are processed in the order of their definition and, if any
rules rule applies, the content is moved to the storage provider assigned to the rule. This
corresponds with an OR operator. The rule operators AND and OR provided with the
Content Move module allow you to combine several rules to define a more complex
evaluation. For instance, you can make the content move dependent on a certain file
size and type, or on an attribute value or a modification date.

65.2. Configuring storage provider rules
To combine several rules with AND, OR operators:
1. Open the Configure Storage Rules page in the Content Server Administration.
2. Click on Add new rule before this one ( ) for the expression you want the
new rule to appear above in the list.
3. Select the type of Rule you want to define (AND, OR).
4. Define a Description for the rule, which will appear in the overview on the
Configure Storage Rules page.
5. In the Value section, define the first rule.
6. Click on Apply this value ( ) to apply the rule before defining the next rule in
the combination set.
7. Define the next rule that you want to combine with the previous one. Again, the
order of the rules is significant. Therefore, you find an Add icon behind each
rule in the combination set. Click on the appropriate Add ( ) icon, depending
on which expression you want the new rule to appear above in the set.
8. Repeat Step 6 and Step 7 until you have defined all rules that are to be
combined for evaluation. You can define rules recursively, combining the AND,
OR operators with any other rule definitions.
9. Click on Submit.
The rule is added to the overview on the Configure Storage Rules page.
Tips on rule types and their usage

• Keep the rules as simple as possible. Complex rules will need more time to
evaluate than simple rules.

• Avoid combinations with several nested rules, where possible.

• Both rules in the overall rules list and sub-rules in a combined rule (AND,
OR, NOT) are evaluated in the listed order. Change the order of the rules in
a way that evaluation performs best if the content is already at the right
location.
65.2.1 Enabling and disabling Content Move for specific

archives
You can allow or deny Content Move for specific Archive Storage Providers. If
Content Move tries to move from an archive where this is not allowed, it is logged as
type LogSkipped. It is not treated as an error.
Trying to move content to an archive where this is not allowed causes the error “Not
allowed to move content to storage provider...”.
To enable/disable Content Move for an Archive Storage Provider:
Note: The Allow Content Move Operation feature is only available if Archive
Storage Provider is installed.
1. In the Configure Storage Providers section of the Content Server

Administration page, click on the corresponding Edit entry of the Archive
Storage Provider.
2. Activate (deactivate) the Allow Content Move Operation check box to allow
(deny) Content Move for the Archive Storage Provider.
Note: Content Move is only possible if Delete Documents from Archive is

activated, too.
3. Click Submit.
65.3 Configuring customer-specific settings in the

opentext.ini file
You can define some customer-specific settings in the global opentext.ini file.
Settings for the Content Move module are located in the SPCHANGE section.
Storage location of protocol files

Define where the protocol files are to be stored. By default, the protocol files are
located in the <Content_Server_install_root>/temp folder. Define the path
using the ProtocolDir key.
File retention period
The retention period (in days) for protocol files is defined using the
ProtocolFileRetention key. If the file is no longer listed in the job statistics
when the retention period expires, it is automatically deleted. The default is 30
days.

65.4. Configuring auditing for Content Move
Display unit
To improve performance, the job protocol pages are displayed byte-wise, not
page-wise, as the list may be very large. You can define how many lines per
page are displayed using the ProtocolBrowsePageSize key. By default, 50 lines
are displayed per page.
65.4 Configuring auditing for Content Move

Content Server allows you to track events that occur in the Content Server database.
An event is any action that users perform on a Content Server item, such as a
document or folder. Auditing events lets you monitor how Content Server users are
using the system and determine who has performed certain operations. For
example, you can identify which users have deleted or moved items.
For detailed information about auditing, see “Administering Event Auditing“

on page 303.
For Content Move, the Content Moved audit event is specifically relevant
Setting audit event Content Moved

The audit event Content Moved lists all documents that have been moved using a
Content Move job.
To set the audit event Content Moved:

page, click the Administer Event Auditing link.
2. On the Administer Event Auditing page, click the Set Auditing Interests link.
3. On the Set Auditing Interests page, select the Content Moved check box and
click the Set Interests button at the bottom of the page.
The audit event Content Moved is now set.

Part 16
Object Importer Administration
Chapter 66
Configuring Object Importer
OpenText Object Importer enables the automatic import of any number of objects
from the local file system into Content Server. The control file that manages the
process is configurable. Within the control file, you specify where in Content Server
to upload the objects, and where the objects to be uploaded are located on the file
system. You also have full control over each object's permissions, title, attributes,
and other object metadata within Content Server. You can import the following
Content Server object types:
Object Type Object Importer Syntax

Alias alias
Compound Document compounddoc or cd. OpenText recommends
that you use compounddoc.
Custom View customview
Discussion discussion
Document document
Folder folder
Project project
Reply reply
Task task
Task Group taskgroup
Task List tasklist
Task Milestone taskmilestone
Topic topic
URL url
Working with Object Importer Configuration

From the Configure Object Importer page, you define how the object import
processes occur. You must specify the full paths to the control file, working, and log
directories on the Configure Object Importer page. First, you must create the three
directories and ensure that they are visible to Content Server:
• The control file directory is the location where Object Importer looks for import
files. An example of a valid control file directory is: C:\OPENTEXT
\object_importer\controlfile, where C:\OPENTEXT is the default install path
for Content Server.

Chapter 66 Configuring Object Importer
• The working directory is the location where Object Importer processes the
import. An example of a valid working directory is: C:\OPENTEXT
\object_importer\working, where C:\OPENTEXT is the default install path for
Content Server.
• The log directory is the location where Object Importer writes log files. In order
to view and delete log files from the Object Importer View Import Log Files
page, this directory must be located in either <Content Server_home>\logs or
<Content Server_home>\object_importer. An example of a valid log directory
is: C:\OPENTEXT\object_importer\logfiles, where C:\OPENTEXT is the
default install path for Content Server.
Note: Imports will not proceed unless the control file, working, and log
directories are created, visible to Content Server, and specified on the
Configure Object Importer page.
In addition to creating the Object Importer-specific configuration detailed above,

you must also:
• Ensure the Admin user's email address is set in the Admin user's account page.
This page is accessed by selecting Users & Groups from the Enterprise menu.
Search for the Admin user on the Users & Groups page, then click Edit next to
the Admin user's name. Enter an email address for the Admin user.
• Fill in the Notifications page. The Notifications page does not need to be
enabled. For more information about the Notifications page, see Configuring
Notifications, Reports, Events, and Settings in the “Clearing Outstanding Events”
on page 832.
Note: Imports will not proceed if the Admin user's email address is not set, or
if the Notifications page is not filled in.
Working with the Import Status

From the Import Status page, on the All Processes tab, you can see the status of
processes that have been imported, and on the Running Processes tab you can check
the status of the import threads that are currently running. If no import threads are
running when you click the Import Status link, Content Server will display an
empty status list.
The status of an import thread can be:

• Running – The job is currently scheduled and processing import operations.
• Stopping – The process is attempting to gracefully terminate. The control file is
being rewritten to include only unprocessed items.
• Stopped – The process was gracefully terminated. You can resume and complete
the operation by starting the process.
• Purging – The process is being terminated. Portions of the job may have
completed, the control file for the remainder will be deleted.

• Purged – The process was terminated after partial completion. The control file
was deleted.
• Successful – The job completed with no major errors.
• Failure – The process terminated with errors, or it was manually marked as
failed.
All Processes
The All Processes tab shows the processes that have been imported, indicated as
Successful or Failure and processes that are currently Running, Stopping, or
Purging. The processes that you can delete, purge, or mark as failed have a check
box you can select to apply these operations.
Note: Typically, if a Content Server instance was restarted while an Import

process was running, it could be left in an ambiguous state that appears to be
running but is inactive. This would prevent a new process from running. The
Mark as Failure control allows you to clean up these processes.
Running Processes
The Running Processes tab shows the processes currently being imported. If you
stop the import, data from the control file that was never processed will be saved to
the log file ending in _unprocessed.xml. The process will be in a Stopping status
until it is finished copying the data over, at which time it will complete with a
Stopped status.
For very large import files, it is possible to skip the process of copying the
unprocessed data to the _unprocessed.xml file by selecting a process with either
Running or Stopping status, and clicking the Purge Selected Processes button.
Working with Object Importer Manual Object Import

From the Manual Object Import page, you can import documents into Content
Server manually, rather than on a scheduled basis. Manual imports are primarily
used in test environments. The control files used during a manual import are never
deleted.
When performing a manual object import, it is not necessary for the control file to
exist on the machine on which Content Server is installed.
Note: During a large manual import, when adding many objects to Content
Server, the browser may report an error, or appear to hang; however, this does
not mean that the import has failed.
• If an error dialog appears, click OK and then click the Admin Home link. On
the Object Importer Administration page, click the Show Import Status
link to view the status of the import.

• If the browser appears to hang and no error message is generated, on the

Object Importer Administration page, click the Show Import Status link to
view the status of the import.
Working with the Object Importer Schedule

Use the Schedule Import Tasks page to set which scheduling agents are enabled
and to set their respective schedules. Content Server Notifications needs to be
configured before scheduling automatic imports. For more information, see
“Working with Object Importer Configuration” on page 1141.
The Object Importer runs on a single thread and therefore only one instance of the
importer can run per Content Server install. Object Importer can be installed on
multiple machines connected to the same Content Server database, to reduce the
time required to import large amounts of data. The data on the Schedule Import
Tasks page applies to all instances of Content Server connected to the same
database. Each instance of Content Server, up to a maximum of ten, can run its own
unique import agent.
If you are running more than one instance of Content Server, you will need to add
the following to the [scheduleactivity] section in the opentext.ini file for each
server:
2990=0
2991=0
2992=0
2993=0
2994=0
2995=0
2996=0
2997=0
2998=0
2999=0
Restart each server after editing and saving the opentext.ini file. Note the machine
name and agent ID for future reference.
Enable a different agent per machine by setting the agent ID equal to one, for
example 2991=1. Normally, if multiple instances of Content Server are being
deployed, the scheduling agents are disabled on all but one machine. Object
Importer requires that scheduling agents are enabled on all machines that will be
importing objects. Other agent IDs can be disabled by setting their value to zero.
The following should be added to the opentext.ini file on all machines except for
the one acting as the agent:
[options]
EnableAgents=TRUE
[loader]
load=sockserv;agents
[scheduleactivity]

1000=0
4000=0
8900=0
8999=0
9000=0
3502=0
Restart each server after editing and saving the opentext.ini file. Note the machine
name and agent ID for future reference.
For more information about editing the opentext.ini file, see Understanding the
opentext.ini file in the “Understanding the opentext.ini File“ on page 91.
Working with Object Importer Validation

From the Validation page, you can run an import control file through a validation
tool to check for errors. In particular, this validation tool checks for import errors
relating to the import of multilingual metadata.
Object Importer processes the import control file to validate that specific
requirements are met. The actual import of data will not occur.
Once you select an import control file, and run the validation tool against that
import control file, Content Server displays a new page showing the results of the
validation. This new page will include a link to the Manual Object Import page.
Note: The validation tool will not catch all serious errors your import control
file can encounter. Even after running this tool, and clearing all errors
generated by this tool, your import can fail.
Working with Object Importer Log Files

The View Import Log Files page lists the files located in the logs directory for a
particular instance of Content Server.
The View Import Log Files page lists the name of the temporary file on the server,
and not the name of the control file. Each import creates up to three associated files:
• Any files with the .log extension are the actual log files. They report any errors
during the import process.
• Any files ending in _uncreated.xml contain data from the control file that could
not be created.
• Any files ending in _unprocessed.xml contain data from the control file that
was not processed as a result of stopping the import.
Log files generated by Object Importer are opened in append mode to prevent any
accidental overwrites.

Any log files in use by Object Importer will not be visible on the Object Importer
View Import Log Files page.
You may wish to rename any unprocessed or uncreated XML files before reuse to
prevent odd naming conventions such as: test_unprocessed_unprocessed.xml
66.1 To Configure Object Importer

To configure Object Importer:
1. Create a control file directory, visible to Content Server, where Object Importer
will look for import control files.
2. Create a working directory, visible to Content Server, where Object Importer

will process import control files.
3. Create a log directory where Object Importer will write log files. This directory
must always be found in either: <Content Server_home>\logs or <Content
Server_home>\object_importer.
4. On the Content Server administration page, in the Object Importer

Administration section, click the Configure link.
5. On the Configure Object Importer page, in the Directory section:
a. In the Control File field, specify the full path of the directory you created in
Step 1. This is the directory where Object Importer looks for import files.
b. In the Working field, specify the full path of the directory you created in
Step 2. This is the directory where Object Importer processes import files.
c. In the Log field, specify the full path of the directory you created in Step 3.
This is the directory where Object Importer writes log files, and should
always be found in either <Content Server_home>\logs or <Content
Server_home>\object_importer.
6. In the Advanced section:
a. In the On Error Address field, specify an email address for notification of

critical errors. This does not include errors related to the imported data as
those are written to the log file.
b. In the Report Every field, specify how often the database is updated. For
performance reasons, OpenText recommends that this value be in
proportion to the size of the upload file. If a value of zero, (0), is specified,
the update will not occur.
c. When creating objects in Content Server using Object Importer, you must
specify the path to the parent object between the <location></location>
tags. To create missing folders, and add the object when the parent path
does not exist, select the Create Directory Structure check box. If the check
box is not selected, the object will not be added and an error will be logged.
d. To delete the control file from the working directory after processing is
complete, select the Delete Control Files check box. If the check box is not

66.1. To Configure Object Importer
selected, the control file remains in the working directory. This check box
only applies to scheduled imports.
e. To stop processing when an error occurs during control file processing,

select the Stop Processing on Error check box. By default, Object Importer
will process the entire control file, skipping any errors that are
encountered.
f. The Add Title to Location check box is used to maintain compatibility

between different versions of Object Importer so that existing control files
can still be used. For new installations, OpenText recommends that you
leave this option cleared, so that you are able to rename objects.
Clear this option for control files created for, and used in, Object Importer
Version 1.0.x, Object Importer Version 1.1.7, and Object Importer Version
1.1.7.1. Select this option for control files used in versions of Object
Importer after 1.1.7.1, and before Version 3.
Note: Once you have created control files using one method, you
should not use the other method, as undesired results may occur.
g. During a scheduled import, when the agent is activated, a list of files in the
upload directory at that time is noted by Object Importer. These files are
then processed, ignoring any new files that may have been added. To poll
the upload directory until there are no files left to process, select the
Refresh Control Files check box.
h. To gain the ability to alter the “modify date” on a document during the
create operation only, select the Document Modify Date check box. This
option does not apply to the update operation, and therefore will only
work on documents with only one version.
Normally, Content Server does not permit this behavior since adding a
version constitutes a modification, which automatically sets the Date
Modified field to the current date. Setting the “modify date” is not
permanent, as it will be reset to the current date when certain actions are
performed within Content Server. These actions include altering the name
of the document or changing permissions on the document.
i. To set the value for the <owner> tag to “Admin” if the value cannot be
found in the system, instead of throwing an error, select the Default Owner
to Admin check box.
j. To set the value for the <createdby> tag to “Admin” if the value cannot be
found in the system, instead of throwing an error, select the Default
Creator to Admin check box.
7. Click Update.

66.2 To View Import Status Information

To view import status information:
1. On the Content Server administration page, in the Object Importer

Administration section, click the Import Status link.
2. On the Import Status page, the All Processes tab shows all processes that have
been imported, indicated as Successful or Failure. Each row has a check box
you can select. If needed, select one or more check boxes, and click Delete,
Purge History, or Mark as Failure.
Also, processes that are currently Running, Stopping, or Purging are shown,
although these processes do not have a check box so you cannot change their
status.
3. The Running Processes tab shows the processes currently being imported, each
with a check box you can select. If no import threads are currently running, the
list is empty. To refresh the page content, click Update Status.
If needed, select one or more check boxes, and click Stop Selected Processes,
Purge Selected Processes, or Mark as Failure.
66.3 To Manually Import a Document

To manually import a document:
1. On the Content Server Administration page, in the Object Importer

Administration section, click the Manual Object Import link.
2. On the Manual Object Import page, in the Log File Name field, specify a name
for the log file, without an extension, that will be written to the log directory as
specified in the administration pages. The name cannot contain any special
characters.
3. In the File Location field:
a. Click one of the two radio buttons:
• Use absolute file paths – which applies processing based on:
// absolute paths
<node action="create" type="document">
<location>Enterprise</location>
<file>C:\temp\guidelines.docx</file>
<title language="en">My New Guidelines.docx</title>
</node>
// relative paths
<node action="create" rootPathID="1" type="document">
<file>guidelines.docx</file>

66.3. To Manually Import a Document
</node>
<information>
…
<rootpaths>
<rootpath id="1">C:\temp\</rootpath>
</rootpaths>
…
</information>
• Use relative file paths – which applies processing based on:
// relative paths
<file>folder1\guidelines.docx</file>
</node>
b. If you clicked Use relative file paths, you can also enable the Strip Path
Prefix check box, which removes text from the <file> tag path. This allows
for absolute paths to exist within the <file> tag, and to be stripped and
edited at runtime. For example, based on:

<file>C:\temp\guidelines.docx</file>
</node>
c. Click one of the two radio buttons:
• Use system UPLOAD directory – to use a predefined folder location in

your Content Server installation, for example, C:\OPENTEXT\MAIN
\upload\guidelines.docx
If needed, click the Configure UpLoad Folder link to see or define the
Upload Directory setting on the Configure Server Parameters page. For
details, see “Configuring Basic Server Parameters” on page 71.
• Define an import folder – to use a folder location of your choice outside
Content Server, for example, C:\PROJECTS\MAIN\guidelines.docx
4. In the Import Control File field, click Browse... to select an import control file.
5. Click Start Import.

66.4 To Configure or Disable Import Schedules

To configure import schedules:

Administration section, click the Schedule link.
2. On the Schedule Import Tasks page, click the Enabled check box for each
schedule that you want to activate.
a. In the On these days field, select all the check boxes associated with the
days on which you want this schedule to run.
b. In the At these hours field, select all the check boxes associated with the
hours at which you want this schedule to run.
c. In the At these times field, select all the check boxes associated with the
times at which you want this schedule to run.
3. Repeat these steps for each schedule that you want to activate.
4. Click Update.
5. Restart the servers when prompted.
To disable import schedules:
1. Clear the Enabled check box associated with the schedule you want to disable.
Note: Clearing the day, hour, and time settings associated with a schedule
does not disable the schedule, and may have undesired results.
2. Click Update.
66.5 To Validate an Import Control File

To validate an import control file:

Administration section, click the Validation link.
2. On the Validation page, to select an import control file, click the button to the
right of the Import Control File field.
3. In the Action field, click Start Validation.
4. After the validation has completed, you will see the validation results page. If
errors are found, they will be listed on the validation results page. If there are
no errors, the validation results page will contain a link to the Manual Object
Import page, so that you can run your import control file immediately.

66.6. To View or Delete Log Files
66.6 To View or Delete Log Files

To view log files:

Administration section, click the View Log Files link.
2. On the View Import Log Files page, click the name of any log file you want to
view.
To delete log files:

Administration section, click the View Log Files link.
2. On the View Import Log Files page, select the check box next to the log file that
you want to delete.
3. Click Delete.

Chapter 67
Object Importer Best Practices
This section provides a list of best practices, techniques, and tips for your Object
Importer configuration.
Agent Thread Utilization

When frequent import jobs are scheduled, it may be necessary to monitor the agent
thread to ensure that all Content Server scheduled activities on the site are
happening promptly. In rare cases, it may be advisable to allocate a dedicated agent
thread for scheduling Object Importer jobs. If this is necessary at your site, and for
assistance configuring it, contact OpenText Customer Support.
Anchor
If Object Importer is run from the anchor, or index/notifications server, you will
need to install Object Importer on all servers in the cluster because it has an
associated schema.
Control File
Try to keep the volume at approximately 1000 documents per control file. It is
possible to increase the number of documents beyond 1000, but this may adversely
affect performance as it will consume more resources on both Content Server and
the database server. It is possible to access control files and upload files on machines
other than the machine on which Content Server is installed, provided Content
Server can access the other machines. However, this may not be possible if there is
inconsistency amongst the machines with regards to operating systems, for example,
if your system is a mix of Windows and Solaris machines.
Load Time
Load time can be impacted by the amount of metadata being added to the
documents, by the average size of the documents being loaded, and by your system
architecture.
Depending on the amount of metadata being added to the documents, and the
average size of the documents being loaded, the average time to load per document
is, in most cases, a little less than one second per document.
Manual Versus Scheduled Imports

There is an option to conduct a manual import, but this is intended for small, single
batch test runs. For more information about running a manual import, see “To
Manually Import a Document” on page 1148.

Chapter 67 Object Importer Best Practices
The preferred method for larger imports is to enable scheduling of imports, and to
put control files into the designated upload directory.
For Content Server 16, the default setting is <relative_path enabled="false">.

The import process considers the <file> tag as an absolute path, which is the same
logic as described in “To Manually Import a Document” on page 1148 for selecting
an absolute path.
If <relative_path enabled="true">, the import process treats the the <file> tag
as a relative path:
<node action="create" type="document" >

<file>F:\temp\guidelines.docx</file>
</node>
<information>
<relative_path enabled="true">
<strip_path_prefix>F:\temp</strip_path_prefix>
<import_location type="defined_directory">C:\projects\</
import_location>
</relative_path>
</information>
Where:
• <strip_path_prefix> can be an empty string

• <import_location type can be one of "defined_directory" or
"upload_directory". Only defined_directory will look at the
import_location tag value (like above)
• For upload_directory, <import_location type="upload_directory">[IS
IGNORED]</import_location>, the final location will be C:\projects\
guidelines.docx
Object Importer Servers

Adding parallel servers will decrease the overall import time needed for the job.
Typically, Object Importer does not put too great a strain on the instance of Content
Server. Object Importer can run on up to ten servers in parallel. For very large or
frequent jobs, greater stress will be put on the database server; as such, it should be
monitored to ensure adequate hardware resources are available, especially in areas
such as disk space for database logs. In most cases, it should only be necessary to
run Object Importer on one server.
OpenText Object Importer Versus OpenText Explorer

Use Object Importer when:
• You have a larger volume of documents.

• You want to apply other metadata. Examples of other metadata include
categories and attributes, privileges, and owner.
• You want to upload other types of objects. Examples of other types of objects
include compound documents and folder structures.
Preparing to Run Object Importer

1. Be certain that the users and categories referenced in the import control file exist
in Content Server prior to beginning the import.
2. Be certain that you are not overloading destination directories. Overloading
destination directories will affect browsing, so keep the destination object count
to no more than 200 objects or less.
3. Ensure you configure Object Importer as described in “Configuring Object
Importer“ on page 1141. Configuring Object Importer includes, but is not limited
to, setting the Object Importer directories.
Scheduler Agent
Only enable one scheduler agent per server on which Object Importer is being run.
Be certain to choose a different scheduler agent to run on each server.
Scheduling
When possible, run Object Importer during non-peak times. If processing a large job,
it may be desirable to disable the index during the load.
Upload Directory
The Upload Directory field is found by clicking Configure Server Parameters in the
Server Configuration section of the Content Server administration pages.
The upload directory may be set or disabled. With the upload directory disabled,
which means that the Upload Directory field is cleared, Object Importer looks for
the documents as specified between the <file></file> tags in the control file.
Example 67-1: Object Importer looks for a document readme.txt in the

directory c:\files\:
<file>c:\files\readme.txt</file>
When a value is specified in the upload directory field, Object Importer looks for the
document in the directory specified, therefore the control file only needs to contain
the name of the file, not the entire path.
Example 67-2: Object Importer looks for a document readme.txt in the

directory specified in the configuration page:
<file>readme.txt</file>

Chapter 67 Object Importer Best Practices

Chapter 68
Working with Object Importer Control Files
Object Importer creates, updates, or deletes objects within Content Server based on
directions from an import control file. The import control file contains meta
information supplied by the user. It is an XML file, and must contain valid XML. The
import control file can have any name and ASCII extension, for example,
import.txt.
Control files must be placed in the control file directory, where Object Importer
processes them one at a time. Before Object Importer begins processing a control file,
each file is moved from the control file directory into the working directory. Once
the file has been processed, which means that the import has completed and
stopped, the control file may be deleted from the working directory, if that is how
you have configured Object Importer. Import control files can be added to, or
removed from, the control file directory at any time. For information about setting
up and configuring the working and control file directories, see “To Configure
Object Importer” on page 1146.
Note: To prevent data loss, you must stop any running imports before you
stop or restart the server.
Warning
It is very important that the control file be properly formatted. The import will
fail unless the entire import control file, including comments, is contained
within the import tags, <import></import>.
The Import Control File Character Set

By default, the Import Control File is in the ANSI character set. You can use other
character sets, for example UTF-8, as long as the XML header provides the correct
encoding. For more information about using UTF-8 with the import control file, see
“Object Importer and UTF-8” on page 1160.
When using the import control file in the ANSI character set, the following special
characters must be encoded as entities.
Character Encoded Value

< <
> >
' '
" "
& &

Chapter 68 Working with Object Importer Control Files
The XML parser will allow for more flexibility in dealing with characters that
needed to be escaped such as “<”, “>”, and “&”.
Example 68-1: The CDATA tag can be used to wrap data that you do not
want the XML engine to process:
<node action="create" type="folder">

<location>Enterprise:OI</location>
<title language="en"><![CDATA[Anything in here will not be
processed such as <, >, &.]]></title>
</node>
Example 68-2: CDATA will not work with attribute values, so certain
characters may need to be escaped: “<”, “>”, “'”, “"”,
and “&”:

<location>Enterprise:OI</location>
<title language="en"><![CDATA[Anything in here will not be
processed such as <, >, &.]]></title>
<category name="Content Server Categories:Test">
<attribute name="Height & Width"><![CDATA[2'x2"]]></
attribute>
</category>
</node>
Importing Multilingual Metadata using Object Importer

Object Importer provides support for the multilingual feature available with Content
Server. When a new instance of Content Server is installed, the administrator selects
the language which will function as the system default language. You can view your
system default language, and all languages which have been installed and enabled
for metatdata, in the Metadata section of the Content Server Administration page.
Click the Configure Multilingual Metadata link. For more information about
configuring multilingual metadata on Content Server, see Configuring Multilingual
Metadata in the [xref to non-existent element "lleswba-h-agd-wba-multilingual-
metadata-config-bg"].
Object Importer users can now import multilingual metadata to Content Server,
provided the languages referenced in the import control file are installed and
enabled on the system. Support for multilingual metadata import is provided by
using the“description Tag Control File Syntax” on page 1205 and the “title Tag
Control File Syntax” on page 1212.
Previously, only one <description> and one <title> tag was permitted per node
paragraph. Each node paragraph details one action which will be undertaken on one

object. With support for multilingual metadata, you can apply multiple
<description> tags and multiple <title> tags per node paragraph. Each
<description> tag must contain a unique language="<language_code>" attribute,
and each <title> tag must contain a unique language="<language_code>"
attribute.
Important
All languages referenced in the import control file must be both installed and
enabled on Content Server. If you try to import objects that have multiple
languages set for their titles and descriptions into a unilingual Content
Server environment, then the import of those objects will fail. If you selected
the Stop Processing on Error check box on the Configure Object Importer
page, your import will stop after encountering the first error.
Any failures will be written to the Object Importer log file which can be
found in <Content Server_home>/logs or in <Content Server_home>/
objectimporter, depending on how you have set up Object Importer. For
more information about Object Importer log file setup, see “To Configure
Object Importer” on page 1146. For more information about viewing Object
Importer log files, see “To View or Delete Log Files” on page 1151.
Example 68-3: An import control file which imports multilingual data for
a folder
The following import control file will create a folder called “Project” in the
Enterprise Workspace. The “Project” folder will have a second, German, title
assigned to it, “Projekte”. The reason that the created folder will be called
“Project”, and not “Projekte”, occurs because the system default language for
this Content Server installation is set to English. This folder will have both
English and German titles and descriptions assigned to it.
<import>
<title language="de">Projekte</title>
<title language="en">Project</title>
<description language="de">Projektdaten</description>
<description language="en">Project Data</description>
</node>
</import>
Example 68-4: An import control file which imports multilingual data for
a project
The following import control file will update a project called “projects_list”
in the Enterprise Workspace. The descriptions for this project are updated in
both German and English. The title for this project is updated in English,

Chapter 68 Working with Object Importer Control Files
while the German title is deleted. The opportunity to add a German title at a
later date exists.
<import>
<node action="update" type="project">
<description language="de">eine Liste aller Projekte</
description>
<description language="en">a list of all projects</
description>
<location>Enterprise:Projects</location>
<title clear="true" language="de"></title>
<title language="en">projects_list</title>
</node>
</import>
For more information about importing multilingual metadata in Object Importer, see
the “description Tag Control File Syntax” on page 1205 and the “title Tag Control
File Syntax” on page 1212.
Object Importer and UTF-8

If the control file contains non-ASCII characters, add the following line, <?xml
version="1.0" encoding="UTF-8"?>, to the top of the control file and save the
control file with UTF-8 encoding.
Example 68-5: Example showing an import control file which can

contain non-ASCII characters:
<?xml version="1.0" encoding="UTF-8"?>

<import>
<title language="en">New Document</title>
<file>c:\readme.txt</file>
</node>
</import>
Note: Documents on the file system to be imported into Content Server, must
be made up of characters in the ASCII or ISO-8859-1 character sets. These
documents are specified between the <file></file> tags in the import control
file.
Removing Content from Fields with Object Importer Control Files

When specifying control files for importing objects, it is possible in some cases to use
the clear="true" attribute to remove specific types of data from fields that

currently contain information. These fields include Categories and Attributes,
Descriptions, and Projects. To see an example of the clear="true" attribute, see
“description Tag Control File Syntax” on page 1205.

Chapter 69
Object Importer Control File Syntax
Every import control file must begin with one <import> tag and end with one </
import> tag. Every import control file must contain valid XML.
Between the <import></import> tags are multiple paragraphs, called node

paragraphs. Each node paragraph describes one action against a particular object.
Each node paragraph begins with a <node> tag and ends with a </node> tag.
For an example of a small import control file, see “Object Importer Import Control
File Examples“ on page 1215.
The following pages contain the control file syntax and descriptions for the node tag
and its available types.
69.1 node Control File Syntax

Description
Control files are used to create, update, synchronize, and delete objects. Each control
file consists of one or more <node> paragraphs, with each paragraph describing
actions against a particular object.
Syntax
<import>
<node type="folder" action="create">
<title language="en">Temp</title>
</node>
</import>
Usage
1. The node tag is a required tag for every control file. The <node> tag's two
attributes, “type Attribute” on page 1164 and “action Attribute” on page 1164,
are required attributes on every <node> tag.
2. The <node> tag can also contain multiple subordinate tags. These subordinate
tags are detailed in “Object Importer Tag Descriptions and Syntax“
on page 1195.

Chapter 69 Object Importer Control File Syntax
Attributes
type Attribute
The following object types can be imported into Content Server:
Object Type Syntax

Alias type="alias"
Compound Document type="compounddoc" or type="cd"
OpenText recommends that you use

compounddoc.
Custom View type="customview"
Discussion type="discussion"
Document type="document"
Folder type="folder"
The Folder object type contains no unique

metadata.
Project type="project"
Reply type="reply"
Task type="task"
Task Group type="taskgroup"
Task List type="tasklist"
Task Milestone type="taskmilestone"
Topic type="topic"
URL type="url"
action Attribute
The following are valid actions for the import of objects and data from the file
system to Content Server:
Action Syntax Description

Create action="create" Creates objects, such as
folders, in Content Server, or
imports data, such as
documents, into Content
Server from the file system.

69.2. alias Control File Syntax
Action Syntax Description

Update action="update" Updates general object
metadata, specific object
metadata, permissions, and
category & attribute data.
Examples of general object
metadata include name and
description. Examples of
specific object metadata
include mime type, url, and
alias.
Synchronize action="sync" Performs either a create or an
update depending on
whether the object exists in
Content Server.
Add Version action="addversion" Performs an update by
adding a new version of an
existing Content Server
object.
Delete action="delete" Deletes objects in Content
Server.
69.2 alias Control File Syntax

alias
Description
Use type="alias" on the <node> tag to create, update, or delete an Alias.
Syntax
<node type="alias" action="create"></node>
Usage
1. Creating an Alias requires the “alias Tag” on page 1166, which is detailed
below.
2. The “alias Tag” on page 1166 is optional when updating or deleting an Alias.
3. Creating, updating, or deleting an Alias can also require subordinate tags, such
as the location tag. These subordinate tags are detailed in “Object Importer Tag
Descriptions and Syntax“ on page 1195.
Example
To create an Alias to the “Projects” folder in the Enterprise Workspace from the
“Example” folder:

<import>
<node type="alias" action="create">
<location>Enterprise:Documentation</location>
<title language="en">Example</title>
<alias>Enterprise:Projects</alias>
</node>
</import>
To view more alias examples, see “alias Import Control File Examples”
on page 1217.
alias Tag
Use the alias tag to specify a full path to an existing object in Content Server.
Separate each item in the path using colons, “:”. This tag's syntax is:
<alias>Enterprise:Projects:readme.txt</alias>
Usage
1. The alias tag cannot exist on its own and must be contained within a <node
type="alias" tag.
2. The alias tag is required when:
• <node type="alias" action="create">
The alias tag is optional when:
• <node type="alias" action="update">
• <node type="alias" action="delete">
69.3 compounddoc Control File Syntax

Description
Use type="compounddoc", or type="cd", on the <node> tag to create, update, or
delete a Compound Document.
Syntax
<node type="compounddoc" action="create"></node>
<node type="cd" action="update"></node>
Usage
Creating, updating, or deleting a Compound Document can require subordinate
tags, such as the location tag. These subordinate tags are detailed in “Object
Importer Tag Descriptions and Syntax“ on page 1195.
Notes
While compounddoc and cd are interchangeable, OpenText recommends that you
use compounddoc.

69.4. customview Control File Syntax
Example
To create a Compound Document called “Prototype”, stored in the “Temp” folder,
and shown in the personal workspace of the Admin user:
<import>
<node type="compounddoc" action="create">
<location>Admin Home:Temp</location>
<title language="en">Prototype</title>
</node>
</import>
To view more compounddoc examples, see “compounddoc Import Control File

Examples” on page 1218.
69.4 customview Control File Syntax

Description
Use type="customview" on the <node> tag to create, update, or delete a Custom
View.
Syntax
<node type="customview" action="create"></node>
Usage
Creating, updating, or deleting a Custom View can require subordinate tags, such as
the location tag. These subordinate tags are detailed in “Object Importer Tag
Example
To import a Custom View called “Customview 001” into the Enterprise Workspace:
<import>
<node type="customview" action="create">
<title language="en">Customview 001</title>
<file>C:\OI\Files\My Custom View.html</file>
</node>
</import>

69.5 discussion Control File Syntax

Description
Use type="discussion" on the <node> tag to create, update, or delete a Discussion.
Syntax
<node type="discussion" action="create"></node>
Usage
Creating, updating, or deleting a Discussion can require subordinate tags, such as
the location tag. These subordinate tags are detailed in “Object Importer Tag
Example
To create a Discussion in the Enterprise Workspace for the Admin user:
<import>
<node type="discussion" action="create">
<title language="en">Discussion 001</title>
<description language="en">This is a discussion</description>
</node>
</import>
69.6 document Control File Syntax

document
Description
Use type="document" on the <node> tag to create, update, or delete a Document.
Syntax
<node type="document" action="create"></node>
Usage
1. Creating, updating, or deleting a Document can include a number of

subordinate tags: “file Tag” on page 1169, “mime Tag” on page 1170,
“versioncontrol Tag” on page 1170, “versionmajor Tag” on page 1171,
“versionminor Tag” on page 1172, and “versiontype Tag” on page 1172. These
subordinate tags are detailed below.
2. Creating, updating, or deleting a Document can also require a number of other
subordinate tags, such as the location tag. These other subordinate tags are
detailed in “Object Importer Tag Descriptions and Syntax“ on page 1195.

69.6. document Control File Syntax
Notes
1. Livelink Enterprise Server 9.6 introduced the ability to specify major and minor
document versions. Object Importer supports both this functionality, with
versions, and the previous functionality, without versions. To support the
functionality without versions, it is not necessary to do anything new to the
import control file.
2. To support the functionality with versions, you must add the
<versioncontrol> tag to the import control file during document creation.
3. When adding a version to an existing Document that is under advanced version

control, use the <versiontype> tag. Instead of the <versiontype> tag, you can
use the <versionmajor> or <versionminor> tags. More information about the
<versiontype>, <versionmajor>, and <versionminor> tags can be found
below.
4. If the <versiontype>, <versionmajor>, and <versionminor> tags are not
specified in the import control file, the document will be added using the next
minor version increment. If the <versiontype>, <versionmajor>, and
<versionminor> tags are specified in the import control file, and the Document
is not under advanced version control, the tags are ignored.
Important
Using <versiontype>, <versionmajor>, and <versionminor> together
in the same import control file will generate an error.
Example
To create a minor version of a Document called “guidelines.doc” in the

“Documents” folder of the Enterprise Workspace's “Projects” folder:
<import>
<node type="document" action="create">
<location>Enterprise:Projects:Documents</location>
<file>c:\temp\guidelines.doc</file>
<versioncontrol>TRUE</versioncontrol>
<versiontype>MINOR</versiontype>
</node>
</import>
To view more document examples, see “document Import Control File Examples”
on page 1221.
file Tag
The file tag sets the absolute path name of the file to be imported into Content
Server. This tag's syntax is:
<file>c:/documents/readme.txt</file>

Usage Notes
1. The file tag cannot exist on its own and The path to the file must be visible by the
must be contained within a <node server that is processing the import control
type="document" tag. file, either the local or the mapped drive. The
2. The file tag is required if the “mime files to be imported into Content Server
Tag” on page 1170 is used. should not be placed anywhere in the
directory structure of the Content Server
3. The file tag is required when: instance. An example of a good location to
• <node type="document" place these files is: C:/temp/.
action="create">
• <node type="document"
action="addversion">
4. The file tag is optional when:
action="update">
mime Tag
The mime tag is used to assign the mime-type of the document. This tag's syntax is:
<mime>image/jpeg</mime>
Usage Notes
1. The mime tag cannot exist on its own. It If not specified, Content Server will try to
must be contained within a <node determine the mime-type from the extension
type="document" tag, and must be of the Document, based on the mapping file
used in conjunction with the “file Tag” <Content Server_home>\config
on page 1169. \mime.types.
2. The mime tag is optional when:
action="create">
action="update">
action="addversion">
action="sync">
versioncontrol Tag
The versioncontrol tag is used to support the import of major and minor
document versions. This tag's syntax is:

69.6. document Control File Syntax
Usage Notes
1. The versioncontrol tag cannot exist 1. When the value is set to TRUE, the
on its own and must be contained within version imported into Content Server
a <node type="document" tag. will be the next minor version increment.
2. The versioncontrol tag is required if 2. If major/minor versions are not utilized,
the “versiontype Tag” on page 1172 is do not include this tag.
used.
3. The versioncontrol tag is required
when:
action="addversion">, and
neither the versionmajor nor the
versionminor tags are used.
4. The versioncontrol tag is optional
when:
action="create">
action="update">
action="sync">
versionmajor Tag
The versionmajor tag can be used in place of the <versiontype>MAJOR</
versiontype> tag to state a specific major version number. This tag's syntax is:
<versionmajor>2</versionmajor>
Usage Notes
1. The versionmajor tag cannot exist on Object Importer will check that the major
its own and must be contained within a version you are entering is greater than the
<node type="document" tag. latest version; if the version is not greater,
2. The versionmajor tag is optional Object Importer reports an error.
when:
neither the versionminor nor the
versiontype tags are used.
action="create">
action="update">
action="sync">

versionminor Tag
The versionminor tag can be used in place of the <versiontype>MINOR</
versiontype> tag to specify a specific minor version number. This tag's syntax is:
<versionminor>5</versionminor>
Usage Notes
1. The versionminor tag cannot exist on Object Importer will check that the minor
its own and must be contained within a version you are entering is greater than the
<node type="document" tag. latest version; if the version is not greater,
2. The versionminor tag is optional Object Importer reports an error.
when:
versiontype tags are used.
action="create">
action="update">
action="sync">
Note: If a document is created with a major version specified that is > 0, as

well as having a minor version > 0, then the document will be treated as
though it only has a minor version. Based on their permissions, certain users
will not have full access to the document. To maintain access rights on such
imports, you can either change the minor version to 0, or add a subsequent
"addversion" node within the control file to increase the major version. For
Documents and Text Documents (LLESWBD-H-UGD).
versiontype Tag
The versiontype tag is used to support the import of major or minor document
versions. This tag's syntax is:
<versioncontrol>FALSE</versioncontrol>
<versiontype>MAJOR</versiontype>

69.7. folder Control File Syntax
Usage Notes
1. The versiontype tag cannot exist on its 1. When the value is set to MAJOR, the
own and must be contained within a version imported into Content Server
<node type="document" tag. It must will be the next major version increment.
also be accompanied by the 2. When the value is set to MINOR, the
“versioncontrol Tag” on page 1170. version imported into Content Server
2. The versiontype tag is optional when: will be the next minor version increment.
versionminor tags are used.
action="create">
action="update">
action="sync">
69.7 folder Control File Syntax

Description
Use type="folder" on the <node> tag to create, update, or delete a Folder.
Syntax
<node type="folder" action="create"></node>
Usage
Creating, updating, or deleting a Folder can require subordinate tags, such as the
location tag. These subordinate tags are detailed in “Object Importer Tag
Example
To create a “Documents” folder in the personal workspace for the Admin user:
<import>
<location>Admin Home</location>
<title language="en">Documents</title>
</node>
</import>
To view more folder examples, see “folder Import Control File Examples”
on page 1224.

69.8 project Control File Syntax

project
Description
Use type="project" on the <node> tag, to create, update, or delete a Project.
Syntax
<node type="project" action="create"></node>
Usage
1. Creating or updating a Project can include a number of subordinate tags: “goals

Tag” on page 1175, “include_channel Tag” on page 1175, “include_discussion
Tag” on page 1175, “include_participants Tag” on page 1176, “include_tasklist
Tag” on page 1176, “initiatives Tag” on page 1177, “mission Tag”
on page 1177, “objectives Tag” on page 1178, “public_access Tag”
on page 1178, “roles Tag” on page 1179, “startdate Tag” on page 1180, “status
Tag” on page 1180, and “targetdate Tag” on page 1180. These subordinate tags
are detailed below.
2. Creating, updating, or deleting a Project can also require a number of other
Example
To create a Project called “Standard Project” in the “Documentation” Folder of the

Enterprise Workspace:
<import>
<node type="project" action="create">
<title language="en">Standard Project</title>
<goals>This project will be completed in three weeks.</goals>
<include_channel>TRUE</include_channel>
<include_discussion>TRUE</include_discussion>
<include_participants>TRUE</include_participants>
<include_tasklist>TRUE</include_tasklist>
<initiatives clear="true"></initiatives>
<mission>The mission is to deliver a quality product.</mission>
<objectives>Resolve all outstanding customer issues.</objectives>
<public_access>TRUE</public_access>
<roles>
<coordinator>jdoe</coordinator>
</roles>
<startdate>20110314</startdate>
<status>Pending</status>
<targetdate>20110401</targetdate>

69.8. project Control File Syntax
</node>
</import>
To view more project examples, see “project Import Control File Examples”
on page 1227.
goals Tag
The goals tag is used to create or update the goals for the project. This tag's syntax
is:
<goals>Here are some project goals.</goals>
<goals clear="true"></goals>
Usage Notes
1. The goals tag cannot exist on its own, To clear the value, use the clear="true"
and must be used with the <node attribute.
type="project" tag.
2. The goals tag is not a required tag.
3. The goals tag is optional when:
• <node type="project"
action="create">
action="update">
action="sync">
include_channel Tag
The include_channel tag is used to add a Channel to the Project. This tag's syntax
is:
<include_channel>TRUE</include_channel>
Usage Notes
1. The include_channel tag cannot exist Valid values are TRUE, which adds a
on its own, and must be used with the Channel to the Project, and FALSE, which
<node type="project" tag. does not add a Channel to the Project. If this
2. The include_channel tag is not a tag is not specified, no Channel will be
required tag. added to the Project.
3. The include_channel tag is optional
when:
action="create">
include_discussion Tag
The include_discussion tag is used to add a Discussion to the Project. This tag's
syntax is:

<include_discussion>TRUE</include_discussion>
Usage Notes
1. The include_discussion tag cannot Valid values are TRUE, which adds a
exist on its own, and must be used with Discussion to the Project, and FALSE, which
the <node type="project" tag. does not add a Discussion to the Project. If
2. The include_discussion tag is not a this tag is not specified, no Discussion will be
required tag. added to the Project.
3. The include_discussion tag is
optional when:
action="create">
include_participants Tag
The include_participants tag is used to copy ACLs from the parent into the
Project. This tag's syntax is:
<include_participants>TRUE</include_participants>
Usage Notes
1. The include_participants tag Valid values are TRUE, which copies ACLs
cannot exist on its own, and must be from the parent into the Project, and FALSE,
used with the <node type="project" which does not. If this tag is not specified, no
tag. ACLs will be inherited.
2. The include_participants tag is not
a required tag.
3. The include_participants tag is
optional when:
action="create">
include_tasklist Tag
The include_tasklist tag is used to add a Task List to the Project. This tag's syntax
is:
<include_tasklist>TRUE</include_tasklist>

Usage Notes
1. The include_tasklist tag cannot Valid values are TRUE, which adds a Task
exist on its own, and must be used with List to the Project, and FALSE, which does
the <node type="project" tag. not add a Task List to the Project. If this tag is
2. The include_tasklist tag is not a not specified, no Task List will be added to
required tag. the Project.
3. The include_tasklist tag is optional
when:
action="create">
initiatives Tag
The initiatives tag is used to add or update initiatives to the Project. This tag's
syntax is:
<initiatives>Here are some project initiatives.</initiatives>
<initiatives clear="true"></initiatives>
Usage Notes
1. The initiatives tag cannot exist on its To clear the value, use the attribute
own, and must be used with the <node clear="true".
type="project" tag.
2. The initiatives tag is not a required
tag.
3. The initiatives tag is optional when:
action="create">
action="update">
action="sync">
mission Tag
The mission tag is used to add or update a mission statement for the Project. This
tag's syntax is:
<mission>Here is the project mission.</mission>
<mission clear="true"></mission>

Usage Notes
1. The mission tag cannot exist on its own, To clear the value, use the attribute
and must be used with the <node clear="true".
type="project" tag.
2. The mission tag is not a required tag.
3. The mission tag is optional when:
action="create">
action="update">
action="sync">
objectives Tag
The objectives tag is used to create or update objectives for the Project. This tag's
syntax is:
<objectives>Here are the objectives for the project.</objectives>
<objectives clear="true"></objectives>
Usage Notes
1. The objectives tag cannot exist on its To clear the value, use the attribute
type="project" tag.
2. The objectives tag is not a required
tag.
3. The objectives tag is optional when:
action="create">
action="update">
action="sync">
public_access Tag
The public_access tag is used to provide public access to the Project. This tag's
syntax is:

Usage Notes
1. The public_access tag cannot exist on 1. Valid values are TRUE, which permits
its own, and must be used with the public access to the Project, and FALSE,
<node type="project" tag. which removes public access to the
2. The public_access tag is not a Project.
required tag. 2. If this tag is not specified when the
3. The public_access tag is optional Project is created, public access is
when: disabled on the Project.
action="create">
roles Tag
The roles tag allows you to add additional users or groups to various project roles.
This tag's syntax is:
<roles>
<coordinator>neil</coordinator>
<member>geddy</member>
<guest>alex</guest>
</roles>
<roles>
<guest type="user">jdoe</guest>
</roles>
<roles>
<guest type="group">DefaultGroup</guest>
</roles>
Usage Notes
1. The roles tag cannot exist on its own, 1. You cannot remove users or groups from
and must be used with the <node roles using Object Importer.
type="project" tag. 2. Any user or group must exist in Content
2. The roles tag is not a required tag. Server before you can reference it using
3. The roles tag is optional when: the roles tag. Keep in mind that user
and group names are case-sensitive.
• <node type="project" 3. The guest subordinate tag of the role
action="create">
tag has an optional attribute: type. The
• <node type="project" only valid values for type are: user and
action="update"> group. If the type attribute is not
• <node type="project" specified on the guest tag, Object
action="sync"> Importer assumes a value of user.

startdate Tag
The startdate tag allows you to add or update the start date for the Project. This
tag's syntax is:
Usage Notes
1. The startdate tag cannot exist on its Dates must be in the format YYYYMMDD or
own, and must be used with the <node YYYYMMDDHHMMSS, where HH refers to
type="project" tag. the 24-hour clock and is a value between 01
2. The startdate tag is not a required tag. and 24. If YYYYMMDD is used, the time
defaults to 000000.
3. The startdate tag is optional when:
action="create">
action="update">
action="sync">
status Tag
The status tag allows you to add or update the status of the Project. This tag's
syntax is:
<status>Caution</status>
Usage Notes
1. The status tag cannot exist on its own, 1. Allowable values for the status tag are:
and must be used with the <node Pending, OnTarget, Caution, or
type="project" tag. Critical.
2. The status tag is not a required tag. 2. If the status tag is not specified during
3. The status tag is optional when: the creation of the project, the status will
default to Pending.
action="create">
action="update">
action="sync">
targetdate Tag
The targetdate tag allows you to add or update the target date for the Project. This
tag's syntax is:

69.9. reply Control File Syntax
Usage Notes
1. The targetdate tag cannot exist on its Dates must be in the format YYYYMMDD or
own, and must be used with the <node YYYYMMDDHHMMSS, where HH refers to
type="project" tag. the 24-hour clock and is a value between 01
2. The targetdate tag is not a required and 24. If YYYYMMDD is used, the time
tag. defaults to 000000.
3. The targetdate tag is optional when:
action="create">
action="update">
action="sync">
69.9 reply Control File Syntax

reply
Description
Use type="reply" on the <node> tag to create, update, or delete a Reply.
Syntax
<node type="reply" action="create"></node>
Usage
1. Creating a Reply might require the “body Tag” on page 1182, which is detailed
below.
2. Creating, updating, or deleting a Reply can also require subordinate tags, such
as the location tag. These subordinate tags are detailed in “Object Importer Tag
Example
To create a Reply, called “Reply 001”, attached to the Topic called “Topic 001”,
which is part of the “Discussion 001” in the Enterprise Workpace:
<import>
<node type="reply" action="create">
<location>Enterprise:Discussion 001:Topic 001</location>
<title language="en">Reply 001</title>
<body>This is a reply</body>
<createdby>Admin</createdby>
<owner>Admin</owner>
<created>20110104</created>
<modified>20110117<modified>

</node>
</import>
body Tag
The body tag allows you to add a message body for the reply. This tag's syntax is:
Usage
1. The body tag cannot exist on its own, and must be used with the <node
type="reply" tag.
2. The body tag is not a required tag.
3. The body tag is optional when:
• <node type="reply" action="create">
69.10 task Control File Syntax

task
Description
Use type="task" on the node tag to create, update, or delete a Task.
Syntax
<node type="task" action="create"></node>
Usage
1. Creating or updating a Task can include a number of subordinate tags:

“assigned Tag” on page 1183, “comments Tag” on page 1183, “duedate Tag”
on page 1184, “instructions Tag” on page 1184, “milestone Tag” on page 1185,
“priority Tag” on page 1185, “startdate Tag” on page 1186, and “status Tag”
on page 1186. These subordinate tags are detailed below.
2. Creating, updating, or deleting a Task can also require a number of other
Example
To create a Task called “New Task”, assigned to the “Admin” user, and attach it to
the “New Task List” located in the Enterprise Workspace:
<node type="task" action="create"></node>

<location>Enterprise:New Task List</location>
<title language="en">New Task</title>
<assigned>Admin</assigned>

69.10. task Control File Syntax
<comments clear="true"></comments>
<duedate>20110715180000</duedate>
<instructions clear="true"></instructions>
<milestone>Enterprise:New Task List:New Milestone</milestone>
<priority>High</priority>
<status>In Process</status>
</node>
To view more task examples, see “task Import Control File Examples”
on page 1229.
assigned Tag
The assigned tag assigns a user or group to a Task. This tag's syntax is:
<assigned>Admin</assigned>
<assigned clear="true"></assigned>
Usage Notes
1. The assigned tag cannot exist on its 1. If this tag is not specified during task
own, and must be used with the <node creation, the task will not be assigned.
type="task" tag. 2. Any user or group must exist in Content
2. The assigned tag is not a required tag. Server before it can be referenced in an
3. The assigned tag is optional when: assigned tag. User names and group
names are case sensitive.
• <node type="task"
3. Only users and groups who have at least
action="create">
write permission on the Task List can be
• <node type="task" assigned a Task. However, if, after being
action="update"> assigned to a Task, the assigned user or
• <node type="task" group has their permissions revoked on
action="sync"> the Task List, the assignment still stands.
Therefore, it is possible through Object
Importer to assign a user or group to a
Task even if they do not have at least
write permission on the associated Task
List. Under these circumstances, Content
Server permissions will prevent the
assigned user from being able to see or
modify the Task.
4. To remove the assigned user or group,
use the attribute clear="true".
comments Tag
Use the comments tag to add a comment to a Task, or update a Task's comments.
<comments><![CDATA[Here is a comment.]]></comments>
<comments clear="true"></comments>

Usage Notes
1. The comments tag cannot exist on its To clear the value, use the attribute
type="task" tag.
2. The comments tag is not a required tag.
3. The comments tag is optional when:
action="create">
action="update">
action="sync">
duedate Tag
The duedate tag adds or updates the due date of a Task. This tag's syntax is:
<duedate clear="true"></duedate>
Usage Notes
1. The duedate tag cannot exist on its own, 1. Dates must be in the format
and must be used with the <node YYYYMMDD or
type="task" tag. YYYYMMDDHHMMSS, where HH
2. The duedate tag is not a required tag. refers to the 24-hour clock and is a value
between 01 and 24. If YYYYMMDD is
3. The duedate tag is optional when: used, the time defaults to 000000.
2. To clear the value, use the attribute
action="create"> clear="true".
action="update">
action="sync">
instructions Tag
The instructions tag adds instructions to a Task, or updates a Task's instructions.
<instructions><![CDATA[Here are some instructions.]]></instructions>
<instructions clear="true"></instructions>

69.10. task Control File Syntax
Usage Notes
1. The instructions tag cannot exist on To clear the value, use the attribute
its own, and must be used with the clear="true".
<node type="task" tag.
2. The instructions tag is not a required
tag.
3. The instructions tag is optional
when:
action="create">
action="update">
action="sync">
milestone Tag
Use the milestone tag to add a Milestone to a Task, or update a Task's Milestone.
<milestone clear="true"></milestone>
Usage Notes
1. The milestone tag cannot exist on its 1. The Milestone must exist in Content
own, and must be used with the <node Server before it can be assigned to a Task.
type="task" tag. If this tag is not specified during create,
2. The milestone tag is not a required tag. no milestone will be assigned to the Task.
3. The milestone tag is optional when: 2. To unassign the milestone, use the
attribute clear="true".
action="create">
action="update">
action="sync">
priority Tag
The priority tag adds or updates the priority of the Task. This tag's syntax is:
<priority>High</priority>

Usage Notes
1. The priority tag cannot exist on its 1. Allowable values for the priority tag
own, and must be used with the <node are any one of: Low, Medium, or High.
type="task" tag. 2. If the priority tag is not specified
2. The priority tag is not a required tag. during the creation of the Task, the
3. The priority tag is optional when: priority is set to Medium.
action="create">
action="update">
action="sync">
startdate Tag
The startdate tag adds or updates the start date of a Task. This tag's syntax is:
<startdate clear="true"></startdate>
Usage Notes
1. The startdate tag cannot exist on its 1. Dates must be in the format
own, and must be used with the <node YYYYMMDD or
type="task" tag. YYYYMMDDHHMMSS, where HH
2. The startdate tag is not a required tag. refers to the 24-hour clock and is a value
between 01 and 24. If YYYYMMDD is
3. The startdate tag is optional when: used, the time defaults to 000000. If the
• <node type="task" startdate tag is not specified during
action="create"> creation, the current system date is used.
• <node type="task" 2. To clear the value, use the attribute
action="update"> clear="true".
action="sync">
status Tag
The status tag adds or updates the status of a Task. This tag's syntax is:
<status>On Hold</status>

69.11. taskgroup Control File Syntax
Usage Notes
1. The status tag cannot exist on its own, 1. Allowable values for the status tag are
and must be used with the <node any one of: Pending, In Process,
type="task" tag. Issue, On Hold, Completed, or
2. The status tag is not a required tag. Cancelled.
3. The status tag is optional when: 2. If this tag is not specified during creation
of the Task, the status is set to Pending.
action="create">
action="update">
action="sync">
69.11 taskgroup Control File Syntax

taskgroup
Description
Use type="taskgroup" on the node tag to create, update, or delete a Task Group.
Syntax
<node type="taskgroup" action="create"></node>
Usage
1. Creating or updating a Task Group can include a subordinate tag, “milestone

Tag” on page 1187, which is detailed below.
2. Creating, updating, or deleting a Task Group can also require a number of other
Example
To create a Task Group with a Milestone, called “New Task Group” and “New
Milestone”, attached to the Task List, “New Task List”, in the Enterprise Workspace:
<import>
<node type="taskgroup" action="create">
<title language="en">New Task Group</title>
</node>
</import>
milestone Tag
Use the milestone tag to assign a Milestone to a Task Group. This tag's syntax is:

Usage Notes
1. The milestone tag cannot exist on its 1. The Milestone must exist in Content
own, and must be used with the <node Server before it can be assigned to a Task
type="taskgroup" tag. Group. If this tag is not specified during
2. The milestone tag is not a required tag. create, no milestone will be assigned to
the Task Group.
3. The milestone tag is optional when:
2. To unassign the milestone, use the
• <node type="taskgroup"
attribute clear="true".
action="create">
action="update">
action="sync">
69.12 tasklist Control File Syntax

Description
Use type="tasklist" on the <node> tag to create, update, or delete a Task List.
Syntax
<node type="tasklist" action="create"></node>
Usage
Creating, updating, or deleting a Task List can require a number of subordinate tags,
such as the location tag. These subordinate tags are detailed in “Object Importer
Tag Descriptions and Syntax“ on page 1195.
Example
To create a Task List called “New Task List” in the Enterprise Workpace:
<import>
<node type="tasklist" action="create">
<title language="en">New Task List</title>
</node>
</import>
To view more tasklist examples, see “task Import Control File Examples”
on page 1229.

69.13. taskmilestone Control File Syntax
69.13 taskmilestone Control File Syntax

taskmilestone
Description
Use type="taskmilestone" on the node tag to create, update, or delete a Task

Milestone.
Syntax
<node type="taskmilestone" action="create"></node>
Usage
1. Creating or updating a Task Milestone can include a number of optional

subordinate tags: “actualdate Tag” on page 1189, “currentdate Tag”
on page 1190, and “originaldate Tag” on page 1190. These subordinate tags are
detailed below.
2. Creating, updating, or deleting a Task Milestone can also require a number of

other subordinate tags, such as the location tag. These other subordinate tags
are detailed in “Object Importer Tag Descriptions and Syntax“ on page 1195.
Example
To create a Task Milestone, called “New Milestone,” attached to a Task List, called
“New Task List”, in the Enterprise Workspace:
<import>
<node type="taskmilestone" action="create">
<title language="en">New Milestone</title>
<actualdate>20110114</actualdate>
<currentdate>20110107150000</currrentdate>
<originaldate>20100201</originaldate>
</node>
</import>
actualdate Tag
The actualdate tag adds or updates the actual date for the Task Milestone. This
tag's syntax is:
<actualdate clear="true"></actualdate>

Usage Notes
1. The actualdate tag cannot exist on its 1. Dates must be in the format
type="taskmilestone" tag. YYYYMMDDHHMMSS, where HH
2. The actualdate tag is not a required refers to the 24-hour clock and is a value
tag. between 01 and 24. If YYYYMMDD is
used, the time defaults to 000000.
3. The actualdate tag is optional when:
2. To clear the value, use the attribute
• <node type="taskmilestone" clear="true".
action="create">
• <node type="taskmilestone"
action="update">
action="sync">
currentdate Tag
The currentdate tag adds or updates the current date for the Task Milestone,
sometimes known as the Target Date. This tag's syntax is:
<currentdate>20101130</currentdate>
<currentdate>20101130150000</currrentdate>
<currentdate clear="true"></currentdate>
Usage Notes
1. The currentdate tag cannot exist on its 1. The date must be in the format
type="taskmilestone" tag. YYYYMMDDHHMMSS, where HH
2. The currentdate tag is not a required refers to the 24-hour clock and is a value
tag. between 01 and 24. If YYYYMMDD is
used, the time defaults to 000000. If this
3. The currentdate tag is optional when: tag is not specified during create, the
• <node type="taskmilestone" current system date is used.
action="create"> 2. To clear the value, use the attribute
• <node type="taskmilestone" clear="true".
action="update">
originaldate Tag
The originaldate tag adds or updates the original date for the Task Milestone. This
tag's syntax is:
<originaldate clear="true"></originaldate>

69.14. topic Control File Syntax
Usage Notes
1. The originaldate tag cannot exist on 1. Dates must be in the format
its own, and must be used with the YYYYMMDD or
<node type="taskmilestone" tag. YYYYMMDDHHMMSS. If YYYYMMDD
2. The originaldate tag is not a required is used, the time defaults to 000000. If
tag. this tag is not specified during create, the
current system date is used.
3. The originaldate tag is optional
when: 2. To clear the value, use the attribute
clear="true".
action="create">
action="update">
action="sync">
69.14 topic Control File Syntax

topic
Description
Use type="topic" on the <node> tag to create, update, or delete a Topic.
Syntax
<node type="topic" action="create"></node>
Usage
1. topic has an optional subordinate tag, “body Tag” on page 1192, which is
detailed below.
2. Creating, updating, or deleting a Topic can also require a number of other
Example
To create a Topic, called “Topic 001”, attached to a Discussion, called “Discussion

001”, in the Enterprise Workspace:
<import>
<node type="topic" action="create">
<location>Enterprise:Discussion 001</location>
<title language="en">Topic 001</title>
<body>When should our next meeting occur?</body>
<owner>Admin<owner>

<modified>20110113</modified>
</node>
</import>
body Tag
The body tag adds the message body for the topic. This tag's syntax is:
<body>This is the message body of the topic.</body>
Usage
1. The body tag cannot exist on its own, and must be used with the <node
type="topic" tag.
2. The body tag is not a required tag.
3. The body tag is optional when:
• <node type="topic" action="create">
69.15 url Control File Syntax

url
Description
Use type="url" on the <node> tag to create, update, or delete a URL.
Syntax
<node type="url" action="create"></node>
Usage
1. Creating or updating a URL can include a subordinate tag, “url Tag”

on page 1193, which is detailed below.
2. Creating, updating, or deleting a URL can also require a number of other
Example
To create a URL called “OpenText” in the “Links” Folder of the Enterprise

Workpace:
<import>
<node type="url" action="create">
<location>Enterprise:Links</location>
<title language="en">OpenText</title>
<url>http://www.opentext.com</url>
</node>
</import>

69.15. url Control File Syntax
To view more url examples, see “url Import Control File Examples” on page 1231.
url Tag
The url tag is used to specify a URL. This tag's syntax is:
Usage Notes
1. The url tag cannot exist on its own, and Make sure the URL is prefixed with a valid
must be contained within a <node protocol. Examples of valid protocols include
type="url" tag. http and https.
2. The url tag is required when:
• <node type="url"
action="create">
3. The url tag is optional when:
• <node type="url"
action="update">

Chapter 70
Object Importer Tag Descriptions and Syntax
The following pages contain the control file syntax and descriptions for the required
and optional subordinate tags of the node tag.
70.1 acl Tag Control File Syntax

acl Tag
Description
Use the acl tag to add, update, or delete permissions for a given object. If an access
control list, (ACL), exists for the object, the permissions on that existing ACL will be
updated, otherwise the ACL will be added to the object.
Syntax
<acl user="jdoe" permissions="111111100"></acl>
Usage
1. The acl tag is not a required tag.

2. The acl tag is optional when:
• <node type="<any_type>" action="create">
• <node type="<any_type>" action="update">
• <node type="<any_type>" action="sync">
3. If the acl tag is used, there are two required attributes:
a. Either the “permissions Attribute” on page 1196 or the action="remove"
attribute.
b. One of: “basegroup Attribute” on page 1196, “baseowner Attribute”
on page 1196, “group Attribute” on page 1196, “role Attribute”
on page 1198, “standard Attribute” on page 1199, or “user Attribute”
on page 1199.
Example
To remove the user “jdoe” in the ACL list of the Folder “New Folder”:
<import>
<node type="folder" action="update">
<location>Enterprise:New Folder</location>
<acl user="jdoe" action="remove"/>

Chapter 70 Object Importer Tag Descriptions and Syntax
</node>
</import>
To view more acl tag examples, see “acl Import Control File Examples”
on page 1216.
basegroup Attribute
The basegroup attribute sets the basegroup name to which the permission will
apply. In other words, you can both change the name of the owner group of the
object and set the owner group's permissions in one step. This attribute's syntax is:
<acl basegroup="DefaultGroup" permissions="111111111"></acl>
Usage
1. The basegroup attribute is not required.
2. The basegroup attribute can be set to any group name which exists in Content Server.
Group names are case-sensitive.
baseowner Attribute
The baseowner attribute sets the baseowner name to which the permission will
apply. In other words, you can both change the name of the owner of the object and
set the owner's permissions in one step. This attribute's syntax is:
<acl baseowner="Admin" permissions="111111111"></acl>
Usage
1. The baseowner attribute is not required.
2. The baseowner attribute can be set to any user name which exists in Content Server.
User names are case-sensitive.
group Attribute
The group attribute sets the group name to which the permission will apply. This
attribute's syntax is:
<acl group="Testing" permissions="111111100"></acl>
Usage
1. The group attribute is not required.
2. The group attribute can be set to any group name which exists in Content Server.
Group names are case-sensitive.
permissions Attribute
Description
The permissions attribute sets the allowable permissions for the ACL.

70.1. acl Tag Control File Syntax
Usage for all objects except a Discussion
1. The permissions attribute is required if the action="remove" attribute is not

present.
2. For each permissions attribute, you must specify a permission string containing
nine digits, where each digit is either a zero, which denies permission, or a one,
which allows permission. The positions, from one to nine in the string, define the
type of permission for all objects except Discussions.
Position Description
1 See node. Setting a one in this position
allows the user or group specified to see
that the object exists.
2 See contents of the node. Setting a one in
this position allows the user or group
specified to see that the object exists, and
to see any contents of that object.
3 Modify the node. Setting a one in this
position allows the user or group specified
to see that the object exists, to modify the
object, and to see any contents of that
object.
4 Edit node permissions. Setting a one in this
object, and to see and modify any contents
of that object.
5 Edit node attributes. Setting a one in this
object, to see and modify any contents of
that object, and to modify any metadata
associated with the object.
6 Add items to a node, for example add
documents to a folder. The sixth digit in
the string only applies to container nodes,
such as a folder. When specifying the acl
tag for a non-container object, such as a
document, the sixth digit does not apply.
As a best practice, non-container objects
should have this bit set to zero, although
there is no difference in how the object will
behave after import, regardless of the
value.
7 Delete node versions. Setting a one in this
to see that the object exists, and to delete
versions of that object.

Position Description
8 Delete node. Setting a one in this position
that the object exists, and to delete the
object.
9 Reserve node. Setting a one in this position
that the object exists, and to reserve the
object.
Usage for a Discussion
1. The permissions attribute is required if the action="remove" attribute is not

present.
2. The permissions attribute of an acl tag applied to a discussion object

functions differently from those applied to any other object.
Only those permissions settings listed below are supported for Discussions:
permissions Setting Description

permissions="000000000" Sets the acl for the discussion to “None”.
permissions="111011111" Sets the acl for the discussion to “Write”.
permissions="110000000" Sets the acl for the discussion to “Read”.
permissions="111111111" Sets the acl for the discussion to
“Administer”.
role Attribute
The role attribute sets the permissions for designated groups assigned to Projects in
Content Server. This attribute's syntax is:
<acl role="members" permissions="111111111"></acl>
Usage
1. The role attribute is not required.
2. The role attribute is optionally available when <node type="project"
action="<any_action>"> only. The role attribute can only be applied to the child
objects of Projects, and cannot be applied to the Project itself. A Folder is an example of a
child object of a Project.
3. The role attribute must be assigned one of the following values:
• coordinators: The permissions will be assigned to the designated coordinator
group of a project.
• guests: The permissions will be assigned to the designated guest group of a project.
• members: The permissions will be assigned to the designated member group of a
project.

70.2. category Tag Control File Syntax
standard Attribute
The standard attribute allows you to set the permissions for the basegroup,
baseowner, or world, without requiring you to state a specific user or group. This
<acl standard="owner" permissions="111111100"></acl>
Usage
1. The standard attribute is not required.
2. The standard attribute must be assigned one of the following values:
• basegroup: The default group of a node.
• owner: The owner of a node.
• world: All users and groups.
user Attribute
The user attribute sets the user name to which the permission will apply. This
<acl user="jdoe" permissions="111111110"></acl>
Usage
1. The user attribute is not required.
2. The user attribute can be set to any user name which exists in Content Server. User
names are case-sensitive.
70.2 category Tag Control File Syntax

category Tag
Description
The category tag specifies a Category name that is to be applied to an object.
Syntax
<category name="Content Server Categories:Test"></category>
Usage
1. The category tag is not a required tag.

2. The category tag is optional when:

3. Creating or updating a Category can include a number of subordinate tags:

“attribute Tag” on page 1200, “noninherit Tag” on page 1201, “setattribute Tag”
on page 1202, and “subitems Tag” on page 1202. These subordinate tags are
detailed below.
Notes
1. The Category, with all referenced attributes, must exist in Content Server before
you can use it. If the Category, and all referenced attributes, do not exist in
Content Server, the Category will not be created and an error message will
appear in the log file.
2. If the Category has previously been applied to the object, directly or through
inheritance, only the attribute data specified will be updated. If the Category has
not been applied to the object, it will be added, and any attribute data will be
updated.
If the Category has changed in Content Server, the Category on the object must
be “updated” before altering the category data using Object Importer. This can
be done in the Categories tab for a given object through the standard Content
Server interface.
3. You can apply as many Categories as you want for any object using Object
Importer. You cannot remove Categories from any object using Object Importer.
attribute Tag
The attribute tag is used to assign a value to an existing attribute. This tag's syntax
is:
<attribute name="Name">John Doe</attribute>
<attribute name ="xyz" clear="true"></attribute>

70.2. category Tag Control File Syntax
Usage Notes Example

1. The attribute tag is 1. The number and syntax
not a required tag. of any attribute's values
2. The attribute tag depends on the values <import>
cannot exist on its own, which have been set up, <node
and must be contained and applied to the type="document"
within a category tag. attribute, in Content action="update">
Server. <category
3. Multiple line attribute
2. If the attribute supports name="Content Server
tags are supported in the Categories:Test">
import control file. multiple values, these can
be added by specifying <attribute
multiple attribute tags in name="Name">John
the import control file. Doe</attribute>
<attribute
3. To clear an attribute's
name="DateOfBirth">19
value, use
650216</attribute>
clear="true".
</category>
4. Dates must be in the </node>
format YYYYMMDD or </import>
YYYYMMDDHHMMSS,
where HH refers to the
24-hour clock and is a
value between 01 and 24. <import>
If YYYYMMDD is used, <node
the time defaults to type="document"
000000. action="update">
5. When defining a check <category
box attribute type, use name="Content Server
TRUE for selected and Categories:Test">
FALSE for cleared. <attribute
name="Color">Red</
6. All values must be
attribute>
specified when updating
<attribute
a multi-value attribute,
name="Color">Green</
(MVA). For example, if
attribute>
an attribute contains five
<attribute
values before the update,
name="Color">Blue</
and the import control
attribute>
file specifies three values,
</category>
the MVA will only
</node>
contain the three values
</import>
after the update.
noninherit Tag
The noninherit tag determines whether inheritance can be enabled or disabled on
Categories. This tag's syntax is:
<noninherit>FALSE</noninherit>

Usage Notes Example

1. The noninherit tag is 1. The noninherit tag
not a required tag. must be set to either
2. The noninherit tag TRUE or FALSE. <import>
cannot exist on its own, <node
If the noninherit tag is
and must be contained type="document"
set to TRUE, inheritance
within a category tag. action="update">
can be enabled on
<category
Categories. If the
name="Content Server
noninherit tag is set to
Categories:Test">
FALSE, inheritance can
<attribute
be disabled on
name="Name">Jane
Categories.
Doe</attribute>
2. The default inheritance
behavior is derived from <noninherit>FALSE</
the parent object. noninherit>
</category>
</node>
</import>
setattribute Tag
In addition to regular attributes, setattributes are also supported. The setattribute
tag is used to assign a value to an existing setattribute. This tag's syntax is:
<setattribute name="Fruit"></setattribute>
Usage Example
1. The setattribute tag is not a required
tag.
2. The setattribute tag cannot exist on <import>
its own, and must be contained within a <node type="document"
category tag. action="update">
<category name="Content
3. The setattribute tag can contain
Server Categories:SetTest">
attributes. <setattribute name="Fruit">
<attribute
name="Name">Orange</attribute>
<attribute
name="Color">Orange</attribute>
</setattribute>
</category>
</node>
</import>
subitems Tag
The subitems tag is used to apply a Category, and its attribute values, recursively to
all children of the current object. This tag's syntax is:
<subitems>reapply</subitems>

70.3. createby / createdby Tags Control File Syntax
Usage Notes Example

1. The subitems tag is not The only valid value for the
a required tag. subitems tag is reapply.
2. The subitems tag <import>
cannot exist on its own, <node
and must be contained type="document"
within a category tag. action="update">
<category
name="Content Server
Categories:Test">
<attribute
name="Name">Jane
Doe</attribute>
<subitems>reapply</
subitems>
</category>
</node>
</import>
70.3 createby / createdby Tags Control File Syntax

Description
Use these tags, createby and createdby, to specify a different creator for the object.
Syntax
<createby>Admin</createby>
Usage
1. The createby or createdby tags are not required tags.
2. The createby or createdby tags are optional when:

• <node type="<any_type>" action="addversion">
Notes
1. To change the identity of the creator of an object, specify the user name of the
person who is to be assigned the new creator. The user name is case sensitive.
2. There are two variations in syntax for backwards compatibility, createby and
createdby, which are interchangeable.

3. For document objects, there are two “created by” fields, one on the object and
one on each version.
4. If this tag is specified during an action="create", the creator will be modified
on the object and on the version.
5. When updating a document with the <file> tag present, or when adding a new
version, the creator will apply to the new version. When updating a document
with the <file> tag missing, the creator will apply to the document.
Example
<import>
<title language="en">My Guidelines</title>
<file>c:\temp\guidelines.doc<\file>
</node>
</import>
70.4 created Tag Control File Syntax

Description
Use the created tag to specify a different create date for the object.
Syntax
Usage
1. The created tag is not a required tag.
2. The created tag is optional when:
Notes
1. Dates must be in the format YYYYMMDD or YYYYMMDDHHMMSS, where
HH refers to the 24-hour clock and is a value between 01 and 24. If YYYYMMDD
is used, the time defaults to 000000. If this tag is not specified during create, the
2. For document objects, there are two created fields, one on the document and one
for each version of the document. If this tag is specified during an

70.5. description Tag Control File Syntax
action="create", the date will be modified on the document and on the version
of the document.
3. When updating a document with the <file> tag present, or when adding a new
version, the date will apply to the new version. When updating a document
without the <file> tag, the date will apply to the document.
Example
<import>
</node>
</import>
70.5 description Tag Control File Syntax

Description
Use the description tag to provide a description for the object. Content Server
supports using multiple description tags for an object in order to create multiple
descriptions, in multiple languages, for that object.
Syntax
<description language="en">first draft</description>
<description clear="true" language="en"></description>
Usage
1. The description tag is not a required tag.
2. The description tag is optional when:
•<node type="<any_type>" action="sync">
3. Creating, updating, or clearing a description might require the “language
Attribute” on page 1206, which is detailed below.
Tip: OpenText recommends that you always use the language attribute on
the description tag, and, if there is only one description tag, that you
specify the system default language code on the language attribute.

If the language attribute is not used, Object Importer will use the system
default language.
Notes
1. To clear the value of the description tag, use the attribute clear="true".
2. If a description doesn't exist in a language which has been enabled in the system
to which you are importing, the clear="true" attribute will be used for clearing
out the description in that language.
3. In the event that two, or more, description tags with the same language attribute
appear in the same node paragraph, no error will occur. Object Importer will set
the description to the value contained in the last <description> tag it
encounters with that language attribute.
Example
To create the “guidelines.doc” document, with descriptions in both English and
French, when the “Add Title to Location” check box is selected:
<import>
<title language="en">guidelines.doc</title>
<description language="en">Final Drafts</description>
<description language="fr">Versions Finales</description>
</node>
</import>
To view more description tag examples, see “description Import Control File
Examples” on page 1219.
language Attribute
Use the language attribute to specify a <language_code> which will create, update,
or clear the description of that object associated with that language. This tag's syntax
is:
<description language="en">Final Drafts</description>

<description language="fr">Versions Finales</description>
<description clear="true" language="it"></description>

70.6. location Tag Control File Syntax
Usage Notes
1. The language attribute is not required, 1. If <node type="<any_type>"
provided only one <description></ action="create">, then multilingual
description> tag appears in the node descriptions will be created, provided the
paragraph. If you are applying multiple language exists, and is enabled, on the
<description></description> tags system. If <node action="update" or
in the node paragraph, the language <node action="sync", then
attribute is required. multilingual descriptions will be updated
if the description exists for that language
Tip: OpenText recommends that attribute.
you always use the language
attribute on the description tag.
2. In order for multilingual descriptions to
be created or updated, all languages
referenced by the language attribute
must exist on Content Server, and those
languages must be enabled.
70.6 location Tag Control File Syntax

Description
Important
This is a mandatory tag regardless of object type or import action.
The location tag specifies the location of the object. The path must be absolute,
starting at the top of the hierarchy, with each level separated by colons, “:”.
Syntax
Usage
This is a mandatory tag regardless of object type or import action.
Notes
1. If action="create" is used:
The <location></location> tag represents the path in Content Server where
the object is to be created. Depending on how the Object Importer has been
configured, the path may be created if it does not exist. Path creation only
applies to the action="create".
2. If action="update" is used:
The <location></location> tag represents either the path in Content Server to
the object that is to be updated, or the path in Content Server to the parent
object. Which path depends on the Add Title to Location setting in the
configuration section. For example, to update a document called readme.txt
which is located in the “Projects” folder of the Enterprise Workspace:

If the Add Title to Location check box is selected, the syntax is:
<title language="en">readme.txt</title>
If the Add Title to Location check box is cleared, the syntax is:
<location>Enterprise:Projects:readme.txt</location>
3. If action="sync" is used:
the object is to be created or updated.
4. If action="addversion" is used:
the object is to be created.
5. If action="delete" is used:
The <location></location> tag represents the path in Content Server to the
object that is to be deleted. The syntax rules relating to the Add Title to Location
setting, described in “location Tag Control File Syntax” on page 1207, for
action="update" apply to action="delete" as well.
If the location is from a Workspace whose associated user is deleted, then the
attribute deletedUser="true" must be used to tell Object Importer to search
deleted user Workspaces. By default deleted Workspaces will be ignored.
Example
To create a Project called “Standard Project” in the “Documentation” folder of the
Enterprise Workspace when the Add Title to Location check box is selected:
<import>
</node>
</import>

70.7. modified Tag Control File Syntax
70.7 modified Tag Control File Syntax

Description
Use the modified tag to specify a different modify date for the object.
Syntax
Usage
1. The modified tag is not a required tag.
2. The modified tag is optional when:
The exception to this rule relates to type="document". See the Notes section
below for further information.
Notes
1. By default, the modified tag is not applicable for Document objects,
type="document". If specified, the modified date will not be updated on the
Document object.
2. Dates must be in the format YYYYMMDD or YYYYMMDDHHMMSS, where

HH refers to the 24-hour clock and is a value between 01 and 24. If YYYYMMDD
is used, the time defaults to 000000. If this tag is not specified during create, the
3. If you set the modified date to occur before the create date, Object Importer will
return an error.
Example
<import>
<node type="reply" action="create">
<location>Enterprise:Discussion 001:Topic 001</location>
<title language="en">Reply 001</title>
<modified>20041225<modified>
</node>
</import>

70.8 nickname Tag Control File Syntax

Description
Use the nickname tag to specify a nickname for an object.
Syntax
<nickname>HR</nickname>
Usage
1. The nickname tag is not a required tag.
2. The nickname tag is optional when:
Example
<import>
<nickname>docs</nickname>
</node>
</import>
70.9 owner Tag Control File Syntax

Description
Use the owner tag to specify a different owner for the object without changing
permissions.
Syntax
Usage
1. The owner tag is not a required tag.
2. The owner tag is optional when:

70.10. ownergroup Tag Control File Syntax
The exception to this rule relates to type="project". See the Notes section below
for further information.
Notes
1. By default, the owner tag is not applicable for Project objects, type="project".
The owner will not be updated on the Project.
2. Any user specified must exist in the system before you can reference it. User
Example
<import>
<node type="topic" action="create">
<location>Enterprise:Discussion 001</location>
<title language="en">Topic 001</title>
<body>This is a topic</body>
<owner>Admin<owner>
</node>
</import>
70.10 ownergroup Tag Control File Syntax

Description
Use the ownergroup tag to specify a different owner group for the object without
changing permissions.
Syntax
<ownergroup>DefaultGroup</ownergroup>
Usage
1. The ownergroup tag is not a required tag.
2. The ownergroup tag is optional when:
The exception to this rule relates to type="project". See the Notes section below
for further information.

Notes
1. By default, the ownergroup tag is not applicable for Project objects,
type="project". The ownergroup will not be updated on the Project.
2. Any owner group must exist in the system before you can reference it. Group
Example
<import>
<ownergroup>DefaultGroup</ownergroup>
</node>
</import>
70.11 title Tag Control File Syntax

Note: The colon character, “:”, cannot be used in any title because colons are
used to delimit path information.
Description
The title tag is used to apply a title to an object. Content Server supports using
multiple title tags for an object in order to create multiple titles, in multiple
languages, for that object.
Syntax
<title language="en">Moving Pictures</title>
<title clear="true" language="en"></title>
Usage
1. The title tag is required when:
The exception to this rule relates to type="document". See the Notes section
below for further information.
2. The title tag may be either required or optional, depending on the setting of
the “Add Title to Location” check box in Object Importer, when:

• <node type="<any_type>" action="delete">

70.11. title Tag Control File Syntax
3. The “Notes” section below provides more information about the requirements
for the “Add Title to Location” setting. For information about how to set the
“Add Title to Location” check box, see “To Configure Object Importer”
on page 1146.
4. Creating, updating, or deleting a title might require the “language Attribute”

on page 1214, which is detailed below.
Notes
1. During an action="create", the title tag is required for all object types
except Documents, type="document. If your import uses <node
type="document action="create" with no title specified, the name of the
document will be used. For example, if the <title language="en"></title>
tag is not used when importing the document <file>c:/
temp/import_dir/readme.txt</file>, Content Server uses “readme.txt” for
the object name and filename of the version.
2. During an action="update" or action="delete", this tag is required, and

must contain the name of the object, if the Add Title to Location check box is
selected. If the Add Title to Location check box is cleared, this tag can,
optionally, be used to rename an object during an update.
3. To clear the value of the title tag, use the attribute clear="true".
4. If a title doesn't exist in a language which has been enabled in the system to
which you are importing, the clear="true" attribute will be used for clearing
out the title in that language.
5. In the event that two, or more, title tags with the same language attribute appear
in the same node paragraph, no error will occur. Object Importer will set the title
to the value contained in the last <title> tag with that language attribute.
Example
To create a document called “My Guide” in the “Documents” folder, with a title
listed for English and a title listed for French:
<import>
<title language="en">My Guide</title>
<title language="fr">Mon Guide</title>
<file>c:\temp\my_guide.doc<\file>
</node>
</import>
To view more title tag examples, see “title Import Control File Examples”
on page 1230.

language Attribute
Use the language attribute to specify a <language_code> which will create, update,
or delete the title of that object associated with that language. This tag's syntax is:
<title language="en">Moving Pictures</title>

<title language="fr">Images Mobiles</title>
<title clear="true" language="de"></title>
Usage Notes
1. The language attribute is optional, 1. If <node type="<any_type>"
provided only one <title></title> action="create", then multilingual
tag appears in the node paragraph. If you titles will be created, provided the
are applying multiple <title language exists, and is enabled, on the
language="en"></title> tags in the system. If <node action="update" or
node paragraph, the language attribute <node action="sync", then
is required. multilingual titles will be updated if the
title exists for that language attribute.
Tip: OpenText recommends that
you always use the language Note: On the Object Importer
attribute on the title tag, and, if Configure page, one of the selectable
there is only one title tag, that options is the Add Title to Location
you specify the system default check box. If selected, all update, add
language code on the language version and delete operations will take
attribute. the first <title> tag in the node
paragraph in the import script, append
If the language attribute is not
the contents of the <title> tag to the
used, Object Importer will use the
contents of the <location> tag, and
system default language.
perform the update, add version, or
2. In order for multilingual titles to be delete operation on this object.
created, or updated, all languages
referenced by the language attribute When multiple titles are defined within
must exist on Content Server, and those the node paragraph, for example in a
languages must be enabled. multilingual system, Object Importer
will only assess the first title for the
purposes of determining which object
is to be updated, added to, or deleted.
If the first title is not in the user's
preferred metadata language, the
operation may fail to find the object
because the <location> tag contains
one component in the wrong language.
You must ensure that the first title is

always in the same language as the
<location> tag, or you can choose to
clear the Add Title to Location check
box in the Object Importer Configure
page.

Chapter 71
Object Importer Import Control File Examples
Several sample control files have been provided that enable you to create, update, or
delete objects in Content Server with Object Importer. These files are made up of one
or more <node> paragraphs, each paragraph describing actions against a particular
object.
Several of the examples on the following pages refer to the “Add Title to Location”
check box. This check box is found from the Content Server Administration pages,
under Object Importer Administration, by clicking Configure. You will find the
Add Title to Location check box in the Advanced section.
Note: The entire import control file, including comments, must be contained
within the import tags, <import></import>, or else it will fail. It is very
important that the control file be properly formatted.
Example 71-1: General Example of an Object Importer Import Control

File
<import>
</node>

<location>Admin Home:My Documents</location>
<file>c:\temp\photo.jpg</file>
<acl standard="world" permissions="000000000"></acl>
</node>
<node type="url" action="update">

<location>Enterprise:Links:Opentext</location>
</node>
</import>

Chapter 71 Object Importer Import Control File Examples
71.1 acl Import Control File Examples

Example 71-2: To remove the group “Managers” in the ACL list of the
object “New Folder”:
<import>
<acl group="Managers" action="remove"/>
</node>
</import>
Example 71-3: To remove the “Base Owner” ACL in the object “New
Folder”:
<import>
<acl standard="owner" action="remove"/>
</node>
</import>
Example 71-4: To remove the “Base Group” ACL in the object “New
Folder”:
<import>
<acl standard="basegroup" action="remove"/>
</node>
</import>
Example 71-5: To remove the “World (public access)” ACL in the object
“New Folder”:
<import>
<acl standard="world" action="remove"/>
</node>
</import>

71.2. alias Import Control File Examples
71.2 alias Import Control File Examples

Example 71-6: To update an Alias object by adding a category with
multi-value attributes, when the “Add Title to Location” check box is
selected:
<import>
<node type="alias" action="update">
<category name="Content Server Categories:Transportation">
<attribute name="vehicle">Car</attribute>
<attribute name="vehicle">Truck</attribute>
</category>
</node>
</import>
Example 71-7: To update an Alias object by adding a category with

multi-value attributes, when the “Add Title to Location” check box is
cleared:
<import>
<node type="alias" action="update">
<location>Enterprise:Documentation:Example</location>
<category name="Content Server Categories:Transportation">
<attribute name="vehicle">Car</attribute>
<attribute name="vehicle">Truck</attribute>
</category>
</node>
</import>
Example 71-8: To delete an Alias object, when the “Add Title to

Location” check box is selected:
<import>
<node type="alias" action="delete">
</node>
</import>

Example 71-9: To delete an Alias object, when the “Add Title to

Location” check box is cleared:
<import>
<node type="alias" action="delete">
<location>Enterprise:Documentation:Example</location>
</node>
</import>
71.3 compounddoc Import Control File Examples

For backwards compatibility, either compounddoc or cd can be used in the type
parameter when dealing with compound documents.
Example 71-10: To create a Compound Document and assign a

Category with inheritance disabled:
<import>
<node type="compounddoc" action="create">
<title language="en">CD</title>
<category name="Enterprise:Human Resources:Categories">
<attribute name="firstname">John</attribute>
<attribute name="lastname">Smith</attribute>
<noninherit>true</noninherit>
</category>
</node>
</import>
Example 71-11: To delete the “Docs” Compound Document from the

Enterprise Workspace, when the “Add Title to Location” check box is
selected:
<import>
<node type="compounddoc" action="delete">
<title language="en">Docs</title>
</node>
</import>

71.4. description Import Control File Examples
Example 71-12: To delete the “Docs” Compound Document from the

Enterprise Workspace, when the “Add Title to Location” check box is
cleared:
<import>
<node type="cd" action="delete">
<location>Enterprise:Docs</location>
</node>
</import>
71.4 description Import Control File Examples

Example 71-13: To update the description of a document in English and
French. This code may or may not work since the action is sync. If the
document exists, then the description will be updated. If the document
does not exist, an error will be generated because the <file> tag was
not specified. In this example, the “Add Title to Location” check box is
selected:
<import>
<node type="document" action="sync">
<title language="en">logo.jpg</title>
<description language="en">Final draft</description>
<description language="fr">Version Finale</description>
</node>
</import>
Example 71-14: To update the description of a document. This code

may or may not work since the action is sync. If the document exists,
then the description will be updated. If the document does not exist, an
error will be generated because the <file> tag was not specified. In this
example, the “Add Title to Location” check box is cleared:
<import>
<location>Enterprise:Projects:Documents:logo.jpg</
location>
<description language="en">Final drafts</description>
<description language="fr">Version Finale</description>
</node>
</import>

Example 71-15: To create a “Documents” Folder in the “Projects”

Folder of the Enterprise Workspace, giving the “Client” group See &
See Contents permissions, while removing permissions from the public
group. Descriptions are created in English and French. In order for the
descriptions to be applied, both languages need to be installed and
enabled on the system:
<import>
<description language="en">This folder stores documents</
description>
<description language="fr">Ce dossier stocke des
documents</description>
<acl group="Client" permissions="100000000"></acl>
</node>
</import>
Example 71-16: To update an existing Folder called “Documents”

located in the Enterprise Workspace, by adding a Nickname. In this
example, the “Add Title to Location” check box is selected. The English
description for the folder is updated, while the French description for
the folder is deleted:
<import>
<description language="en">This folder stores obsolete
<description clear="true" language="fr"></description>
</node>
</import>
Example 71-17: To rename an existing Folder from “Documents” to “My

Documents”, when the “Add Title to Location” check box is cleared:
<import>
<title language="en">My Documents</title>

71.5. document Import Control File Examples
<title language="en">Mes Documents</title>

</node>
</import>
71.5 document Import Control File Examples

Example 71-18: To create a file called “My Guidelines” in the
“Documents” folder, with the mime type set and a category applied to
all sub-items:
<import>
<mime>application/msword</mime>
<category name="Content Server Categories:Test">
<attribute name="date">20060214</attribute>
<attribute name="internal">TRUE</attribute>
<attribute name="user">Admin</attribute>
<subitems>reapply</subitems>
</category>
</node>
</import>
Example 71-19: To add a version to the existing “My Guidelines”

document, when the “Add Title to Location” check box is selected:
<import>
<node type="document" action="addversion">
<file>c:\temp\new_guidelines.doc</file>
</node>
</import>
Example 71-20: To add a version to the existing “My Guidelines”

document, when the “Add Title to Location” check box is cleared:
<import>
<node type="document" action="addversion">
<location>Enterprise:Projects:Documents:My Guidelines</

location>
</node>
</import>
Example 71-21: The following code could be used to add a version to

the existing “guidelines.doc” document, when the “Add Title to
Location” check box is selected:
<import>
<node type="document" action="update">
</node>
</import>
Example 71-22: The following code could be used to add a version to

the existing “guidelines.doc” document, when the “Add Title to
Location” check box is cleared:
<import>
<location>Enterprise:Projects:Documents:guidelines.doc</
location>
</node>
</import>
Example 71-23: To update the description of the “guidelines.doc”

document, when the “Add Title to Location” check box is selected:
<import>
</node>
</import>

71.5. document Import Control File Examples
Example 71-24: To update the description of the “guidelines.doc”

document, when the “Add Title to Location” check box is cleared:
<import>
<location>Enterprise:Projects:Documents:guidelines.doc</
location>
</node>
</import>

example, the “Add Title to Location” check box is selected:
<import>
<title language="en">logo.jpg</title>
</node>
</import>

<import>
<location>Enterprise:Projects:Documents:logo.jpg</
location>
</node>
</import>

Example 71-27: To delete a document called “junk.txt” from the “Temp”

folder in the Enterprise Workspace, when the “Add Title to Location”
check box is selected:
<import>
<node type="document" action="delete">
<location>Enterprise:Temp</location>
<title language="en">junk.txt</title>
</node>
</import>
Example 71-28: To delete a document called “junk.txt” from the “Temp”

folder in the Enterprise Workspace, when the “Add Title to Location”
check box is cleared:
<import>
<node type="document" action="delete">
<location>Enterprise:Temp:junk.txt</location>
</node>
</import>
71.6 folder Import Control File Examples

group:
<import>
<description language="en">This folder is to store
</node>
</import>

71.6. folder Import Control File Examples

example, the “Add Title to Location” check box is selected:
<import>
</node>
</import>

<import>
<location>Enterprise:Documents</location>
</node>
</import>
Example 71-32: To update an existing Folder by removing permissions

from the public group, when the “Add Title to Location” check box is
selected:
<import>
</node>
</import>

from the public group, when the “Add Title to Location” check box is
cleared:
<import>


</node>
</import>
Example 71-34: To rename an existing Folder from “Documents” to “My

Documents”, when the “Add Title to Location” check box is cleared:
<import>
<title language="en">My Documents</title>
</node>
</import>
Example 71-35: To delete a Folder called “Temp” from the “Enterprise

Workspace”, when the “Add Title to Location” check box is selected:
<import>
<node type="folder" action="delete">
</node>
</import>
Example 71-36: To delete a Folder called “Temp” from the “Enterprise

Workspace”, when the “Add Title to Location” check box is cleared:
<import>
<node type="folder" action="delete">
<location>Enterprise:Temp</location>
</node>
</import>

71.7. project Import Control File Examples
71.7 project Import Control File Examples

Example 71-37: To create a Project with all of the optional parameters
specified:
<import>
<title language="en">Deluxe Project</title>
<status>caution</status>
<goals>here are some goals</goals>
<initiatives>here are some initiatives</initiatives>
<mission>here is the mission statement</mission>
<objectives>here are some objectives</objectives>
<Include_discussion>TRUE</Include_discussion>
<Include_tasklist>TRUE</Include_tasklist>
<Include_channel>TRUE</Include_channel>
<Include_participants>TRUE</Include_participants>
</node>
</import>
Example 71-38: To update the target date and objectives for a Project,
when the “Add Title to Location” check box is selected:
<import>
<node type="project" action="update">
<objectives>here are some new objectives</objectives>
</node>
</import>
Example 71-39: To update the target date and objectives for a Project,
when the “Add Title to Location” check box is cleared:
<import>
<location>Enterprise:Documentation:Standard Project</
location>
<objectives>here are some new objectives</objectives>

</node>
</import>
Example 71-40: To change the guest permissions on a Project and add

two additional members, when the “Add Title to Location” check box is
selected:
<import>
<roles>
<member>jdoe</member>
<member>jsmith</member>
</roles>
</node>
</import>
Example 71-41: To change the guest permissions on a Project and add

two additional members, when the “Add Title to Location” check box is
cleared:
<import>
location>
<roles>
<member>jdoe</member>
<member>jsmith</member>
</roles>
</node>
</import>
Example 71-42: To delete a Project, when the “Add Title to Location”

check box is selected:
<import>
<node type="project" action="delete">
</node>
</import>

71.8. task Import Control File Examples
Example 71-43: To delete a Project, when the “Add Title to Location”

check box is cleared:
<import>
<node type="project" action="delete">
location>
</node>
</import>
71.8 task Import Control File Examples

Example 71-44: To create a Task List with none of the optional
parameters specified:
<import>
<node type="tasklist" action="create">
<title language="en">New Task List</title>
</node>
</import>
Example 71-45: To create a Milestone inside the Task List created

above:
<import>
<node type="taskmilestone" action="create">
<title language="en">New Milestone</title>
</node>
</import>
Example 71-46: To create a Task with the Milestone created above,

inside the Task List created above:
<import>
<node type="task" action="create">

<title language="en">New Task</title>

<milestone>Enterprise:New Task List:New Milestone</
milestone>
</node>
</import>
Example 71-47: To remove the Milestone created above, from the Task
created above:
<import>
<node type="task" action="update">
<location>Enterprise:New Task List:New Task</location>
</node>
</import>
71.9 title Import Control File Examples

group. Titles are created in English, French, and Italian:
<import>
<title language="fr">Documents</title>
<title language="it">Documenti</title>
</node>
</import>

from the public group, and removing the Italian title from the Folder,
when the “Add Title to Location” check box is selected:
<import>

71.10. url Import Control File Examples
<title clear="true" language="it"></title>

</node>
</import>

from the public group, and removing the Italian title from the Folder,
when the “Add Title to Location” check box is cleared:
<import>
<title clear="true" language="it"></title>
</node>
</import>
71.10 url Import Control File Examples

Example 71-51: To create or update the URL, and adjust the
permissions of the base group, when the “Add Title to Location” check
box is selected:
<import>
<node type="url" action="sync">
<location>Enterprise:Links</location>
<title language="en">OpenText</title>
<acl standard="basegroup" permissions="110000000"></acl>
</node>
</import>
Example 71-52: To delete the “Admin” URL from the Enterprise

Workspace, when the “Add Title to Location” check box is cleared:
<import>
<node type="url" action="delete">
<location>Enterprise:Admin</location>
</node>
</import>

Example 71-53: To delete the “Admin” URL from the Enterprise

Workspace, when the “Add Title to Location” check box is checked:
<import>
<node type="url" action="delete">
<title language="en">Admin</title>
</node>
</import>

Part 17
Directory Services Administration
Chapter 72
Configuring Directory Services Integration
OpenText Directory Services is an integral part of Content Server Version 16. OTDS
handles all authentication for Content Server Version 16. During the installation of
Content Server Version 16, the administrator chose to install a particular version of
Directory Services:
• Internal OTDS: if your administrator selected an internal version of OTDS
during the installation of Content Server version 16, you will be accessing the
version of OTDS that shipped with the Content Server installation files.
The internal OTDS installation creates and makes use of a Content Server process
in the System Object Volume. You can access this process directly from the
Content Server administration page, under the Directory Services Integration
Administration heading, click Configure Directory Services Process. For more
information about this process, see “To Edit or Delete an Internal OTDS Process”
on page 1240.
Important
OpenText recommends the use of an external OTDS installation in order
to take advantage of high-availability capabilities.
Once you have completed the installation process for Content Server Version 16,
you can switch from an interal installation of OTDS to an external installation.
For more information, see “To Change from an Internal Installation of OTDS to
an External” on page 1239.
• External OTDS: if your administrator selected an external version of OTDS
during the installation of Content Server version 16, you will be accessing a
version of OTDS downloaded from the OpenText Knowledge Center (https://
knowledge.opentext.com/go/OTDS).
72.1 Configuring Directory Services

Directory Services is configured using the OTDS web administration user interface.
Selecting the Configuring Directory Services option from the Content Server
administration menu will bring up the OTDS web admin UI in a separate tab or
window.

Chapter 72 Configuring Directory Services Integration
72.1.1 To Configure Directory Services

To configure Directory Services:
1. In the Content Server administration page, under the Directory Services

Integration Administration heading, click Configure Directory Services.
2. A new, separate page will open. This is the sign in page to either the internal or
the external OTDS user interface. By default, the user name is
“otadmin@otds.admin”.
If you are signing in to the internal OTDS user interface, the password is the one
selected by your administrator during the installation of Content Server.
If you are signing in to the external OTDS user interface, the password is the
one selected by your administrator during the installation of OTDS.
Enter your user name and password, and then click Sign in.
3. You can access the help for OTDS from the OTDS user interface by clicking the
help button at the top right-hand side of the main page.
For more information on OpenText Directory Services, see OpenText Directory
Services - Installation and Administration Guide (OTDS-IWC) on the OpenText
Knowledge Center (https://knowledge.opentext.com/go/OTDS). Select
Documentation.
72.2 Configuring Integration Settings

The Directory Services Integration Settings page in Content Server is used to
configure how users will authenticate with Content Server. Content Server supports
Single Sign On (SSO) and authentication services provided by either an internal or
an external installation of OTDS.
You can configure the following authentication options:
Web Server Authentication

Your Web Server may be configured to authenticate users as they access Content
Server URLs. For example, if you are using Microsoft Internet Information
Services (IIS), your server may be configured to authenticate users with
Integrated Windows Authentication (IWA), in which case IIS will populate the
Web Server environment variable REMOTE_USER with the account name of the
authenticated user. The format of the <username> can be supplied and
configured in the following forms, select the option that corresponds to the
format of users' Log-in names in Content Server.
• Username only
• NT-style username which can also be expressed as DOMAIN\username.
• Resolve through OTDS. The value from REMOTE_USER is sent to OTDS in
order to find the corresponding user name in Content Server. You must
configure OpenText Directory Services. For more information, see OpenText
Directory Services - Installation and Administration Guide (OTDS-IWC).

72.2. Configuring Integration Settings
Note: A Web Access Management authentication handler must be

configured on OTDS in order for this option to work.
Case sensitivity for the <username> can be configured to preserve case or change
case to all lowercase. You may wish to change case to lowercase when you have
a case-sensitive database and synchronization is configured to lowercase.
If Web Server authentication is enabled but user information is not available,
authentication will try OTDS authentication.
OTDS Settings
This section provides Content Server with the information it needs to access
either the internal or the external version of OTDS. All three fields in this section
are required fields.
Content Server's installation will have populated the following three fields:
OTDS Server URL, OTDS Sign In URL, and Resource Identifier.
If you are accessing an external version of OTDS, the Admin must first create a
Content Server resource in OTDS. For more information, see OpenText Directory
Services - Installation and Administration Guide (OTDS-IWC). During the process, a
unique identifier, called the resource ID, is generated. The resource ID and the
OpenText Directory Services server URL are required values, and must be
entered to set up OTDS Authentication in Content Server. For more information
about configuring OpenText Directory Services, see OpenText Directory Services -
72.2.1 To Configure OTDS Integration Settings

To configure Directory Services integration settings:
1. On the Content Server Administration page, in the Directory Services

Integration Administration section, click the Configure Integration Settings
link.
Tip: You can use a shortcut to access this page directly, http://
<fully_qualified_server_name>/<Content Server_service_name>/
cs.exe?func=otdsintegration.settings.
An example of a URL is: http://machine1.opentext.com/OTCS/cs.exe?
func=otdsintegration.settings
2. Optional Select Web Server Authentication to retrieve authenticated user
information directly from your Web Server.
a. In the Environment Variable area, enter the variable used to validate user
credentials or leave the default, REMOTE_USER.
The Environment Variable parameter allows you to choose which variable
to use for determining the user name. By default, this will be set to
REMOTE_USER. Other authentication schemes may set Environment
Variable to a different value, such as Siteminder, which uses the value
HTTP_SM_USER.

b. In the Username Format in Content Server area, select the option that
corresponds to the format of users' Log-in names in Content Server:
• Username Only
• NT-style username
• Resolve through OTDS
c. In the Username Case Sensitivity area, click Preserve Case to preserve the
user name when the user signs in to Content Server or click Lowercase to
change the user name to all lowercase letters when the user signs in to
Content Server.
3. In the OTDS Server URL field, enter the URL of the Directory Services server.
The URL must include the fully-qualified domain and port number of the
Directory Services server. For example, the URL would be one of:
• http://<server_name>:<port_number>
• https://<server_name>:<port_number>
Note: If your Directory Services server has been installed in a cluster, you
must enter the fully-qualified domain and port number of the load
balancer in the OTDS Server URL field.
An example of a valid URL when using an external installation of OTDS is:

http://mymachine.opentext.com:8080
An example of a valid URL when using an internal installation of OTDS is:
http://mymachine.opentext.com:8002
4. In the OTDS Sign In URL field, enter the URL to sign in to OTDS.
For an example of the URL convention, see Step 3.
5. In the Resource Identifier field:
a. If you are using an external installation of OTDS, enter the unique ID that
was generated when you created a synchronized Content Server resource
in Directory Services.
b. If you are using an internal installation of OTDS, Content Server will have
generated the Resource Identifier and it will be present in the field.
6. In the Verify Connections field, click Run Test to confirm that the URL entered
in the OTDS Server URL field is valid.
Note: The connection test does not check whether the OpenText Directory
Server is configured properly with Content Server. It only checks that the
URL provided in the OTDS Server URL field is valid.
7. Click Save.
Note: Do not restart Content Server yet.

8. On the Content Server Administration page, in the Server Configuration

section, select Configure Security Parameters.
9. On the Configure Security Parameters page, in the Trusted Referring Websites

box, ensure that the OTDS Server name from Step 3 is listed.
72.2.2 To Change from an Internal Installation of OTDS to an

External
To change from an internal installation of OTDS to an external:
1. On the Content Server administration page, under the Directory Services

Integration Administration heading, click Configure Integration Settings.
2. On the Directory Services Integration Administration page, in the OTDS

Server URL field, enter the URL for the external installation of OTDS.
3. Click Save.
4. You can optionally choose to delete the internal OTDS process. For more
information, see “To Edit or Delete an Internal OTDS Process” on page 1240.
5. You can optionally choose to migrate users from an internal installation of

OTDS to your new external installation by doing the following:
a. Make sure that you are logged into your system as an administrator. Open
an administrator command window.
b. You must first reset the OpenDJ Directory Manager password that your
internal OTDS installation set for you at installation:
i. Stop the Content Server services.

ii. Change directory to the internal OTDS installation path:
<Content_Server_home>\module\otdsintegration_16_0_0\otds
\install
iii. Type the following command:
java -jar otds-deploy.jar -resetpassword <new_password>

iv. Restart the Content Server services.
c. Make a copy of the config.ldif file from the <Content_Server_home>
\module\otdsintegration_16_0_0\otds >\OpenDJ\config folder.
d. Generate a copy of the otds-16.0.0.ldif file. This file must be generated from
the system on which you run the internal installation of OTDS. This is an
LDIF export of the entire OpenDJ user database. You can use any
Lightweight Directory Access Protocol (LDAP) editor, provided you ensure
that the lines are not broken after a certain number of characters.

e. Open a command window while logged in as an administrator and type

the following command:
export-ldif "--ldifFile" "otds-16.0.0.ldif" "--backendID"

"userRoot" "--appendToLDIF" "--hostName" "localhost" "--
port" "4444" "--bindDN" "cn=Directory Manager" "--
bindPassword" "********" "--trustAll" "--noPropertiesFile"
The export-ldif executable is found:
• on Windows, in the <OpenDJ_installdir>\bat directory.

• on UNIX, in the <OpenDJ_installdir>/bin directory.
Note: The bindPassword is the password that you reset in Step 5.b.
f. You now have two files. One called otds-16.0.0.ldif and one called
config.ldif. Make sure these files are located in a temporary directory on
the system on which you intend to install the external OTDS.
g. When you begin your installation of the external OTDS, follow the
instructions in the installation guide to import users. You will find these
instructions in the “To Import your Data to OTDS 16” section of the
OpenText Directory Services - Installation and Administration Guide (OTDS-
IWC).
72.2.3 To Edit or Delete an Internal OTDS Process

To edit or delete an internal OTDS Process:
1. If you have been using an internal installation of OTDS and you intend
switching to an external installation, you may want to delete the Internal OTDS
process.
2. Login to Content Server as the administrator. From the Content Server

administration page, under the Search Administration heading, click Open the
3. On the System page, click Process Folder.
4. On the Process Folder page, do one of the following:
• If you want to edit the ports that your internal installation of OTDS is using:
1. From the Internal OTDS functions menu, select Stop.
2. Now, also from the Internal OTDS functions menu, select Specific from
the General menu.
3. On the Internal OTDS page, you can optionally change any of the port
fields. OpenText recommends that you do not edit any fields, other than
the port fields, unless directed by OpenText support.
4. Click Update.
5. On the Process Folder page, from the Internal OTDS functions menu,
select Start.

• If you want to delete your internal OTDS process, from the Internal OTDS
functions menu, select Delete. Confirm that you want to delete this process.

Part 18
ActiveView Administration
Chapter 73
Important ActiveView Development Information
Although it is governed by Content Server permissions and security settings,

ActiveView users can potentially create custom ActiveView templates that violate
security guidelines for web applications, such as including JavaScript that allows
XSS attacks. Given this, ActiveView should be considered a development tool,
ActiveView creators should be treated as developers, and ActiveView development
should be subject to any relevant company security policies. Some recommended
practices include the following:
• Give ActiveView template-editing privileges to approved users only.
• Be aware of which users have privileges to create and edit ActiveView templates.
• Set up a process to peer-review ActiveView templates versions before they go
into production.

Chapter 74
Template Upgrades
This page is used to identify and update ActiveView templates using out-of-date
syntax.
The page contains a list of upgrade options.

• Select one or more of the check boxes to select which upgrades to apply to your
ActiveView templates.
• To view which templates will be affected by the upgrade(s), click List
Candidates.
• To apply the upgrade(s), click Execute Upgrade.

Chapter 75
Administering ActiveView Login Users
The selected user will be used as the context for running the ActiveView as the
Login Page override occurs before a user has logged in. The selected user will also
require the proper permissions for the ActiveView selected for the Login Page
override, otherwise the standard Content Serverlogin page will be displayed. If no
user is specified, then the standard Content Server login page will be displayed.
To specify a user for this override, simply choose a user, click Apply and then restart
the Content Server service. Whenever this setting is changed, a service restart is
required for the change to take place. Click Clear to delete any saved user and force
the login page to display the standard Content Server login page regardless of an
ActiveView override being set for the login page.

Chapter 76
Allowing AVID In URL
If &AVID;=<ActiveView ID>is used in a URL then it will force the destination page
to use the ActiveView template corresponding to the AVID value, if it exists. &AVID;
=0 can be used to prevent an ActiveView from being run and is supported in the
URL and in a cookie.
This administration page allows administrators to set whether &AVID; is allowed to

dynamically change ActiveViews, which by default it is. To stop &AVID;= from
working, clear the Allow AVID In URL check box.
This page also allows administrators to set whether &AVID;=0 is allowed to disable
ActiveViews. To stop &AVID;=0 from working, clear the Allow AVID=0 In URL
check box. This option is also selected by default but it is affected by the Allow
AVID=0 In URL Admin Only option below.
If the Allow AVID=0 In URL check box is selected it can be restricted to only work
for Administrative users by ticking the Allow AVID=0 In URL Admin Only check
box.
To restrict the use of browser cookies to set the AVID to 0, clear the Allow AVID=0
In Cookies check box. This option is selected by default.

Chapter 77
Managing ActiveView Templates and Override
Types
Each part of Content Server that can be modified is called an Override Component. In
order to use an ActiveView override or perspective on an override component, an
administrator must first enable that override component.
Important
Although it is governed by Content Server permissions and security settings,
ActiveView users can potentially create custom ActiveView templates that
violate security guidelines for web applications, such as including JavaScript
that allows XSS attacks. Given this, ActiveView should be considered a
development tool, ActiveView creators should be treated as developers, and
ActiveView development should be subject to any relevant company security
policies. Some recommended practices include the following:
• Give ActiveView template-editing privileges to approved users only.
• Be aware of which users have privileges to create and edit ActiveView
templates.
• Set up a process to peer-review ActiveView templates versions before
they go into production.
77.1 Enabling or Disabling an Override Component

Only an administrator can enable an override component on the Content Server
Administration > ActiveView Administration > Enable or Disable ActiveView
Override Types page.
On the Enable or Disable ActiveView Override Types page, selecting or clearing

the Enable Globally check box allows you to enable or disable all ActiveView
overrides or perspectives for a given server. Additionally, this page allows you to
enable or disable specify override component types.
Note: Any changes made on this page will require a restart of the Content
Server service before they take effect.

Chapter 77 Managing ActiveView Templates and Override Types
77.1.1 To Enable or Disable ActiveView Override Types

To enable or disable ActiveView Override Types:
1. As Administrator, sign in to Content Server.
2. From the Global menu bar, click Admin > Content Server Administration >
ActiveView Administration > Enable or Disable ActiveView Override Types.
3. On the Enable or Disable ActiveView Override Types page, select the check
box to enable the individual override type.
4. Optional Select the Select/Deselect All check box to select or clear all of the check
boxes on the page.
• To save the changes, click Apply. Then click Restart to restart Content
• To discard any changes, click Reset.

Chapter 78
Managing ActiveView Overrides
As administrator, you can manage ActiveView overrides with the following

procedures:
• “Converting ActiveView Overrides that use Appearance” on page 1255
• “Enabling or Disabling ActiveView Override Types” on page 1256
• “Enabling or Disabling ActiveView Templates” on page 1257
• “Managing Global ActiveView Overrides” on page 1258
78.1 Converting ActiveView Overrides that use

Appearance
Versions of ActiveView prior to ActiveView 10.1.0 only allowed ActiveView
overrides to be applied through Appearances. From ActiveView 10.1.0 new
functionality has been added which allows ActiveView overrides to be applied
globally via the Manage Global ActiveView Overrides page, or applied directly to
nodes via the ActiveView tab on the node's Properties page.
This administration page allows administrators to convert ActiveView overrides

applied through Appearances to use the new method that uses the ActiveView tab
in Properties. The page will list any ActiveView overrides which are contained
within Appearances, with the exception of ActiveView overrides used by
Appearance Headers or Footers, which cannot be converted.
Use the check boxes in the Select column to select ActiveView overrides to be
converted. Any ActiveView overrides contained within enabled Appearances will be
selected by default. Use the Select/Deselect All check box to select or clear all of the
check boxes.
Use the drop-down lists in the Priority column to select a Priority value for the
ActiveView override.
Overrides can be given one of five Priority values:

• Global (available for global overrides only)
• Priority (available for local overrides only)
• High
• Medium
• Low
If a node has more than one ActiveView template applied to an override type then
the one with the highest priority will be used.If there is more than one ActiveView

Chapter 78 Managing ActiveView Overrides
template applied to an override type with the same priority then the first one from
the lowest level of the node hierarchy that matches the expression logic will be
used.For example, if a node has an ActiveView Folder Browse override applied to it
that has the same priority value as an ancestor node which has a cascading
ActiveView override applied to it, or a Global ActiveView override, then the
ActiveView override applied to the node will be used.'Global' is the highest priority
that can be set for a global override. It can be overridden by the higher 'Priority'
value that can be set against local overrides.
Click on the Convert button to convert the selected overrides. Conversion will delete
the selected ActiveView overrides from the Appearances they are contained in, and
recreate them using the new method. ActiveView overrides contained in Global
Appearances will be applied globally. Overrides contained in local Appearances will
be applied to the nodes that the Appearances are contained in, with the same
Cascade settings that the Appearances use. The page will refresh and display any
overrides that are left, with a message indicating whether the conversion was
successful or not.
78.2 Enabling or Disabling ActiveView Override Types

An administrator can individually control which ActiveView override types are
enabled. Customers who have customized their Content Server installations in a
way that affect one or more of the containers on which ActiveView overrides may
affect, may want to disable the corresponding ActiveView override type to avoid a
clash.
Note: Any changes made on this page will require a restart of the Content
Server service before they take effect.
78.2.1 To Enable or Disable ActiveView Override Types

To enable or disable ActiveView Override Types:
ActiveView Administration > Enable or Disable ActiveView Override Types.
3. On the Enable or Disable ActiveView Override Types page, select the check
box to enable the individual override type.
4. Optional Select the Select/Deselect All check box to select or clear all of the check
boxes on the page.
• To save the changes, click Apply. Then click Restart to restart Content

78.3. Enabling or Disabling ActiveView Templates
78.3 Enabling or Disabling ActiveView Templates

An administrator can enable or disable individual ActiveView template within
Content Server.
This function is particularly useful if you accidentally apply an ActiveView override

where the template lacks basic container controls and thereby prevents you from
accessing the Appearance or ActiveView templates themselves to turn it off.
Note: Changes will take place immediately, it is not necessary to restart the
Content Server services.
78.3.1 To Enable or Disable ActiveView Templates

To Enable or Disable ActiveView Templates:
ActiveView Administration > Enable or Disable ActiveView Templates.
3. On the Enable or Disable ActiveView Templates page, select the check box to
enable the individual ActiveView template.
Note: The list will sort the ActiveView templates in alphabetical order.
• To save the changes, click Apply.

78.4 Viewing All Local and Global ActiveView

Overrides
The View All ActiveView Overrides page lists all the ActiveView overrides in
affect both locally and globally in the system. To open the View All ActiveView
Overrides page, from the Content Server Administration > ActiveView
Administration page, click the View All ActiveView Overrides link.
The page groups the overrides by their Type, such as Folder Browse, Add Item
Menu, or Request, and lists them in alphabetic order of their override type, showing
the following relevant information:
Name Description
Type The container type for the override.

Node Override The node to which the ActiveView override is applied. This shows
Applied To inherited overrides as well as overrides applied directly to the current
node.
Note: To see the local overrides that apply to a listed node, click the
Overrides link to see the Override Summary tab for that node.
ActiveView Name of the associated ActiveView template used by the override.
Template
ActiveView Lists the rules or logical expressions defined for the override that
Expression ActiveView evaluates to determine if this override should be applied.
ActiveView The priority value combines with Rules and Cascade value to determine if
Priority the ActiveView override will be executed. The priority values include the
following:
• Priority
• High
• Medium
• Low
ActiveView The cascade value determines whether the override applies to child nodes.
Cascade Value The cascade values include the following:
• Cascading
• Non-Cascading
• Cascade to Contents
• Cascade to Level Below Only
• Cascade to Level All Below Only
For more information about override cascade values, see “Understanding

Cascade Options for an Override” on page 1260.
For information about how to create a local perspective, see Customizing Content
Server Using ActiveView in the Content Server User Help.
For information about how to create a global perspective, see “To Create a Global
Perspective” on page 1266.
78.5 Managing Global ActiveView Overrides

The Manage Global ActiveView Overrides page allows an adminstrator to apply
ActiveView overrides globally. Global overrides will be used throughout the system
unless a local override takes precedence. Provided that a user has See Contents
permission on the ActiveView template, they will see the new tailored view when
they next open the item to which the ActiveView override is applied. Should a user
find that they are still receiving the standard browse view, they should ask their
administrator to check the ActiveView Administration page settings to ensure that
ActiveView overrides are enabled and that the template for that container type is
also enabled.

78.5. Managing Global ActiveView Overrides
Notes
• Different ActiveView overrides can be applied to the different container

types if desired. If an ActiveView override is not applied, then the standard
browse view for that container will be used.
•
The green exclamation icon indicates that the ActiveView override type is
not enabled on the Content Server. For information about how to enable
override types, see “Enabling or Disabling ActiveView Override Types”
on page 1256.
ActiveView overrides include the following metadata:
Override Fields
Field Name Description

Override Type Mandatory. Describes the type of override that is applied.
Notes
• Different overrides can be applied to the different container types.
• If evaluates the rule and does not apply the override, then the
standard browse view for that container will appear.
•
The Feature Disabled icon indicates that the override type

is not enabled in that Content Server instance. An administrator
can enable the features from the Content Server Administration
pages, in the Administration section, by clicking the Enable or
Disable Override Types link.
Priority Mandatory.The priority value combines with Rules and Cascade value to
determine if the ActiveView override will be executed. Local overrides
can be given one of four priority values:
• Priority
• High
• Medium
• Low
Cascade Value Not applicable for Global overrides. Mandatory for local overrides. The
cascade value determines whether the override applies to child nodes.
Local overrides can be given one of five cascade values:
• Cascading
• Non-Cascading
For more information about cascade values, see “Understanding Cascade

Options for an Override” on page 1260.

Rule Optional. The Rule column allows you to define a rule or conditional logic
that ActiveView must evaluate before applying the override.
For example, if the override includes the following rule:
"SpecialFolder" IN "[LL_REPTAG_&ObjID NODEINFO:NAME /"
then ActiveView will only apply the override to nodes which have
“SpecialFolder” in the name.
Notes
• To expand the input box. click the Resize Logic Entry Field
icon.
• To open the expression editor in a separate window, click the
Open Logic Editor Window icon .
ActiveView Mandatory. The ActiveView Template column shows the path to the
Template ActiveView template currently used for the override. You can change the
template.
Note: To browse Content Server and select a different ActiveView

template, click Browse.
78.5.1 Understanding Cascade Options for an Override

Cascade settings only apply to local overrides, since global overrides apply to the
whole system and therefore do not cascade. The cascade setting determines whether
the effects of a local override will propagate to the selected container and the
descendants of the container.
• Non-Cascading
Only affects the container to which the override is applied. No descendant
objects are affected.
• Cascading
Affects the container to which the override is applied as well as all descendant
objects.
• Cascade to contents
Affects the container to which the override is applied as well as the immediate
contents of the container, but none of the descendants of the container.
Note: Overrides do not apply to any browse actions since a browse would
open a descendant level of the container.
• Cascade to level below only
Affects the immediate children of the container, but not the container itself or any
of the descendants of the container. This is useful when an override needs to be
applied to multiple containers without changing the top level container itself.
• Cascade to all levels below only

Affects all the children and levels below the container, but not the container itself.
This is useful when you need to apply a override to an entire branch of the
content hierarchy without changing the top level container itself.
78.5.2 Creating a Global ActiveView Override

You can set global overrides from the Content Server Administration page, in the
ActiveView Administration section, on the Manage Global ActiveView Overrides
page. The parameters on the Manage Global ActiveView Overrides page are
similar to those described for the Manage The Node’s ActiveView Overrides
secondary tab, with the following exceptions:
• Cascade value is enabled, by default, for all overrides.

• Global priority values differ from the local priority values as follows:
Global Priority Local Priority

Global Priority
High High
Medium Medium
Low Low
Notes
• The High, Medium, or Low priority values apply throughout the system
unless a local override has a higher priority. For more information about
local priority values, see “Override Fields” on page 1259
• Subject to how ActiveView evaluates the associated rule, you should
generally use the Global priority value to implement an override across
the system. The Global priority will ensure that ActiveView always
evaluates a global override first for every object in the system.
• The exception to the Global priority is any object has a local priority of
Priority
Global Override Categories
Section Name Description

Browse These overrides apply when browsing a container object. Several
Overrides overrides are available and are separated by container subtype.
Personal Report These overrides apply when accessing your Personal menu links in the
Overrrides Global menu, such as Personal Favorites page, Personal Project page, etc.
Miscellaneous These overrides apply to various components that do not fall into the
Component Browse Overrides category or the Personal Report Overrides category,
Modifications such as Add Item menu, Add Item page, Document Overview page,
Promoted Commands, Global menu, and so on.

Property Tab These overrides apply to the Properties tabs, such as the General tab, the
Overrides Specific tab, the Category tab, and so on.
Generic Request These are customized overrides that apply to any requests that match the
Handlers pattern value entered.
To Create a Global ActiveView Override

To create a global override from the Manage Global ActiveView Overrides
page:
ActiveView Administration > Manage Global ActiveView Overrides.
3. On the Manage Global ActiveView Overrides page, click Expand this section
to expand the override category that you want as described in “Global
Override Categories” on page 1261.
4. On the row for the component to which you want to apply the override,
provide parameters as described in “Override Fields” on page 1259.
To Do this
Add a rule Click Add Row .

below the
current one Important
• ActiveView evaluates the rules for each perspective in
top-to-bottom order.
• To add new new rule in the topmost position, you will
need to add a new row and then drag it to the topmost
position.
Add a rule in Create a new rule and then drag it to the top position. For more
the top position information, see ??? on page 1263.
Remove a rule On the row for the rule that you want to delete, click Delete Row .
from the
perspective Note: You cannot delete the topmost override in a perspective.
Clear the On the row for the rule that you want clear, click Clear to restore all
parameters for a parameters to their default values.
rule • Priority – “Global” for a global override. “High” for a local
override.
• Cascade – “Non-Cascading” for a local override. Not applicable
to global overrides.
• Rules – Blank.
• ActiveView Template – Blank.

Reorder the Cick the Drag handle ( ↕) on each row and drag the rule to change
rules the order in which they appear and will be evaluated.
• To save the changes and return to the Content Server Administration page,
click Update.
• To save the changes and stay on the Manage Global ActiveView Overrides
page, click Apply.
• To discard any changes and return to the Content Server Administration
page, click Cancel.
78.5.3 Viewing All Local and Global ActiveView Overrides

The View ActiveView Overrides tab shows details of all ActiveView overrides
applied throughout the system. Click the Add/Edit Global ActiveView Overrides
link to make changes to global ActiveView overrides.

Chapter 79
Managing Perspectives
A perspective allows you to customize the appearance and layout of the new Smart
View of the Content Server user interface. A local perspective can affect specific
containers in the Smart View, based on container type, ancestry, and other custom
rules. A perspective is an extension to an ActiveView override, such that an
ActiveView override controls the Classic View of the Content Server user interface
while a perspective controls the layout of the new Smart View Content Server user
interface.
For more information about how to work with overrides, see Customizing Content
Server Using ActiveView
A global perspective affects the Smart View of the entire Content Server system,
applying to all containers and child objects. Only an administrator can create a
global perspective. Certain components such as the Landing Page can only be
customized using a Global perspective.
79.1 Working in the Perspectives Volume

Installation of the ActiveView module automatically creates the Perspectives
Volume, which is accessible from a link on the ActiveView Administration page.
The Perspective Manager tool always creates both new local perspectives and new
global perspectives in this volume.
Note: When manually creating a perspective, using the Manage Perspectives

tab, you can choose to create the perspective in the Perspectives volume or in
any other location in Content Server.
79.2 Creating a Global Perspective

As administrator, you can create a global perspective from the Content Server
Administration page or by using the Perspective Manager tool. You will need to
enable at least one of the following prerequisites:
• Enable the Container Perspectives Override
• Enable the Landing Page Perspectives Override
Important
Before you can create a global perspective, you must first enable the
component to which you want to apply the perspective. On the Manage

Chapter 79 Managing Perspectives
Perspectives page, the green exclamation icon indicates that the

ActiveView override type is not enabled on the Content Server. For
information about how to enable override types, see “Enabling or Disabling
ActiveView Override Types” on page 1256.
For information about how to create a global perspective using the Perspective
Manager tool, see the Online Help available from the Perspective Manager tool.
79.2.1 To Create a Global Perspective

To create a global perspective from the Manage Global Perspectives page:
ActiveView Administration > Manage Global Perspectives.
3. On the Manage Global Perspectives page, click Expand this section to

expand the override category that you want as described in “Global Override
Categories” on page 1261.
4. On the row for the component to which you want to apply the perspective,
provide parameters as described in “Override Fields” on page 1259.
To Do this
Add a rule Click Add Row .

below the
current one Important
• ActiveView evaluates the rules for each perspective in
top-to-bottom order.
• To add new new rule in the topmost position, you will
need to add a row below the topmost row, then drag the
row to the top position.
Add a rule in Create a new rule and then drag it to the top position. For more
the top position information, see ??? on page 1263.
Remove a rule On the row for the rule that you want to delete, click Delete Row .
from the
perspective Note: You cannot delete the topmost override in a perspective.

79.3. Viewing All Local and Global Perspectives
Clear the On the row for the rule that you want clear, click Clear to restore all
parameters for a parameters to their default values.
rule • Priority – “Global” for a global perspective. “High” for a local
perspective.
• Cascade – “Non-Cascading” for a local perspective. Not
applicable to global perspectives.
• Rules – Blank.
• ActiveView Template – Blank.
Reorder the Cick the Drag ↕handle on each row and drag the rule to change the
rules order in which they appear and will be evaluated.
• To save the changes and return to the Content Server Administration page,
click Update.
• To save the changes and stay on the Manage Global Perspectives page, click
Apply.
• To discard any changes and return to the Content Server Administration
page, click Cancel.
79.3 Viewing All Local and Global Perspectives

The View All Perspectives page lists all the perspectives in affect both locally and
globally in the system. To open the View All Perspectives page, from the Content
Server Administration > ActiveView Administration page, click the View All
Perspectives link.
The page groups the perspectives by their priority, listing Global priority at the top
and Low priority at the bottom, and shows the following relevant information:
Name Description
Type The type of the perspective.
Perspective The node to which the perspective is applied. This shows inherited
Applied To perspectives as well as perspectives applied directly to the current node.
Note: To see the local perspectives that apply to the listed node,
click the Perspectives link to see the Perspective Summary tab for
that node.
ActiveView Name of the associated ActiveView template used by the perspective.
Template
ActiveView Lists the rules or logical expressions defined for the perspective that
Expression ActiveView evaluates to determine if this perspective should be applied.

Chapter 79 Managing Perspectives
ActiveView The priority value combines with Rules and Cascade value to determine if
Priority the perspective will be executed. The priority values include the
following:
• Priority
• High
• Medium
• Low
ActiveView The cascade value determines whether the perspective applies to child
Cascade Value nodes. The cascade values include the following:
• Cascading
• Non-Cascading
For information about how to create a global perspective, see “To Create a Global
Perspective” on page 1266.
79.4 Using the Perspective Manager Tool

The Perspective Manager tool guides you through the process of creating and
editing a perspective by configuring settings on various tabs.
You can launch the Perspective Manager by navigating to the Admin > Content
Server Administration > ActiveView Administration page and clicking the Open
the Perspective Manager link.
For information about how to work with perspectives, see the ActiveView User Help.
For information about how to use the Perspective Manager tool, see the Online Help
available in the Perspective Manager.

Part 19
Transport Administration
Chapter 80
Configuring Transport Warehouse Settings
The Transport feature allows you to move objects to different instances of Content
Server. Transport has a dedicated workspace in Content Server called the Transport
Warehouse. By default, the Administrator is the only user that can access the
Transport Warehouse, but you can change permissions so other users can perform
the tasks associated with Transport.
For more detailed information about Transport features and user roles, see OpenText
Content Server User Online Help - Working with Transport (LLESTRP-H-UGD).
Transport Roles and Object Permissions

Transport functionality is role-based, which means the features and functions
available to users depend on the role they are assigned. Content Server has a
designated Warehouse Manager group. Users must be members of the Warehouse
Manager group to work with and have access to the Transport Warehouse. The
Administrator can add users to this group by editing the Warehouse
Administration Usage Privilege, which appears on the Object and Usage Privilege
administration page. For more information about Object and Usage privileges in
Content Server, see “Administering Object and Usage Privileges“ on page 327.
Warehouse Managers are designated by the Administrator as users who have full
access to the Transport Warehouse. To designate a Warehouse Manager, you must
add the user to the Warehouse Manager group and change the permissions on the
Transport Warehouse object. Warehouse Managers should have a minimum of See/
See Contents and Modify permissions; however, granting full permissions will allow
them to perform all the necessary tasks associated with the Transport Warehouse. If
you want Warehouse Managers to be able to modify the Object and Usage
privileges, you can give them system administration rights. For more information,
see “Administering Permissions“ on page 21.
The following object types are specific to Transport. By default, the privileges for
these objects are not restricted, which means users can create them.
• Transport Item
• Workbench
• Warehouse Folder
• Transport Package
Note: By default, user access to Transport objects is not restricted. For more
information about Object and Usage privileges in Content Server, see

Chapter 80 Configuring Transport Warehouse Settings
The number of objects users can add to the Transport Warehouse at one time
depends on the Warehouse Setting specified on the Administration page. By default,
the maximum number of items user can add to the Warehouse at one time is 100.
80.1 To Configure Warehouse Settings

To configure Warehouse settings:
1. In the Warehouse Administration section of the Content Server administration

page, click the Warehouse Settings link.
2. On the Configure Warehouse Settings page, type the maximum number of

items allowed in a Warehouse in the Add to Warehouse Limit field, and then
click Update.
80.2 To Designate a Warehouse Manager

To designate a Warehouse Manager:
1. Click the Administer Object and Usage Privileges link in the System
2. In the Usage Privileges section of the Administer Object and Usage Privileges
page, click the Edit Restrictions link for the Warehouse Administration usage
type.
3. On the Edit Group page, search for the users or groups you want to add to the
Warehouse Manager group, click the Add to group check box, and then click
Submit.
4. In the Modify Group area, click Done.
5. Click Transport Warehouse on the Enterprise menu.
6. Click the Transport Warehouse Functions menu, and then choose Permissions.
7. In the Assigned Access section on the Permissions page, click the Grant Access
button.
8. Click the Find button, navigate to the user you are designating as the
Warehouse Manager, select the Grant Access check box in the Actions column,
and then click Submit.
9. In the Access section, select the check box for each permission you want to grant
the user.
10. In the Apply To section, select This Item and Sub-Items, and then click
Update.
11. In the user access area, click Done.

80.3. To Provide Users Access to the Transport Warehouse
Tip: To remove access from specific users or groups, click the user or group
link on the Edit Group page, and then click Remove From Group.
80.3 To Provide Users Access to the Transport

Warehouse
To provide users access to the Transport Warehouse:
2. In the Usage Privileges section of the Administer Object and Usage Privileges
page, click the Edit Restrictions link for the Warehouse Administration usage
type.
3. On the Edit Group page, search for the users or groups you want to add to the
Warehouse Manager group, click the Add to group check box, and then click
Submit.
4. In the Modify Group area, click Done.
Tip: To remove access from specific users or groups, click the user or group
link on the Edit Group page, and then click Remove From Group.
80.4 To Restrict User Access to Transport Objects

To restrict user access to Transport objects:
2. In the Object Privileges section of the Administer Object and Usage Privileges
page, click the Restrict link

Content Server Opentext

Diunggah oleh

Informasi Dokumen

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

Content Server Opentext

Diunggah oleh

Hak Cipta:

Format Tersedia

OpenText™ Content Server

Admin Online Help Collection

This document is a collection of the OpenText Content Server

40 Avenue Monterey , Luxembourg, Luxembourg L-2163

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

No Warranties and Limitation of Liability

1 Accessing the Content Server Administration Page ........... 17

2 Administering Permissions .................................................... 21

Part 2 Server Configuration 29

3 Configuring General Environment Settings .......................... 31

4 Configuring and Customizing Faceted Browsing ................ 49

5 Configuring Virtual Folders .................................................... 69

6 Configuring Server Parameters and Settings ....................... 71

OpenText Content Server – Admin Online Help Collection iii

7 Understanding the opentext.ini File ...................................... 91

8 Administering MIME Types and Icons ................................. 221

9 Managing the Servers in Content Server ............................ 227

10 Managing Licenses in Content Server ................................ 233

Part 3 System Administration 239

11 Managing UI Languages ....................................................... 241

12 Working with Multilingual Metadata .................................... 247

13 Working with Memcache ....................................................... 249

14 Configuring Rendering Settings .......................................... 251

15 Working with the Distributed Agent .................................... 253

Part 4 Database Administration 261

16 Changing Your Content Server Database ........................... 263

iv OpenText Content Server – Admin Online Help Collection

16.1 Deselecting Your Current Database ............................................... 264

17 Maintaining an Existing Database ....................................... 283

18 Administering Blob Deletion Failures ................................. 301

19 Administering Event Auditing .............................................. 303

20 Administering Item Control .................................................. 323

21 Administering Modified Date Trigger .................................. 325

22 Administering Object and Usage Privileges ....................... 327

23 Configuring Access Control ................................................. 345

24 Working with Copy and Delete Item Operations ................ 347

Part 5 Item Administration 349

25 Storage Providers and Storage Management ..................... 351

OpenText Content Server – Admin Online Help Collection v

25.3 Configuring Storage Rules ............................................................. 355

26 Recycle Bin Administration .................................................. 371

Part 6 Module Administration 377

27 Administering Modules ......................................................... 379

Part 7 User Setting Administration 389

28 Administering Users and Groups ........................................ 391

29 Administering Domains ........................................................ 397

Part 8 Search and Collaboration Administration 403

30 Administering Search ........................................................... 405

vi OpenText Content Server – Admin Online Help Collection

31 Administering Prospectors .................................................. 793

32 Administering Recommender .............................................. 797

33 Administering eLink .............................................................. 821

34 Working with Notifications ................................................... 831

35 Administering Pulse .............................................................. 845

36 Configuring Collaboration Settings ..................................... 857

37 Content Server Collaboration Widget Configuration ......... 869

Part 9 Document Administration 873

38 Working with Item Templates ............................................... 875

39 Configuring Web Edit Settings ............................................. 879

OpenText Content Server – Admin Online Help Collection vii

40 Administering and Configuring Renditions ........................ 885

41 Administering Collections .................................................... 895

42 Administering the Multi-File Output Module ....................... 905