OpenText Archive Server 10.5 SP1 - Administration Guide English (AR100500-01-ACN-En-04)

OpenText™ Archive Server
Administration Guide
The guide describes the administration, monitoring and

maintenance of OpenText Archive Server and introduces
guidelines for troubleshooting.
AR100500-01-ACN-EN-04
OpenText™ Archive Server
Administration Guide
AR100500-01-ACN-EN-04
Rev.: 2017-June-23
This documentation has been created for software version 10.5 SP1.
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 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: https://support.opentext.com
For more information, visit https://www.opentext.com
Copyright © 2017 Open Text. All Rights Reserved.

Trademarks owned by Open Text.
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
List of tables xix
List of figures xxi
PRE Introduction xxiii

i About this document ...................................................................... xxiii
ii What’s new? ................................................................................. xxiv
Part 1 Overview 25
1 Archive Server ......................................................................... 27

1.1 Basic features of Archive Server ...................................................... 27
1.2 Flexibility for different business processes ........................................ 27
1.3 Main components of Archive Server ................................................. 28
1.4 Important directories on Archive Server ............................................ 29
2 Basic principles of archives ................................................... 31

2.1 Documents, data, and logical archives .............................................. 31
2.2 Content capture and storage ............................................................ 31
2.3 Content retrieval ............................................................................. 33
2.4 Logical archives .............................................................................. 34
2.4.1 Disk buffers .................................................................................... 36
2.4.2 Storage devices .............................................................................. 36
2.4.3 Storage scenarios ........................................................................... 37
2.4.4 Pools and pool types ....................................................................... 38
2.4.5 Caches ........................................................................................... 39
2.5 Jobs ............................................................................................... 40
3 Administration Client and the main objects of the

Archive Server node ................................................................ 41
3.1 Administration Client ....................................................................... 41
3.2 Main objects of the Archive Server node ......................................... 41
3.2.1 Infrastructure ................................................................................ 42
3.2.2 Archives ........................................................................................ 43
3.2.3 Environment .................................................................................. 43
3.2.4 System .......................................................................................... 43
3.2.5 Configuration ................................................................................ 44
OpenText Archive Server – Administration Guide iii

AR100500-01-ACN-EN-04
Table of Contents
Part 2 Archive Center scenario 47
4 Understanding Archive Center ............................................... 49
5 What happens on Archive Server? ........................................ 51

5.1 SAP ArchiveLink scenario ................................................................ 53
5.2 Additional information for Email Cloud Archiving ................................ 53
6 Tasks remaining for the Archive Server administrator ........ 55

6.1 Additional tasks for Email Cloud Archiving ........................................ 55
6.2 Enabling transaction logs ................................................................. 56
7 Configuring accounting and statistics .................................. 57

7.1 Generating accounting information ................................................... 58
7.2 Collecting billing information ............................................................ 59
8 Configuring miscellaneous Archive Center options ............ 61
9 Working with Archive Center Access .................................... 63
10 Troubleshooting Email Cloud Archiving ............................... 65

10.1 Logging .......................................................................................... 65
10.2 Monitoring the Email Archiving Services ........................................... 66
10.3 Avoiding out of memory errors ......................................................... 67
Part 3 Configuration 69
11 Setting up the infrastructure .................................................. 71

11.1 Installing and configuring storage devices ......................................... 71
11.1.1 Adding a write at-once (STORM) device ........................................... 73
11.1.1.1 Compliant file systems (STORM) ..................................................... 74
11.1.1.2 EMC Centera (STORM) ................................................................... 76
11.1.1.3 IBM TSM SSAM (STORM) ............................................................... 76
11.1.1.4 HDS HCP (STORM) ........................................................................ 77
11.1.2 Configuring STORM storage devices ................................................ 78
11.1.2.1 Attaching and detaching devices ...................................................... 78
11.1.2.2 Initializing storage volumes .............................................................. 78
11.1.3 Adding a single file (VI) device ......................................................... 79
11.1.3.1 Amazon S3 ..................................................................................... 79
11.1.3.2 Windows Azure ............................................................................... 80
11.1.3.3 EMC Centera (single file) ................................................................. 82
11.1.3.4 IBM TSM SSAM (single file) ............................................................. 83
11.1.3.5 HDS HCP (single file) ...................................................................... 84
11.2 Configuring disk volumes ................................................................. 85
iv OpenText Archive Server – Administration Guide

AR100500-01-ACN-EN-04
Table of Contents
11.2.1 Creating and modifying disk volumes ............................................... 86

11.2.2 Configuring a volume for single-file storage ....................................... 87
11.3 Configuring buffers .......................................................................... 88
11.3.1 Creating and modifying a disk buffer ................................................. 88
11.3.2 Attaching a disk volume to a disk buffer ............................................ 89
11.3.3 Detaching a volume from a disk buffer .............................................. 90
11.3.4 Configuring the Purge Buffer job ...................................................... 90
11.3.5 Checking and modifying attached disk volumes ................................ 91
11.3.6 Synchronizing servers ..................................................................... 92
11.3.7 Configuring replicated buffers .......................................................... 93
11.4 Configuring caches ......................................................................... 93
11.4.1 Overview ........................................................................................ 93
11.4.2 Creating and deleting caches ........................................................... 95
11.4.3 Adding hard-disk volumes to caches ................................................ 95
11.4.4 Deleting assigned hard-disk volumes ............................................... 96
11.4.5 Defining priorities of cache volumes ................................................. 96
11.5 Checking unavailable volumes ......................................................... 97
11.6 Changing the database user password ............................................. 97
11.7 Setting the reconnection time for the database .................................. 98
12 Configuring archives and pools ............................................. 99

12.1 Logical archives .............................................................................. 99
12.1.1 Data compression ......................................................................... 100
12.1.2 Single instance ............................................................................. 101
12.1.3 Retention ...................................................................................... 103
12.1.3.1 Basics – retention on Archive Server .............................................. 103
12.1.3.2 Retention on storage systems ........................................................ 106
12.1.3.3 Document deletion ........................................................................ 107
12.1.3.4 VolumeMigration and Retention ................................................... 110
12.2 Creating and configuring logical archives ........................................ 111
12.2.1 Creating a logical archive ............................................................... 111
12.2.2 Configuring the archive security settings ......................................... 112
12.2.3 Configuring the archive settings ..................................................... 113
12.2.4 Configuring the archive retention settings ....................................... 114
12.2.5 Activating and configuring timestamp usage ................................... 116
12.3 Creating and modifying pools ......................................................... 117
12.3.1 Creating and modifying a HDSK (write-through) pool ....................... 118
12.3.2 Creating and modifying pools with a buffer ...................................... 119
12.3.2.1 Write at once (ISO) pool settings .................................................... 120
12.3.2.2 Single file (VI, FS) pool settings ..................................................... 121
12.3.3 Marking the pool as default ............................................................ 122
12.3.4 Creating and configuring shadow pools .......................................... 122
OpenText Archive Server – Administration Guide v

AR100500-01-ACN-EN-04
Table of Contents
12.3.4.1 Single file (FS) shadow pool .......................................................... 126

12.3.4.2 Write at-once (ISO) shadow pool .................................................... 127
12.3.4.3 Single file (VI) shadow pool ............................................................ 129
12.3.5 Creating copy orders for shadow pools ........................................... 130
12.3.5.1 Creating copy orders when defining new shadow pools ................... 131
12.3.5.2 Creating copy orders when attaching a volume to an original pool .... 132
12.3.6 Handling shadow copy errors ......................................................... 132
12.3.6.1 Report of shadow copy errors ........................................................ 133
12.3.6.2 Clearing shadow copy errors .......................................................... 133
12.3.7 Recovering original pool data from a shadow pool ........................... 135
12.4 Creating and modifying storage tiers .............................................. 137
12.5 Enabling certificates ...................................................................... 138
12.6 Changing the server priorities ........................................................ 139
13 Configuring jobs and checking job protocol ...................... 141

13.1 Important jobs and commands ....................................................... 141
13.1.1 Configuring security settings for pagelist job ............................... 145
13.2 Starting and stopping the scheduler ................................................ 145
13.3 Starting and stopping jobs ............................................................. 146
13.4 Enabling and disabling jobs ........................................................... 146
13.5 Checking settings of jobs ............................................................... 146
13.6 Creating and modifying jobs ........................................................... 147
13.7 Setting the start mode and scheduling of jobs ................................. 148
13.8 Checking the execution of jobs ....................................................... 149
14 Configuring security settings ............................................... 151

14.1 Overview ...................................................................................... 151
14.2 Authentication using signed URLs .................................................. 152
14.2.1 Activating secKey usage for a logical archive .................................. 153
14.2.2 secKeys from leading applications and components ........................ 153
14.2.3 secKeys from SAP ........................................................................ 154
14.3 Encrypted document storage ......................................................... 155
14.3.1 Activating encryption usage for a logical archive .............................. 156
14.3.2 Creating a system key for document encryption .............................. 156
14.3.3 Exporting and importing system keys ............................................. 158
14.4 Timestamps .................................................................................. 160
14.4.1 Basic timestamp settings ............................................................... 162
14.4.2 Configuring connection parameters ................................................ 163
14.4.2.1 timeproof TSS80 ........................................................................... 164
14.4.2.2 AuthentiDate over the Internet ....................................................... 165
14.4.2.3 Quovadis ...................................................................................... 165
14.4.2.4 Keyon true-Sign ............................................................................ 166
14.4.3 Configuring certificates and signature keys ..................................... 167
vi OpenText Archive Server – Administration Guide

AR100500-01-ACN-EN-04
Table of Contents
14.4.4 Creating a hash tree ...................................................................... 167

14.4.5 Renewing hash trees ..................................................................... 168
14.4.6 Renewing timestamps of hash trees ............................................... 168
14.4.7 Migrating existing document timestamps ........................................ 169
14.5 Certificates ................................................................................... 169
14.5.1 Basic procedures and commands .................................................. 170
14.5.1.1 Checking a certificate .................................................................... 170
14.5.1.2 Enabling a certificate ..................................................................... 171
14.5.1.3 Deleting a certificate ...................................................................... 172
14.5.1.4 Creating a certificate using the Certtool .......................................... 172
14.5.2 Configuring a certificate for authentication ...................................... 174
14.5.2.1 Importing an authentication certificate ............................................. 175
14.5.2.2 Granting privileges for a certificate ................................................. 176
14.5.3 Configuring a certificate for document encryption ............................ 177
14.5.4 Configuring a certificate for timestamp verification ........................... 177
14.6 Using checksums .......................................................................... 178
14.7 ArchiveLink using Common Names (CN) ........................................ 179
15 Configuring Archive Timestamp Server .............................. 181

15.1 Using the auto initialization mode ................................................... 181
15.2 Configuration variables for Archive Timestamp Server ..................... 183
15.3 Logging information and status ...................................................... 184
15.4 Testing the connection .................................................................. 185
16 Configuring users, groups, and policies ............................. 187

16.1 Password security and settings ...................................................... 187
16.2 Concept ........................................................................................ 189
16.3 Configuring users and their rights ................................................... 190
16.4 Checking, creating, or modifying policies ........................................ 190
16.4.1 Available rights to create policies ................................................... 190
16.4.2 Checking policies .......................................................................... 191
16.4.3 Creating and modifying policies ...................................................... 191
16.5 Checking, creating, or modifying users ........................................... 192
16.5.1 Checking users ............................................................................. 192
16.5.2 Creating and modifying users ......................................................... 192
16.6 Checking, creating, or modifying user groups .................................. 193
16.6.1 Checking user groups .................................................................... 193
16.6.2 Creating and modifying user groups ............................................... 194
16.6.3 Adding users and policies to a user group ....................................... 194
16.7 Creating tenants ........................................................................... 195
16.8 Checking a user’s rights ................................................................ 197
16.9 Connecting to Directory Services ................................................... 198
OpenText Archive Server – Administration Guide vii

AR100500-01-ACN-EN-04
Table of Contents
17 Connecting to SAP servers .................................................. 201

17.1 Creating and modifying SAP system connections ............................ 201
17.2 Creating and modifying SAP gateways ........................................... 203
17.3 Assigning an SAP system to a logical archive ................................. 204
18 Configuring scan stations .................................................... 207

18.1 Scenarios and archive modes ........................................................ 207
18.2 Adding and modifying archive modes ............................................. 209
18.3 Adding additional scan hosts .......................................................... 212
18.4 Adding a new scan host and assigning archive modes .................... 212
18.5 Adding additional archive modes .................................................... 213
18.6 Changing the default archive mode ................................................ 214
18.7 Removing assigned archive modes ................................................ 214
19 Adding and modifying known servers ................................ 215

19.1 Adding known servers ................................................................... 215
19.2 Enabling replication to known servers ............................................. 216
19.3 Checking and modifying known servers .......................................... 216
19.4 Synchronizing servers ................................................................... 217
20 Configuring remote standby scenarios ............................... 219

20.1 Configuring original Archive Server and Remote Standby Server ..... 220
20.1.1 Configuring the original Archive Server ........................................... 220
20.1.2 Configuring the Remote Standby Server ......................................... 221
20.2 Backups on a Remote Standby Server ........................................... 223
20.2.1 ISO volumes ................................................................................. 223
20.2.2 Generalized Storage (GS) volumes with Vendor Interface (VI) ......... 224
21 Configuring Archive Cache Server ...................................... 225

21.1 Restrictions using Archive Cache Server ........................................ 227
21.2 Configuring an Archive Cache Server in the environment ................. 229
21.2.1 Adding an Archive Cache Server to the environment ....................... 229
21.2.2 Modifying an Archive Cache Server ................................................ 230
21.2.3 Deleting an Archive Cache Server .................................................. 231
21.2.4 Configuring volumes of an Archive Cache Server ............................ 232
21.2.5 Changing database files ................................................................ 234
21.3 Configuring access using an Archive Cache Server ......................... 234
21.3.1 Subnet assignment of an Archive Cache Server .............................. 234
21.3.2 Configuring archive access using an Archive Cache Server ............. 235
21.3.3 Configuring access for write-back scenario ..................................... 237
21.3.4 Adding and modifying subnet definitions of an Archive Cache
Server .......................................................................................... 237
21.3.5 Deleting an assigned Archive Cache Server ................................... 238
viii OpenText Archive Server – Administration Guide

AR100500-01-ACN-EN-04
Table of Contents
22 Scenario reports .................................................................... 239
23 Setting configuration variables ............................................ 241

23.1 Setting and modifying the value of configuration variables ............... 241
23.2 Searching configuration variables ................................................... 242
23.3 Customizing configuration view ...................................................... 243
Part 4 Maintenance 245
24 Handling storage volumes .................................................... 247

24.1 When the retention period has expired ........................................... 247
24.1.1 Checking for Empty Volumes and Deleting Them Manually .............. 249
24.1.2 Deleting Empty Volumes Automatically ........................................... 250
24.2 Exporting volumes ......................................................................... 250
24.3 Importing volumes ......................................................................... 251
24.3.1 Importing ISO volumes .................................................................. 251
24.3.2 Importing hard-disk volumes .......................................................... 252
24.3.3 Importing GS volumes for Single File (VI) pool ................................ 253
24.4 Consistency checks for storage volumes and documents ................. 254
24.4.1 Checking database against volume ................................................ 254
24.4.2 Checking volume against database ................................................ 256
24.4.3 Checking a document .................................................................... 256
24.4.4 Counting documents and components in a volume .......................... 257
24.4.5 Checking a volume ........................................................................ 258
24.5 Backup for storage systems ........................................................... 258
25 Backups and recovery .......................................................... 261

25.1 Backing up the database ............................................................... 262
25.1.1 Backing up an Oracle Database ..................................................... 263
25.1.2 Backing up a Microsoft SQL Server database ................................. 263
25.2 Backing up and restoring of the Storage Manager configuration ....... 264
25.3 Backup and recovery of an Archive Cache Server ........................... 264
25.3.1 Backup of Archive Cache Server data ............................................ 264
25.3.2 Recovery of Archive Cache Server data ......................................... 265
26 Utilities .................................................................................... 267

26.1 Starting utilities ............................................................................. 268
26.2 Checking utilities protocols ............................................................ 268
Part 5 Migration 271
27 About migration ..................................................................... 273

27.1 Features of volume migration ......................................................... 274
27.2 Restrictions ................................................................................... 274
OpenText Archive Server – Administration Guide ix

AR100500-01-ACN-EN-04
Table of Contents
28 Setting parameters of volume migration ............................. 277

28.1 Setting configuration parameters of volume migration ...................... 277
28.2 Setting logging parameters of volume migration .............................. 279
29 Preparing the migration ........................................................ 281

29.1 Preparing for local migration .......................................................... 281
29.2 Preparing for remote migration ....................................................... 281
29.3 Preparing for local fast migration of ISO images .............................. 284
29.4 Preparing for remote fast migration of ISO images .......................... 285
30 Creating a migration job ....................................................... 287

30.1 Creating a local migration job ......................................................... 287
30.2 Creating a remote migration job ..................................................... 290
30.3 Creating a local fast migration job for ISO volumes .......................... 293
30.4 Creating a remote fast migration job for ISO volumes ...................... 294
31 Monitoring the migration progress ...................................... 297

31.1 Starting monitoring ........................................................................ 297
31.2 States of migration jobs ................................................................. 298
32 Manipulating migration jobs ................................................. 301

32.1 Pausing a migration job ................................................................. 301
32.2 Continuing a migration job ............................................................. 301
32.3 Canceling a migration job .............................................................. 302
32.4 Renewing a migration job .............................................................. 302
33 Volume migration utilities ..................................................... 303

33.1 Deleting a migration job ................................................................. 303
33.2 Finishing a migration job manually .................................................. 303
33.3 Modifying attributes of a migration job ............................................. 304
33.4 Changing the target pool of write jobs ............................................. 305
33.5 Determining unmigrated components ............................................. 305
33.6 Switching component types of two pools ......................................... 306
33.7 Adjusting the sequence number for new volumes ............................ 306
33.8 Statistic about components on certain volumes ............................... 307
33.9 Collecting diagnostic information .................................................... 307
34 Attribute migration ................................................................ 309
Part 6 Monitoring 311
35 Everyday monitoring of the archive system ....................... 313
36 Monitoring with notifications ............................................... 315

36.1 Creating and modifying event filters ................................................ 315
x OpenText Archive Server – Administration Guide

AR100500-01-ACN-EN-04
Table of Contents
36.1.1 Conditions for event filters ............................................................. 316

36.1.2 Available event filters .................................................................... 318
36.2 Creating and modifying notifications ............................................... 319
36.2.1 Notification settings ....................................................................... 320
36.2.2 Using variables in notifications ....................................................... 322
36.3 Checking alerts ............................................................................. 323
37 Using OpenText Archive Server Monitoring ....................... 325

37.1 Access permission for the Archive Monitoring Web Client ................ 326
37.1.1 Creating a dedicated group for the Archive Monitoring Web Client
(built-in OpenText User Management) ............................................ 326
37.1.2 Creating a dedicated group for the Archive Monitoring Web Client
(OTDS) ........................................................................................ 327
37.2 Starting the Archive Monitoring Web Client ..................................... 329
37.3 Archive Server Statistics ............................................................. 329
37.4 Archive Server Health Status ...................................................... 330
37.4.1 Database ..................................................................................... 331
37.4.2 Storage Manager ......................................................................... 331
37.4.3 Services ...................................................................................... 331
37.4.4 Pools and Volumes ..................................................................... 332
37.5 Threats ........................................................................................ 332
38 Auditing, accounting, and statistics .................................... 335

38.1 Auditing ........................................................................................ 335
38.1.1 Configuring auditing ...................................................................... 335
38.1.2 Accessing auditing information ....................................................... 335
38.2 Accounting ................................................................................... 337
38.2.1 Settings for accounting .................................................................. 338
38.2.2 Evaluating accounting data ............................................................ 338
38.3 Storage Manager statistics ............................................................ 340
Part 7 Troubleshooting 341
39 Basics ..................................................................................... 343

39.1 Avoiding problems ......................................................................... 343
39.2 Viewing installed Archive Server patches ........................................ 344
39.3 Correcting wrong installation settings ............................................. 344
39.4 Monitoring and administration tools ................................................ 345
39.5 Deleting log files ........................................................................... 345
40 Starting and stopping Archive Server ................................. 347

40.1 Starting and stopping under Windows ............................................. 347
40.2 Starting and stopping under UNIX/Linux ......................................... 348
40.3 Starting and stopping single services with spawncmd ...................... 349
OpenText Archive Server – Administration Guide xi

AR100500-01-ACN-EN-04
Table of Contents
40.4 Setting the operation mode of Archive Server ................................. 350
41 Analyzing problems .............................................................. 351

41.1 Spawner log file ............................................................................ 351
41.2 Analyzing processes with spawncmd .............................................. 351
41.3 Working with log files ..................................................................... 353
41.3.1 About log files ............................................................................... 353
41.3.2 Setting log levels ........................................................................... 354
41.3.3 Log settings for Archive Server components (Except STORM) ......... 354
Part 8 Configuration parameter reference 357
42 Introduction ............................................................................ 359

42.1 Configuration Files ........................................................................ 360
42.2 Priorities ....................................................................................... 360
42.3 General Installation Variables ........................................................ 361
42.4 Configuration of Log Files .............................................................. 361
43 Archive Server ....................................................................... 365

43.1 Administration Server (ADMS) ....................................................... 365
43.1.1 Jobs and Commands .................................................................... 366
43.1.1.1 SYS_CLEANUP_PROTOCOL ....................................................... 366
43.1.1.2 Local_backup ............................................................................... 367
43.1.1.3 Delete_Empty_Volumes ................................................................ 367
43.1.1.4 SYS_EXPIRE_ALERTS ................................................................ 368
43.1.1.5 SYS_CLEANUP_ADMAUDIT ........................................................ 368
43.1.2 Buffers ......................................................................................... 368
43.1.3 Archives ....................................................................................... 369
43.1.3.1 Security ........................................................................................ 369
43.1.3.2 Settings ........................................................................................ 370
43.1.3.3 Retention ...................................................................................... 373
43.1.4 Pools ............................................................................................ 375
43.1.4.1 Write through (HDSK) .................................................................... 375
43.1.4.2 Write at-once (ISO) ....................................................................... 376
43.1.4.3 Single file (VI) ............................................................................... 377
43.1.5 Cache servers .............................................................................. 378
43.1.6 Certificates ................................................................................... 379
43.1.7 Notifications .................................................................................. 380
43.1.8 Connection Parameters ................................................................. 380
43.1.9 Directories .................................................................................... 381
43.1.10 System Keys ................................................................................ 382
43.2 Document Service (DS) ................................................................. 383
43.2.1 Document Service related settings ................................................. 383
xii OpenText Archive Server – Administration Guide

AR100500-01-ACN-EN-04
Table of Contents
43.2.2 Accounting and Statistics ............................................................... 384

43.2.2.1 Cookie exclusion list ...................................................................... 386
43.2.3 Backup configuration ..................................................................... 387
43.2.4 Cache configuration ...................................................................... 388
43.2.5 Component settings ...................................................................... 389
43.2.5.1 Compression ................................................................................ 389
43.2.5.2 Blobs ............................................................................................ 390
43.2.5.3 Encryption .................................................................................... 391
43.2.5.4 Timestamps (old) .......................................................................... 391
43.2.5.4.1 Headers for HTTP TS requests ...................................................... 394
43.2.5.5 ArchiSig Timestamps .................................................................... 394
43.2.5.6 Single Instance Archiving ............................................................... 399
43.2.5.6.1 Component or application types that prohibit(!) single instance
archiving ....................................................................................... 399
43.2.5.6.2 Component names that prohibit(!) single instance archiving ............. 400
43.2.5.7 Settings for big components ........................................................... 400
43.2.6 Directories .................................................................................... 401
43.2.7 Document settings ........................................................................ 401
43.2.8 HTTP settings ............................................................................... 402
43.2.9 Media configuration ....................................................................... 402
43.2.9.1 ISO settings .................................................................................. 402
43.2.9.2 HDSK settings .............................................................................. 405
43.2.9.3 HSM settings ................................................................................ 405
43.2.9.4 IXW settings ................................................................................. 406
43.2.9.5 Generalized Store ......................................................................... 406
43.2.10 Logging ........................................................................................ 407
43.2.10.1 Administration and Document Service ............................................ 407
43.2.11 Security settings ........................................................................... 407
43.2.11.1 Global security settings for HTTP ................................................... 407
43.2.11.2 Global security settings for RPC ..................................................... 408
43.2.12 STORM communication ................................................................. 409
43.2.12.1 NFS Server ................................................................................... 410
43.2.12.1. NFS Server ................................................................................... 410
1
43.2.12.1. Additional NFS Servers ................................................................. 411
2
43.2.13 System settings ............................................................................ 411
43.2.13.1 Database (fine tuning) ................................................................... 412
43.2.14 Special cs2ds settings ................................................................... 413
43.2.15 Special pagelist settings ................................................................ 414
43.3 Database Server (DBS) ................................................................. 414
43.4 Notification Server (NOTS) ............................................................ 416
OpenText Archive Server – Administration Guide xiii

AR100500-01-ACN-EN-04
Table of Contents
43.5 Key Export Tool (RCIO) ................................................................. 418

43.6 Storage Manager (STORM) ........................................................... 419
43.6.1 Configuration STORM (file server.cfg) ............................................ 419
43.6.1.1 Parameters Sizing STORM Server ................................................. 419
43.6.1.2 Parameter SCSI report .................................................................. 419
43.6.1.3 Parameters jbd scheduler .............................................................. 420
43.6.1.4 Parameters ISO9660 Finalization ................................................... 420
43.6.1.5 Parameters Logging Filenames/Dirs/Limits ..................................... 421
43.6.1.6 Logging Trace Levels .................................................................... 423
43.6.1.6.1 Defaults Logging Trace Levels ....................................................... 423
43.6.1.6.2 Logging trace levels STORM internal components .......................... 423
43.6.1.7 Parameters Notification server connection (NOTS) .......................... 427
43.6.1.8 STORM Internals .......................................................................... 428
43.6.1.9 Parameters STORM Statistics ....................................................... 428
43.6.1.10 Parameters ISO9660 Filesystem .................................................... 429
43.6.1.11 Device Configuration ..................................................................... 429
43.6.1.12 NFS VIEWS Definition ................................................................... 433
43.6.1.13 Backup STORM control files .......................................................... 435
43.6.1.14 WORM Filesystem ........................................................................ 436
43.6.1.14. Definition for hashing directories .................................................... 438
1
43.6.1.14. Definition of hashing file names ...................................................... 439
2
43.6.1.14. Definition of hashing file IDs ........................................................... 440
3
43.6.1.14. Definition of files to store inodes ..................................................... 442
4
43.6.1.15 WORM Filesystem (Small: original hash chunk size 35 MB - inode
chunk size 600 MB) ....................................................................... 443
43.6.1.15. Definition of hashing directories ..................................................... 445
1
2
3
4
43.6.1.16 WORM Filesystem (Medium: original hash chunk size 200 MB -
inode chunk size 600 MB) .............................................................. 451
1
2
3
xiv OpenText Archive Server – Administration Guide

AR100500-01-ACN-EN-04
Table of Contents

4
43.6.1.17 WORM Filesystem (Large: original hash chunk size 700 MB - inode
chunk size 800 MB) ....................................................................... 459
1
2
3
4
43.7 Timestamp Server (TSTP) ............................................................. 468
43.7.1 Configuration for Autostart ............................................................. 470
43.7.2 Script for the Archive Web Monitor ................................................. 472
43.8 Volume Migration (VMIG) .............................................................. 472
43.8.1 Mapping of NFSSERVER names ................................................... 476
43.9 Archive Server settings (JDS) ........................................................ 477
43.9.1 Document Service related settings ................................................. 477
43.9.1.1 Alias name for Retrieval Requests .................................................. 481
43.9.1.2 Alias name for Storage Requests ................................................... 482
43.9.1.3 Tape Pools and Volumes ............................................................... 482
43.9.2 Notification Clients ........................................................................ 483
43.9.3 Filter settings ................................................................................ 483
43.9.4 Administration Service ................................................................... 490
43.9.4.1 Database ...................................................................................... 490
43.9.4.2 Command ..................................................................................... 491
43.9.4.3 Audit ............................................................................................ 491
43.9.4.4 OTDSconnection ........................................................................... 492
43.9.4.5 AllowedUsers ................................................................................ 495
43.9.4.6 Policy ........................................................................................... 499
43.9.4.6.1 Assignments ................................................................................. 499
43.9.4.7 Reports ........................................................................................ 500
43.9.4.7.1 Archive Report .............................................................................. 501
43.9.4.8 SolutionRegistry ............................................................................ 502
43.9.4.8.1 SAP System Landscape Directory .................................................. 502
43.9.5 Search Service ............................................................................. 503
43.9.6 MDF Rendition Service .................................................................. 504
43.9.7 Archive Administration Service ....................................................... 504
43.9.7.1 Contact Information ....................................................................... 505
43.9.8 Logging ........................................................................................ 505
43.9.8.1 Application Server ......................................................................... 506
43.9.8.1.1 Group definitions ........................................................................... 509
OpenText Archive Server – Administration Guide xv

AR100500-01-ACN-EN-04
Table of Contents
43.9.9 Record Integration related settings (Elib) ........................................ 511

43.9.10 Record Access Configuration ......................................................... 511
43.10 CMIS settings ............................................................................... 512
43.10.1 OTDS integration settings for Email Archiving ................................. 512
43.11 Business Administration ................................................................ 514
43.11.1 Default values for the administration web client ............................... 518
43.12 Integrated Common Service Settings (ICS) ..................................... 528
43.12.1 Archive Link specific Settings (AL) .................................................. 535
43.12.2 HTTP communication parameter .................................................... 540
43.12.3 Rights Management Services parameters ....................................... 544
43.12.4 Logging ........................................................................................ 546
43.12.4.1. Group definitions ........................................................................... 549
1
44 Document Pipeline ................................................................ 551

44.1 Common settings for Document Pipelines ....................................... 551
44.1.1 Logging ........................................................................................ 555
44.2 Remote pipeline interface .............................................................. 557
44.2.1 Logging ........................................................................................ 558
44.3 DocTool rendition .......................................................................... 558
44.4 DocTool timestampdt .................................................................... 559
44.5 COLD for DocuLink (COR3) ........................................................... 560
44.6 Batch import for DocuLink (EXR3) .................................................. 561
44.7 Common settings for Project Pipelines ........................................... 563
44.8 Batch load for XML documents (XMLBL) ........................................ 564
45 Email Cloud Archive .............................................................. 567

45.1 Email Archiving Services (ECA) ..................................................... 567
45.1.1 Configuration ................................................................................ 567
45.1.1.1 Archive System ............................................................................. 568
45.1.1.1.1 CMIS related settings .................................................................... 568
45.1.1.1.2 OTDS related settings ................................................................... 571
45.1.1.2 Audit Logs .................................................................................... 574
45.1.1.3 Credential ..................................................................................... 575
45.1.1.4 Dispatcher .................................................................................... 576
45.1.1.5 Email Source or Temporary Storage ............................................... 576
45.1.1.5.1 session ......................................................................................... 577
45.1.1.6 IMAP Server ................................................................................. 578
45.1.1.7 SMTP Server ................................................................................ 580
45.1.1.7.1 SMTP Server Logging ................................................................... 581
45.1.1.8 OTDS Proxy ................................................................................. 582
45.1.1.8.1 OTDS Proxy Logging .................................................................... 582
xvi OpenText Archive Server – Administration Guide

AR100500-01-ACN-EN-04
Table of Contents
45.1.1.9 Marking System ............................................................................ 583

45.1.1.10 Query Mailbox Scan ...................................................................... 584
45.1.1.11 Queue Mailbox Scan ..................................................................... 585
45.1.1.12 Spam Headers .............................................................................. 585
45.1.1.13 Notification System ....................................................................... 586
45.1.1.14 Processor ..................................................................................... 587
45.1.1.15 Status .......................................................................................... 588
45.1.1.16 Worker Mailbox Scan .................................................................... 589
45.1.1.17 Working Time ............................................................................... 590
45.1.2 Logging ........................................................................................ 591
45.1.3 Monitoring .................................................................................... 592
46 File Archive ............................................................................ 595

46.1 Specific settings for FSA Document Pipelines ................................. 595
47 Monitor Server ....................................................................... 601

47.1 Monitor Server (MONS) ................................................................. 601
47.1.1 Variables for monitor server agent .................................................. 601
48 Cache Server .......................................................................... 603

48.1 Archive Cache Server settings (ACS) ............................................. 603
48.1.1 Scheduler ..................................................................................... 613
48.1.2 Logging ........................................................................................ 614
48.1.3 Business Administration ................................................................ 616
48.2 Integrated Common Service Settings (ICS) ..................................... 618
48.2.1 Archive Link specific Settings (AL) .................................................. 625
48.2.2 HTTP communication parameter .................................................... 630
48.2.3 Rights Management Services parameters ....................................... 634
48.2.4 Logging ........................................................................................ 636
GLS Glossary 641
OpenText Archive Server – Administration Guide xvii

AR100500-01-ACN-EN-04
List of tables
• “Types of storage devices” on page 72
• “Supported storage devices” on page 72
• “Cache configuration” on page 94
• “Retention period types” on page 105
• “Retention behavior settings” on page 105
• “Retention on storage systems” on page 106
• “Purging content” on page 109
• “Deletion on backup media” on page 109
• “Preconfigured jobs” on page 141
• “Pool-related jobs” on page 143
• “Other jobs” on page 144
• “Generate self-signed certificates” on page 172
• “Request a certificate from a trust center ” on page 173
• “Send the certificate to an Archive Server (putCert)” on page 173
• “Administrative WebServices” on page 190
• “Restrictions using Archive Cache Server” on page 227
• “Overview of utilities” on page 267
• “Fields in accounting files” on page 339
• “Job numbers and names of requests” on page 339
OpenText Archive Server – Administration Guide xix

AR100500-01-ACN-EN-04
List of figures
Figure 1-1: “Main components of Archive Server” on page 28
Figure 2-1: “Content capture and storage” on page 32
Figure 2-2: “Content retrieval” on page 33
Figure 2-3: “Logical archives” on page 35
Figure 2-4: “Pool types and storage systems” on page 39
Figure 3-1: “Main objects of Archive Server” on page 42
Figure 11-1: “Filling the local cache” on page 94
Figure 12-1: “Shadow pools” on page 123
Figure 12-2: “Pool replication” on page 124
Figure 14-1: “Hash tree for ArchiSig timestamps” on page 161
Figure 14-2: “Verification through hash chain” on page 161
Figure 20-1: “Remote Standby scenario” on page 219
Figure 21-1: “ Archive Cache Server scenario” on page 226
Figure 21-2: “Example of subnet assignment of Archive Cache Servers”

on page 235
Figure 25-1: “Backup-relevant areas” on page 261
OpenText Archive Server – Administration Guide xxi

AR100500-01-ACN-EN-04
Preface
Introduction
OpenText Archive Server (short: Archive Server) provides a full set of services for
content and documents. Archive Server can either be used as an integral part of
OpenText Enterprise Library or as stand-alone server in various scenarios.
i About this document

Structure This manual describes all jobs that are relevant after Archive Server is installed on a
machine:
“Overview” on page 25
Read this part to get an introduction of Archive Server, the architecture, the
storage systems and basic concepts like logical archives and pools. You find also
a short introduction to the Administration Client and its main objects.
“Configuration” on page 69
This part describes also the preparation of the system and the configuration of
Archive Server: logical archives, pools, jobs, security settings, connections to
SAP and scan stations.
“Maintenance” on page 245

Here you find all tasks to keep the system running: how to prepare and handle
storage media, backups and recovery.
“Migration” on page 271

Here you find all information to migrate content from one storage platform to
another.
“Monitoring” on page 311

Read here how to monitor the system, how to simplify the monitoring by
configuration of notifications, how to get auditing, accounting and statistic data
and how to use Archive Monitoring Web Client monitoring utility.
“Troubleshooting” on page 341

This part provides support if problems occur and hints how you can avoid
problems. It explains where to find the log files and how to find the cause of the
problem. If fatal problems occur, you have to contact OpenText Customer
Support.
Audience and This document is written for administrators of Archive Server, and for the project
knowledge managers responsible for the introduction of archiving. Further, all readers who
share an interest in administration tasks and have to ensure the trouble-free
operation of Archive Server. The following knowledge is required to take full
advantage of this document:
• Familiarity with the relevant operation system Windows® or UNIX®/Linux®.
OpenText Archive Server – Administration Guide xxiii

AR100500-01-ACN-EN-04
Introduction
• A general understanding of TCP/IP networks, HTTP protocol, network and data

security, and databases (Oracle® Database or Microsoft® SQL Server®).
• Additional knowledge of NFS file systems is helpful.
Besides these technical backgrounds, a general understanding of the following

business issues is important:
• How many and which types of documents have to be archived electronically
each day or each month?
• How often will archived documents be retrieved?
• Are retrieval requests predictable or independent?
• For what period of time documents will be frequently accessed?
• For how long must documents be archived?
• Which archived documents are highly sensitive, or might have to be updated
often (for example, personal files)?
On the basis of this information you can decide which scenario you are going to use
for archiving and how many logical archives you need to configure. You can
determine the size of disk buffers and caches in order to guarantee fast access to
archived data.
ii What’s new?
This version features the following:
“Document deletion”, page 107

With version 10.5.0 SP1, you can also use the AutoDelete job to find and remove
documents with expired retention. For more information, see “Other jobs”
on page 144.
“Encrypted document storage”, page 155
From Update 2014.4 on, system keys are assigned to logical archives.
“Basic timestamp settings”, page 162
Archive Server supports timestamps from Keyon true-Sign since Update 2017.1.
xxiv OpenText Archive Server – Administration Guide

AR100500-01-ACN-EN-04
Part 1
Overview
Chapter 1
Archive Server
1.1 Basic features of Archive Server

Archive Server provides a complete set of services for content and documents. These
services incorporate:
• Store and retrieve content
• Content lifecycle
• Storage virtualization
• Caching and Archive Cache Servers
• Single instance archiving
• Long-term preservation and readability
• secKeys and timestamps
• Compression and encryption
• Retention handling
• Backup and replication
• Disaster recovery
• High availability
1.2 Flexibility for different business processes

Depending on the business process, the content type and the storage devices,
Archive Server provides different techniques to store and access documents. This
guarantees optimal data and storage resource management. Large or distributed
Enterprise Library implementations can consist of several Archive Servers. To
support disaster recovery, servers can be replicated. Additional Archive Cache
Servers can speed up the access to the archived documents. Archive Cache Server is
used in distributed environments with low network bandwidth (optional).
OpenText Archive Server – Administration Guide 27

AR100500-01-ACN-EN-04
Chapter 1 Archive Server
1.3 Main components of Archive Server

The following figure shows the main components of Archive Server and its
environment.
Applications
Enterprise
Document
Library SAP Others ...
Pipeline
Services
Archive Services ArchiveLink

Administration Tools Archive Server
Administration Client
Document Service (DS)
Archive Web Monitor Administration
Storage Manager (STORM)

Document Pipeline Info
Storage Devices
CAS NAS HSM SAN
Figure 1-1: Main components of Archive Server
Applications
Application or services deliver documents or content to Archive Server using

Archive Services or SAP ArchiveLink®. Retrieval requests are also sent by
applications to get documents back from the Archive Server.
Archive Server
Archive Server incorporates the following components for storing, managing and
retrieving documents and data:
• Document Service (DS), handles the storage and retrieval of documents and
components.
• Storage Manager (STORM), manages and controls the storage devices.
• Administration Server, provides the interface to the Administration Client
which helps the administrator to create and maintain the environment of Archive
Servers, including logical archives, storage devices, pools, etc.
28 OpenText Archive Server – Administration Guide

AR100500-01-ACN-EN-04
1.4. Important directories on Archive Server
Administration tools
To administer, configure and monitor the components mentioned above, you can
use the following tools:
• Administration Client is the tool to create logical archives and to perform most of
the administrative work like user management and monitoring. See also
“Important directories on Archive Server” on page 29.
• Archive Monitoring Web Client is used to monitor information regarding the
status of relevant processes, the file system, the size of the database and available
resources. This information is gathered by the Archive Monitoring Server from
Archive Server. See also “Using OpenText Archive Server Monitoring“
on page 325.
• Document Pipeline Info is used to monitor the processes in the OpenText
Document Pipeline.
Storage devices
Various types of storage devices offered by leading storage vendors can be used by
Archive Server for longtime archiving. See “Storage devices” on page 36.
1.4 Important directories on Archive Server

During the installation, several directories are created and the default settings can be
modified. Within this manual, the following variables are used for these directories.
You should replace these variables with the values that are specified on your system.
<OT install AS>

Directory used for Archive Server program files.
Windows default: C:\Program Files\Open Text\Archive Server x.x.x\
UNIX default: /opt/opentext/ArchiveServerSoftware_x_x_x/
<OT config AS>

Directory used for Archive Server configuration files.
Windows default: C:\Documents and Settings\All Users\Application Data
\Open Text\Archive Server x.x.x\config\
UNIX default: /opt/opentext/ArchiveServerConfig_x_x_x/
<OT logging>
Directory used for Archive Server log files.
\Open Text\var\LogDir\
UNIX default: /var/adm/opentext/log/
<OT var>
Directory used for Archive Server variables.
\Open Text\var\
UNIX default: /var/adm/opentext/

AR100500-01-ACN-EN-04
<OT install SPAWNER>

Directory used for Archive Spawner program files.
Windows default: %COMMON FILES%\Opent Text\Spawner\bin
UNIX default: /opt/opentext/spawner/

AR100500-01-ACN-EN-04
Chapter 2
Basic principles of archives
2.1 Documents, data, and logical archives

Documents and data to be archived can consist of a number of components.
Examples are documents (main component) with notes and annotations or an email
document, which consists of an information header, the message body and possible
attachments. Within this guide, “content” is used to label all components belonging
together. Normally, all content components are stored together on the same type of
medium. However, it is also possible to separate the components and store them on
different media. For example, you can store documents notes on different hard
disks. Documents are identified by a unique ID. The leading application uses this ID
for content retrieval. Archive Server delivers all components belonging to this ID to
the leading application.
Archive Server only stores the content of documents. The metadata describing the
business context of the documents are stored in Enterprise Library’s metadata
repository or leading application. The link between the metadata and the content is
the unique ID mentioned above.
Archive Server represents a large virtual storage system, which can be used by
various applications. All documents that belong to a business process can be
grouped together by the concept of a logical archive. In general, a logical archive is a
collection of documents that have similar properties.
On a single Archive Server, a multitude of logical archives can be created. Often,

shortly “archive” is used instead of “logical archive”.
2.2 Content capture and storage

The following description shows a usual way to capture and store content.
Depending on your requirements, variations of this description are possible.

AR100500-01-ACN-EN-04
Chapter 2 Basic principles of archives
Application
Content input Archive Server

Logical Archive
Buffer Cache
Pool
Write activity
Storage Device
(Volumes)
Figure 2-1: Content capture and storage
1. The application sends the content to a logical archive created on an Archive

Server.
2. Content is stored temporarily in the disk buffer.
3. Content is copied to the associated storage platform for longtime archiving. The
time scheduling is configured in the Write job. If a cache is used, the content is
copied simultaneously to the cache. This can also be done by the scheduled
purge buffer job.
4. If configured, the content is also copied to the back-up storage device.
5. When at least one copy of the document has successfully been written to the
long-term storage, the document can be deleted from the disk buffer.

AR100500-01-ACN-EN-04
2.3. Content retrieval
2.3 Content retrieval

The following description shows a usual way to retrieve content. Depending on
your requirements, variations of this description are possible.
Application
Content
request
Content
delivery
Archive Server
Logical Archive
Buffer
Cache
Pool
If content is neither in buffer nor in cache

Content
request
Content
delivery
Storage Device
(Volumes)
Figure 2-2: Content retrieval
1. Content is requested by a client. For this, the client sends the unique document
ID and archive ID to Archive Server.
2. Archive Server checks whether the content consists of more components and
where the components are stored.
3. If the content is still stored in the buffer or in the cache, it is delivered directly to
the client.
4. If the content is already archived on the storage device, Archive Server sends a
request to the storage device, gets the content and leads it forward to the
application. Content is returned in chunks, so the client does not have to wait
until the complete file is read. That is important for large files or if the client only
reads parts of a file.

AR100500-01-ACN-EN-04
2.4 Logical archives

Archive Server is storing the data in a well-organized way. The logical organization
unit is the logical archive. You can organize documents in different logical archives
according to the following criteria:
• Metadata belonging to the content
• Leading application
• Document lifecycle or the retention period
• Archiving and cache strategy
• Storage system and media types
• Security requirements for documents
• Customer relations (for ASPs)
The logical archive does not determine where and the way the content is archived.
The archive settings define the general aspects of data handling during archiving,
retrieval, and at the end of the document lifecycle.
Important settings are:

• compression
• single instance archiving
• caching
• restrictions to ensure document security (signatures, certificates, SSL, encryption,
timestamps)
• auditing mode
• retention settings
Below you find an overview of the main components of logical archives.

AR100500-01-ACN-EN-04
2.4. Logical archives
Archive Server Storage Devices
Archive 1
Disk Volume(s) Buffer P1a Storage Volume HD1

Pool 1a
Disk Volume(s) Buffer P1b Pool 1b

Storage Volume HD2
Disk Volume(s) Cache 1
Archive 2
Disk Volume(s) Buffer P2a

Pool 2a Storage Volume HD3
Disk Volume(s) Buffer P2b Pool 2b

Storage Volume HD4
Disk Volume(s) Cache 2
Figure 2-3: Logical archives
To create a logical archive you have to configure:
• Pool(s) to specify the storage platform and to assign the buffer(s) to the
designated storage platform(s); see also “Pools and pool types” on page 38.
• Buffer(s) and disk volumes to store incoming content temporarily; see also “Disk
buffers” on page 36.
• Storage devices and storage volumes for longtime archiving of content; see also
“Installing and configuring storage devices” on page 71.
• Cache to accelerate content retrieval. Only necessary if slow storage devices are
used; see also “Caches” on page 39.
• Retention period for content; see also “Retention” on page 103.
• Compression and encryption settings; see also “Data compression” on page 100
and “Encrypted document storage” on page 155.
• Security settings and certificates; see also “Configuring the archive security
settings” on page 112.

AR100500-01-ACN-EN-04
• An Archive Cache Server, if used; see also “Configuring Archive Cache Server“
on page 225.
2.4.1 Disk buffers

The buffer (or disk buffer) is a hard-disk volume where the content is physically
collected until the Write job writes it to the final storage. In ISO pools, the
documents are collected until the amount of data is sufficient to write an ISO image.
The Write job regularly checks the amount of data and writes the image, if there is
sufficient data in the buffer. In other pools, the Write job writes all data that has
been arrived in the buffer since the last run of the job. Sufficient free disk space must
be available in the buffer in order to accommodate new incoming documents. The
documents that have already been written to the storage media must therefore be
deleted from the disk buffer at regular intervals. This can only be done if a copy of
the document has successfully been stored on the long-term storage. This is usually
done by the Purge Buffer job.
Documents can be fast retrieved as soon as they are in the disk buffer. The disk
buffer works as read cache in this case. Retrieval time can increase if the content is
written to the final storage platform.
Related Topics
• “Configuring buffers” on page 88

• “Configuring disk volumes” on page 85
2.4.2 Storage devices

Various types of storage devices offered by leading storage vendors can be used by
Archive Server for longtime archiving:
• CAS: Content Addressed Storage

• NAS: Network Attached Storage
• HSM: Hierarchical Storage Management
• SAN: Storage Area Network
Archive Server primarily supports storage devices that offer WORM functionality,
retention handling, or HSM functionality. Depending on their type, the storage
devices are connected via STORM, VI (vendor interface) or API (application
programming interface).
Related Topics
• “Installing and configuring storage devices” on page 71

• “Creating and modifying pools” on page 117
• “Pools and pool types” on page 38

AR100500-01-ACN-EN-04
2.4.3 Storage scenarios

Regarding the archiving of and access to individual documents over its lifecycle, we
differentiate between single file storage and container file storage. “Single file
storage” means that documents are archived individually on the storage platform.
“Container file storage” indicates that the documents are bundled in containers like
ISO images or BLOBs.
Below you find criteria for single file storage and ISO images.
Single file storage

• Large files in COLD scenarios
• Document requires individual treatment
• Lifecycle of document not known or depends on metadata
• Individual deletion of documents on the end of the lifecycle required
• More administration effort
• Time-consuming migration
ISO images
• Very small files
• Same document type
• Same lifecycle
• Bulk deletion at the end of the lifecycle
• Less administration effort
• Simple backup or migration
• Partial read access to documents
Related Topics

AR100500-01-ACN-EN-04
2.4.4 Pools and pool types

At least one pool belongs to each logical archive. A pool points to a certain type of
physical storage devices that are written in the same way. Components are assigned
to the pool using storage tiers; see “Creating and modifying storage tiers”
on page 137.
Note: For backing up the documents stored in a pool, so-called shadow pools
can be assigned to the original pool; see “Creating and configuring shadow
pools” on page 122
The same storage platform can be used in different archives with different pool
types. The following pool types are currently available:
ISO pool, Write at once

In an ISO pool, a number of documents is written to the physical storage media
at once as ISO image. Each ISO image builds one ISO volume. The storage
volumes are hard disks providing the WORM feature (HD-WO). These systems
are managed as jukeboxes in the Administration Client. ISO pools require a disk
buffer.
FS pool, Single file
The FS pool (FS = File System interface) points to mounted hard-disk volumes of
an HSM, NAS or SAN system over the network. FS pools support single file
storage. They require a disk buffer.
VI pool, Single file

The VI pool (VI = Vendor interface) is connected to the storage system via the
API of the storage vendor. VI pools support single file storage. They require a
disk buffer. This storage scenario is sometimes also referred to as GS
(Generalized Store) scenario.
HDSK pool, Write through

In an HDSK (HDSK = hard disk) pool, documents are stored directly to the
storage, which can be a local file system directory or a local SAN system. HDSK
pools support single file storage. It is the only pool type that works without a
buffer. No WORM functionality is available.
Notes
• As HDSK pools do not use a buffer, they are not intended for use in
production systems. Use them only for test purposes.
• HDSK pools cannot have shadow pools assigned.
Figure 2-4 illustrates the dependencies between pool types and storage systems.

AR100500-01-ACN-EN-04
Archive Server
Single File Storage Container Storage
HDSK Single File VI Single File FS ISO
Document Service
Local Hard Disk Disk Buffer
STORM
Storage Devices
NAS, HSM,
SAN
NAS, HSM,
CAS CAS
VI: Vendor interface SAN
FS: File system interface
Figure 2-4: Pool types and storage systems
Related Topics
2.4.5 Caches
Caches are used to speed up the read access to documents. Archive Server can use
several caches: the disk buffer, the local cache volumes and an Archive Cache Server.
The local cache resides on the Archive Server and can be configured. The local cache
is recommended to accelerate retrieval actions. An Archive Cache Server is intended
to reduce and speed up the data transfer in a WAN. It is installed on its own host in
a separate subnet.
Related Topics
• “Configuring caches” on page 93
• “Configuring Archive Cache Server“ on page 225

AR100500-01-ACN-EN-04
2.5 Jobs
Jobs are recurrent tasks, which are automatically started according to a time
schedule or when certain conditions are met. This allows, for example, that
temporarily stored content is transferred automatically from the disk buffer to the
storage device. See also “Configuring jobs and checking job protocol“ on page 141.

AR100500-01-ACN-EN-04
Chapter 3
Administration Client and the main objects of the
Archive Server node
3.1 Administration Client

Administration Client is used to configure Archive Server and to perform most of
your administrative work:
• Administering users and rights
• Creating logical archives and pools
• Administering devices and volumes
• Defining disk buffers
• Planning and monitoring jobs
• Configuring server connections (to other Archive Servers, to Archive Cache
Servers, to SAP servers, etc.)
• Inserting volumes
• Defining the settings for archive modes
• Configuring events and notifications
• Setting configuration parameters
The structure of this documentation corresponds to the structure of the program. If

you need to find information quickly concerning a particular window, press F1 to
open the associated context online help.
3.2 Main objects of the Archive Server node

In this section you find an overview and a short description of the main objects of
the Archive Server node in the console tree. Cross-references are leading to detailed
descriptions of the different objects.

AR100500-01-ACN-EN-04
Chapter 3 Administration Client and the main objects of the Archive Server node
Figure 3-1: Main objects of Archive Server
3.2.1 Infrastructure
Within this object, you configure the required infrastructure objects to enable the
usage with logical archives.
Buffers
Documents are collected in disk buffers before they are finally written to the
storage medium. To create disk buffers, see “Configuring buffers” on page 88.
To get more information about buffer types, see “Disk buffers” on page 36.
Caches
Caches are used to accelerate the read access to documents. To create caches, see
“Configuring caches” on page 93.
Storage Devices
Storage devices are used for longtime archiving. To configure storage devices,
see “Installing and configuring storage devices” on page 71.
Disk Volumes
Disk volumes are used for buffers and pools. To configure disk volumes, see
“Configuring disk volumes” on page 85.

AR100500-01-ACN-EN-04
3.2. Main objects of the Archive Server node
3.2.2 Archives
Within this object, you create logical archives and pools, you can define replicated
archives for remote standby scenarios and you can see external archives of known
servers.
Original Archives
Logical archives of the selected server. To create and modify archives, see
“Configuring archives and pools“ on page 99.
Replicated Archives
Shows replicated archives; see “Logical archives” on page 99.
External Archives
Shows external archives of known servers; see “Logical archives” on page 99.
3.2.3 Environment
Within this object, you configure the environment of an Archive Server. For
example, Archive Cache Servers must first be configured in the environment if it
should be assigned to a logical archive.
Cache Servers
Cache servers can be used to accelerate content retrieval in a slow WAN. See
“Configuring Archive Cache Server“ on page 225
Known Servers
Known servers are used for replicating archives in remote standby scenarios.
See “Adding and modifying known servers“ on page 215.
SAP Servers
The configuration of SAP gateways and systems to connect SAP servers to
Archive Server. See “Connecting to SAP servers“ on page 201.
Scan Stations
The configuration of scan stations and archive modes to connect scan stations to
Archive Server. See “Configuring scan stations“ on page 207.
3.2.4 System
Within this object, you configure global settings for the Archive Server. You also
find all jobs and a collection of useful utilities.
Alerts
Displays alerts of the “Admin Client Alert” type. See “Checking alerts”
on page 323. To receive alerts in the Administration Client, configure the events
and notifications appropriately. See, “Monitoring with notifications“
on page 315.
Events and Notifications
Events and notifications can be configured to get information on predefined
server events. See “Monitoring with notifications“ on page 315.

AR100500-01-ACN-EN-04
Chapter 3 Administration Client and the main objects of the Archive Server node
Jobs
Jobs are recurrent tasks which are automatically started according to a time
schedule or when certain conditions are met, for example, to write content from
the buffer to the storage platform. A protocol allows the administrator to watch
the successful execution of jobs. See “Configuring jobs and checking job
protocol“ on page 141.
Key Store
The certification store is used to administer encryption certificates, security keys
and timestamps. See “Configuring a certificate for document encryption”
on page 177.
Policies
Policies are a combination of rights which can be assigned to user groups. See
“Checking, creating, or modifying policies” on page 190.
Reports
Reports contains the tabs "Reports" and "Scenarios" which display the generated
reports and available scenarios respectively. See “Scenario reports“ on page 239.
Storage Tiers
Storage tiers designate different types of storage. See “Creating and modifying
storage tiers” on page 137.
Users and Groups

Administration of users and groups. See “Checking, creating, or modifying
users” on page 192 and “Checking, creating, or modifying user groups”
on page 193.
Utilities
Utilities are tools which are started interactively by the administrator; see
“Utilities“ on page 267.
3.2.5 Configuration
Within this object, you can set the configuration variables for:
Archive Server
Shows configuration variables related to the Archive Server. This includes
Administration Server, database server, Document Service logging, Notification
Server, Archive Timestamp Server.
Monitor Server
Shows configuration variables related to the Archive Monitoring Server.
Document Pipeline
Shows configuration variables related to the document server.
For a description of how to set, modify, delete, and search configuration variables,
see “Setting configuration variables“ on page 241.

AR100500-01-ACN-EN-04
3.2. Main objects of the Archive Server node
For a complete list including short descriptions of all configuration variables, see
“Configuration parameter reference” on page 357.

AR100500-01-ACN-EN-04
Part 2
Archive Center scenario
Chapter 4
Understanding Archive Center
OpenText Archive Center offers a common installation for multi-tenant, integrated

archiving. You can easily set up collections involving email (Google Apps, Microsoft
Exchange), file systems (CIFS), or SAP systems.
Note: The Archive Center scenario is a new feature set, which is only available
when Archive Server was installed using the OpenText Archive Center
Installer.
Archive Center must be licensed separately.
This part is intended for the Archive Center scenario exclusively. It covers specific
aspects that are only relevant for this scenario. Note that it does not cover all aspects
that are relevant to run Archive Server in the Archive Center scenario – you still
need to pay attention to the other parts within this guide.
For more information about the Archive Center scenario, see OpenText Archive Center
- Installation and Configuration Guide (AREIA-IGD).

AR100500-01-ACN-EN-04
Chapter 5
What happens on Archive Server?
New collection When the business administrator creates a collection in the Archive Center
Administration client, the following happens on Archive Server:
Note: When creating collection and data source for SAP ArchiveLink, the
course of events differs. See “SAP ArchiveLink scenario” on page 53.
1. A logical archive is created including a new single file (FS) pool and a new
buffer for the new archive. If Additional Copies are used, corresponding
shadow pools and buffers are created.
The name of the logical archive is derived from a randomly generated identifier
of the collection and an appended, consecutive number.
Note: The configuration variable named Host Identifier (internal name:

AS.AS.BIZ_HOST_IDENTIFIER) holds the identifier string. You can
change it after installation if you prefer another name for the archive. The
name must be five characters long at most and must consist of letter (a-z, A-
Z) or number (0-9) characters only. See also “Tasks remaining for the
Archive Server administrator“ on page 55.
Tip: If you create volumes following the naming convention above in

advance for a given tenant (that is a given host identifier), these volumes
will be attached automatically to new buffers and pools.
2. For the first new pool and the first new buffer, two corresponding disk volumes
are created. For subsequently created logical archives, no disk volumes are
created!
Note: These volumes are required to achieve a running system from within
Archive Center Administration. They should be used for demonstration or
testing only.
The created pools, buffers, and volumes adhere to the following naming
convention:
Archive: <short name>-<host identifier>-<m>
Pool: P<n>
Buffer: <short name>-<host identifier>_<m>_PB
Volume for pool: <short name>_<host identifier>_<m>_P<n>_<n>
Volume for buffer: <short name>_<host identifier>_<m>_PB_<n>
where <m>, <n>, and are consecutive, whole numbers starting with 1. <short
name> is the tenant’s Short name, which was defined when the tenant user
group was created; see “Creating tenants” on page 195.
P1 is the original pool, P2 is the first shadow pool, P3 is the second shadow pool.

AR100500-01-ACN-EN-04
Chapter 5 What happens on Archive Server?
The location of the volumes by default is C:\ProgramData\demodir<n> (pools)

and C:\ProgramData\demodir<n>b (buffers) and depends on the chosen
configuration folder during installation.
Important
Do not use the automatically created disk volumes for production
systems.
Example 5-1: Automatically created pools and buffers for Archive

Center
The first pools and buffers created automatically look like this:
One archive: TENA1-OYXEM-1
One pool: P1
One buffer: TENA1_OYXEM_1_P1B
The first volumes attached automatically if present and adhering to the
naming convention look like this:
Up to three volumes for pool (and shadow pools): TENA1_OYXEM_1_P1_1
to TENA1_OYXEM_1_P3_1
Up to three volumes for buffers: TENA1_OYXEM_1_P1B_1 to
TENA1_OYXEM_1_P3B_1
3. Write and purge jobs for the new pools are created (PoolWrite_<short
name>_<host identifier>_<m>_PB, Purge_<short name>_<host
identifier>_<m>_PB). They are scheduled to run every full hour by default.
Furthermore, Jobs for generating statistics are available to allow accounting.
These jobs are enabled depending on the operating mode. For details, see
“Configuring accounting and statistics“ on page 57.
New data When the business administrator creates a data source (within a previously created
source collection), the following happens on Archive Server:
File Archiving data source

Enqueue jobs are created (FsaEnqueue_<short name>_<host
identifier>_<m>).
Email Cloud Archiving data source

Email Cloud Archiving jobs are created (EmailArchiving_<short name>_<host
identifier>_<m>_s<q>,
where q is a whole number starting with 1, which numbers the email addresses
across tenants consecutively).
See “Additional information for Email Cloud Archiving” on page 53 for
further details.
Configuration All archiving services monitor their configuration, and, if the configuration is
changes changed significantly, stop themselves. Examples of significant changes are:
Disabling or deleting of the collection or the data source; changing of values for
retention, archiving mode, journaling, archiving group, or allowed domains.

AR100500-01-ACN-EN-04
5.1. SAP ArchiveLink scenario
The scheduler will restart the job with changed configuration. If the collection or
data source is disabled, the service gets started and will immediately stop again. The
jobs for deleted data sources will be removed.
Email scenarios
Before making any such significant changes, make sure that the email root
directory has enough disk space left to hold all emails coming in while the
archiving service is stopped. Start the archiving job manually if necessary.
Related Topics
• “Creating and configuring shadow pools” on page 122
5.1 SAP ArchiveLink scenario

Archive name Logical archives within the SAP ArchiveLink scenario must follow a special naming
convention. Usually, the name of the archive is set by the SAP system and consists of
an upper-case letter and a one-digit number, for example A1.
After the business administrator has defined the name of the archive of the SAP
system in Archive Center Administration, Archive Server subsequently creates a
logical archive of identical name.
Data source In contrast to the other scenarios (File Archiving, Email), it is not possible to create
data sources directly in Archive Center Administration. ArchiveLink data sources
are created as soon as a authentication certificate is sent from the SAP system to the
Archive Server.
Note: You can also send the certificate by other means, for example, by using
the putCert option of the certtool command; compare “Creating a certificate
using the Certtool” on page 172.
This also triggers the creation of a data source.
5.2 Additional information for Email Cloud Archiving

Root folder The email root directory is common to all email archiving services and was
configured during the installation of Archive Center. You can find the current
location in the configuration variable Root folder for buffering emails (internal
name: ECA.ECA.configuration.emailsystem.rootfolder).
The default value is C:\ProgramData\OpenText\emaildir.
Subfolders When a new data source is created in Archive Center Administration, a subfolder is
added to the email root directory. Its name corresponds to the journaling email
address. Within this subfolder, the following types of subfolders are created:
• Inbox folder
• Journal Processor <1..n>
• Problems folders (Problems Archive, Problems Rejected, Problems Retry)

AR100500-01-ACN-EN-04
Chapter 5 What happens on Archive Server?
• tmp
As new emails arrive, they are stored in the Inbox folder of the corresponding
journaling email address. To avoid having too many email files in one folder, a
subfolder structure is created which reflects the date and hour when the email
arrived, with consecutively numbered folders at the lowest level:
\emaildir\<journaling address>\<year>\<month>\<day>\<UTC hour>\<1..n>
Email distribu- If the email archiving service runs, the incoming emails are then distributed to the
tion Journal Processor folders. From there, they are deleted after successful archiving
or moved to one of the Problems folders. The subfolder structure is kept
throughout, that is:
\emaildir\<journaling address>\JournalProcessor 01\<year>\<month>
\<day>\<hour>\<1..n>
\emaildir\<journaling address>\Problems Archive\<year>\<month>\<day>
\<hour>\<1..n>
\emaildir\<journaling address>\Problems Rejected\<year>\<month>\<day>
\<hour>\<1..n>
\emaildir\<journaling address>\ProblemsRetry\<year>\<month>\<day>
\<hour>\<1..n>
The Problems Retry folder holds emails for which archiving failed a configured
number of times while they are waiting to be processed again.
Note: You can configure the number of times to process failed emails in the
Max. number of retries variable (internal name:
EC.ECA.configuration.processor.maxretries).
The Problems Rejected folder holds emails which did not match the restrictions
configured for the SMTP server, for example, none of the recipients was in the range
of allowed domains.
The Problems Archive folder holds emails that could not be archived within the
maximum number of retries.

AR100500-01-ACN-EN-04
Chapter 6
Tasks remaining for the Archive Server
administrator
Storage system As with every archiving solution, the storage system for Archive Center must be
planned, installed, and configured.
Tenants In cloud scenarios, tenant user groups must be created in Administration Client. For
further information, see “Creating tenants” on page 195.
Volumes After the business administrator has created an archive (“collection”) using Archive
Center Administration, the Archive Server administrator must attach disk volumes
to the pools and buffers of the new archive.
Tip: Save the administrator’s contact data in the Archive Server configuration.
This information is visible in Archive Center Administration, and the business
administrator can easily contact the Archive Server administrator.
For details, see “Configuring miscellaneous Archive Center options“
on page 61.
Jobs Check the scheduling of the new Archive Center jobs, for example, to balance peak
load. While the jobs are scheduled for typical scenarios, it can be required to re-
schedule them on your system.
Background
• “Setting up the infrastructure“ on page 71
• “Configuring archives and pools“ on page 99
6.1 Additional tasks for Email Cloud Archiving

Problems While the Problems Retry folder is only a transitory location, the folders Problems
folders Archive and Problems Rejected are final destinations. The administrator should
check them regularly to ensure that they do not fill up the hard disk space.
If the email collection has been configured only recently, examine the emails in
Problems Rejected to make sure that they have been rejected justifiably rather than
due to a configuration error. Later, you can simply delete them.
Emails building up in the Problems Archive folder may point to problems with the
Archive Server or CMIS system. If such an issue has been identified and fixed,
reprocess the emails by moving them back into the Inbox folder.
Note: The original subfolder structure must be maintained when moving the
emails. Like the folder structure, the email file names are generated from the

AR100500-01-ACN-EN-04
Chapter 6 Tasks remaining for the Archive Server administrator
year, month, day, and UTC hour of their arrival and a consecutive number. If
the file name does not match the folder structure, the email is rejected.
Tip: To reprocess the mails from a problem folder, drag the year’s folder from
the corresponding Problems folder to the Inbox folder.
Depending on the number and size of emails ingested into Email Cloud Archiving,
monitor the email root directory on a daily or even hourly basis. See also Monitoring
the Email Archiving Service.
6.2 Enabling transaction logs

If your license model is based on transactions (that is you want to use the CMIS API
for custom integrations) you must enable a configuration variable on Archive Server.
For more information, see “Configuring accounting and statistics“ on page 57.
Note: The default data sources (email, file shares) are licensed per user.
Enabling transaction logs is not mandatory in these cases.

AR100500-01-ACN-EN-04
Chapter 7
Configuring accounting and statistics
The following configuration variables enable or disable accounting functionality of

Archive Center. You can find them in the Configuration > Archive Server >
Document Service (DS) > Accounting and Statistics node; see also “Configuring
accounting and statistics“ on page 57.
• Enable archiving and retrieval statistics
If set to on, the volume and performance of client archiving and retrieval
operations are collected per archive. The SYS_CONDENSE_STATISTICS job
condenses these values into corresponding values for hours, days, and months.
Internal name: AS.DS.STATISTIC
Important
If your license is based on transactions you must enable this option.
• Enable detailed transaction logs
If set to on, every ArchiveLink and CMIS request is logged into a transaction log
file. The SYS_EXPORT_TRANSACTIONLOG writes the transactions to CSV formatted
files (one file per archive and per day).
Internal name: AS.DS.TRANSACTIONLOG
• Enable storage allocation
If set to on, the amount of storage allocated to hold user data (including copies) is
collected by the SYS_SNAPSHOT_STORAGE_ALLOCATION job. When this data is
exported to CSV formatted files by the SYS_EXPORT_ARCHIVE_UTILIZATION job,
the data will be augmented by their corresponding statistics data (that is
archiving and retrieval operations).
Internal name: AS.DS.STORAGE_ALLOCATION
Note: If your license is based on transactions you should enable this option
to write CSV files. Alternatively, the corresponding information can be
extracted using a database report.
Background
• “Configuring jobs and checking job protocol“ on page 141

AR100500-01-ACN-EN-04
Chapter 7 Configuring accounting and statistics
7.1 Generating accounting information

The Archive Center scenario offers the following jobs and options to configure the
generation of accounting information.
Important
Do not change the default scheduling of the accounting and statistics jobs.
Otherwise, the accounting results can become distorted.
SYS_SNAPHOT_STORAGE_ALLOCATION job
Purpose: Creates a snapshot of the current storage allocation
Note: Calculating the storage allocation can be an expensive operation and
should be scheduled deliberately. The job is labeled for the UTC day on which
the job is running, which can differ from the scheduled time (local server time).
Default schedule: daily at 23:55
SYS_EXPORT_ARCHIVE_UTILIZATION job
Purpose: Exports for each local archive one CSV formatted file per month
displaying the data read and written by clients and the storage allocation. Used
for volume-based licensing.
Location of the files: %ECM_VAR_DIR%/statistics/<archive>/<year>/
<month>/details/<YYYYMMDD>-<archive>.atl.csv
Format of the CSV files: date; components read; components written; bytes
read (MB); bytes written (MB); storage allocated (MB)
Note: This job should run once a day and must be scheduled after the
SYS_SNAPSHOT_STORAGE_ALLOCATION job and the first run of the
SYS_CONDENSE_STATISTICS job for a UTC day as it merges these two data
sources according to date.
Default schedule: daily at 0:20
Note: If your license is based on transactions you should run this job daily
to write CSV files. Alternatively, the corresponding information can be
extracted using a database report.
SYS_EXPORT_TRANSACTIONLOG job
Purpose: Exports for each local archive one CSV formatted file per day
displaying the received client requests.
Location of the files: %ECM_VAR_DIR%/statistics/<archive>/<year>/
<month>/details/<YYYYMMDD>-<archive>.dtl.csv
Format of the CSV files: date; local time; time zone; command; archive;
docID; bytes; result; user; application; IP address; interface
Note: This job can run several times per hour to avoid a backlog of entries to
export. This job is disabled in the “On-Premises” scenario.
Default schedule: every 15 min
SYS_CONDENSE_STATISTICS job
Purpose: Combines statistics, which are sampled per minute, to hours, days, and
months to speed up access to statistics when querying days or months.

AR100500-01-ACN-EN-04
7.2. Collecting billing information
Note: Statistics are recorded according to their UTC timestamps. The server’s
time zones or daylight saving are not taken into consideration. That is, a day
from a statistics point of view usually is not identical to a calendar day in the
server’s or client’s time zone.
This job should run every hour.
Default schedule: hourly (0:15, 1:15, 2:15, ...)
7.2 Collecting billing information

For the “Public Cloud” scenario, information about the number of users and amount
of transactions is required to be able to bill the customers. To this end, the Archive
Center Installer adds and schedules a job called RetrieveBillingData. The job is
scheduled to run at the end of each day by default.
Billing job The RetrieveBillingData job has the following characteristics:
1. Determining the maximum number of users for each tenant in OpenText™

Directory Services (OTDS).
2. Retrieving the amount of transactions from the accounting information; compare
“Generating accounting information” on page 58.
3. Exporting the collected data into an XML file. For each month, one file is written,
which contains the aggregated information of this month. For the current month,
this includes all days from the first to the current day of the month.
The name of the files is usage_<YYYY><MM>.xml. The default location of the files
is %ECM_VAR_DIR%\reports.
You can configure the location of the XML file as follows.
To change the storage location of the billing XML file:
• Enter the path to the directory in which to store the billing XML files as the
Value of the Output directory for billing reports configuration variable
(internal name: BILLING_REPORT_DIR).
For a description of how to set, modify, delete, and search configuration
variables, see “Setting configuration variables“ on page 241.
XML structure The billing information in the XML file is structured as shown in the example.
Example 7-1: Structure of the billing XML files

<?xml version='1.0' encoding='UTF-8'?>
<Root Format="1.0" Generated="1437479082" RangeFrom="07/01/2015" RangeTo="07/21/2015" UnitDefinition="JEDEC">
<Tenants>
<Tenant Reference="<Contract ID>">
<Users Peak="50"</Users>


<Transactions Read="0" Write="0" Delete="0"/>


<Volume Read="0" Write="0" Unit="B"/>


<Collections>
<Collection Name="Collection1" ID="MT1-NETZI-1" AL_enabled="false">
<Storage Capacity="84" Unit="MB"/>


</Collection>

AR100500-01-ACN-EN-04
Chapter 7 Configuring accounting and statistics
<Collection Name="SAPCollection" ID="MT1-NETZI-2" AL_enabled="true">

<Storage Capacity="0" Unit="MB"/>


<Volume Read="0" Write="974617880" Delete="20165977" Unit="B"></Volume>


</Collection>
</Collections>
</Tenant>
<Tenant Reference="<Contract ID 2>">
<Users Peak="0" Date="1436788044"></Users>



<Collections/>
</Tenant>
<Tenant Reference="<Contract ID 3>">
<Users Peak="0" Date="1436788044"></Users>



<Collections/>
</Tenant>
</Tenants>
</Root>

AR100500-01-ACN-EN-04
Chapter 8
Configuring miscellaneous Archive Center options
Archive Center introduces several general configuration variables. For a description

of how to set, modify, delete, and search configuration variables, see “Setting
configuration variables“ on page 241.
Configuration variables for Archive Center
The following configuration variables are located in the nodes

Configuration > Archive Server > Archive Server settings (JDS) > Archive
Administration Service > Contact Information,
Configuration > Archive Server > Archive Server settings (JDS) > Business
Administration, and
Configuration > Archive Server > Archive Server settings (JDS) > Business
Administration > Default values for the administration web client.
• Contact Information node

The configuration variables below the Contact Information node hold
information that is visible in the Archive Center Administration web client.
Thereby, the business administrator can easily contact the Archive Server
administrator.
For details, see Section 43.9.7.1: “Contact Information” on page 505.
• Business Administration node
The configuration variables below the Business Administration node are used to
configure special settings of the Archive Center scenario.
For further details, see Section 43.11: “Business Administration” on page 514.
• Default values for the administration web client node
The configuration variables below the Default values for the administration
web client node allows to overwrite the default configuration values within the
Archive Center Administration client.
To overwrite default values of Archive Center Administration:
1. Set the Overwrite internal default values configuration value to on.

Otherwise, the changes of the variables below will not be active.
Internal name: AS.AS.BIZ_SCENARIO_DEFAULTS_OVERWRITE
2. Set the default value for compression, encryption, encryption alterable or

read-only, additional copies, or single instance in the corresponding
variable.
For further details, see Section 43.11.1: “Default values for the administration
web client” on page 518.

AR100500-01-ACN-EN-04
Chapter 8 Configuring miscellaneous Archive Center options
See also “Configuring collections” in OpenText Archive Center - Installation

and Configuration Guide (AREIA-IGD).

AR100500-01-ACN-EN-04
Chapter 9
Working with Archive Center Access
Access OpenText™ Archive Center Access is a web-based, easy-to-use client included in

Archive Center, which allows to access the archive independently from the
archiving application.
This can, for example, be important in case of an impending litigation: Using the
Archive Center Administration client, collections can be put on hold to protect all
currently archived documents from modification and deletion. The archived
documents within the collection can then be searched and all relevant documents
can be exported.
Allowed users Only users who belong to the <tenant>_ED group are allowed to work with Archive
Center Access.
Export directory Whenever a business administrator exports documents, the documents are
temporarily saved in a local directory. By default, this directory is C:\ProgramData\
OpenText\var\exports (%ECM_VAR_DIR%\exports). The path can be changed
during the installation of Archive Center. You can also change the path in the
configuration variable Directory for the generated EDRM-XML files (internal
name: AS.AS.BIZ_EXPORT_DIRECTORY).
If you change the directory, existing exports in the old directory cannot be seen in
Archive Center Access anymore unless copied to the new directory.
Important
Depending on the scenario and usage, the exported files can become very
big. Take care to provide enough disk space for the export directory.
Further For details about Access, see section 13 “Working with OpenText Archive Center
information Access” in OpenText Archive Center - Installation and Configuration Guide (AREIA-
IGD).
Procedure
• “Setting configuration variables“ on page 241

AR100500-01-ACN-EN-04
Chapter 10
Troubleshooting Email Cloud Archiving
The following sections can help you to avoid and solve problems related to Email
Cloud Archiving.
10.1 Logging
Log files Email Cloud Archiving stores log files in the <OT logging> folder. In particular, the
following log files exist:
• ecaImap.log
Log file of the IMAP server responsible for serving Personal Archive emails to
users
• ecaSmtp.log
Log file of the SMTP server that receives incoming journaled emails
• ecaServiceStart_<journaling email address>.log
ecaServiceStop_<journaling email address>.log
Start and stop messages of the email archiving service
• emailarch_<data source identifier>.log
Log file of the email archiving service
Protocol file The email archiving service keeps a record of all processed emails in <OT var>\eca.
The name of this CSV file is emailarch_<data source identifier>-<date>.csv.
A new protocol file is started every day.
The information in the CSV file is:

Date,Status,Archive[ms],Read[ms],Extract[ms],Repository[ms],Idle[ms],
Size[Bytes],DocID,MessageID,Thread,Remark
Example:
2013/12/10 16:14:39:496,Success,302,1,3,291,0,3163,30447,<52A72EAA.
40808@gmaildev.opentext.com>,jrn-processor1,
2013/12/10 16:14:39:798,Duplicate,0,1,2,455,0,3189,30446,<52A72EAA.
40808@gmaildev.opentext.com>,jrn-processor1,

AR100500-01-ACN-EN-04
Chapter 10 Troubleshooting Email Cloud Archiving
10.2 Monitoring the Email Archiving Services

Java JConsole monitoring allows to watch the internal behavior of the Email
Archiving Services. This includes, for example, values like “heap memory usage”,
“memory pool”, “threads”, “CPU usage”, and internal variables like
“TotalDuplicates”, “ArchiveRate”, or “ProblemsArchiveCount”.
Note: For further information about Java monitoring, see the Java SE
Monitoring and Management Guide on the Oracle website (http://
docs.oracle.com/javase/7/docs/technotes/guides/management/toc.html).
Enabling To enable JConsole monitoring for a Email Archiving Service, edit the corresponding
JConsole Email Cloud Archiving job.
monitoring
To enable JConsole monitoring:
1. Start Administration Client and sign in to Archive Server.
2. In the console tree, select System > Jobs.
3. In the result pane, edit the corresponding Email Archiving job (named
EmailArchiving_<host identifier>_<m>_s<q>).
4. Append the following to the job’s Arguments:

-jmxport <free port num>
where <free port num> is a free port to which JConsole can connect later.
Example:
-collection OLZTU-1 ‑mailbox OLZTU-1_s1.demo@email.tst ‑jmxport

8139
5. Restart the job.
6. After starting JConsole (%ECM_ECA_JAVA_HOME%\bin\jconsole.exe) and

connecting, you can see the monitored variables on the MBeans tab under
com.opentext.ecb.service.unified > <journaling address> > Attributes.
Monitored The journaling service provides the following service attributes for monitoring:
attributes
Archive Rate
Number of emails archived per millisecond
Average Archive Time

Average time in milliseconds required to archive one email
Created
Time when the service was started
LastUpdated
Time of last update of the monitoring data

AR100500-01-ACN-EN-04
10.3. Avoiding out of memory errors
ProblemsArchiveCount
Number of emails in the Problems Archive folder, that is how many emails
could not be archived
ProblemsRetryCount
Number of emails in the Problems Retry folder, that is emails that could not be
archived but the service will retry to archive them
ProblemsRejectedCount
Number of emails in the Problems Rejected folder, that is emails that are
excluded from archiving (like illegal domain names of email users)
ProcessingCount
Total number of processed emails
Processors
Number of parallel processors
TotalArchiveTime
Total time used for archiving
TotalArchived
Total number of archived emails
TotalDuplicates
Total number of emails detected as duplicates
TotalRejected
Total number of rejected emails
Related Topics
• “What happens on Archive Server?“ on page 51
10.3 Avoiding out of memory errors

By default, each email archiving service is started with a maximum Java memory of
1280 MB, which is shared by all the processing threads. Very large emails can lead to
“out of memory” errors, causing the affected processing thread to die. The
remaining threads will continue to run.
Before stopping and restarting the archiving job after an out of memory error,
remove the email in question from the processing folder of the affected thread and
set it aside for reprocessing later.
To avoid memory errors, you can do the following:
• Limit the number of processing threads per Email Archiving Service by editing
the Count configuration variable (internal name:
EC.ECA.configuration.processor.count; default: 5).
• Raise the maximum Java heap size.

AR100500-01-ACN-EN-04
Chapter 10 Troubleshooting Email Cloud Archiving
1. Open the <OT install ECA>\bin\StartScenarioEmailArchiving.bat file

with an editor.
2. Locate the :STARTPROCESS label. Change the command below the label to,
for example,
"%JAVA_HOME%\bin\java" -Xrs -Xms128m -Xmx2048m %JMXJAVAARGS%
com.opentext.eca.scenario.ServiceControl %RMIOPTION% %RMIPORT%
%*
This will set the maximum available Java heap size to 2 GB.
3. Stop and restart the archiving job for the changes to take effect.
Note: The maximum heap size is limited by the physical memory of the
host, the number of archiving services, and the memory requirements of
Archive Server and the operating system.

AR100500-01-ACN-EN-04
Part 3
Configuration
Chapter 11
Setting up the infrastructure
Before you can start configuring the archive system, in particular the logical
archives, their pools and jobs, you have to prepare the infrastructure on which the
system is based.
To prepare the infrastructure:
1. Create and configure disk volumes at the operating system level to use it as
buffer, cache, or storage device.
2. Configure the storage device for longtime archiving. Set up the connection to
the Archive Server.
3. In the Administration Client:
• Set up the connection between the storage device and Archive Server.
• Add prepared disk volumes for various uses as buffers or local storage
devices (HDSK).
• Create disk buffers and attach hard-disk volumes.
• Create caches and specify volume paths.
• Check whether the storage device is usable.
11.1 Installing and configuring storage devices

The configuration of storage devices depends on the storage system and the storage
type. If you are not sure how to install your storage device, contact OpenText
Customer Support.
Note: Storage devices can now be connected to Archive Server using the
Administration Client.
Storage devices are configured and administered either in the Storage Devices or in
the Disk Volumes in the Infrastructure object in the console tree. See the tables 11-1
and 11-2 below for specific systems.
Storage There are two main types of devices that are connecting using the Storage Devices
Devices node:
• Container storage: virtual jukeboxes that are managed by STORM
These kinds of devices are also called “write at-once” and are described in
“Adding a write at-once (STORM) device” on page 73.
• Single file storage: hard disk-based storage devices (“Generalized Store”, GS)
that are connected with an API.

AR100500-01-ACN-EN-04
Chapter 11 Setting up the infrastructure
These kinds of devices are also called “single file (vendor interface)” and are
described in “Adding a single file (VI) device” on page 79.
Disk Volumes NAS and local hard disk devices are administered in the Disk Volumes node; see
“Configuring disk volumes” on page 85.
Important
Released and certified storage platforms can be found in the Storage
Platforms Release Notes in the Knowledge Center (https://
knowledge.opentext.com/knowledge/llisapi.dll/open/12331031).
Table 11-1: Types of storage devices
Storage type Possible pool types Administration

Cloud Single file (VI) Infrastructure > Storage Devices
Write at-once (ISO) Infrastructure > Storage Devices
NAS Single file (FS) Infrastructure > Disk Volumes
Single file (VI) Infrastructure > Storage Devices
Single file (VI)
CAS Infrastructure > Storage Devices
Write at-once (ISO)
SAN Write at-once (ISO) Infrastructure > Storage Devices
Table 11-2: Supported storage devices
Storage device Supported pool types

Amazon S3 Single file (VI)
Single file (FS)
EMC Celerra FLR
Write at-once (ISO)
Single file (VI)
EMC Centera
Write at-once (ISO)
Single file (FS)
EMC VNX FLR
Write at-once (ISO)
Single file (FS)
Fast LTA SilentCubes
Write at-once (ISO)
Write at-once (ISO)
Hard Disk
Write through (HDSK)
Write at-once (ISO)
Hard Disk Read Only
Write through (HDSK)
HDS HCP Single file (VI)

AR100500-01-ACN-EN-04
11.1. Installing and configuring storage devices
Storage device Supported pool types

Write at-once (ISO)
Single file (VI)
IBM TSM SSAM
Write at-once (ISO)
Single file (FS)
iTernity Compliant Solution
Write at-once (ISO)
Single file (FS)
NetApp SnapLock
Write at-once (ISO)
Single file (FS)
SUN SamFS
Write at-once (ISO)
Windows Azure Single file (VI)
Note: Storage devices can only be added in the Administration Client, not
edited or deleted.
11.1.1 Adding a write at-once (STORM) device

Independent of the specific storage device you plan to use, the basic procedure to
connect it to Archive Server is described in the following. We assume that the
storage device is ready and an IP connection between Archive Server and the device
is established. For details, see the section that corresponds to your device below.
To add a write at-once device:
1. In the Infrastructure object in the console tree, select Storage Devices.

2. In the action pane, click Add Storage Device.
3. On the General page of the Add Storage Device wizard, type a name for the
new device in the Storage Device name field.
Select the values for Storage type and Storage strategy according to “Supported
storage devices” on page 72.
Click Next.
4. If your storage type supports both kinds of Storage strategy, select Container
File.
Click Next.
5. On the Settings page, enter the values according to the section that corresponds
to your device below.
Click Test Connection to verify your settings.
To change the Maximum number of slots or the Default retention (days), click
Advanced; for details, see “Number of slots” on page 74 and “Retention”
on page 103, respectively.

AR100500-01-ACN-EN-04
Click Next.
6. On the Summary page, verify your settings.

To restart the Storage Manager, select Restart Storage Manager.
Note: You can also restart STORM later using the corresponding
commands in the action pane.
For example, you can create multiple virtual jukeboxes and then restart
STORM once.
7. Click Finish to create the new device.
Number of slots
The available storage capacity is dynamically allocated as Archive Server writes data
to the device. However, the server internally works with a fixed number of available
slots that are to be filled. If all available slots are exceeded, no new data can be
written to the device, because no new blank area is being found.
Usually, the internal limit is sufficient for most cases, but for large installations the
limit needs to be raised.
If you want to put more than 1000 ISO images (default) into one virtual jukebox, the
DS write job will return an error (not enough blank partitions); see the
Knowledge Center (https://knowledge.opentext.com/knowledge/cs.dll/open/
15536782).
In this case, the number of available slots should be raised by adding a

maxslots=<x> parameter to the device description file. The value specifies the
number of available slots for this virtual jukebox and also the size of the save file.
Note: If no maximum slot number has been specified (missing maxslots=…

line) in the device description file, the default is set to 1000 slots.
The maxslots value also specifies the size of the devices SAVE file. Lowering
the maxslots value is not allowed and may lead to unexpected results!
11.1.1.1 Compliant file systems (STORM)

What is CFS? The name Compliant File System (CFS) means the integration of file systems with
write once, read many (WORM) functionality and retention periods into Archive
Server.
Supported CFS The following Compliant File Systems are supported:

• EMC Celerra FLR
• EMC VNX FLR
• FAST LTA Silent Cubes
• Hard Disk

AR100500-01-ACN-EN-04
• Hard Disk Read Only

• iTernity iCAS
• NetApp SnapLock
• Sun SamFS
Further Detailed information about configuring a CFS storage device can be found in the
information corresponding dedicated guide: OpenText Archive Center - Compliant File System
Installation and Configuration Guide (AR-ICF).
To add a compliant file system as write at-once storage device:
1. Add a write at-once (ISO) device by following the description in “Adding a

write at-once (STORM) device” on page 73.
2. On the Settings page, enter the File system path to your device, that is the
mount path of the volume in the file system. The path is a drive under Windows
and a volume directory under UNIX/Linux.
On Windows, you can either specify fully-qualified paths of the form x:
\directory\ or UNC paths like \\NASserver\win_share1.
The Archive Spawner service must be able to access the path. You might have to
run the service under a dedicated user to achieve this. If you use a drive letter,
you will have to make sure that the drive is mapped at boot time before the
Spawner service is started and will not disconnect after being idle for a while.
For the latter reason, OpenText recommends using UNC paths and not mapped
network drives with drive letters.
Click Browse to open the directory browser. Select the designated directory and
click OK to confirm.
If you enter the directory path manually, ensure that a backslash is inserted in
front of the directory name if you are using volume letters (for example, e:
\vol2).
3. Optional To change the Maximum number of slots or the Default retention

(days), click Advanced.
For details, see “Number of slots” on page 74 and “Retention” on page 103,
respectively.
4. Click Next and then click Finish.

A device of corresponding type is added in the result pane. The new device is
attached automatically (see “Configuring STORM storage devices”
on page 78).
5. In the action pane, click Refresh to update the view in Administration Client.

AR100500-01-ACN-EN-04
11.1.1.2 EMC Centera (STORM)

Further Detailed information about configuring the EMC Centera storage device can be
information found in the corresponding dedicated guide: OpenText Archive Center - EMC Centera
Installation and Configuration Guide (AR-ICE).
To add EMC Centera as write at-once storage device:
1. Add EMC Centera as write at-once (ISO) device by following the description in
2. On the Settings page, enter the Connection string to your device.
Note: Centera connection strings containing a PEA (Pool Entry

Authorization) file require that the PEA file is located on the Archive
Server host and the path is the server path.
For details, see Section 3 “Centera connection information” in OpenText Archive

Center - EMC Centera Installation and Configuration Guide (AR-ICE).
3. Optional To change the Maximum number of slots or the Default retention
(days), click Advanced.
For details, see “Number of slots” on page 74 and “Retention” on page 103,
respectively.
The EMC Centera device is added in the result pane.
11.1.1.3 IBM TSM SSAM (STORM)

Further Detailed information about configuring the IBM TSM SSAM storage device can be
information found in the corresponding dedicated guide: OpenText Archive Center - IBM TSM
SSAM Installation and Configuration Guide (AR-IDR).
Prerequisites Follow the instructions in Section 2 “Configuring SSAM” in OpenText Archive Center
- IBM TSM SSAM Installation and Configuration Guide (AR-IDR) before continuing.
To add IBM TSM SSAM as write at-once storage device:
1. Add IBM TSM SSAM as write at-once (ISO) device by following the description
in “Adding a write at-once (STORM) device” on page 73.
2. On the Settings page, enter the following:
Management class
Enter the name of the policy that defines how objects are stored and
managed in TSM.
For details, see Section 2.3 “Management classes and retention initiation” in
OpenText Archive Center - IBM TSM SSAM Installation and Configuration
Guide (AR-IDR).

AR100500-01-ACN-EN-04
OPT file
Enter the path to the OPT file defining the connection parameters for TSM
SSAM. The OPT file must be located on the Archive Server host and the
path must be a server path.
For details, see Section 1.1 “TSM client configuration files” in OpenText
Archive Center - IBM TSM SSAM Installation and Configuration Guide (AR-
IDR).

3. Optional To change the Maximum number of slots, click Advanced.
For details, see “Number of slots” on page 74.
The IBM TSM SSAM device is added in the result pane.
You can now attach the device; see “Configuring STORM storage devices”
on page 78.
11.1.1.4 HDS HCP (STORM)

Further Detailed information about configuring the HDS HCP storage device can be found
information in the corresponding dedicated guide: OpenText Archive Center - HDS HCP
Installation and Configuration Guide (AR-IHC).
To add HDS HCP as write at-once storage device:
1. Add HDS HCP as write at-once (ISO) device by following the description in
2. On the Settings page, enter the
Connection URL (<protocol>://
<namespace>.<tenant>.<cluster>:<port>/rest/<basedir>)
and the
User name (name of the Data Access Account for the namespace).
Click Set Password and enter the (unencrypted) password for the Data Access
Account.
For details, see Section 3 “HCP HTTP connection information” in OpenText
Archive Center - HDS HCP Installation and Configuration Guide (AR-IHC).
3. Optional To change the Maximum number of slots, click Advanced.
For details, see “Number of slots” on page 74.
The HDS HCP device is added in the result pane.
You can now attach the device; see “Configuring STORM storage devices”
on page 78.

AR100500-01-ACN-EN-04
11.1.2 Configuring STORM storage devices

After installing the storage device, it appears in Storage Devices in the
Infrastructure object. To use the storage device, it must be attached. Volumes can be
attached to pools (see “Creating and modifying pools” on page 117).
Note: To determine the name of the STORM server, select Storage Devices in
the Infrastructure object in the console tree. The name of the STORM server is
displayed in brackets behind the device name, for example: WORM
(STORM1).
11.1.2.1 Attaching and detaching devices

Detached and new devices are made available to the archive by means of attaching.
In the event of maintenance and repair work, devices have to be detached
beforehand, i.e. logged off from the archive. Only then can they be turned off.
To attach a device:
1. Select Storage Devices in the Infrastructure object in the console tree.
2. Select the designated device in the top area of the result pane.
3. Click Attach in the action pane.
It is now possible to access the device. The status is set to “Attached”.
To detach a device:
2. Select the designated device in the top area of the result pane.
3. Click Detach in the action pane.
This device can no longer be accessed and can be turned off. The status is set to
“Detached”.
11.1.2.2 Initializing storage volumes

Every volume requires a name, and it must be assigned to a pool and known to the
Document Service database. Volumes that are written in ISO pools automatically get
a name and assigned to a pool when the volume is written. The original and backup
volumes are assigned the same name. Identically named ISO volumes are
automatically assigned to the correct pool.

AR100500-01-ACN-EN-04
11.1.3 Adding a single file (VI) device

Independent of the specific storage device you plan to use, the storage device must
be ready and an IP connection between Archive Server and the device must be
established.
For details about a specific device, see the section that corresponds to your device
below.
11.1.3.1 Amazon S3
This section describes the setup of Amazon Simple Storage Service (Amazon S3) as a
storage system for Archive Server. Amazon S3 can only be used as single file (VI)
device.
Note: We assume that the Amazon S3 account has been created and configured
properly.
Prerequisites Ensure that the following prerequisites are met:
• Access information for your Amazon S3 account is available. You will need your
Amazon Security Credentials (Access Key ID and the corresponding
Secret Access Key); see https://aws-portal.amazon.com/gp/aws/
securityCredentials.
• The storage container (the Bucket) has been created; see https://
console.aws.amazon.com/s3.
• An IP connection between Archive Server and Amazon S3 has been established.
To add Amazon S3 as storage device:
Select Amazon S3 as Storage type.
Click Next.
4. On the Settings page, browse for the path to the SSL certificates.
Specify a file holding one or more CA (i.e. root) certificates in PEM format. With
those certificates, an additional check against the server’s SSL certificate is
performed to verify the identity of the peer.
Tip: You can use the certificates provided in <OT config AS>/gs/
awss3_cert.pem.
Click Next and then click Finish.

AR100500-01-ACN-EN-04
A device of type Amazon S3 is added in the result pane.
To add a connection to the new storage device:
1. In the result pane, select the Amazon S3 device you created before.
2. In the action pane, click Add Connection and enter the following:
Bucket Name
Basically the top-level directory your data is being stored in. The
Bucket Name has several limitations. For details, see http://
docs.amazonwebservices.com/AmazonS3/latest/dev/
BucketRestrictions.html.
Access Key
The Access Key ID key for your Amazon S3 account. It is part of the access
credentials for your Amazon S3 account and can be found at https://aws-
portal.amazon.com/gp/aws/securityCredentials.
Secret Key
The Secret Access Key for your Amazon S3 account.
It is part of the access credentials for your Amazon S3 account and can be
found at https://aws-portal.amazon.com/gp/aws/securityCredentials.
3. Click Test Connection.
If all settings are correct, click OK to add the connection.
To initialize a volume for the new storage device:
1. In the lower part of the result pane, select the connection you created before.
2. In the action pane, click Initialize Volume.
3. Enter a name for the new volume and click OK.
Further See OpenText Archive Center - Amazon S3 Installation and Configuration Guide (AR-
information IAM) for details about the configuration.
11.1.3.2 Windows Azure

This section describes the setup of Windows Azure as a storage system for Archive
Server. Windows Azure can only be used as single file (VI) device.
Note: We assume that the Windows Azure account has been created and
configured properly.
The following requirements have to be fulfilled prior to configuring Archive Server

and Windows Azure:
• Access information for your Windows Azure storage account is available. You
will need the Storage Account name and the Primary Access Key.
• An IP connection between Archive Server and the Windows Azure service has to
be established.

AR100500-01-ACN-EN-04
To add Windows Azure as storage device:
Select Windows Azure as Storage type.
Click Next.
4. On the Settings page, browse for the path to the SSL certificates.
Specify a file holding one or more CA (i.e. root) certificates in PEM format. With
those certificates, an additional check against the server’s SSL certificate is
performed to verify the identity of the peer.
Tip: You can use the certificates provided in <OT config AS>/gs/
azure_cert.pem.
Click Next and then click Finish.

A device of type Windows Azure is added in the result pane.
1. In the result pane, select the Windows Azure device you created before.
Container name
Basically the top-level directory your data is being stored in. <Container> has
a minimum length of 3 characters.
Account name
The name of the Windows Azure storage account. This account must be
created using the Azure Management Portal (https://
manage.windowsazure.com/?whr=live.com#Workspace/All/dashboard).
Access Key
The Primary Access Key generated after creating the Storage Account.


AR100500-01-ACN-EN-04
Further See OpenText Archive Center - Windows Azure Installation and Configuration Guide (AR-
information IAZ) for details about the configuration.
11.1.3.3 EMC Centera (single file)

Further Detailed information about configuring the EMC Centera storage device can be
information found in the corresponding dedicated guide: OpenText Archive Center - EMC Centera
Installation and Configuration Guide (AR-ICE).
Prerequisites Follow the instructions in Section 2.1 “Centera server” in OpenText Archive Center -
EMC Centera Installation and Configuration Guide (AR-ICE) before continuing.
To add EMC Centera as single file (VI) device:
Select EMC Centera as Storage type and Single File as Storage strategy.
Click Next.
4. No more settings are required. Click Next.

On the Summary page, verify your settings.
1. In the result pane, select the EMC Centera device you created before.
2. In the action pane, click Add Connection and enter the Connection string.
Note: Centera connection strings containing a PEA (Pool Entry

Authorization) file require that the PEA file is located on the Archive
Server host and the path is the server path.
For details, see Section 3 “Centera connection information” in OpenText Archive

Center - EMC Centera Installation and Configuration Guide (AR-ICE).


AR100500-01-ACN-EN-04
11.1.3.4 IBM TSM SSAM (single file)

Further Detailed information about configuring the IBM TSM SSAM storage device can be
information found in the corresponding dedicated guide: OpenText Archive Center - IBM TSM
SSAM Installation and Configuration Guide (AR-IDR).
Prerequisites Follow the instructions in Section 2 “Configuring SSAM” in OpenText Archive Center
- IBM TSM SSAM Installation and Configuration Guide (AR-IDR) before continuing.
To add IBM TSM SSAM as single file (VI) device:
Select IBM TSM SSAM as Storage type and Single File as Storage strategy.
Click Next.

tsmutil tool If not done already, set the password for the TSM SSAM client and define the file
space for Archive Server on the storage device.
To set the password and create the filespace on TSM SSAM:
1. Open a command line interface and navigate to the <OT install AS>\bin
directory.
2. Run the tsmutil program in password mode to set the password for the TSM
SSAM client.
Example: root@server / # tsmutil password /usr/tivoli/tsm/client/

api/bin/tsm1.opt <client node password>
Note: On Windows, the tsmutil password ... command requires

elevation.
For details, see Section 4.1 “Setting the password” in OpenText Archive Center -
IBM TSM SSAM Installation and Configuration Guide (AR-IDR).
3. Run the tsmutil program in filespace mode to define the file space for
Archive Server.
Example: Create a file space with 20 gigabytes:

root@server / # tsmutil filespace /usr/tivoli/tsm/client/api/bin/
tsm1.opt -C <Archive Server name> 20G

AR100500-01-ACN-EN-04
For details, see Section 4.2 “Defining file space” in OpenText Archive Center -
IBM TSM SSAM Installation and Configuration Guide (AR-IDR).
1. In the result pane, select the IBM TSM SSAM device you created before.
Filespace name
Enter the name of the file space that you defined previously using the
tsmutil program.
Management class
Enter the name of the policy that defines how objects are stored and
managed in TSM.
For details, see Section 2.3 “Management classes and retention initiation” in
OpenText Archive Center - IBM TSM SSAM Installation and Configuration
Guide (AR-IDR).
OPT file
Enter the path to the OPT file defining the connection parameters for TSM
SSAM.
For details, see Section 1.1 “TSM client configuration files” in OpenText
Archive Center - IBM TSM SSAM Installation and Configuration Guide (AR-
IDR).
3. Click OK.
11.1.3.5 HDS HCP (single file)

Further Detailed information about configuring the HDS HCP storage device can be found
information in the corresponding dedicated guide: OpenText Archive Center - HDS HCP
Installation and Configuration Guide (AR-IHC).
To add HDS HCP as single file (VI) device:
Select HDS HCP as Storage type and Single File as Storage strategy.

AR100500-01-ACN-EN-04
11.2. Configuring disk volumes
Click Next.

1. In the result pane, select the EMC Centera device you created before.
2. In the action pane, click Add Connection. Enter the

Connection URL (<protocol>://
<namespace>.<tenant>.<cluster>:<port>/rest/<basedir>)
and the
User name (name of the Data Access Account for the namespace).
Click Set Password and enter the (unencrypted) password for the Data Access
Account.
For details, see Section 3 “HCP HTTP connection information” in OpenText
Archive Center - HDS HCP Installation and Configuration Guide (AR-IHC).

11.2 Configuring disk volumes

Hard disk volumes are used for disk buffers, for local caches, and as local storage
devices. At first, you create these volumes at operating system level. The number
and size depends on many factors and is usually defined together with OpenText
experts or partners when the installation is prepared. Important factors are:
• Leading application and scenario
• Number and size of documents to be archived and accessed, per time unit
• Frequency of read access
• If the volume is used as disk buffer:
Pool and media type, in particular if ISO images are written.
The buffer must be large enough to accommodate the entire storage capacity of
the ISO image, and in addition, the amount of data that has to be stored in the
buffer between two Write jobs.
• If the volume is used as cache:

AR100500-01-ACN-EN-04
If documents are retrieved after archiving, for example, in Early Archiving

scenarios, they should stay on the hard disk for a while. The cache volume must
be large enough to store documents for the required time. You can configure and
schedule the Purge_Buffer job to copy documents automatically to the cache
(see “Configuring caches” on page 93).
• If the volume is used as storage device:
Hard disk volumes can be used for NAS (Network Attached Storage) systems
and as local storage device (HDSK pool). Using HDSK pools is only
recommended for test purposes. Ensure that the volume is large enough to store
your test documents. See “Configuring a volume for single-file storage”
on page 87.
11.2.1 Creating and modifying disk volumes

The hard disks must be partitioned at the operating system level first. These disk
volumes can be added in Administration Client to be used by Archive Server. This
process is called creating. After creating, the disk volumes can be used as buffer,
pool, or local storage device of a logical archive.
To create disk volumes:
1. Create the volumes at the operating system level.

2. Start Administration Client.
3. Select Disk Volumes in the Infrastructure object of the console tree.
4. Click New Disk Volume in the action pane. The New Disk Volume window
opens.
5. Enter the settings:
Volume name
Unique name of the volume
Mount path
Mount path of the volume in the file system. The mount path is a drive
under Windows and a volume directory under UNIX/Linux.
On Windows, you can either specify fully-qualified paths of the form x:
\directory\ or UNC paths like \\NASserver\win_share1.
The Archive Spawner service must be able to access the path. You might
have to run the service under a dedicated user to achieve this. If you use a
drive letter, you will have to make sure that the drive is mapped at boot
time before the Spawner service is started and will not disconnect after
being idle for a while. For the latter reason, OpenText recommends using
UNC paths and not mapped network drives with drive letters.
Click Browse to open the directory browser. Select the designated directory
and click OK to confirm.
If you enter the directory path manually, ensure that a backslash is inserted
in front of the directory name if you are using volume letters (for example,
e:\vol2).

AR100500-01-ACN-EN-04
11.2. Configuring disk volumes
Volume class
Select the storage medium or storage system to ensure correct handling of
documents and their retention.
Hard Disk
Hard disk volume that provides WORM functionality or that can be
used as disk buffer. Documents are written from the buffer to the
volume without additional attributes. Use this volume class for buffers.
Hard Disk based read-only system

Local hard-disk volume read-only, documents are written from the
buffer to the volume and the read-only attribute is set.
Further supported storage vendors

For details on the other supported storage systems, see “Configuring a
volume for single-file storage” on page 87 and the Storage Platform
Release Notes in the Knowledge Center (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/12331031).
6. Click Finish.
Create as many hard-disk volumes as you need.
Renaming disk To rename a disk volume, select it in the result pane and click Rename in the action
volumes pane.
Note: If you want to rename a disk volume, make sure that an existing
replicated disk volume is also renamed. Then start the Synchronize_Replicates
job on the remote server. This will update the volume names on both servers.
Procedure
• “Creating and modifying a disk buffer” on page 88

• “Creating and modifying a HDSK (write-through) pool” on page 118
• “Creating and modifying pools with a buffer” on page 119
11.2.2 Configuring a volume for single-file storage

Compliant File Systems used as single-file storage are connected through disk
volumes.
To configure a volume for single-file storage:
1. Consult OpenText Archive Center - Compliant File System Installation and

Configuration Guide (AR-ICF). In particular, see the “Prerequisites” and follow
the instructions for your system in the section “Subsystem Specifics”.
2. Follow the general procedure in “Creating and modifying disk volumes”

on page 86 to create a new disk volume.
3. Create buffers and caches as required (see sections below for details).

AR100500-01-ACN-EN-04
4. Create logical archive(s) with pools of type Single File (FS); see “Configuring
archives and pools“ on page 99.
11.3 Configuring buffers

Disk buffers (short: buffers) are required for all pool types except for local HDSK
(write-through) pools. Documents are collected in the buffer before they are finally
written to the storage medium by the Write job. You must use either local hard
disks or SAN disks as disk buffers.
Preconditions The hard disks must be partitioned at the operating system level and then created in
Administration Client. See “Creating and modifying disk volumes” on page 86.
11.3.1 Creating and modifying a disk buffer

To create a disk buffer:
1. Select Buffers in the Infrastructure object in the console tree.
2. Click New Original Disk Buffer in the action pane.
Disk buffer name

Name of the disk buffer. The name cannot be modified later.
Purge job
Name of the Purge_Buffer job.
Min. free space

Minimum available storage space (%). If selected, the Purge_Buffer job
deletes data from the buffer until the required percentage of storage space is
available. This applies to every hard-disk volume that is assigned to the
buffer.
If it is not possible to delete sufficient documents from the disk buffer
because these have not yet been written to storage media, the
Purge_Buffer job is terminated without a message and the required
minimum amount of storage space is not available. You can check the free
space in the disk buffers using Archive Server Monitoring (see “Using
OpenText Archive Server Monitoring“ on page 325).
Purge documents older than ... days

Specifies the time period after which documents are removed from the disk
buffer. The time period starts after the documents are written to a storage
medium.
Cache documents before purging

Ensures that documents are always fast accessible on a fast hard disk
(buffer or cache).
See also “Configuring caches” on page 93.

AR100500-01-ACN-EN-04
11.3. Configuring buffers
Verify documents by checksums if checksums are longer than ... bits

If selected, the Purge_Buffer job uses checksums of documents to compare
documents instead of byte-wise comparison of the documents themselves.
You can specify how long at least the checksum must be to be used for
comparison. Otherwise, byte-wise comparison is used. Enabling checksum
comparison can improve performance.
Number of threads
You can change the number of threads used by the Purge_Buffer job to
improve performance (1-50 threads); default: 3.
Note: If both conditions Purge documents older than ... days and Cache
documents before purging are specified, the job runs in a way which
satisfies both conditions to the greatest possible extent. Documents that are
older than n days are also deleted even if the required storage space is
available. Conversely, documents that are more recent than n days are
deleted until the required percentage of storage space is free.
4. Click Next and read the information carefully.
5. Click Finish to create the disk buffer.
6. Attach a hard disk volume to the disk buffer.

See “Attaching a disk volume to a disk buffer” on page 89.
7. Schedule the Purge_Buffer job. The command and the arguments are entered
automatically and can be modified later. See “Setting the start mode and
scheduling of jobs” on page 148.
Modifying a disk To modify a disk buffer, select it and click Properties in the action pane. Proceed in
buffer the same way as when creating a disk buffer. The name of the disk buffer and the
Purge_Buffer job cannot be changed.
Deleting a disk To delete a disk buffer, select it and click Delete in the action pane. A disk buffer can
buffer only be deleted if it is not assigned to a pool.
11.3.2 Attaching a disk volume to a disk buffer

A disk buffer needs at least one disk volume to be usable. By and by, the archive
system grows, and the initial configuration of buffers might become too small for a
buffer. To adjust the configuration, you can attach additional volumes to the disk
buffer.
Replicated volumes are attached to a replicated buffer on the Remote Standby Server
in the same way.
To attach a volume to a buffer:
2. Select the designated disk buffer in the top area of the result pane.

AR100500-01-ACN-EN-04
3. Click Attach Volume in the action pane. A window with all available volumes
opens.
4. Select an existing volume. The volume must have been created previously; see
“Creating and modifying disk volumes” on page 86.
5. Click OK to attach the volume.
Related Topics
• “Creating and modifying disk volumes” on page 86
• “Creating and modifying a disk buffer” on page 88
11.3.3 Detaching a volume from a disk buffer

If a re-configuration of disk buffers is required, sometimes it is necessary to detach a
volume from a disk buffer. This is the case when you want to reduce the size of the
disk buffer or move resources to another disk buffer because the amount of data to
be archived has increased considerably. When the volume has been detached, it can
be attached to another buffer. A volume does not receive any more data when it is
not attached to a buffer.
Note: If a buffer is attached to a pool, it must have at least one attached hard-
disk volume. Thus, the last hard-disk volume cannot be detached.
To detach a volume from a buffer:
3. Select the volume to be detached in the bottom area of the result pane.
4. Click Detach Volume in the action pane.
5. Confirm with OK to detach the volume.
11.3.4 Configuring the Purge Buffer job

If documents are not immediately deleted from the disk buffer after being written to
a storage medium, they must be removed from the buffer at regular intervals. For
example, in some pool types, the disk buffer is used as a type of cache. Documents
are removed from the disk buffer using the Purge_Buffer job. This job is created
when a disk buffer is created.
To configure a Purge_Buffer job:
3. Click Edit Purge Job in the action pane.

AR100500-01-ACN-EN-04
11.3. Configuring buffers
Job name
The job name is set during buffer creation and cannot be changed.
Command
The command is set to Purge_Buffer during buffer creation.
Arguments
The argument is set to the buffer's name during buffer creation.
Start mode
Configures whether the job starts at a certain time or after a previous job
was finished. See also “Setting the start mode and scheduling of jobs”
on page 148.
5. Click Next.
6. Enter the settings for the selected start mode.
7. Click Finish.
Related Topics
• “Creating and modifying jobs” on page 147
• “Setting the start mode and scheduling of jobs” on page 148
11.3.5 Checking and modifying attached disk volumes

This function can be used to check the status of a volume, for example if it is online.
For maintenance, volumes can be set to write locked or locked to avoid access.
To check and modify a volume:
2. Select the Original Disk Buffers tab or the Replicated Disk Buffers tab,
according to the type of buffer you want to check or modify.
4. Select the volume you want to check in the bottom area of the result pane.
5. Click Properties in the action pane. A window with volume information opens.
Volume name
The name of the volume
Type
Original or replicated
Capacity (MB)
Maximum capacity of the volume

AR100500-01-ACN-EN-04
Free (MB)
Free capacity of the volume
Last Backup or Last Replication
Date when the last backup or the last replication was performed. Depends
on the type of the volume.
Host
Specifies the host on which the replicated volume resides if the disk buffer
is replicated
6. Modify the volume status if necessary. To do this, select or clear the status. The
settings that can be modified depend on the volume type.
Full, Offline
These flags are set by Document Service and cannot be modified.
Write locked
No more data can be copied to the volume. Read access is possible; write
access is protected.
Locked
The volume is locked. Read or write access is not possible.
Modified
Is automatically selected, if the Document Service performs a write access to
a HDSK volume. If cleared manually, Modified is selected with the next
write access again.
7. Click OK.
11.3.6 Synchronizing servers

The Synchronize Servers function transfers settings from known servers to the local
server. This is useful if settings on a known server are changed (for example,
replicated archives, pools, or buffers).
You can update the following properties:

• Settings of replicated archives
• Settings of replicated buffers
• Encryption certificates
• Timestamp certificates
• System keys
To synchronize servers:
1. Select Buffers in the Infrastructure object or select Archives in the in the

console tree.
2. Click Synchronize Servers in the action pane.

AR100500-01-ACN-EN-04
11.4. Configuring caches
3. Click OK to confirm. The synchronization is started.
11.3.7 Configuring replicated buffers

Buffers of replicated archives can also be replicated if necessary.
To configure replicated buffers:
1. Select Known Servers in the Environment object in the console tree.
3. Select the disk buffer you want to replicate in the bottom area of the result pane.
4. Click Replicate in the action pane.
5. Enter a name for the replicated disk buffer, click Next.
Note: If you want to rename a replicated disk volume, you also have to
rename the original disk volume to the same new name. Then start the
Synchronize_Replicates job on the remote server. This will update the
volume names on both servers.
6. Click Finish.
11.4 Configuring caches

11.4.1 Overview
Caches are used to speed up the read access to documents. The local cache resides
on the Archive Server and is recommended to accelerate retrieval actions. To use a
local cache, it must be assigned to a logical archive.
A cache must have at least one assigned hard-disk volume. It is also possible to
assign more disk volumes to a cache and to configure their priority.
Note: Do not mix up the local cache and Archive Cache Servers. See also
“Configuring Archive Cache Server“ on page 225).
The local cache can be filled on different ways:
• When a document is retrieved for reading.

• While documents are written to the final storage medium (Write job).
• When the buffer is purged (Purge_Buffer job).

AR100500-01-ACN-EN-04
Buffers Caches
Disk Volume Disk Volume Disk Volume Disk Volume Disk Volume Disk Volume
... ...
Purge_Buffer
activity
Write activity Content retrieval
Storage Volume Storage Volume Storage Volume
Pools ...
Figure 11-1: Filling the local cache
Global cache
If no cache path is configured and assigned to a logical archive, the global cache is
used. The global cache is usually created during installation but there is no volume
assigned. To use the global cache a volume must be assigned. See “Adding hard-
disk volumes to caches” on page 95.
Depending on the time when you want to cache documents, you select the
appropriate configuration setting:
Table 11-3: Cache configuration
Enable caching for the Caching option in the archive configuration; see “Configuring the
logical archive archive settings” on page 113
Caching when the If the Write job is performed, documents are also written to the
document is written cache.
Caching when the Cache documents before purging option in the disk buffer
buffer is purged properties. See “Creating and modifying a disk buffer” on page 88.
Related Topics
• “Adding hard-disk volumes to caches” on page 95
• “Creating and deleting caches” on page 95
• “Defining priorities of cache volumes” on page 96

AR100500-01-ACN-EN-04
11.4. Configuring caches
11.4.2 Creating and deleting caches

If you want to assign a local cache to a logical archive, you create a cache and assign
one or more volumes to it.
To create a cache:
1. Create the volumes for the caches on the operating system level.
2. Start the Administration Client and sign in.
3. Select Caches in the Infrastructure object in the console tree.
4. Click New Cache in the action pane.
5. Enter the Cache name and click Next.
6. Enter the Location of the hard-disk volume.
7. Click Finish.
Note: If you want to change the priority of assigned hard-disk volumes, see
“Defining priorities of cache volumes” on page 96.
Deleting a To delete a cache, select it and click Delete in the action pane. It is not possible to
cache delete a cache which is assigned to a logical archive. The global cache cannot be
deleted either.
Related Topics
• “Adding hard-disk volumes to caches” on page 95
11.4.3 Adding hard-disk volumes to caches

A cache must have at least one assigned hard-disk volume. The global cache is
usually created during installation but not the corresponding volume. You can
modify the initial configuration of the global cache by adding or deleting volumes.
Caution
Be aware that your cache content gets invalid if you change the volume
priority.
To add a HD volume to a cache:
2. Select the designated cache in the top area of the result pane. In the bottom area
of the result pane, the assigned hard-disk volumes are listed.
3. Click Add Cache Volume in the action pane.

AR100500-01-ACN-EN-04
4. Click Browse to open the directory browser. Select the designated Location of
the hard-disk volume and click OK to confirm.
5. Click Finish to add the new cache volume.
Note: If you want to change the priority of hard-disk volumes, see “Defining
priorities of cache volumes” on page 96.
Related Topics
11.4.4 Deleting assigned hard-disk volumes

Note: A cache must have at least one assigned hard-disk volume. Thus, the last
assigned hard-disk volume cannot be deleted.
To delete a HD volume:

of the result pane, the assigned hard-disk volumes are listed.
3. Select the hard-disk volume you want to delete.
4. Click Delete in the action pane.
5. Click OK to confirm.
Note: If you want to change the priority of hard-disk volumes, see “Defining
priorities of cache volumes” on page 96.
Related Topics
11.4.5 Defining priorities of cache volumes

If there is more than one hard-disk volume assigned to a cache, the priority of the
single volumes can be defined.
Caution
Be aware that your cache content gets invalid if you change the volume
priority.
To define the priority of cache volumes:

AR100500-01-ACN-EN-04
11.5. Checking unavailable volumes
of the result pane the assigned hard-disk volumes are listed.
3. Click Change Volume Priorities in the action pane. A window to change the
priorities of the volumes opens.
4. Select a volume and click the designated arrow button to increase or decrease
the priority.
5. Click Finish.
11.5 Checking unavailable volumes

If a document is requested that is stored on an offline medium, the requestor gets a
corresponding message. In addition, an entry is created in Storage Devices
(Unavailable Volumes tab) in the Infrastructure object in the console tree. The
administrator can check how often this volume was requested.
To check unavailable volumes:
2. Select the Unavailable Volumes tab in the result pane to list all unavailable
devices.
11.6 Changing the database user password

Login and password of the database user are stored encrypted in the DBS.Setup file.
If you change the password of the database user, you must change it in the
corresponding database entry, too.
To change the password of the DB user:
1. Change the password on the database. Make sure to create a secure password.
Note: Characters allowed within a password are all printable ASCII

characters except ;, ' and ".
2. In the console tree, expand Archive Server > Configuration and search for the
User password of database variable (internal name: AS.DBS.DBPASSWORD;
see “Searching configuration variables” on page 242).
3. Open the User password of database configuration parameter, enter the new
password and click OK.
The password is encrypted automatically.
4. For the changes to take effect, restart the Apache Tomcat and Archive Spawner
services.

AR100500-01-ACN-EN-04
11.7 Setting the reconnection time for the database

By default, Archive Server tries to reconnect to the database for five minutes if the
connection has been lost. Under some circumstances, for example in high-
availability or database server scenarios, this value can be too short. You can
configure the reconnection time as follows.
To configure the reconnection time:
Number of minutes to wait for reconnect variable (internal name:
AS.DBS.MAXWAITTIMETORECONNECTMINUTES; see “Searching
configuration variables” on page 242).
2. Open the Number of minutes to wait for reconnect variable and enter the time
in minutes during which Archive Server tries to reconnect to the database.
Note: The recommended value depends on the scenario.
Click OK.

AR100500-01-ACN-EN-04
Chapter 12
Configuring archives and pools
Before you can work effectively with Archive Server, you have to perform some
configuration steps:
• Create and configure logical archives
• Create storage tiers
• Create and configure pools
• Schedule and configure jobs
• Configure security settings
• Configure the storage system
When you configure the archive system, you often have to name the configured
element. Make sure that all names follow the naming rule:
Naming rule for archive components
Archive component names must be unique throughout the entire archive

network. No umlauts or special characters must be used for the names of
archive components. This includes names of servers, archives, pools and
volumes. OpenText recommends using only numerals and standard
international letters when assigning names to archive components. Archive
and pool names together may have at maximum 31 characters in length since
the Document Service forms an internal pool name of the form <Archive
name>_<Pool name>, which may have at maximum 32 characters in length.
12.1 Logical archives

The logical archive is the logical unit for well-organized long-term data storage.
Within Administration Client, three groups of logical archive types are available:
• Original Archives
Logical Archives which are created on the actual administered (local) server.
• Replicated Archives
Replications of original logical archives. These archives are located and
configured on known servers for remote standby scenarios. Thus, document
retrieval is possible although the access to the original archive is disconnected
(see “Configuring remote standby scenarios“ on page 219).
• External Archives
Logical archives of known servers. These archives are located on known servers
and can be reached for retrieval (see “Adding and modifying known servers“
on page 215).

AR100500-01-ACN-EN-04
Chapter 12 Configuring archives and pools
For each original archive, you give a name and configure a number of settings:
• Encryption, compression, BLOBs and single instance affect the archiving of a
document.
• Caching and Archive Cache Servers affect the retrieval of documents (see
“Configuring archive access using an Archive Cache Server” on page 235).
• Signatures, SSL and restrictions for document deletion define the conditions for
document access.
• Timestamps and certificates for authentication ensure the security of documents.
• Auditing mode, retention and deletion define the end of the document lifecycle.
Some of these settings are pure archive settings. Other settings depend on the
storage method, which is defined in the pool type. The most relevant decision
criterion for their definition is single file archiving or container archiving.
Of course, you can use retention also with container archiving. In this case, consider
the delete behavior that depends on the storage method and media (see “When the
retention period has expired” on page 247).
12.1.1 Data compression

In order to save storage space, data compression is activated by default for all new
archives. You can deactivate compression for individual archives; see “Configuring
the archive settings” on page 113.
Formats to All important formats including email and office formats are compressed by default.
compress You can check the list and add additional formats in Configuration, search for the
List of component types to be compressed variable (internal name:
COMPR_TYPES (row1 to rowN); see “Searching configuration variables”
on page 242).
Pools with For pools using a disk buffer, the Write job compresses the data in the disk buffer
buffer and then copies the compressed data to the medium. After compressing a file, the
job deletes the corresponding uncompressed file.
If ISO images are written, the Write job checks whether sufficient compressed data
is available after compression as defined in Minimum amount of data to write. If so,
the ISO image is written. Otherwise, the compressed data is kept in the disk buffer
and the job is finished. The next time the Write job starts, the new data is
compressed and the amount of data is checked again.
HDSK pool When you create an HDSK pool, the Compress_<archive name>_<pool name> job is
created automatically for data compression. This job is activated by default.

AR100500-01-ACN-EN-04
12.1.2 Single instance

Single instance You can configure a logical archive in a way that requests to archive the same
component do not result in a copy of the component on the Archive Server but in a
single instance of the component. The component is archived only once and then
referenced. This method is called Single Instance Archiving (SIA) and it saves disk
space. It is mainly used if a large number of emails with identical attachments have
to be archived.
By default, Single Instance Archiving is disabled. You can enable it, for example, for
email archives; see “Configuring the archive settings” on page 113.
Important
• OpenText strongly recommends not using single instance in combination
with retention periods for archives containing pools for single file
archiving (FS, VI, HDSK).
• If you want to use SIA together with retention periods, consider
“Retention” on page 103.
Excluding If necessary, you can exclude component types (formats) from Single Instance
formats from Archiving. Microsoft Exchange and Lotus Notes emails are excluded by default
SIA
because their bodies are unique, although the attachments are archived with SIA.
To exclude component types from SIA:
List of component/application types that are NOT using SIA variable (internal
name: AS.DS.SIA_TYPES; see “Searching configuration variables”
on page 242.
3. Open the Properties window of the configuration variable and add the MIME
types to be excluded.
4. Click OK and restart the Archive Spawner service.
SIA and ISO Be careful when using Single Instance Archiving and ISO images: Emails can consist
images of several components, for example, logo, footer, attachment, which are handled by
Single Instance Archiving. Using ISO images, these components can be distributed
over several images. When reading an email, several ISO images must be accessed to
read all the components in order to recompose the original email. Caching for
frequently used components and proper parameter settings will improve the read
performance.
SIA for emails For emails, archiving in single instance mode decomposes emails, which means that
attachments are removed from the original email and are stored as separate
components on Archive Server. As soon as an email is retrieved from Content
Server, it is checked whether the email needs to be recomposed. If so, the

AR100500-01-ACN-EN-04
appropriate attachments are reinserted into the email and the complete email is
passed to Content Server.
Important
If you use OpenText Email Archiving or Management, do not use the Email
Composer additionally.
Configuring Composing or decomposing emails can use a lot of memory, which has impact on
email (de-)com- the performance. Therefore, you can configure how large emails are handled as
posing
described below.
To configure email (de-)composing for SIA:

2. Change the following variables if required.
• Maximum size of an email message, which will be decomposed

(decomposer) (internal name:
AS.AS.EA_DECOMPOSER_MAX_MSG_SIZE_MB)
Maximum size (in megabytes) an email can have to be decomposed. Emails
larger than this value are not decomposed.
Default: 200 MB.
• Maximum size of an email where composing/decomposing will totally be
done in memory (internal name: AS.AS.EA_STORE_TO_FILE_SIZE)
Maximum size (in bytes) an email can have when composing or
decomposing to be held in memory. Emails larger than this value will
temporarily be stored in the filesystem.
Default: 10000000 = 9.53 MB
• Temporary directory to de-/compose emails (internal name:
AS.AS.EA_TMP_DIR)
Temporary storage for large emails when composing or decomposing, that is
for emails larger than specified by the Maximum size of an email where
composing/decomposing will totally be done in memory parameter.
In addition, this directory is always used to temporarily hold a backup of the
email during decomposition.
Note: Make sure that the available storage is sufficient.

AR100500-01-ACN-EN-04
12.1.3 Retention
Introduction This part explains the basic retention handling mechanism of Archive Server.
OpenText strongly recommends reading this part if you use retention periods for
documents. For administration, see “Configuring the archive retention settings”
on page 114.
Retention The retention period of a document defines a time frame, during which it is
period impossible to delete or modify the document.
The retention period – more precisely, the expiration date of the retention period – is
a property of a document and is stored in the database and additionally together
with the document on the storage medium, if possible.
Compliance Various regulations require storing documents for a defined retention period. To
facilitate compliance with regulations and meet the demand of companies, Archive
Server can handle retention of documents in cooperation with the leading
application and the storage subsystem. The leading application manages the
retention of documents, and Archive Server executes the requests or passes them to
the storage system.
To meet compliance, the content of documents needs to be physically protected or

protected by a system supporting a WORM capability. This means that it is not
sufficient to store the components with a specified retention period on a simple hard
disk.
12.1.3.1 Basics – retention on Archive Server

Introduction Retention handling enables a leading application to implement retention
management and pass retention periods to Archive Server. Archive Server sets the
retention period for documents during creation of the first document component.
The retention period is then inherited by all components of the document. A
component cannot be deleted or updated as long as the retention period has not
expired. Updating of notes and annotations, also called add-ons, is allowed.
Retention Modern storage systems support retention periods on hardware level. Archive
handling Server can propagate the retention period to those storage systems.
The overall retention handling process is designed as a top down concept:

• The client of the leading application sends the retention period explicitly. This
means, the leading application specifies a retention period (and a retention
behavior) during the creation of a document. Archive Server sets the retention
period on the storage systems.
• If nothing is specified by the leading application, the document can inherit a
default retention period and a retention behavior on the Archive Server. The
retention behavior is then part of the document, i.e. modifying the archive-
specific retention does not modify the document’s retention. The default values
are configured per logical archive within OpenText Administration Client (see
“Configuring the archive retention settings” on page 114).

AR100500-01-ACN-EN-04
• When the retention period has expired, the leading application has to trigger the
deletion of the document. Archive Server then triggers the purge of the files on
the storage system.
If both explicit and default retention period are given, the leading application has
priority.
Archive Server only reacts to requests sent by the leading application. That is why
we talk about retention handling in Archive Server. Thereby, we avoid the situation
that a leading application still might have index information for documents already
deleted in Archive Server.
Changing the retention settings on the archive has no influence on already archived
documents. However, it is possible to prolong the retention period using the
ArchiveLink API.
Note: As regulations can change in the course of time, you can adapt the
retention period of documents by means of a complete document migration;
see “Migration” on page 271.
Handling of Notes and annotations can be added to a document, they are add-ons and do not
add-ons change the document itself. Components that are defined as add-ons and that can be
modified during the retention period are listed in the List of addon components
variable (retrieve the variable in Configuration; see “Searching configuration
variables” on page 242; internal variable name: ADDON_NAMES (row1 to.rowN).
Compliance Archive Server supports two different kinds of compliance regulations:
Fixed retention
The retention period is known at creation time, and can be propagated to the
storage system. The storage system protects against illegal deletion: neither an
application nor Archive Server are able to delete the object on the storage system
before the retention period has expired.
Variable retention
The retention period is unknown at creation time, or can change during the
document life cycle. In this case, retention periods have to be handled by the
leading application only (i.e., the leading application sets retention to
READ_ONLY), and cannot be passed to Archive Server (i.e. no retention is set at
the archive).
Retention types Different retention types can be applied during the creation of a document by the
leading application or by inheritance of default values on the Archive Server (see
“Configuring the archive retention settings” on page 114).

AR100500-01-ACN-EN-04
Table 12-1: Retention period types
Retention Period Type Description

NONE No retention defined on the Archive Server. Retention period
is not propagated to the storage system.
Compliant File Systems only

The retention value NONE is always mapped to “NOW
+ 3 s” on the storage system for technical reasons.
DATE Retention period (in days)
INFINITE Infinite retention period. The document can never be deleted.
READONLY Use this mode when retention periods have to be handled by
the leading application only. Archive Server will prevent
updating components unless the component is an add-on.
Deleting components and documents is possible.
A retention period of zero days is set on the storage platform.
Use read-only only for single file scenarios. Do not use it

together with ISO, SIA, or meta-documents.
Compliant File Systems only

The retention value READONLY is always mapped to
“NOW + 3 s” on the storage system for technical
reasons.
Retention The following table lists settings and their impact on the retention behavior (see
behavior “Configuring the archive retention settings” on page 114):
Table 12-2: Retention behavior settings
Setting Description
Deferred Deferred archiving prevents Archive Server from writing the content from
archiving the disk buffer to the storage system until another call removes the deferred
flag from the document.
Destroy Destroy activates overwriting the document several times before purging.
Destroy is not available for all storage system.
Terms used The terms storage system or storage platform are used for any long-term storage device
supported by Archive Server, such as Content-Addressed Storage (CAS), Network-
Attached Storage (NAS), Hierarchical Storage Management Systems (HSM) and
others. The term delete refers to the logical deletion of a component and the term
purge is used to describe the cleanup of content on the storage system.
Related Topics
• “Configuring the archive retention settings” on page 114
• “When the retention period has expired” on page 247

AR100500-01-ACN-EN-04
12.1.3.2 Retention on storage systems

Introduction The retention period is set for each document within the Archive Server database. If
the retention period is propagated to the underlying storage system, the physical
retention on the storage system can differ from the retention period maintained in
the Archive Server database. This depends on the storage scenario in use, for
example, container or single instance archiving.
Using retention periods requires a thorough planning. The storage system, the pool
type in use, and other settings (Single File, ISO, BLOBs, single instance archiving,
etc.) can influence retention handling.
Tips
• If you use retention for archives with Single Instance Archiving (SIA), make
sure that documents with identical attachments are archived within a short
time frame and the documents in one archive have similar retention
periods. See also: “Single instance” on page 101.
• You cannot export volumes containing at least one document with non-
expired retention.
• If retention periods vary strongly, delete requests for the documents will
spread over a long period. In this case, single document storage should be
preferred.
• If documents stored within the same archive have a similar retention
period, the retention will expire within a short time window for these
documents. In this case, ISO images can be used for storage.
Retention on The following table lists the storage systems and their retention handling.
storage
systems
Table 12-3: Retention on storage systems
Pool Type Retention

Single File (FS) Retention is set if supported by the storage system.
Write At Once (ISO) Retention is stored in the ISO image and set on the storage
system, if supported by the storage system. The retention
period is the maximum of the periods of all files in the ISO
image.
Single File (VI) Retention set if supported by the storage system.
For the concrete retention support of the storage system, refer to the storage release
notes.

AR100500-01-ACN-EN-04
12.1.3.3 Document deletion

Document When the retention period has expired, Archive Server allows the client to delete the
deletion document. The leading application must send the deletion request.
New: With version 10.5.0 SP1, you can also use the AutoDelete job to find and
remove documents with expired retention. For more information, see “Other
jobs” on page 144.
When the retention periods of documents have expired, documents can be deleted
mainly to
• free storage space and thus to save costs,

• get rid of documents that might cause liability of the company.
In this case, the document has to be deleted as soon as possible after the retention
period has expired. This case cannot be fulfilled immediately if the document is
stored within a container like an ISO image, a BLOB, a meta-document, or
referenced by other objects (Single Instance Archiving).
The following retention-independent settings can prevent deletion:
• Document deletion settings for the logical archive (see Document deletion
on page 113) and
• The maintenance level of Archive Server (see “Setting the operation mode of
Archive Server” on page 350).
Deletion The deletion process has two aspects:

process
• Delete the document logically, that means: Delete the information on the
document from the archive database so that retrieval is not possible any longer.
Only the information that the document was deleted is kept. This step is
executed as soon as the delete request arrives.
• Delete (= purge, remove) the document physically from the storage media. The
time of this action depends on the storage method:
• Documents that are stored as single files can be deleted immediately.

• Documents that are stored in containers (ISO images, BLOBs) can be deleted
physically only when the retention period of all documents in the container
has expired and all documents are deleted logically. The
Delete_Empty_Volumes job checks for such volumes and removes them if the
underlying storage system does not prevent it.
For the concrete retention support of the storage system, refer to the Storage Release
Notes.
Deletion The following lists the deletion behavior per pool type.
behavior

AR100500-01-ACN-EN-04
Deletion behavior per pool type
ISO Images
Purging a document in an ISO image cannot be completed before all documents
on the image have been deleted. Only after that, the ISO image file can be
purged from the storage system.
Single Instance Archiving
Be careful when using single instance archiving (SIA) and retention periods; see
also “Retention on storage systems” on page 106.
Example: An email with an attachment is archived in 2005 with the retention period of 5
years. ISO images are used. The ISO image is stored as a file on the storage system with a
retention period, which is the maximum of all documents in the ISO image. Assume the
maximum is 2010.
Another email with the same attachment is archived in 2007 and retention period of 5
years.
The components cannot be deleted from Archive Server since they are belonging to a
document with a proper retention. However, the image file on the storage system could
be purged by tools of the storage system, as in 2010 the retention period of the ISO image
expires.
BLOB
Take care when using containers such as BLOBs. A BLOB has a retention which
is the maximum retention of all documents within the BLOB.
Single documents within a BLOB cannot be copied and nor be purged, BLOBs
can only be copied or purged as a whole.
Purge process A document or component can be deleted after the retention of the document has
expired or no retention has been applied.
The leading application can delete a single component or delete the document.
Deleting a document implies that all components are deleted and then the document
itself. Due to the nature of storage, deletion cannot be handled within a transaction.
Purge process
ISO, BLOB
Delete requests cannot be propagated to the storage system.
The document is deleted in Archive Server. The content remains on the storage
system until all documents on the media or container have been deleted. The
DELETE_EMPTY_VOLUMES job purges the container files on the storage
system.
Single file pools
Delete requests for the components and documents initiate a synchronous purge
request on the storage system.
The following error situation can arise:
Storage system reports an error when the document or component is to be
deleted.

AR100500-01-ACN-EN-04
• For documents: The document information in Archive Server is deleted (as all
component information is already deleted).
• For components: The component information in Archive Server is deleted.
Note: This is new for versions from 10.0 on. In former versions, the
leading applications received an error message and the component
information was not deleted.
The leading application gets a success message. In addition, an

administrative notification is sent. A job will regularly retry to purge the
orphaned content on the storage system (version 9.7.0 or later).
If in doubt, contact OpenText Customer Support.
Purging content In single file archiving scenarios, the content on the storage system is purged during
the delete command. Content on ISO images cannot be purged, and an additional
job is necessary to purge the content as soon as all content of the partition is deleted
from Archive Server.
The purging capabilities depend on storage system and pool type. The following
table lists the purge behavior depending on the pool type.
Table 12-4: Purging content
Pool Type Purge Content Destroy (overwrite)

Single File (VI) YES NO
ISO Not immediately NO
Use DELETE_EMPTY_
PARTITIONS job.
Single File (FS) YES Destroy is propagated to the storage
system but not all storage systems will
execute the destruction.
Deletion on The deletion of documents, BLOBs and partitions is automatically propagated to

backup media backup volumes. Note that backup volumes must be online. The following table lists
the deletion behavior depending on the pool type.
Table 12-5: Deletion on backup media
Pool Type Local backup Backup media (remote standby)

Single File (VI) Not supported Document delete requests and purge
requests are asynchronously
forwarded to the Remote Standby
Server (SYNCHRONIZE_
REPLICATES job).

AR100500-01-ACN-EN-04
Pool Type Local backup Backup media (remote standby)

ISO Call DELETE_EMPTY_ Deletion of all identical ISO images is
VOLUMES job. Deletes all automatically done by the
identical ISO images SYNCHRONIZE_REPLICATES job.
Single File (FS) Not supported Document delete requests and purge
requests are asynchronously
forwarded to the Remote Standby
Server (SYNCHRONIZE_
REPLICATES job).
Note: If the document’s retention date has changed on the original server due
to a migrate call, the new values are only held by Archive Server and not
written to the ATTRIB.ATR file, which holds the technical metadata of the
document. The ATTRIB.ATR file will only be updated if the document is
updated, for example, if a component is added on the original server or if the
document is copied to a different volume.
As soon as the updated ATTRIB.ATR has been replicated to the Remote Standby
Server, the new retention value will be known on the Remote Standby Server.
12.1.3.4 VolumeMigration and Retention

Introduction VolumeMigration is the only way to extend the retention period of a document. It
implies that a new copy of the content is written.
Export of Export of volumes is prohibited if the volume contains document components under
volumes retention. Exception: there is at least one logical copy of each component under
retention on another volume. This is typically the case after a VolumeMigration.
Note: Fast VolumeMigration and local backups do not create logical copies of
components.
Fast Volume Migration and Retention Periods
Fast Volume Migration does not change nor apply retention periods to single
documents. Only a retention period for the ISO image file is set according to the
rules listed below.
The following situations can occur during Fast Volume Migration:

• No retention in the source image
The target image will inherit the retention period from the device file. The
retention starts when the file has been migrated.
If no retention period is specified in the device file, STORM will apply a default
retention of 365 days.
• Retention in the source image available
If there is a retention period in the source image available, the retention settings
of the device file are ignored.

AR100500-01-ACN-EN-04
12.2. Creating and configuring logical archives
• The retention of the source image has not yet expired: The target image will
inherit the retention of the remaining period.
• The retention has already expired or was set to NONE: No retention will be
applied to the target image.
12.2 Creating and configuring logical archives

On each Archive Server, one or more logical archives can be created. To do so,
follow these main steps:
1. “Creating a logical archive” on page 111

2. “Configuring the archive security settings” on page 112
3. “Configuring the archive settings” on page 113
4. “Configuring the archive retention settings” on page 114
5. “Activating and configuring timestamp usage” on page 116
6. “Creating and modifying storage tiers” on page 137
7. “Creating and modifying pools” on page 117
12.2.1 Creating a logical archive

First, a logical archive must be created. After this, you can configure the different
settings of the archive.
To create a logical archive:
1. Select Original Archives in the Archives object in the console tree.
2. Click New Archive in the action pane. The window to create a new logical
archive opens.
3. Enter archive name and description.
Archive name
Unique name of the new logical archive. Consider the Naming rule for
archive components on page 99.
In the case of SAP applications, the archive name consists of two
alphanumeric characters (only uppercase letters and digits).
Description
Brief, self-explanatory description of the new archive.
4. Click Next and read the information carefully.
5. Click Finish to create the new archive.
Note: After creating the logical archive, default configuration values for all
settings are provided. If you want to change these settings, open the Properties
window and modify the settings of the corresponding tab.

AR100500-01-ACN-EN-04
General The description of the new archive can be viewed and modified (open Properties in
information the action pane and select the General tab).
12.2.2 Configuring the archive security settings

In the Security tab of the properties dialog, you specify the settings for secKeys and
SSL. You also specify whether document deletion is allowed.
To configure the security of an archive:
1. Select the logical archive in the Original Archives object of the console tree.
2. Click Properties in the action pane. The property window of the archive opens.
3. Select the Security tab. Check the settings and modify it, if needed.
Authentication (secKey) required to

Set the archive-specific access permissions:
• Read documents
• Update documents
• Create documents
• Delete documents
Each permission marked for the current archive has to be checked when
verifying the signed URL. With their first request, clients evaluate the access
permissions required for the current archive and preserve this information.
With the next request, the signed URL contains the access permissions
required, if these are not in conflict with other access permission settings
(for example, set per document).
The settings determine the access rights to documents in the selected
archive which were archived without a document protection level, or if
document protection is ignored. The document protection level is defined
by the leading application and archived with the document. It defines for
which operations on the document a valid secKey is required.
See also “Activating secKey usage for a logical archive” on page 153.
Select the operations that you want to protect. Only users with a valid
secKey can perform the selected operations. If an operation is not selected,
everybody can perform it.
SSL
Specifies whether SSL is used in the selected archive for authorized,
encrypted HTTP communication between the Imaging Clients, Archive
Servers, Archive Cache Servers and OpenText Document Pipelines.
• Use: SSL must be used.

• Don't use: SSL is not used.
• May use: The use of SSL for the archive is allowed. The behavior
depends on the clients' configuration parameter HTTP UseSSL (see also

AR100500-01-ACN-EN-04
OpenText Imaging Viewers and DesktopLink - Configuration Guide (CL-

CGD)).
OpenText Imaging Java Viewer does not support SSL.
Document deletion
Here you decide whether deletion requests from the leading application are
performed for documents in the selected archive, and what information is
given. You can also prohibit deletion of documents for all archives of the
Archive Server. This central setting has priority over the archive setting.
See also: “Setting the operation mode of Archive Server” on page 350.
Deletion is allowed
Documents are deleted on request, if no maintenance mode is set and
the retention period is expired.
Deletion Causes error

Documents are not deleted on request, even if the retention period is
expired. A message informs the administrator about deletion requests.
4. Click OK to resume.
12.2.3 Configuring the archive settings

In the Settings tab of the properties dialog, you specify how documents are handled
in the archive.
To configure the settings of a logical archive:
3. Select the Settings tab. Check the settings and modify them, if needed.
Compression
Activates data compression for the selected archive.
See also: “Data compression” on page 100
Encryption
Activates the data encryption to prevent that unauthorized persons can
access archived documents.
See also: “Encrypted document storage” on page 155.
Blobs
Activates the processing of BLOBs (binary large objects).
Very small documents are gathered in a meta document (the BLOB) in the
disk buffer and are written to the storage medium together. The method
improves performance. If a document is stored in a BLOB, it can be
destroyed only when all documents of this BLOB are deleted. Thus, BLOBs
are not supported in single-file storage scenarios and should not be used
together with retention periods.

AR100500-01-ACN-EN-04
Single instance
Enables single instance archiving.
See also: “Single instance” on page 101.
Deferred archiving
Select this option, if the documents should remain in the disk buffer until
the leading application allows Archive Server to store them on final storage
media.
Example: The document arrives in the disk buffer without a retention period and
the leading application will provide the retention period shortly after. The
document must not be written to the storage media before it gets the retention
period.
Audit enabled
If auditing is enabled, all document-related actions are audited (see
“Configuring auditing” on page 335).
Cache enabled
Activates the caching of documents to the DS cache at read access.
Cache
Pull down menu to select the cache path. Before you can assign a cache
path, you must create it. (See “Creating and deleting caches” on page 95
and “Configuring caches” on page 93).
Important
After assigning a cache to an archive you must restart Archive
Server.
12.2.4 Configuring the archive retention settings

In the Retention tab of the properties dialog, you specify document lifecycle
requirements. When the retention period of a document is expired and deletion is
not otherwise prohibited, Archive Server accepts and executes deletion requests
from the leading application.
To configure the retention of a logical archive:
3. Select the Retention tab. Check the settings and modify them, if needed.
No retention
Use this option if the leading application does not support retention, or if
retention is not relevant for documents in the selected archive. Documents
can be deleted at any time if no other settings prevent it.

AR100500-01-ACN-EN-04
No retention – read only

Like No retention, but documents cannot be changed.
Retention period of x days

Enter the retention period in days. The retention period of the document is
calculated by adding this number of days to the archiving date of the
document. It is stored with the document.
Infinite retention
Documents in the archive never can be deleted. Use this setting for
documents that must be stored for a very long time.
Destroy (unrecoverable)
This additional option is only relevant for archives with hard disk storage.
If enabled, the system at first overwrites the file content several times and
then deletes the file.
Auto delete after expiration (appears dimmed)

You cannot modify this setting in the Administration Client (and you
cannot modify the value of the corresponding configuration parameter,
ADMS_ARCH_AUTO_DELETE, either). This option can only be modified in the
Archive Center Administration web client. In all scenarios other than
Archive Center, the leading application must trigger the deletion.
See also “Archive Center scenario” on page 47.
Important
Documents with expired retention period are only deleted
• if document deletion is allowed; see “Configuring the archive security
settings” on page 112, and
• if no maintenance mode is set; see “Setting the operation mode of Archive
Server” on page 350.
Related Topics
• “Retention” on page 103
• “When the retention period has expired” on page 247

AR100500-01-ACN-EN-04
12.2.5 Activating and configuring timestamp usage

In the Timestamps tab of the properties dialog, you specify whether timestamps are
to be used for verifying documents. In addition, you can choose between different
timestamp verification levels.
Note: In addition to old timestamps and ArchiSig timestamps, each document

can have a timestamp assigned by a client (for example, Document Pipeline).
This has to be taken into account when setting the timestamp verification
handling, i.e.
• if No Timestamps is activated
• or if ArchiSig is activated.
To configure timestamps of a logical archive:
3. Select the Timestamps tab. In the Timestamps area, select one of the following
options:
Old Timestamps
Use old timestamps.
Note: Cannot be used any more. Only visible for compatibility

reasons.
No Timestamps
No use of timestamps, i.e., Archive Server generates no timestamp for the
archived documents.
ArchiSig
Enables ArchiSig timestamp usage, i.e., an ArchiSig timestamp is generated
for the archived documents.
For a description of ArchiSig, see “Timestamps” on page 160.
4. In the Verification area, select one of the following options:
None
Timestamps are not verified. Each requested document is delivered.
Relaxed
Timestamps are verified. Each requested document is delivered. If the
timestamp cannot be verified, an auditing entry is written (if auditing is
enabled).
Strict
Timestamps are verified. Requested documents are delivered only if the
timestamp is verified.

AR100500-01-ACN-EN-04
12.3. Creating and modifying pools
In addition, an auditing entry is written (if auditing is enabled).
Note: Even if no timestamps are used, documents can have

timestamps assigned by clients. If not verified, these documents
cannot be delivered.
12.3 Creating and modifying pools

At least one pool belongs to each logical archive. A pool contains physical storage
volumes for longtime storage. These volumes are written in the same way. The
physical storage media are assigned to the pool either automatically or manually.
The procedure for creating and configuring a pool depends on the pool type. The
main differences in the configuration are:
• Usage of a disk buffer. All pool types, except the HDSK (write through) pools,
require a buffer.
• Settings of the Write job. The Write job writes the data from the buffer to the
final storage media. For all pool types, except the HDSK (write through) pools, a
Write job must be configured.
• Backup of documents in the pool(s) of a logical archive.
• For the ISO pool type, a backup jukebox can be created.
• Shadow pools can be created for all pool types, except for HDSK (write
through) pools. Multiple shadow pools can be assigned to a single original
pool. A Copy job copies the documents from the original pool to the shadow
pool(s) according the current archive settings.
To determine the pool type that suits the scenario and the storage system in use, see
the Storage Platform Release Notes in the Knowledge Center (https://
knowledge.opentext.com/knowledge/llisapi.dll/open/12331031)).
Background

AR100500-01-ACN-EN-04
12.3.1 Creating and modifying a HDSK (write-through) pool

The HDSK (write-through) pool is the only pool that works without a buffer. Each
document is directly written to the storage media, in this case a local hard disk
volume or SAN system. Thus, no Write job must be configured. Before you can
create a pool, create the logical archive; see “Creating and configuring logical
archives” on page 111.
Note: HDSK pools are not intended for use in production systems but for test
purposes and special requirements. Use not more than one HDSK pool.
To create a HDSK pool:
2. Select the designated archive in the console tree.
3. Click New Pool in the action pane. The window to create a new pool opens.
4. Enter a unique, descriptive Pool name. Consider the naming conventions; see
Naming rule for archive components on page 99.
5. Select Write through (HSDK) and click Next.
6. Select a Storage tier (see “Creating and modifying storage tiers” on page 137).
The name of the associated compression job is created automatically.
7. Click Finish to create the pool.
8. Select the pool in the top area of the result pane and click Attach Volume. A
window with all available hard-disk volumes opens (see “Creating and
modifying disk volumes” on page 86).
9. Select the designated disk volume and click OK to attach it.
Scheduling the To schedule the associated compression job, select the pool and click Edit Compress
compression Job in the action pane. Configure the scheduling as described in “Configuring jobs
job
and checking job protocol“ on page 141.
Modifying a To modify pool settings, select the pool and click Properties in the action pane. Only
HDSK pool the assignment of the storage tier can be changed.

AR100500-01-ACN-EN-04
12.3.2 Creating and modifying pools with a buffer

All pool types that use a disk buffer are created in the same way. The only
differences are the settings of the Write job. This section describes the main steps to
create pools. The special settings for the Write job are described in separate sections.
To create a pool:

3. Click New Pool in the action pane. The window to create a new pool opens.
4. Enter a unique (per archive), descriptive Pool name. Consider the naming
conventions; see Naming rule for archive components on page 99
5. Select the designated pool type and click Next.
6. Enter additional settings according to the pool type:
• “Write at once (ISO) pool settings” on page 120

• “Single file (VI, FS) pool settings” on page 121
7. Click Finish to create the pool.
8. For all pools except ISO pools, additionally do the following:
a. Select the pool in the top area of the result pane and click Attach Volume.
A window with all available hard-disk volumes opens (see “Creating and
modifying disk volumes” on page 86).
b. Select the designated disk volume and click OK to attach it.
9. Schedule the Write job; see “Configuring jobs and checking job protocol“
on page 141.
Modifying a To modify pool settings, select the pool and click Properties in the action pane.
pool Depending on the pool type, you can modify settings or assign another buffer.
Important
You can assign another buffer to the pool. If you do so, make sure that:
• all data from the old buffer is written to the storage media,
• the backups are completed,
• no new data can be written to the old buffer.
Data that remains in the buffer will be lost after the buffer change.
Deleting a pool
If a shadow pool has been assigned to an original pool, the Delete option of the
Properties in the action pane is not available for the original pool.

AR100500-01-ACN-EN-04
12.3.2.1 Write at once (ISO) pool settings

Below you find the settings for the configuration of write at once pools.
Storage Selection
Storage tier
Select the designated storage tier (see “Creating and modifying storage tiers”
on page 137).
Buffering
Used disk buffer

Select the designated buffer (see “Configuring buffers” on page 88).
Buffer assignment
Make sure that each buffer is assigned to one pool only (original pool or
shadow pool). Do not assign the same buffer to pools in different archives.
Writing
Write job
The name of the associated Write job is created automatically. The name can
only be changed during creation, but not modified later. To schedule the Write
job, see “Configuring jobs and checking job protocol“ on page 141.
Original jukebox
Select the original jukebox.
Note: The Original jukebox is displayed as Device in the pool Properties

in the action pane.
Volume name pattern

Defines the pattern for creating volume names. $(PREF)_$(ARCHIVE)_$(POOL)_
$(SEQ) is set by default. $(ARCHIVE) is the placeholder for the archive name, $
(POOL) for the pool name and $(SEQ) for an automatic serial number. The prefix
$(PREF) is defined in Configuration, search for the Volume name prefix
variable (internal name: ADMS_PART_PREFIX; see “Searching configuration
variables” on page 242). You can define any pattern, only the placeholder $
(SEQ) is mandatory. You can also insert a fixed text. The initialization of the
medium is started by the Write job.
Click Test Pattern to view the name planned for the next volume based on this
pattern.
Maximum volume size

Defines the maximum size of an ISO image in MB.
Note: For some storage systems, the maximum size is not required; see the
documentation of your storage system in the Knowledge Center (https://

AR100500-01-ACN-EN-04
Minimum amount of data

Minimum amount of data to be written in MB. At least this amount must have
been accumulated in the disk buffer before any data is written to storage media.
The quantity of data that you select here depends on the media in use. For the
HD-WO media type, the value must be less than the maximum size of the ISO
image that you entered in the Maximum volume size field.
Note: Make sure that the size of the smallest document to be written is less
than the difference between Minimum amount of data and Maximum
volume size.
• The size of the ISO image created by the Archive Server is larger than the
Minimum amount of data value and less than the Maximum volume
size value. If an ISO image in creation does not meet this criterion, no
image is written.
• If compression is enabled for the archive, the size of the compressed
documents (components) is applicable.
Backup
Backup enabled
Enable this option if the volumes of a pool are to be backed up locally on a
second device (jukebox) of this Archive Server. During the backup operation, the
Local_Backup jobs only considers the pools for which backup has been enabled.
Backup jukebox
Select the backup jukebox. For virtual jukeboxes with HD-WO media, we
strongly recommend to configure the original and backup jukeboxes on
physically different storage systems.
Related Topics

12.3.2.2 Single file (VI, FS) pool settings

Below you find the settings for the configuration of single file pools.
Storage selection
Storage tier
Select the designated storage tier (see “Creating and modifying storage tiers”
on page 137).
Buffering
Used disk buffer


AR100500-01-ACN-EN-04
Buffer assignment
Make sure that each buffer is assigned to one pool only (original pool or
shadow pool). Do not assign the same buffer to pools in different archives.
Writing
Write job
Documents written in parallel
Number of documents that can be written at once.
Related Topics
12.3.3 Marking the pool as default

The default pool is only used if no storage tier is assigned to the content.
To mark a pool as default:

3. Select the pool, which should be the default pool, in the top area of the result
pane.
4. Click Set as Default Pool in the action pane and click OK to confirm.
12.3.4 Creating and configuring shadow pools

You can created shadow pools to provide local document copies for backup.
Shadow pools are typically used in the following pool configuration scenarios:
• If the pool configuration does not allow local backups, for example, Single File
(VI or FS) original pools, shadow pools provide local document copies.
• If the required type of backup pool is not supported for the original pool, a
shadow pool can be used for the backup copies.
Example: ISO-type pool required for backup of an FS-type original pool
Shadow pools can be created for the following original pool types:
• FS
• ISO
• VI

AR100500-01-ACN-EN-04
Multiple shadow pools can be assigned to an original pool. The group of an original
pool and its assigned shadow pool(s) is called a pool cluster.
A1 Archive layer
P1 P2 P3 Original pools
P 1' P2' P2' ' Shadow pools
Figure 12-1: Shadow pools
• A shadow pool can be created at any time.

• The name of a shadow pool must be unique in the archive context.
• Each shadow pool in a pool cluster must have a separate, dedicated buffer
assigned to it.
Within a pool cluster, a specific buffer cannot be used by different shadow pools.
• A shadow pool does not have a separate storage tier.
Logically, the storage tier is assigned to the pool cluster.
Note: When logical archives are replicated, only the original pools are
replicated. Shadow pools assigned to the original pools are not replicated.

AR100500-01-ACN-EN-04
Original Archive Server Replicate Archive Server
A1 A1 ~
P1 P2 P3 P1~ P2~ P3~
P1' P2' P2' '
Figure 12-2: Pool replication
Copying incoming documents to shadow pools
1. The application sends the incoming content to a logical archive. The logical
archive stores the content temporarily in the disk buffer of an original pool.
2. Write jobs copy the content from the disk buffer to the associated storage
volumes of the original pool for longtime archiving.
3. Copy jobs copy the content from the disk buffer or the attached storage volumes
of the original pool to the corresponding shadow pool(s):
• to the disk buffer of the shadow pool and then, by executing a Write job, to
the storage volumes of the shadow pool
• directly to the storage volume of the shadow pool, if the shadow pool uses an
FS-type storage volume.
Note: Direct copying is available only if the component to be copied is

• not stored in BLOB
• not a SIA source component
The handling of Copy jobs is similar to the handling of Write jobs, except for the
error handling. The special settings for Copy jobs are described in separate
sections.
Copy jobs and Copy jobs require copy orders to copy components from the original pool to a shadow
copy orders pool. Copy orders are automatically created for copying documents that are newly
archived to the original pool’s buffer or storage volumes after the shadow pool was

AR100500-01-ACN-EN-04
created. However, in the following cases, specific copy orders must be explicitly
created for each document:
• The documents are archived in the storage volumes of the original pool before the
shadow pool was created.
• The documents are contained in storage volumes that are attached to the original
pool after the shadow pool was created.
The Create Copy Orders utility is provided to create the missing copy orders (see
“Creating copy orders for shadow pools” on page 130).
To create a shadow pool:
3. Select the original pool, which is to be backed up by a shadow pool, in the top
area of the result pane.
4. Click New Shadow Pool in the action pane. The window to create a new
shadow pool opens.
5. Enter a unique (per archive), descriptive Shadow Pool Name. Consider the
naming conventions; see Naming rule for archive components on page 99
6. Select the designated shadow pool type and click Next.
7. Enter the Backup and Buffering settings according to the selected shadow pool
type:
• “Single file (FS) shadow pool” on page 126
• “Write at-once (ISO) shadow pool” on page 127
• “Single file (VI) shadow pool” on page 129
8. Click Finish to create the shadow pool.
9. For FS or VI shadow pool types, select the shadow pool in the top area of the
result pane and click Attach Volume. A window with all available storage
volumes opens (see “Creating and modifying disk volumes” on page 86).
10. Select the designated storage volume and click OK to attach it.
11. Schedule the Copy job; see “Configuring jobs and checking job protocol“
on page 141.
Modifying a To modify the shadow pool settings, select the pool and click Properties in the
shadow pool action pane. Depending on the pool type, you can modify the settings.

AR100500-01-ACN-EN-04
12.3.4.1 Single file (FS) shadow pool

Below you find the settings for the configuration of FS single file shadow pools.
Backup
Copy job
Enter a unique (per archive), descriptive name for the Copy job. The name can be
modified later via the Properties settings in the action pane. To schedule the
Copy job, see “Configuring jobs and checking job protocol“ on page 141.
Components written in parallel

Number of simultaneously written components.
Number of components
Maximum number of components copied during a single run of the Copy job.
Max Duration [h]

Time limit for copying the components to the shadow pool.
Create copy orders for existing documents

Create the copy orders for the documents stored in the original pool (see
“Creating copy orders for shadow pools” on page 130). The copy orders
determine the documents to be copied to the shadow pool.
Note: The Create copy orders for existing documents option is available
only when a new shadow pool is created.
Copy orders cannot be created when modifying a shadow pool’s
properties.
Buffering
Used disk buffer

Buffers for shadow pools

• You can only assign an already existing buffer to a shadow pool. Create
the required number of buffers before creating the shadow pools (see
“Configuring buffers” on page 88).
• Original pool and shadow pool must have different buffers assigned.
• A disk buffer cannot be shared by two shadow pools of the same
original pool. The disk buffer must be unique within a pool group.
Writing
Write job

AR100500-01-ACN-EN-04

Number of simultaneously written documents.
Related Topics
12.3.4.2 Write at-once (ISO) shadow pool

Below you find the settings for the configuration of write at-once (ISO) shadow
pools.
Backup
Copy job

Max Duration [h]


properties.
Buffering
Used disk buffer



AR100500-01-ACN-EN-04

Writing
Write job
Original jukebox
Select the original jukebox.
Note: The Original jukebox is displayed as Device in the pool Properties

in the action pane.
Volume name pattern

Defines the pattern for creating volume names. $(PREF)_$(ARCHIVE)_$(POOL)_
$(SEQ) is set by default. $(ARCHIVE) is the placeholder for the archive name, $
(POOL) for the pool name and $(SEQ) for an automatic serial number. The prefix
$(PREF) is defined in Configuration, search for the Volume name prefix
variable (internal name: ADMS_PART_PREFIX; see “Searching configuration
variables” on page 242). You can define any pattern, only the placeholder $
(SEQ) is mandatory. You can also insert a fixed text. The initialization of the
medium is started by the Write job.
Click Test Pattern to view the name planned for the next volume based on this
pattern.
Maximum volume size

Defines the maximum size of an ISO image in MB.
Note: For some storage systems, the maximum size is not required; see the
documentation of your storage system in the Knowledge Center (https://
Minimum amount of data

Minimum amount of data to be written in MB. At least this amount must have
been accumulated in the disk buffer before any data is written to storage media.
The quantity of data that you select here depends on the media in use. For the
HD-WO media type, the value must be less than the maximum size of the ISO
image that you entered in the Maximum volume size field.
Note: Make sure that the size of the smallest document to be written is less
than the difference between Minimum amount of data and Maximum
volume size.
• The size of the ISO image created by the Archive Server is larger than the
Minimum amount of data value and less than the Maximum volume
size value. If an ISO image in creation does not meet this criterion, no
image is written.

AR100500-01-ACN-EN-04
• If compression is enabled for the archive, the size of the compressed

documents (components) is applicable.
Related Topics
12.3.4.3 Single file (VI) shadow pool

Below you find the settings for the configuration of VI single file shadow pools.
Backup
Copy job

Max Duration [h]
properties.
Buffering
Used disk buffer



AR100500-01-ACN-EN-04
Writing
Write job

Number of simultaneously written documents.
Related Topics
12.3.5 Creating copy orders for shadow pools

Copy orders Creating specific copy orders is required to copy documents in the buffer or storage
volumes of an original pool to the shadow pool(s) in the following cases:
• A storage volume containing documents is attached to the original pool after the
creation of the shadow pool(s), see “Creating copy orders when attaching a
volume to an original pool” on page 132.
• The documents archived in the buffer and storage volumes of an original pool
are to be copied to a newly created shadow pool, see “Creating copy orders when
defining new shadow pools” on page 131.
Copy order The Create Copy Orders utility creates the copy orders if required.
utility
There are various ways to start the copy order utility:
• Check the Create copy orders for existing documents check box when creating a
new shadow pool or attaching a new storage volume to an original pool.
• Select Archive Server > System > Utilities > Create Copy Orders.
• Select Create Copy Orders in the action pane of the original pool.
Create Copy Orders is displayed only if at least one shadow pool is defined for
the original pool.
• Select Create Copy Orders in the context menu of a volume attached to the
original pool if, at least, one shadow pool is defined for the original pool.
This option is typically used if copy orders were not created when the volume
was attached to the original pool.
Notes
• If multiple shadow pools are defined, the copy order utility creates the copy
orders for all existing shadow pools. Therefore, check Create copy orders for
existing documents only when creating the last shadow pool for an original
pool.

AR100500-01-ACN-EN-04
• Copy orders can only be created during the creation of a shadow pool. Copy
orders cannot be created when modifying a shadow pool’s properties.
• The copy order utility creates copy orders for all storage volumes of the
original pool. This may be time consuming. Always wait until the Create
Copy Orders status is FINISHED. However, working on the original pool is
possible while the copy order utility is running.
Note: If the copy order utility is started from the Attach Volume
dialog, working on the original pool is not possible while the utility is
running.
• Only one instance of the copy order utility can run at the same time.
• Restarting the server while the copy order utility is running stops the utility
before all required copy orders have been created. The copy order utility
does not resume copy order processing when the server restarts. To get all
required copy orders, you must start the copy order utility again.
12.3.5.1 Creating copy orders when defining new shadow pools

When a new shadow pool is created, specific copy orders are required to include the
new shadow pool when copying the documents from the original pool. However, if
multiple shadow pools are defined, the Create Copy Orders utility creates the copy
orders for all existing shadow pools. Therefore, check Create copy orders for
existing documents only when defining the last shadow pool of multiple shadow
pools.
1. In the New Shadow Pool window of the selected shadow pool type, check
Create copy orders for existing documents in the Backup settings.
2. Complete the Backup and Buffering settings according to the selected shadow
pool type and click Finish to create the shadow pool.
3. Click OK to confirm the Shadow pool ... was created information.

The utility for creating copy orders starts.
4. Click Close when the Creating Copy Orders for pool ... utility has finished.
The copy orders for all document components in the buffer and storage
volumes of the original pool have been created.

AR100500-01-ACN-EN-04
12.3.5.2 Creating copy orders when attaching a volume to an original pool

Specific copy orders are required to copy the documents of the new storage volume
to the existing shadow pool(s).
Note: The new storage volume can contain components belonging to

documents in different archives. The copy order utility creates copy orders for
all components of the storage volume, irrespective of whether the components
belong to documents in the archive the storage volume is attached to.

3. Select the original pool and click Attach Volume in the action pane.
A window with all available storage volumes opens.
4. Select the designated storage volume(s) and check Create copy orders for
existing documents.
Note: Create copy orders for existing documents is displayed only if at

least one shadow pool is defined for the original pool.
5. Click OK.
The utility for creating copy orders starts.
6. Click Close when the Create Copy Orders utility has finished.
The copy orders for all document components the storage volume have been
created.
12.3.6 Handling shadow copy errors

If a Copy job cannot execute a copy order, a copy error is indicated. The job protocol
indicates how many copy orders did not get executed.
To handle Copy job errors:
1. When the Copy job run is completed, check for copy errors.
a. Select Archive Server> System> Jobs and select the Copy job. The job
protocol shows the status of the copy errors.
• Pending copy orders are executed with the next run of the Copy job.
Run the Copy job again to clear all Pending-status copy orders
• Failed copy orders are not executed with the next run of the Copy job.
b. To investigate failed copy orders, use the Report Shadow Copy Errors
utility (see “Report of shadow copy errors” on page 133).
2. Use the Clear Shadow Copy Errors utility to clear shadow copy errors from the
Copy job (see “Clearing shadow copy errors” on page 133).

AR100500-01-ACN-EN-04
3. Run the Copy job again.
12.3.6.1 Report of shadow copy errors

The Report Shadow Copy Errors report provides information required for handling
shadow copy errors (see “Handling shadow copy errors” on page 132).
To create a Shadow Copy Errors report:
1. Select Archive Server > System > Utilities > Report Shadow Copy Errors.
2. Enter the Archive Name and Shadow Pool Name.
3. Select the type of error report.
• Report counts of errors

Number of failed copy orders, sorted by error type.
Note: Failed copy orders are not executed with the next run of the
Copy job.
• Detailed report of each error
Detailed report for each error, including error type, document ID, and
component name.
4. Click Run.
12.3.6.2 Clearing shadow copy errors

The Clear Shadow Copy Errors utility allows to clear shadow copy errors from the
Copy job (see “Handling shadow copy errors” on page 132).
• Failed-status copy orders of a Copy job can be set to the Pending status.
Pending copy orders are executed with the next run of the Copy job.
• Copy orders for nonexistent components (ERROR_SOURCE_MISSING errors) can be
deleted from the Copy job; see “To delete copy orders for nonexistent
components from the Copy job:“ on page 134.
To clear shadow copy errors:
1. Select Archive Server > System > Utilities > Clear Shadow Copy Errors.
2. Enter the Archive Name and Shadow Pool Name.
3. Enter the Error Type:
• Enter a specific error type retrieved from the Report Shadow Copy Errors
report.
• Leave Error Type empty to reset all Failed-status copy orders to the
Pending status.
4. Select the error handling:

AR100500-01-ACN-EN-04
• Reset errors
The Failed-status copy orders of the specified Error Type are reset to the
Pending status. The Pending copy orders are executed with the next run of
the Copy job.
Note: To reset all Failed-status copy orders to the Pending status,

leave the Error Type field empty.
• Delete error
Deletes the Failed-status copy orders of the specified Error Type from the
Copy job.
Note: To select Delete error, you must specify a valid error type from
the detailed Report Shadow Copy Errors report in the Error Type
field.
Caution
Delete error deletes the copy order. The copy order is no longer
executed when running the Copy job.
Use Delete error only for ERROR_SOURCE_MISSING errors, that is, to
delete copy orders for nonexistent components from the Copy job.
Contact OpenText Customer Support before deleting copy orders
for any other copy error type.
5. Click Run.
To delete copy orders for nonexistent components from the Copy job:
1. If, after re-running a Copy job, there are still Failed-status copy orders reported,
check the detailed report for ERROR_SOURCE_MISSING errors. This copy error
indicates a copy order for nonexistent components. See “Report of shadow copy
errors” on page 133).
2. Check if the respective components do no longer exist on the Archive Server.
3. Use the Clear Shadow Copy Errors utility (see “Clearing shadow copy errors”
on page 133).
• Enter Error Type: ERROR_SOURCE_MISSING.

• Select Delete error.
Caution
Use Delete error only for ERROR_SOURCE_MISSING errors, that is, to
delete copy orders for nonexistent components from the Copy job.
Contact OpenText Customer Support before deleting copy orders
for any other copy error type.

AR100500-01-ACN-EN-04
• Click Run.
12.3.7 Recovering original pool data from a shadow pool

When the storage volume(s) of an original pool become defective and the data
stored there cannot be accessed anymore, you can recover the data from the shadow
pool and store them in the volumes of a newly created original pool.
Overview of the recovery procedure
The original pool containing the defective storage volumes is replaced by a new pool
of the same pool type. The existing shadow pool is kept as backup pool.
1. Create a new pool as additional shadow pool.

2. Use the Copy job for the new shadow pool to copy all available data from the
original pool (with the defective storage volumes) or the existing shadow pool to
the new shadow pool.
3. Restore the new shadow pool as original pool.
Note: The recovery procedure described here also works if the type of the
existing shadow pool is different from the type of the original pool.
Prerequisites
• At least one shadow pool is assigned to the original pool with the defective
storage volumes.
• Data of the original pool are contained in the original pool’s buffers and/or the
shadow pool(s).
Note: Data that are exclusively stored in the defective storage volumes, that
is, all data that are not additionally stored in a buffer or shadow pool,
cannot be recovered by this procedure and may be lost.
To recover original pool data:
1. Create new storage volumes (see “Configuring disk volumes” on page 85).
a. Create new storage volumes for the recovered original pool if the pool type
is FS or VI. Do not attach the new volumes yet
b. One additional local hard disk volume as temporary disk buffer volume
Note: If the original pool’s disk buffer is shared with other pools, for
example, in different archives, you must create spare hard disk volumes to
be used for the disk buffers of the new pool that replaces the original pool.
2. In the disk buffer of the original pool, set all storage volumes to Write locked
(see “Checking and modifying attached disk volumes” on page 91).
3. Restart the dsaux spawner service.
> spawncmd restart dsaux

AR100500-01-ACN-EN-04
4. Create an additional disk buffer (see “Configuring buffers” on page 88).

Assign the local hard disk volume created in Step 1.b as disk buffer volume.
5. Create an additional shadow pool for the original pool (see “Creating and
configuring shadow pools” on page 122).
a. Specify the original pool’s type as pool type for the new shadow pool.
Select the Create copy orders for existing documents option (see “Creating
copy orders when defining new shadow pools” on page 131).
b. Assign the disk buffer created in Step 4 to the new shadow pool.
c. Wait until the Create Shadow Pool wizard utility has completed its run.
Assign the storage volumes created in step 1a to the new shadow pool.
d. Wait until the Create Copy Orders utility has completed its run (see
“Creating copy orders when defining new shadow pools” on page 131).
6. Copy all documents from the original pool to the existing shadow pool and to
the newly created shadow pool until no more documents can be copied. To do
so, run the following jobs:
• Copy jobs for the existing and new shadow pools
• Write jobs for the existing and new shadow pools
• Purge jobs for the disk buffers of the existing and new shadow pools
Note: Documents stored exclusively on the defective storage volumes

cannot be copied and create Copy job errors.
7. Detach all storage volumes from the original pool (see “Detaching a volume
from a disk buffer” on page 90).
Note: For the recovery procedure, all storage volumes are considered
defective.
8. Restore the new shadow pool (created in Step 5) as original pool. Use Restore To
Original Pool in the context menu of the shadow pool.
9. If the old original pool’s disk buffer was shared with other pools: Clean up the
volumes of this disk buffer.
• Make sure that 10 minutes have passed since restarting the dsaux Spawner
service (see Step 3).
• Run the Write jobs and the Purge jobs for the pools sharing the old original
pool’s disk buffer.
10. Using the Export Volumes utility, export all hard disk volumes from the
original pool’s buffer (see “Exporting volumes” on page 250).
11. Attach the spare hard disk volumes (see step 1) to the new original pool’s disk
buffer.

AR100500-01-ACN-EN-04
12.4. Creating and modifying storage tiers
12. Clean up the orphaned ds_job entries for the old original pool that has
disappeared:
a. Run clnJobs -d -x
b. To check for successful cleanup, run: dscd -size.

The old original pool should not be listed.
12.4 Creating and modifying storage tiers

Tiered storage is the assignment of different categories of data to different types of
storage media in order to reduce storage cost. Categories can be based on levels of
protection needed, performance requirements, frequency of use and other
considerations. The storage tier is the only information a client can receive about a
logical archive and consequently can use (only) storage tiers to decide where to store
a document.
Example 12-1: Some storage tiers examples
• Business-critical
Description: Important to the enterprise, reasonable performance, good
availability
• Accessible Online Data
Description: Low access
• Nearline Data
Description: Rare access, large volumes
To create a storage tier:
1. Select Storage Tiers in the System object. The present storage tiers are listed in
the result pane.
2. Click New Storage Tier in the action pane.
3. Enter name and a short description of the storage tier.
4. Click Finish.
Modifying To modify a storage tier, select it and click Properties in the action pane. Proceed in
storage tiers the same way as when creating a storage tier.
Related Topics

AR100500-01-ACN-EN-04
12.5 Enabling certificates

For each archive, one or several authentication certificates can be enabled (or
disabled, if required).
For further information, see “Configuring a certificate for authentication”

on page 174.
Important
In case you are using Archive Cache Server, consider that a re-initialization
in secure environments can only work if the current certificates are available
on the Archive Cache Server. To avoid problems, the Update documents
security setting must be deselected before certificates are enabled; see Step 3.
To enable certificates:
1. Select the logical archive in the Original Archives or Replicated Archives object
of the console tree.
Tip: Alternatively, you can also navigate to System > Key Store >
Certificates.
2. Select the Certificates tab in the result pane.
For scenarios using an Archive Cache Server, go on with Step 3.
Otherwise, go on with Step 4.
3. If an Archive Cache Server is assigned to a logical archive, proceed as follows:
a. Select Original Archives in the Archives object of the console tree.

b. Select the logical archive in the console tree.
c. Click Properties in the action pane and select the Security tab.
d. Temporarily clear Update documents and click OK.
4. Select the respective certificate by its name (in the result pane).
5. Click Enable or Disable in the action pane.

The certificate is enabled or disabled, respectively.

AR100500-01-ACN-EN-04
12.6. Changing the server priorities
12.6 Changing the server priorities

If you use several servers for an archive, you have to specify the sequence used to
search for documents in the selected archive. The server at the top of this list is
accessed first. If access is refused, the request is routed to the second server in the
list. This enables you to specify that a server first searches in its own replicated
archives before searching in the original archive on the original server or vice versa.
Configuring the server priorities is necessary in case of using replicated or external
archives; see “Configuring the Remote Standby Server” on page 221.
To change the server priorities:
1. Select the logical archive in the Original Archives, Replicated Archives, or

External Archives object of the console tree.
2. Click Change Server Priorities in the action pane.
3. In the Change Server Priorities window, select the server(s) to add from the
Related servers list on the left.
Click the button to move the selected server(s) to the Set priorities list.
Note: You can use up to three servers.
4. Use the arrows on the right to define the order of the servers: Select a server and
click the or to move the server up or down in the list, respectively.
If you want to remove a server from the priorities list, select the server to
remove and click the button.
5. Click Finish.

AR100500-01-ACN-EN-04
Chapter 13
Configuring jobs and checking job protocol
A job is a recurrent task that is automatically started according to a time schedule or

when certain conditions are met.
• Jobs related to an Archive Server are set up during installation of an Archive
Server.
• Pool and Archive Cache Server jobs (Write, Purge_Buffer and Copy_Back) are
configured when the pool is created or an Archive Cache Server is attached to a
logical archive.
• Pool-related Copy jobs are configured when a shadow pool is created.
The successful execution of jobs can be checked in a protocol.
13.1 Important jobs and commands

The tables list all pre-configured jobs and commands for user-defined jobs.
pagelist job See “Configuring security settings for pagelist job” on page 145 below for further
details on the pagelist job.
Table 13-1: Preconfigured jobs
Name Command Description

Compress_Storm_Statistics compress_storm_sta Compresses the statistic files
tistics written by STORM
Delete_Empty_Volumes delete_empty_volum Deletes volumes that contain
es only deleted documents whose
retention period has expired in
Document Service and STORM
Local_Backup backup Writes the backup of a volume
to a local backup jukebox, for
all pools where the Backup
option is enabled.
Organize_Accounting_Data organizeAccData Archives or deletes old
accounting data; see
“Accounting” on page 337.

AR100500-01-ACN-EN-04
Chapter 13 Configuring jobs and checking job protocol

Purge_Expired purge_expired Deletes abandoned files from
storage, which are listed in the
ds_to_be_deleted table, by
executing dsPurgeExp -r
now. The files in this table are
logically deleted but not yet
physically deleted. Works only
for GS and HDSK/HSM
volumes.
Save_Storm_Files save_storm_files Performs a backup of STORM
configuration files; see
“Backing up and restoring of
the Storage Manager
configuration” on page 264.
Synchronize_Replicates synchronize Replicates the data in a remote
standby scenario
SYS_CLEANUP_ADMAUDIT Audit_Sweeper Deletes administrative audit
information that are older than
a given number of days; see
Cleanup job on page 335. Do
not activate this job if you use
the auditing feature.
SYS_CLEANUP_PROTOCOL Protocol_Sweeper Deletes old job protocol entries;
see also “Checking the
execution of jobs” on page 149.
SYS_CONDENSE_STATISTICS CompressStatistics Compresses the statistics data
that are retrieved during the
<AS.DS.STATISTIC_INTERVAL
> interval for the hourly, daily,
weekly, and monthly statistics
display; see also “Archive
Server Statistics” on page 329.
SYS_EXPIRE_ALERTS Alert_Cleanup Deletes notifications of the
“alert” type that are older than
a given number of hours. The
default is 48 hours and can be
changed in: Configuration,
search for the Duration after
alerts expire variable (internal
name: ADMS_ALRT_EXPIRE;
see “Searching configuration
variables” on page 242).

AR100500-01-ACN-EN-04
13.1. Important jobs and commands

SYS_EXPORT_TRANSACTIO ExportTransactionL If switched on in DS.
NLOG og TRANSACTIONLOG, this job
exports the transaction log from
the database to the file system
(location: %ECM_VAR_DIR%
\statistics\<archive>
\YYYY\MM\details\
YYYYMMDD-<archive>.dtl.
csv). Scheduled to run every
15 min.
SYS_MIGRATE_ATTRIBUTES AttribAtrMigration Runs attribute migration from
ATTRIB.ATR files to the
database; see “Attribute
migration“ on page 309
SYS_REFRESH_ARCHIVE Refresh_Archive_In Synchronizes the configuration
fo information of the known
Archive Servers
SYS_RETRY_ATTRIBUTE_MI AttribAtrMigration Retries the attribute migration
GRATION for failed migrations
Table 13-2: Pool-related jobs
Command Description
Write_CD Writes data from disk buffer to storage media as ISO images, belongs
to ISO pools.
Note: Customizing parameters for Write_<xx> jobs must be

added to the command as argument. Example: Write_<xx> -f
<archive name> <poolname>
Write_GS Writes single files from disk buffer to a storage system through the
interface of the storage system (vendor interface), belongs to Single
File (VI) pools.
Write_HDSK Writes single files from disk buffer to the file system of an external
storage system, belongs to Single File (FS) pools.
Purge_Buffer Deletes the contents of the disk buffer according to conditions; see
“Configuring buffers” on page 88.
Note: Customizing parameters must be added to the command

as last argument. Example: Purge_Buffer -e
backup_pool Performs the backup of all volumes of a pool.
Compress_HDSK Compresses the data in an HDSK pool.

as last argument. Example: Compress_HDSK -c

AR100500-01-ACN-EN-04
Command Description
ShadowCopy Copies the documents of an original pool to the specified shadow
pool.
Table 13-3: Other jobs
Command Description
AutoDelete Finds and optionally deletes all documents with expired retention;
syntax:
AutoDelete [-d <duration>] [-g <graceperiod>] <mode>
<archive>
Arguments:
• -d <duration>
Optional; max. processing time in seconds, default unlimited, min.
1s
• -g <graceperiod>
Optional; number of days since the retention has expired, default
10 d, min. 0 d
• <mode>
QUERY or Q: report number of documents to be deleted; DELETE or
D: find and destroy; REPORT or R: report deleted documents
• <archive>
Name of the logical archive
Copy_Back Transfers cached documents from the Archive Cache Server to the
Archive Server. The Copy_Back job is disabled by default and must
only be enabled for Archive Servers with enabling “write back” mode.
See “Configuring Archive Cache Server“ on page 225.
By default, documents not older than three days are transferred. A

message appears if there are older documents remaining. The default
setting can be modified by changing the job settings.
Add the argument: -i <days> to set the interval.
Typically, the job is scheduled to start in times of low network traffic.

as last argument. Example: Copy_Back -i4
Migrate_Volume Controls the operation of the migration service that performs media
s migration; see “Migration” on page 271.
Possible argument: -p <archive name_pool> to run the migration
for the specified pool only. If no argument is given, every enqueued
migration is done.
hashtree Builds the hash trees for ArchiSig timestamps; see “ArchiSig
timestamps” on page 160.
pagelist Creates the index information for SAP print lists (pagelist). No
argument required. For security settings, see “Configuring security
settings for pagelist job” on page 145 below.

AR100500-01-ACN-EN-04
13.2. Starting and stopping the scheduler
Command Description
start<DPname> Starts the Document Pipelines for the import scenarios:
• Import content (documents/data) with extraction of attributes from
content (CO*),
• Import content (documents/data) and attributes (EX*),
• Import forms (FORM).
For further information, see OpenText Document Pipelines - Overview
and Import Interfaces (AR-CDP).
13.1.1 Configuring security settings for pagelist job

For secure pagelist job handling, a certificate is required.
The certificate is sent to the Archive Server with the putCert command or imported
with the Import Certificate for Authentication utility (see “Configuring a certificate
for authentication” on page 174). You can use the certtool utility (command line)
to create a certificate, or to generate a request to get a trusted certificate. For details,
see “Creating a certificate using the Certtool” on page 172.
Always signing You can configure the pagelist job to always sign the URL.
URL
To always sign the URL for the pagelist job:
1. Open the <OT config AS>\config\setup\DS.Setup file in an editor.
2. Append the following lines:

# Always sign URL
DSH_ALWAYS_SIGN_URL=yes
3. Save the file and restart the Archive Spawner service.
Further For details on certificates, see “Certificates” on page 169.

information
13.2 Starting and stopping the scheduler

After installation, the scheduler is running by default. The jobs are started
depending on their settings (see “Setting the start mode and scheduling of jobs”
on page 148). If the scheduler is stopped, all started jobs are continued and finished
but no other jobs are started until the scheduler is started again.
To start or stop the scheduler:
1. Select Jobs in the System object in the console tree.
2. Depending on the actual status of the scheduler click Start Scheduler or Stop
Scheduler in the action pane to change the status. The actual status is displayed
in the first line of the jobs tab.
To start and stop certain jobs, see “Starting and stopping jobs” on page 146.

AR100500-01-ACN-EN-04
13.3 Starting and stopping jobs

Jobs can also be started and stopped manually if necessary.
To start or stop jobs:
2. Select the Jobs tab in the top area of the result pane. The jobs are listed.
3. Select the job you want to start or stop.
4. Depending on the actual status of the job, click Start or Stop in the action pane
to change the status of the job.
13.4 Enabling and disabling jobs

Jobs can be disabled to avoid their execution. Some jobs are disabled by default and
must be enabled manually if necessary.
To enable or disable jobs:
3. Select the job you want to enable or disable.
4. Click Enable or Disable in the action pane to change the status of the job.
13.5 Checking settings of jobs

To check a job:
1. To check, create, modify and delete jobs, select Jobs in the System object in the
console tree.
3. Select the job you want to check. The latest message of this job is listed in the
bottom area of the result pane.
4. Click Edit to check details of the job. See also “Creating and modifying jobs”
on page 147.

AR100500-01-ACN-EN-04
13.6. Creating and modifying jobs
13.6 Creating and modifying jobs

Most of the jobs are created automatically. For example, pool-related jobs (Write,
Purge_Buffer and Copy_Back ) are configured when the pool is created. These jobs
can be modified later if necessary. Jobs can also be created manually to start jobs
automatically, for example, the Alert_Cleanup job which is not archive or pool-
related.
Pool-related Copy jobs are configured for backing up documents in a shadow pool.
See also “Creating and configuring shadow pools” on page 122. The name of a Copy
job is specified during the creation of the shadow pool and can be modified later.
To create a job:
2. Select the Jobs tab in the top area of the result pane.
3. Click New Job in the action pane. The wizard to create a new job opens.
4. Enter a name for the new job. Select the command and enter the arguments
depending on the job.
Name
Unique name of the job that describes its function so that you can
distinguish between jobs having the same command. Do not use blanks and
special characters. You cannot modify the name later.
Command
Select the job command to be executed. See also “Important jobs and
commands” on page 141.
Argument
Entries can expand the selected command. The entries in the Arguments
field are limited to 250 characters. See also “Important jobs and commands”
on page 141.
5. Select the start mode of the job and click Next.
6. Depending on the start mode, define the scheduling settings or the previous job.
See also “Setting the start mode and scheduling of jobs” on page 148.
7. Click Finish to complete.
Modifying jobs To modify a job, select it and click Edit in the action pane. Proceed in the same way
as when creating a job.

AR100500-01-ACN-EN-04
13.7 Setting the start mode and scheduling of jobs

The start mode and the scheduling must be defined when you add or edit an job. A
wizard supports you to define the proper settings; see also “Creating and modifying
jobs” on page 147.
A job can be started:
• at a certain time,
• when another job is finished,
• when another job is finished with a certain return value,
• at a certain time when an job has finished.
Start Mode
Specification of the start mode. Check the mode to define specific settings.
Scheduled
If you use this start mode, you can define the start time of the job, specified
by month, day, hour and minute. Thus, you can define daily, weekly and
monthly jobs or define the repetition of jobs by setting a frequency (hours or
minutes).
After previous job finished

If you use this start mode, you can specify the type of action that is to be
performed before the job is started. You can select between successfully
starting of the Administration Server and other jobs.
The return value indicates the result of a job run. If an job finishes
successfully, it usually returns the value 0. To start a job only when the
previous job finished successfully, enter 0 into the Return Value field.
If you use the Time Frame option, you can specify a time period within the
execution of the job is allowed.
General recommendations for job scheduling
• Distribute the jobs over the 24-hour-day.

• Jobs accessing the database on the same server must not collide, for example, the
Write jobs, Local_Backup job and Purge_Buffer jobs.
• Monitor the job messages and check the time period the jobs take. Adapt the job
scheduling accordingly.
Scheduling for jobs using jukeboxes
• Jobs accessing jukebox drives must not collide: different Write jobs,
Local_Backup, Synchronize_Replicates (Remote Standby Server) and
Save_Storm_Files.

AR100500-01-ACN-EN-04
13.8. Checking the execution of jobs
• Only one drive is used for Write jobs on WORM/UDO. Therefore, only one
WORM/UDO can be written at a time. That means, only one logical archive can
be served at a time.
• Backup jobs need two drives, one for the original, one for the backup media.
13.8 Checking the execution of jobs

Jobs are processes that are started automatically in accordance with a predefined
schedule, for example, jobs for writing storage media or for performing backups.
Many of these jobs run usually at night when Archive Server and network load is
low. Every day, you must check whether the jobs run correctly.
The entries in the job protocol are regularly deleted by the SYS_CLEANUP_PROTOCOL
job that usually runs weekly. You can modify the maximum age and number of
protocol entries in Configuration, search for the Max. number of job protocol
entries variable (internal name: ADMS_PROTOCOL_MAX_SIZE; see “Searching
To check the last message of a job:
2. Select the Jobs tab in the top area of the result pane.
3. Select the job you want to check.

The latest message of the job is listed in the bottom area of the result pane.
To check a job’s protocol:
2. Select the Protocol tab in the top area of the result pane. All protocol entries are
listed. Protocol entries with a red icon are terminated with an error. Green icons
identify jobs that have run successfully.
3. Select a protocol entry to see detailed messages in the bottom area of the result
pane.
4. Solve the problem.
5. Restart the job.
6. Check whether the execution was successful.
The following table lists the properties of a protocol entry:
Time Date and time when the job was started

Job User-specific name of the job
ID Execution identification of the job instance. The number appears on job
initialization and is repeated on job execution.

AR100500-01-ACN-EN-04
Status INFO indicates that the job was completed successfully.

ERROR indicates that the job was terminated with an error.
Command System command and arguments executed by the job
Message Message generated by Archive Server. It provides more detailed information
about how the job was terminated in case of an error.
To clear the protocol list:
2. Select the Protocol tab in the top area of the result pane. All protocol entries are
listed.
3. Click Clear protocol list in the action pane.

All protocol entries are deleted.

AR100500-01-ACN-EN-04
Chapter 14
Configuring security settings
14.1 Overview
Introduction Archive Server provides several methods to increase security for data transmission
and data integrity:
• secKeys/signed URLs, for verification of URL requests (see “Authentication

using signed URLs” on page 152)
• Protection of files and documents (see “Encrypted document storage”
on page 155)
• Timestamps to ensure that documents were not modified unnoticed in the
archive (see “Timestamps” on page 160 and “Configuring Archive Timestamp
Server“ on page 181)
These methods make use of
• Certificates, for authentication, encryption, and timestamps (see “Certificates”

on page 169)
• Checksums to recognize and reveal unwanted modifications to the documents on
their way through the archive (see “Using checksums” on page 178)
Configuration The main GUI elements used for configuration and administration of security
and administra- settings include:
tion
• The Archives node: each time a new archive is added or new pools are created,
security settings are to be configured (Security tab of the Properties dialog).
• The Key Store in the System object of the console tree: used for configuration of
certificates and system keys.
Further You can find more information on security topics in the “Security” folder in the
information Knowledge Center (https://knowledge.opentext.com/knowledge/llisapi.dll/open/
15491557).
Configuration settings concerning security topics are described in more detail in
“Configuration parameter reference” on page 357, in particular:
• “Archive Server“ on page 365

• “Security settings” on page 407
• “Key Export Tool (RCIO)” on page 418
• “Timestamp Server (TSTP)” on page 468

AR100500-01-ACN-EN-04
Chapter 14 Configuring security settings
Protecting from computer viruses
To archive “clean” documents, you must protect the documents from viruses
before archiving. Archive Server does not perform any checks for viruses. To
ensure error-free work of Archive Server, locations where documents are
stored temporarily, like disk buffer volumes, cache volumes, and Document
Pipeline directories, must not be scanned by any antivirus software while
Archive Server is using them.
14.2 Authentication using signed URLs

Signed URL Archive Server supports verification of secKeys for HTTP communication. A secKey
is an additional parameter in the URL of the archive access. It contains a digital
signature and a signature time and date. The requesting system creates this
signature for the relevant parameters in the URL and the expiration time and signs it
with its private key. This is called signed URL. Archive Server verifies the signature
with the public key and only accepts requests with a valid signature and if the
secKey's expiration time is not expired. Thereby, secKeys prevent the copying of
URLs.
Signed URLs are verified using public keys within certificates; see “Certificates”
on page 169.
If secKeys are used, the administrator must provide the necessary certificate
comprising the appropriate public key for each application. Thus, he has to send or
import the certificates comprising their public keys to the Archive Server. In
addition, the administrator must configure the usage of secKeys on the Archive
Server.
secKey usage A secKey requests the right of access. When a document is accessed, Archive Server
checks whether the secKey should be checked.
Procedure
• “Activating secKey usage for a logical archive” on page 153
• “secKeys from leading applications and components” on page 153
• “secKeys from SAP” on page 154
• “Configuring a certificate for authentication” on page 174

AR100500-01-ACN-EN-04
14.2. Authentication using signed URLs
14.2.1 Activating secKey usage for a logical archive

For each logical archive, special access permissions can be set. These settings are
required if the archive system is configured to support signed URLs (secKeys) and
the archive is used by a leading application using URLs with secKeys.
These signed URLs must include information on these permissions. If the secKey of
a request does not meet the permissions required by the archive, access is denied.
Each permission marked for the current archive has to be checked when verifying
the signed URL.
Activating Select the operations that you want to protect. Only client applications using a valid
secKey usage secKey can perform the selected operations. If an operation is not selected,
everybody can perform it.
To activate secKeys:
3. Select the Security tab. Check the settings and modify them, if needed.
Authentication (SecKey) Required To

Set the archive-specific access permissions:
• Read documents
14.2.2 secKeys from leading applications and components

Introduction secKeys can be used to secure the communication between Content Server,
Transactional Content Processing, Enterprise Scan, and Archive Server. Client
programs of Archive Server, for example Enterprise Scan, Document Pipeline, and
Content Server, also support secKeys.
To configure secKey usage for leading applications:
1. Create a certificate with the certtool utility (command line), or create the
request and send it to a trust center (see “Generate self-signed certificates”
on page 172 and “Request a certificate from a trust center ” on page 173).
Example for the a result: the <key>.pem file contains the private key and is used
to sign the URL. <cert>.pem contains the public key and the certificate that
Archive Server uses to verify the signatures.

AR100500-01-ACN-EN-04
2. Store the certificate and the private key on the server of your leading
application (see the corresponding Administration Guide for details). Correct
the path, if necessary, and add the file names.
By storing the certificates in the file system, they are recognized by Enterprise
Scan and the client programs.
Important
For security reasons, limit the read permission for these directories to
the system user (Windows) or the archive user (UNIX/Linux).
3. To provide the certificate to the Archive Server use one of the following options:
• Import the certificate, see “Importing an authentication certificate”

on page 175.
Or:
• Send the certificate with the putcert command (see “Send the certificate to
an Archive Server (putCert)” on page 173).
Repeat this step if you want to use the certificate for several archives.
4. Enable the certificate (see “Enabling a certificate” on page 171).
Procedure
• “Activating secKey usage for a logical archive” on page 153
• “Creating a certificate using the Certtool” on page 172
• “Configuring a certificate for authentication” on page 174
14.2.3 secKeys from SAP

Introduction secKeys can be used if the SAP Content Server HTTP Interface 4.5 (ArchiveLink 4.5) is
used for communication between the SAP system and the Archive Server.
To configure secKey usage for SAP systems, do the following:
1. Create private key and certificate on the application side.

2. Send the certificate to Archive Server using the OAHT transaction. There, you
enter the target Archive Server and the archives for which the certificate is valid.
3. Follow the instructions in “Configuring a certificate for authentication”
on page 174.

AR100500-01-ACN-EN-04
14.3. Encrypted document storage
14.3 Encrypted document storage

Document Document data, in particular critical data, can be stored on the storage device in an
encryption encrypted manner. Thus, the documents cannot be read without an archive system
and a key for decryption.
Document encryption can be activated per logical archive. It is performed when the
documents are transferred to the buffer of the logical archive for temporary storage.
Note: Document encryption is performed only if encryption is activated for the

logical archive; see “Activating encryption usage for a logical archive”
on page 156.
For document encryption, a symmetric key (system key) is used. The administrator
creates this system key and stores it in the Archive Server's keystore. The system key
itself is encrypted on the Archive Server with the Archive Server’s public key and
can then only be read with the help of the Archive Server's private key. RSA
(asymmetric encryption) is used to exchange the system key between the Archive
Server and the remote standby server.
New: From Update 2014.4 on, system keys are assigned to logical archives.
Keys per Update 2014.4 changed the way system keys are used: Before the update, only one
archive key could be active for all archives of an Archive Server; after it, each archive uses its
own key. In particular, several system keys can be used in parallel for different
archives.
Encryption for HDSK pools do not use a buffer. To encrypt documents use the designated
documents in Compress_ job; see “Data compression” on page 100.
HDSK pools
(write through)
Note: HDSK pools are not released for use in production systems. Use them
only for test purposes.
Procedure
• “Activating encryption usage for a logical archive” on page 156
• “Creating a system key for document encryption” on page 156
• “Exporting and importing system keys” on page 158
• “Configuring a certificate for document encryption” on page 177

AR100500-01-ACN-EN-04
14.3.1 Activating encryption usage for a logical archive

Introduction For each logical archive encryption can be activated/deactivated separately. If
enabled, a system key and the respective encryption certificate have to be created;
see “Creating a system key for document encryption” on page 156.
To activate encryption usage:
3. Select the Security tab. Activate Encryption (mark the check box).
14.3.2 Creating a system key for document encryption

System key The system key (arbitrary symmetric key) is used to encrypt documents stored on a
logical archive. To make encryption safer, a new system key can be created after
some time. However, only one system key can be active at a time. Documents are
always encrypted using the currently valid system key. System keys that are not
used any longer remain in the key store. Documents, encrypted with a system key
not equal to the currently valid system key, are decrypted with the appropriate
system key referred to within the document.
System keys are encrypted using the encryption certificate (see “Configuring a
certificate for document encryption” on page 177).
Caution
Be sure to store the system key securely, so that you can re-import it if
necessary.
If the key gets lost, the documents that were encrypted with it can no
longer be read!
Do not delete any key if you set a newer one as current. The old key is still
used for decryption.
To create a system key:
1. Select Key Store in the System object of the console tree.
2. Select the System Keys object of the console tree.
3. Archive Center scenario only: Define the system key folder to which the keys are
exported.
Click System Key Folder in the action pane and specify the path to the Export
folder.
You can split the contents of the key store into different files (Number of token
files, maximum: 8). Further, you can specify how many of them must be

AR100500-01-ACN-EN-04
reimported at least to restore the complete key store (Number of required

token files).
Notes
• Specifying the system key folder is required for the Archive Center
scenario. Business administrators can trigger the creation of a new
system key from within the Archive Center Administration web client.
In this case, the new system key is exported to the system key folder
automatically.
• Collections cannot use encryption before the system key folder is set.
4. Click Generate System Key in the action pane. A new key is generated.
5. Unless using Archive Center: Export the new system key using the recIO
command line tool and store it at a safe place (see “Exporting and importing
system keys” on page 158).
6. Make a backup of the key/certificate pair used by recIO to encrypt the System
Keys:
Copy the <OT config AS>/config/setup/as.pem file and store it alongside
with the exported system key and at a save place.
Important
In the case of system failure or restore scenarios it can be vital to have
backups of the system keys (and the related certificates).
7. Select the created system key and click Set as current key. A key can only be set
as current key if it is successfully exported (see Step 5).
New documents are now encrypted with the current key, while decryption
always uses the appropriate key.
Handling for The Synchronize_Replicates job updates the system keys and certificates between
replicated Archive Servers before it synchronizes the documents. The system keys are
archives
transmitted encrypted.
If you do not want to transmit the system keys through the network, you can also
export them from the original server to an external data medium and re-import
them on the remote standby server. See “Exporting and importing system keys”
on page 158.

AR100500-01-ACN-EN-04
14.3.3 Exporting and importing system keys

The contents of the System key node (all keys) of an Archive Server can be exported
and imported with the recIO command line tool. The program must be executed
directly on the Archive Server.
recIO <command> [<options>]
The following commands are available:
L
Lists the contents of the System key node (without the keys themselves) in a
table.
The user must log on.
Example:
C:\Program Files\OpenText\Archive Server 10.5.0\bin>recIO L

IMPORTANT: -----------------------------------------------------
IMPORTANT: recIO (release) 10.5.0.332
IMPORTANT: -----------------------------------------------------
recIO 10.5.0.332 Copyright ¬ 2013 Open Text Corporation
Please authenticate!
User :dsadmin
Password :
idx ID c x created imported origin
---------------------------------------------------------------------------
1 EB9C088BFA4F1847 0 0 2014/01/14 11:58:23 ----/--/-- --:--:-- <servername>
2 7CB5CA683339CC60 0 0 2014/02/20 11:41:20 ----/--/-- --:--:-- <servername>
E
Exports the contents of the System key node. Use the export in particular to
store the system keys for document encryption.
The user must log on and specify a path for the export files. The option -t NN:MM
splits the contents of the key store into MM different files (maximum: 8). At least
NN files must be reimported to restore the complete key store.
Example:
C:\Program Files\OpenText\Archive Server 10.5.0\bin>recIO E -t 3:5
IMPORTANT: -----------------------------------------------------
IMPORTANT: -----------------------------------------------------
User :dsadmin
Password :
Writing keystore with 2 system-keys to 5 token-files (3 required to restore)
Token[1/5] (default = A:\ixoskey.pem )
File (CR to accept above) : Z:\share\otaskey.pem
File (CR to accept above) : Z:\share\otaskey2.pem
V
Verifies the contents of the System key node against the exported files.

AR100500-01-ACN-EN-04
The user must log on and specify the path for the exported data. Then the
exported data is compared with the key store on the Archive Server.
Example:
C:\Program Files\OpenText\Archive Server 10.5.0\bin>recIO V
IMPORTANT: -----------------------------------------------------
IMPORTANT: -----------------------------------------------------
User :dsadmin
Password :
Token[1/?] (default = A:\ixoskey.pem)
Token[2/3] (default = A:\ixoskey.pem)
key 1 : EB9C088BFA4F1847 : OK
key 2 : 7CB5CA683339CC60 : OK
D
Displays the information on the exported files. The information is shown in a
table.
Example:
C:\Program Files\OpenText\Archive Server 10.5.0\bin>recIO D
IMPORTANT: -----------------------------------------------------
IMPORTANT: -----------------------------------------------------
idx ID created origin
---------------------------------------------------
1 EB9C088BFA4F1847 2014/01/14 11:58:23 <servername>
2 7CB5CA683339CC60 2014/02/20 11:41:20 <servername>
I
Imports the saved contents of the System key node.
The user must log on and specify the path for the exported data. The data in the
System key node is restored, encrypted with the Archive Server's public key
and sent to the administration server. The results are displayed. Keys already
contained in the Archive Server's store are not overwritten.
Example:
C:\Program Files\OpenText\Archive Server 10.5.0\bin>recIO I
IMPORTANT: -----------------------------------------------------
IMPORTANT: -----------------------------------------------------
User :dsadmin
Password :

AR100500-01-ACN-EN-04
ID:EB9C088BFA4F1847 created:2014/01/14 11:58:23 origin:<servername>

Key already exists
ID:7CB5CA683339CC60 created:2014/02/20 11:41:20 origin:<servername>
Key already exists
14.4 Timestamps
Timestamps are used to verify that documents have not been altered since archiving
time. The verification process checks these timestamps. A timestamp service is
required for this. Creating a timestamp means: The computer calculates a unique
number, a cryptographic checksum or hash value, from the content of the document.
The timestamp provider (a qualified Time Stamping Authority or Archive Timestamp
Server) adds the time to this checksum, creates a checksum of this created object and
signs the new checksum with its private key.
The signature is stored together with the document component. When a document is
requested, Archive Server can verify whether the component was modified after
storing it by looking at the signature. Archive Server needs the public key of the
timestamp provider’s certificate for verification. The OpenText products Windows
Viewer or Java Viewer can be used to display the verification result.
Archive Server supports the following types of timestamps:

• ArchiSig timestamps
• Document timestamps (old)
ArchiSig With ArchiSig timestamps, the timestamps are not added per document, but for
timestamps containers of hash trees calculated from the documents (Figure 14-1).

AR100500-01-ACN-EN-04
14.4. Timestamps
Time stamp
Time Stamp
h7=Hash(h5|h6)
Fingerprint
h5=Hash(h1|h2) h6=Hash(h3|h4) (hash value)
h1=Hash(d1) h2=Hash(d2) h3=Hash(d3) h4=Hash(d4)
Document d1 Document d2 Document d3 Document d4
Figure 14-1: Hash tree for ArchiSig timestamps
A job builds the hash tree that consists of hash values of as many documents as
configured, and adds one single timestamp. Thus, you can collect, for example, all
documents of a day in one hash tree. Only one timestamp per hash tree is required.
The verification process needs only the document and the hash chain leading from
the document to the timestamp but not the whole hash tree (Figure 14-2).
Hash Hash Hash Timestamp

h1=H(d1) h2=H(d2) h6=H(h3|h4) t=TSP(h7)
Document d1
Figure 14-2: Verification through hash chain
Document Each document component gets a timestamp when it arrives in the archive, or more
timestamps precisely: when it arrives in the disk buffer and is known to the Document Service.
This (old) method requires a huge amount of timestamps, depending on the number
of documents. Thus, it is available only for archives that used timestamps in former
Archive Server versions. You can migrate these timestamps to ArchiSig timestamps;
see “Migrating existing document timestamps” on page 169.

AR100500-01-ACN-EN-04
Configuration You can set up signing documents with timestamps and the verification of
timestamps including the response behavior for each archive; see “Configuring the
archive settings” on page 113. Consider the recommendations given above.
If you use both methods in parallel, the document timestamp secures the document
until the hash tree is built and signed. As this time period is short, a document
timestamp is sufficient for these documents, while the hash tree, in general, gets a
timestamp created with a certificate of an accredited provider. This trusted
certificate is used for verification.
ArchiSig timestamps have a better performance and can be easily renewed.
Note: Document timestamps are only shown to ensure compatibility. You

cannot use them for new archives.
Timestamps and hash trees may become invalid or unsafe. To prevent this, they can
be renewed. See “Renewing timestamps of hash trees” on page 168 and “Renewing
hash trees” on page 168.
Remote In a Remote Standby environment, the Synchronize_Replicates job replicates the

Standby timestamp certificates. Only enabled certificates are copied. The certificate on the
Remote Standby Server is automatically enabled after synchronization.
Related Topics
• “Configuring Archive Timestamp Server“ on page 181
Procedure
• “Basic timestamp settings” on page 162
• “Activating and configuring timestamp usage” on page 116
• “Creating a hash tree” on page 167
• “Configuring a certificate for timestamp verification” on page 177
14.4.1 Basic timestamp settings

TSAs Archive Server supports the following Time Stamping Authorities (TSA):
• timeproof TSS80
• AuthentiDate
• Quovadis
• Keyon true-Sign
New: Archive Server supports timestamps from Keyon true-Sign since

Update 2017.1.
Configuration The following description includes the most relevant parameters for ArchiSig
timestamps. There are further parameters; in general, you do not need to modify
those. For more information, see “Configuring connection parameters” on page 163.

AR100500-01-ACN-EN-04
14.4. Timestamps
To check and modify configuration variables:
1. Select Configuration, and one by one, search for the following variables (see
“Searching configuration variables” on page 242).
2. Set the port and the hostname of the timestamp server:
• Timestamp server port (internal name: TS_PORT).

• Hostname of the timestamp server (internal name: TS_HOST).
3. Set the minimum and the maximum number of components per hash tree:
• Min. number of components per hashtree variable (internal name:

TS_MINCNT).
The number of document components that are required to build a new hash
tree. In other words, this is the minimum number of document components
signed with one timestamp. For a rough rule of thumb, you can enter 2/3 of
your daily average number of document components to get one hash tree
per day.
• Max. number of components per hashtree (-1 = unlimited) variable
(internal name: TS_MAXCNT).
Limits the number of component hash values signed with one timestamp.
4. Set the pool to be used for the hash trees: Pool for timestamps variable (internal
name: TS_POOL), default: ATS_POOL
5. Check the other values. In general, you can use the default values. See
“Configuring connection parameters” on page 163.
Archive Further, you can use OpenText Archive Timestamp Server for testing. Archive
Timestamp Timestamp Server is not a TSA and is not recommended for production systems. For
Server
more information, see “Configuring Archive Timestamp Server“ on page 181.
14.4.2 Configuring connection parameters

This section describes connection settings for each supported Time Stamp Authority.
Note: For similar information about Archive Timestamp Server, see

“Configuration variables for Archive Timestamp Server” on page 183.

AR100500-01-ACN-EN-04
14.4.2.1 timeproof TSS80

Introduction The timeproof TSS80 timestamping system is a professional solution for customers
with higher demands for trustworthiness and usage of certified hard- and software.
ArchiSig Configuration recommendation:

timestamps
Connection method (internal name: TS_CONNECTION)
Use Plain TCP connection.
Timestamp server port (internal name: TS_PORT)

By default, the timeproof TSS 80 uses port 318. See the configuration of the
timestamp server.
Hostname of the timestamp server (internal name: TS_HOST)

Hostname or IP address of the timestamp server.
Format of used timestamps (internal name: TS_FORMAT)

Use RFC 3161 (IETF).
Timestamps Configuration recommendation:

(old)
Host of the Timestamp Server (internal name: TIME_STAMP_SERVER_HOST)
This is the hostname or the IP address of the timestamp server. Multiple
hostnames can be configured by separating them with a semicolon (“;”).
Individual port numbers can be supplied with multiple hosts if appended to the
hostname with a colon (“:”) in-between.
Example: tshost1:32001;tshost2:10318
Timestamp server port (internal name: TIME_STAMP_SERVER_PORT)

By default, the timeproof TSS 80 uses port 318. See configuration of the
timestamp server.
Mode of the Timestamp Server (internal name: TIME_STAMP_MODE)

Use RFC 3161 (IETF) without HTTP header. SIGIA4 timestamps are no longer
supported by timeproof!
Max. number of connections to the Timestamp Server (internal name:

MAX_TSS_CONNECTIONS)
Use the number of smartcards of your TSS80.

AR100500-01-ACN-EN-04
14.4. Timestamps
14.4.2.2 AuthentiDate over the Internet

Introduction AuthentiDate offers qualified timestamps over the Internet. This kind of service
provides the highest level of trustworthiness.
AuthentiDate uses an authentication system with user name/password. The

connection must therefore be made using SSL/TLS.

timestamps
Use HTTPS (HTTP over SSL).
By default, AuthentiDate uses port 443. See the AuthentiDate service
description for details.
Path for HTTP Timestamp request URLs (internal name: TS_HTTP_PATH)
Path for HTTP timestamp request URLs; see the AuthentiDate service
description for details. Sometimes the path is /rfc3161.
User for HTTP Timestamp request (internal name: TS_AUTH_USER)
User for HTTP timestamp request: User = customerId + “.” + instanceId. See the
AuthentiDate service description for details.
Password for HTTP Timestamp request (internal name: TS_AUTH_PASSWORD)
Password provided by AuthentiDate.
Timestamps Classic timestamps are neither supported nor recommendable with a timestamping
(old) service over the Internet. The cost would be extremely high since every document
component is signed and you would be charged for each timestamp. Finally, dsSign
does not communicate using SSL/TLS.
14.4.2.3 Quovadis
Introduction Quovadis offers qualified timestamps over the Internet. This kind of service
provides the highest level of trustworthiness.

timestamps
Use HTTP.
Use 80.

AR100500-01-ACN-EN-04

Timestamps Classic timestamps are neither supported nor recommendable with a timestamping
(old) service over the Internet.
14.4.2.4 Keyon true-Sign

Introduction Keyon offers qualified timestamps as part of their central signature service “true-
Sign”.
Note: Requires Update 2017.1 or later.

timestamps
Use HTTP.
Use the port configured in the true-Sign server configuration.
Hostname or IP address of the true-Sign server.
Path for HTTP Timestamp request URLs (internal name: TS_HTTP_PATH)
Use /rfc3161/.
Timestamps Configuration recommendation:

(old)
This is the hostname or the IP address of the timestamp server. Multiple
hostnames can be configured by separating them with a semicolon (“;”).
Individual port numbers can be supplied with multiple hosts if appended to the
hostname with a colon (“:”) in-between.

Use the port configured in the true-Sign server configuration.
Use RFC 3161 (IETF) with HTTP header.
Path for HTTP Timestamp request URLs (internal name:
TIME_STAMP_HTTP_PATH)
Use /rfc3161/.
Header-fields that are used in HTTP Timestamp-Requests (internal name:
TSTP_HTTP_HEADERS)
Add the following value as a header field:

AR100500-01-ACN-EN-04
14.4. Timestamps
Connection: close
14.4.3 Configuring certificates and signature keys

Timestamp cer- Archive Server receives the certificates required for timestamp verification on
tificates different ways:
Timeproof timestamp server

The certificate is automatically stored on the Archive Server during the first
signing process. Thus, the certificates are only shown in the Security tab after
several documents have been signed. If you want the certificates to be shown
before the signing starts, enter in the following command:
For Document timestamps
dsSign -t
For ArchiSig timestamps

dsHashTree -T
Other timestamp services

You import the certificate with the Import Timestamp Certificate action.
See “Importing a certificate for timestamp verification” on page 178.
After the import, check the fingerprint, and then enable the certificate.
To configure a new certificate or replace an existing certificate:
1. Get the new certificate.

2. Import the new certificate. See “Importing a certificate for timestamp
verification” on page 178.
3. Enable the new certificate. See “Enabling a certificate” on page 171.
14.4.4 Creating a hash tree

To create a hash tree:
1. In the Archives object of the console tree, create a new archive (for example,
with the name ATS) and a pool named POOL to define where the hash trees are
stored.
Important
The name of the pool is determined by the Pool for timestamps
configuration variable (internal name: AS.DS.TS_POOL). Its default
value is ATS_POOL, which means that you must call the pool POOL.
If the name of the pool and the value of the variable do not fit, the job
building the hash tree will fail.
2. In the System > Jobs object of the console tree, create jobs to build the hash
trees. You need one job for each archive that uses timestamps.
See also: “Configuring jobs and checking job protocol“ on page 141.

AR100500-01-ACN-EN-04
Command
hashtree
Arguments
Archive name
Scheduling
If you use ArchiSig timestamps, schedule a nightly job. If the hash trees are
written to a storage system, make sure that the job is finished before the
Write job starts.
14.4.5 Renewing hash trees

If documents must be retained a very long time (more than 20 years), the hash
algorithm that is used to calculate the hash values may become unsafe. In this rare
case, the hash tree must be renewed: The system reads the documents and calculates
new hash values and a new hash tree with a new hash algorithm, and signs the new
tree with a time stamp. This procedure is very time-consuming.
If you need to renew your hash trees, contact OpenText Customer Support.
14.4.6 Renewing timestamps of hash trees

Electronically signed documents can lose their validity in the course of time, because
the availability and verifiability of certificates is limited (depending on the regional
laws). Further, the key lengths, certificates, and cryptographic and hash algorithms
can become unsafe. Therefore, you can renew the timestamps for long-term stored
documents. You should renew the timestamps before any of the following events:
• The certificate is invalid.

• The key length is unsafe.
• The cryptographic algorithm is unsafe.
• The public key method is unsafe.
You need only one new timestamp per hash tree. No access to the documents is
necessary.
To renew timestamps:
1. Configure a new certificate on your timestamp server, make sure that is

available for the Archive Server, and enable it in the Timestamp Certificates tab
in System > Key Store > Certificates.
For more information, see “Timestamps” on page 160.
2. In a command line, enter:

dsHashTree -show names
3. In the resulting list, find the distinguished subject name(s) of your timestamp
service (subject of the service’s certificate).

AR100500-01-ACN-EN-04
14.5. Certificates
4. In a command line, enter:

dsHashTree -s "<DistinguishedNameOfOldCertificate>" <archive name>
Note: The name of the logical archive (<archive name>) must always be
included in the dsHashTree commands.
The utility finds all timestamps for the given archive that were created with the
certificate indicated in the command. It calculates hash values for the timestamps
and builds new hash trees. Each hash tree is signed with a new timestamp.
Note: Do not delete the old time stamp server certificate. It may still be used
for another logical archive.
14.4.7 Migrating existing document timestamps

You can migrate existing document timestamps into hash trees and sign the tree
with a timestamp. Thus, you can significantly reduce the number of timestamps
required for timestamp renewal.
Important
You can migrate document timestamps only once! Never disable ArchiSig
timestamps after starting migration.
To migrate existing timestamps:
1. Follow the instructions in “Basic timestamp settings” on page 162.
2. In a command line, run the timestamp migration tool for each pool to be
migrated:
dsReSign -p <pool name>
3. Call the hash tree creation tool for each archive with migrated timestamps:
dsHashTree <archive name>
The tools calculate hash values from the existing timestamps, build hash trees, and
get a timestamp for each tree.
14.5 Certificates
Certificates A certificate is an electronic document which uses a digital signature to bind
together a public key with information on the client issuing this public key
(information such as the name of a person or an organization, their address, and so
forth). The certificate can be used to verify that a public key belongs to an
individual, for example, an archive uses this information to verify requests based on
signed URLs from various clients.
Certificate use Archive Server uses certificates for various use cases:
cases
• Authentication certificates, used for signed URLs; see “Configuring a certificate
for authentication” on page 174.

AR100500-01-ACN-EN-04
• Encryption certificates, used for document encryption; see “Configuring a

certificate for document encryption” on page 177.
• Timestamp certificates, used for document verification; see “Importing a
certificate for timestamp verification” on page 178.
Note: The default certificates delivered for Archive Timestamp Server

expired on 2015-05-28. You can replace the certificate files to avoid error
messages in the Archive Monitoring Web Client. For more information, see
“Renewing expired certificates” on page 182.
PEM files Privacy Enhanced Mail Security Certificate (PEM) files are encoded certificate files
used to store the public key and the certificate. Archive Server uses various PEM
files.
Certificates for In a Remote Standby environment, the Synchronize_Replicates job copies the
Remote certificates for authentication. Only enabled certificates are copied. The certificate on
Standby
the remote server is disabled after synchronization. To enable it, follow the
instructions in “Enabling a certificate” on page 171.
14.5.1 Basic procedures and commands

Introduction This topic provides some basic knowledge of certificates, for example, how to create
a certificate using the Certtool or how to enable a certificate. These basic procedures
are relevant for configuration of authentication certificates, encryption certificates
and timestamp certificates.
• Authentication certificates, i.e. Global tab or the Assigned tab
• Encryption certificates, i.e. Encryption Certificates tab
• Timestamp certificates, i.e. Timestamp Certificates tab
14.5.1.1 Checking a certificate

Certificates can be checked manually by approving their fingerprint. Just as every
human's fingerprints are unique, every certificate's fingerprint is unique. The
fingerprint is a hash of the certificate and is shown as one of the certificate's
properties, it is shown as a hexadecimal number. Using the View Certificate action,
certificates can be displayed for reading.
To verify the authenticity of the transmitted certificate, the system administrators of

the leading application and the Archive Server compare the fingerprints of the sent
and the received certificates. If the fingerprints match, the archive administrator
enables the certificate (see “Enabling a certificate” on page 171).
To establish validity of someone's certificate, you can trust that a third individual
has gone through the process of validating it. A Certification Authority (CA), for
example, is responsible for ensuring that prior to issuing a certificate, he or she
carefully checks it to be sure the public key portion really belongs to the purported
owner. Anyone who trusts the CA will automatically consider any certificates
signed by the CA to be valid.

AR100500-01-ACN-EN-04
14.5. Certificates
The following procedure describes the manual verification by checking the

fingerprint.
To check a certificate:
2. Select the Certificates object and select the appropriate <certificate> tab in the
result pane.
All certificates of the selected certificate type are listed.
3. Select the respective tab and the designated certificate and click View
Certificate in the action pane.
4. Check the general information and the certification path.
General
This tab provides detailed information to identify the certificate
unambiguously: the certificate's issuer, the duration of validity, and the
fingerprint.
Certification Path
Here you can follow the certificate's path from the root to the current
certificate. A certificate can be created from another certificate. The path
shows the complete derivation chain. You can also view the parent
certificate information from here.
14.5.1.2 Enabling a certificate

After importing or receiving a certificate, it is disabled (default). The certificate is to
be enabled, optionally, it can be checked before enabling it (see “Checking a
certificate” on page 170). If required, you can disable a certificate.
To enable a certificate:
result pane.
3. Select the respective certificate by its name and click Enable in the action pane.

AR100500-01-ACN-EN-04
14.5.1.3 Deleting a certificate

Certificates not used can be deleted. The certificate is not physically deleted. It
remains in the directory but is no longer displayed.
To delete a certificate:
result pane.
3. Select the respective tab and the designated certificate and click Delete
Certificate in the action pane.
4. Confirm the upcoming message with OK.
14.5.1.4 Creating a certificate using the Certtool

Certtool Certificates are created using the Certtool. The Certtool allows you to generate your
individual private key and self-signed certificate for your Archive Server. In
addition, it allows you to create a certificate-signing-request to apply for a certificate
at a trust center.
Commands The commands to create a certificate include:
• “Generate self-signed certificates” on page 172 Generate self-signed certificates.

• “Request a certificate from a trust center ” on page 173 Request a certificate from
a trust center (optional).
• “Send the certificate to an Archive Server (putCert)” on page 173 Send the
certificate to an Archive Server (optional, putcert).
Provisioning The platform-specific Certtool is included in the delivery of Archive Server.
If you have to manage a large number of certificates, make sure that the AuthIDs and
the names of the certificates are unique.
Table 14-1: Generate self-signed certificates
certtool genCert <bit> <keyOutFile> <certOutFile> [CN=<commonName>]

[C=<country>] [ST=<state/province>] [O=<organization>]
[OU=<organizationaUnit>] [email=<emailAdress>]
bit mandatory Key length, for example: 2048 or higher
keyOutFile mandatory Output file containing private key
certOutFile mandatory Output file containing certificate with the public key

AR100500-01-ACN-EN-04
14.5. Certificates
CN optional Common name, resp. hostname of your Archive

Server. Use fully-qualified hostname, for example:
arch01.example.net
C optional Country name as two-letter code, for example: DE, FR,
UK
ST optional State or province, for example: Michigan, Saxonia
O optional Organization or company, for example: Sample AG
OU optional Organizational unit, for example: Research and
Development
email optional Email address of the person or group responsible for
the certificate or the Archive Server
Table 14-2: Request a certificate from a trust center
certtool genReq <bit> <keyOutFile> <requestOutFile> [CN=<commonName>]

[C=<country>] [ST=<state/province>] [O=<organization>]
[OU=<organizationaUnit>] [email=<emailAdress>]
bit mandatory Key length, for example: 2048
keyOutFile mandatory Output file containing private key
requestOutFile mandatory Output file to be sent to the certification authority
CN optional Common name, resp. hostname of your Archive
Server. Use fully-qualified hostname, for example:
arch01.example.net
C optional Country name as two-letter code, for example: DE, FR,
UK
ST optional State or province, for example: Michigan, Saxonia
O optional Organization or company, for example: Sample
Corp.
OU optional Organizational unit, for example: Research and
Development
email optional Email address of the person or group responsible for
the certificate or the Archive Server
Send your <requestOutFile> file to a trust center. The trust center will return you a
certificate including the public key. The certificate from the trust center must be in
PEM format.
Table 14-3: Send the certificate to an Archive Server (putCert)
certtool putCert <certInFile> <server> <port> <archive> <id>

certInFile mandatory File containing the certificate in PEM format
server mandatory Host name of Archive Server

AR100500-01-ACN-EN-04
port mandatory Port (typically 8080)

archive mandatory Logical archive for which this certificate will be valid
or an empty string ("") for a global certificate
id mandatory The certificate ID to identify the certificate in
After using the Refresh action (System > Key Store > Certificates), the certificates
sent using putCert are displayed in Administration Client.
Note: putCert cannot be used with SSL. To transfer the certificate to the
server, switch the SSL settings for the logical archive to May use or Don’t use.
Alternatively, if provided, you can also use dsh to send the certificate to Archive
Server.
To send a certificate with dsh:
1. Open a command line and enter the following command:

dsh -h <host>
<host> is the name of your Archive Server.
The following prompt is displayed: command: _
2. Enter the following command:

setAuthId -I <myserver>
<myserver> is the name of your leading application server.

putCert -a <archive> -f <file>
For the <archive> variable, enter the logical archive on the Archive Server for
which the certificate is relevant. Replace the <file> variable with the name of
the certificate, that iscert.pem.
If you need the certificate for several archives, call the command again for each
archive.
4. Quit the program by entering exit.
14.5.2 Configuring a certificate for authentication

Authentication Authentication certificates are used for signed URLs. A certificate can be used by
certificates one or several or all archives, for example, if these archives communicate with the
same leading application (client). These certificates are called global certificates.
Several certificates can be used by one archive, for example, if there are more than
one leading application or document types with different security requirements.
The following assignments are available:
• Assigned globally (global certificate)

These certificates are valid for all logical archives of the Archive Server.

AR100500-01-ACN-EN-04
14.5. Certificates
A global certificate can be imported (that is added) and assigned to all logical
archives (globally) at once. Global certificates are valid for all logical archives –
also for archives that will be created later on. A global certificate can only be
enabled or disabled generally.
• Assigned to one single archived (assigned to one archive only)
These certificates are valid for a single logical archive of the Archive Server.
Procedure
• “Importing an authentication certificate” on page 175
• “Granting privileges for a certificate” on page 176
• “Checking a certificate” on page 170
• “Enabling a certificate” on page 171
14.5.2.1 Importing an authentication certificate

Before certificates can be used, they have to be imported, assigned and enabled,
either for single archives or for all archives of the Archive Server.
Certificates can also be automatically provided (putCert) by the client.
To import an authentication certificate:
1. Select the Certificates node of the Key Store in the System object of the console
tree.
In the console tree select System > Key Store > Certificates.
2. Click the Import Authentication Certificate ... in the action pane.

The Import Authentication Certificate window is opened.
3. In the Certificate Import area, enter a new ID or select an existing ID if you

want to replace an existing certificate.
4. Click Browse to open the file browser for the Archive Server file system and
select the designated Certificate. Click OK to resume.
5. In the Certificate Assignment area, choose:
• Global, if you want to assign the certificate to all archives

• Assign to archive, if you want to assign the certificate to a dedicated
archive.
In the selection list select the dedicated archive.
6. Click OK to start the import.

A protocol window shows the progress and the result of the import. To check
the protocol later on, see “Checking utilities protocols” on page 268.

AR100500-01-ACN-EN-04
14.5.2.2 Granting privileges for a certificate

Certificates Certificates comprise a set of privileges related to the access mode of documents.
privileges Certificates can be used to grant privileges or to restrict privileges to special
requirements.
For example, a scan station may not be allowed to delete documents. Thus, the
privilege “delete documents” must not be set in the certificate that is used to
communicate with the scan station.
Important
Any change to the settings affects all archives that use this certificate!
Note: Consider the following dependencies:
• Certificate privileges (as described here)

• Access permissions set per archive (see “Configuring the archive security
settings” on page 112)
To grant privileges:
2. Select the Certificates entry in the result pane and then the Global tab. All
imported certificates are listed.
3. Select the designated certificate and click Change Privileges in the action pane.
4. Select (set check box) the privileges you want to assign to the certificate. The
following privileges are available:
• Read documents
• Pass by
This privilege is only evaluated in Enterprise Library scenarios. Pass by must
be set for the certificate of the
• Archive Storage Provider

• Enterprise Library Proxy Services (if used)
• Rendition Services (if used)
Pass by must not be set for all other kinds of client certificates, for example,
SAP.
5. Click OK to confirm changes.

AR100500-01-ACN-EN-04
14.5. Certificates
14.5.3 Configuring a certificate for document encryption

Encryption Encryption certificates are used to encrypt the System Key node of the Key Store
certificate itself and for communication between known servers. For security reasons,
OpenText recommends obtaining and importing your own certificate instead of
using the delivered one.
Importing an encryption certificate

Encryption With the Set Encryption Certificates utility, you replace the server key and the
certificate certificate that is used to encrypt the key store. With a new certificate, you can re-
encrypt the key store.
To import an encryption certificate:
1. Select the Certificates entry of the Key Store node in the System object of the
console tree.
2. Select the Encryption Certificates tab in the result pane. All available
certificates are listed.
3. Click Set Encryption Certificates in the action pane.
4. Enter the path and the complete file name of the certificate or click Browse to
open the file browser. Select the designated Certificate and click OK to confirm.
5. Click OK to set the certificate.
6. Check the protocol whether the certificate is successfully imported. See

“Checking utilities protocols” on page 268.
Procedure
• “Importing an encryption certificate” on page 177
14.5.4 Configuring a certificate for timestamp verification

Timestamp cer- Timestamp certificates are used for timestamp verification.
tificates
To configure timestamp certificates, you must create or get a valid certificate.
Certificates for timestamp verification are provided
• by timestamp servers and special certification authorities used by the customer

(recommended),
• by the OpenText Archive Timestamp Server; see “Configuring certificates and
signature keys” on page 167.

AR100500-01-ACN-EN-04
Importing a certificate for timestamp verification

With the Import Timestamp Certificate action, you can import certificates for
timestamp servers like AuthentiDate.
To import certificates for timestamp verification:
1. Select the Certificates entry of the Key Store node in the System object of the
console tree.
2. Click Import Timestamp Certificate in the action pane.
3. Enter a new ID or select an existing ID if you want to replace an existing
certificate.
4. Click Browse to open the file browser and select the designated Certificate.
Click OK to resume.
5. Click OK to start the import.
A protocol window shows the progress and the result of the import. To check
the protocol later on, see “Checking utilities protocols” on page 268.
Procedure
• “Importing a certificate for timestamp verification” on page 178
14.6 Using checksums

Checksums Checksums are used to recognize and reveal unwanted modifications to the
documents on their way through the archive. Checksums are not signed, as the
methods used to reveal modifications are directed towards technical failures and not
malicious attacks. Verification checks these checksums.
Enterprise Scan Enterprise Scan generates checksums for all scanned documents and passes them on
to Document Service. Document Service verifies the checksums and reports errors
(see “Monitoring with notifications“ on page 315). On the way from Document
Service to STORM, the documents are provided with checksums as well, in order to
recognize errors when writing to the media.
Timestamp and The leading application, or some client, can also send a timestamp (including
checksum checksum) instead of the document checksum; see “Timestamps” on page 160.
Verification can check timestamps as well as checksums.
The certificates for those timestamps must be known to the Archive Server and
enabled, before the timestamp checksums can be verified (see “Importing a
certificate for timestamp verification” on page 178).
To activate the usage of checksums for Document Pipeline:
1. Open the Configuration object.

AR100500-01-ACN-EN-04
14.7. ArchiveLink using Common Names (CN)
2. Search for the Use checksum in Archive Server communication variable

(internal name: DP.COMMON.DSH_CHECKSUM; see “Searching
3. Set the Use checksum in Archive Server communication variable to on.
14.7 ArchiveLink using Common Names (CN)

ArchiveLink SAP ArchiveLink is a service used to link archived documents and external
applications accessing these documents.
Enterprise This topic describes the special treatment when using ArchiveLink connections and
Library only Enterprise Library. Signed ArchiveLink connections between external applications
and Enterprise Library require that the Common Name (CN) Subject of the
certificate and the name of the client application (for example, Enterprise Library
Server) for Enterprise Library are identical. This can be achieved in two ways:
• You can define the name of the application and configure the certificate
correspondingly (for example, if you set up a whole new system). Thus, use the
application name as Common Name when creating the certificate, for example,
using the Certtool (see “Creating a certificate using the Certtool” on page 172).
• You can retrieve the Subject from the certificate and use it as application ID
(name of the application); see the procedure below.
To retrieve the application name from a certificate:
2. In the console tree, expand Archiving and Storage and log on to the Archive
Server.
3. Select the Archives > Original Archives > <archive to connect> node.
4. In the result pane, from the Certificates tab, select the imported certificate.
5. In the action pane, click View Certificate.
6. From the Subject entry, note or copy the value after CN=
Use this value as the application ID when creating the application (<server name>
> Enterprise Library Services > Applications).

AR100500-01-ACN-EN-04
Chapter 15
Configuring Archive Timestamp Server
To put a timestamp on every document, Archive Server needs a service to request

timestamps from for each document. This can be a special hardware device, a Time
Stamp Authority, or Archive Timestamp Server.
Archive Timestamp Server is installed and configured together with Archive Server.
It handles the incoming requests, creates the timestamps, and sends the reply. It
runs as an Archive Server component.
After the installation of Archive Server and Archive Timestamp Server, basic
settings of Archive Timestamp Server are preset, for example, default signature key
and certificate are provided. You can also configure other settings, if required.
Note: Archive Timestamp Server allows you to use the timestamp features
independent from external software, for example, for test cases. However, it
does not provide the same high-security level as a trusted service provider.
OpenText strongly recommends using a qualified Time Stamp Authority for

production systems. Archive Timestamp Server is not sufficient in this case.
The configuration of Time Stamp Authorities is described in “Basic timestamp
settings” on page 162.
Configuration The configuration and administration of Archive Timestamp Server is done in the
and administra- Administration Client. See “Configuration variables for Archive Timestamp Server”
tion
on page 183.
Background
• “Timestamps” on page 160
15.1 Using the auto initialization mode

For operating Archive Timestamp Server, the following modes are provided:
Non-auto initialization mode

After starting the Archive Timestamp Server, you have to provide key,
certificate, and other security settings manually to Archive Timestamp Server.
Auto initialization mode

After starting the Archive Timestamp Server, it is ready to run without further
configuration. In environments where an automatic initialization after the start
of Archive Timestamp Server is vital, this mode can be used. All necessary
information must be provided in the configuration, for example, the paths to the
certificates and the signature key, including the passphrase, and other; see
below.

AR100500-01-ACN-EN-04
Chapter 15 Configuring Archive Timestamp Server
However, this method provides no security against an intruder with read access
to the server configuration.
Required For auto initialization, the following settings are required:

settings
• Private key
Configure Archive Timestamp Server to use the signature key from the file
containing the private key in the configuration as described in “Configuration for
Autostart” on page 470. The file is typically located in the <OT config AS>/
timestamp/ directory.
After the installation of Archive Server, Archive Timestamp Server is ready to
use with default signature keys and certificates. However, OpenText
recommends that you create your own signature keys and certificates. These
signature keys and certificates must be provided to Archive Timestamp Server.
• Passphrase
Optional; used to protect the private key.
Configuration You must administer the required settings using configuration variables in
variables Administration Client. Search the following configuration variables in the
Configuration node (see “Searching configuration variables” on page 242):
• Path to the certificate <n>

• Passphrase for the private key
• Path to the private key
Renewing expired certificates

The default certificates for Archive Timestamp Server, which were installed together
with Archive Server, expired on 2015-05-28. You can replace the certificate files to
avoid error messages.
To renew expired certificates for Archive Timestamp Server:
1. Move the existing files cert_ca.pem, cert_root.pem, cert_tss.pem, and

stampkey.pem from the <OT config AS>/timestamp/ directory to a temporary
directory.
2. Download the timestamp_enc.zip file from the Knowledge Center (https://

knowledge.opentext.com/go/60153523).
3. Extract the ZIP file and copy the four PEM files to the <OT config AS>/
timestamp/ directory.
4. Start Administration Client and sign on.

Expand the Archive Server > Configuration > Archive Server > Timestamp
Server (TSTP) node and select Configuration for Autostart.

AR100500-01-ACN-EN-04
15.2. Configuration variables for Archive Timestamp Server
Verify the paths and filenames for each certificate (Path to the certificate 1 to 3
variables). Verify the Path to the private-key file (stampkey.pem). If required,
correct the paths.
5. Import the new certificate files: Expand Archive Server > System > Key Store >
Certificates and then click Import Timestamp Certificate to start the wizard for
each file. Import the certificates with the following IDs and in this order:
Certificate ID Certificate
CA <OT config AS>/timestamp/cert_ca.pem
ROOT <OT config AS>/timestamp/cert_root.pem
TSS <OT config AS>/timestamp/cert_tss.pem
6. Restart the “timestamp” Archive Spawner process by running the command

spawncmd restart timestamp.
15.2 Configuration variables for Archive Timestamp

Server
The required configuration variables are preset with reasonable values. You can
modify them, if necessary. The configuration and administration of Archive
Timestamp Server is done in the Administration Client.
Search the respective configuration variables in the Configuration node; see
“Searching configuration variables” on page 242.
“Configuration recommendation” on page 183 shows the recommended default

settings.
For a reference of all available variables related to the configuration of Archive
Timestamp Server, see “Timestamp Server (TSTP)” on page 468.
Configuration recommendation
ArchiSig timestamps

Use Plain TCP connection.
It is possible to use HTTP if your infrastructure requires it. However, using
HTTP is not recommended because the HTTP header is only overhead and
slows down the timestamping. The port number remains the same.
By default, Archive Timestamp Server uses port 32001.
The hostname or the IP address of Archive Timestamp Server. This can be
localhost if Archive Timestamp Server runs on the same host.


AR100500-01-ACN-EN-04
Chapter 15 Configuring Archive Timestamp Server
Timestamps (old)

By default, Archive Timestamp Server uses port 32001.

The hostname or the IP address of Archive Timestamp Server. This can be
localhost if Archive Timestamp Server runs on the same host.
Multiple hostnames can be configured by separating them with a semicolon
(“;”). Individual port numbers can be supplied with multiple hosts if appended
to the hostname with a colon (“:”) in-between.

Use RFC 3161 (IETF) without HTTP header. SIGIA4 timestamps are strongly
discouraged!
Max. number of connections to the Timestamp Server (internal name:

MAX_TSS_CONNECTIONS)
Use 2. Archive Timestamp Server usually is fast enough so that higher values do
not increase performance.
15.3 Logging information and status

Archive Timestamp Server writes one line containing the serial number of the
timestamp and other information to its protocol file for each timestamp issued. The
location of the file is <OT logging>/timestamp.hist. You can change the location
in the File for the timestamp-protocol configuration variable (internal name:
TSTP_PROTOCOL_FILE). When starting up, Archive Timestamp Server reads the
last serial number issued and continues timestamping with the next serial number.
Checking the You can retrieve and display the general status of Archive Timestamp Server
status together with some details about its configuration with a standard Web browser.
Enter the following URL:
http://<servername>:<port>
As <servername>, use the host name of Archive Timestamp Server and as <port>,
use the configured port. The default port is 32001.
Note: The status can only be retrieved on computers that are configured as
administration hosts in the Archive Timestamp Server setup. If Allow remote
administration from any host is enabled, the web status can be accessed from
any host.

AR100500-01-ACN-EN-04
15.4. Testing the connection
15.4 Testing the connection

ArchiSig From the command line, enter the following command: dsHashTree -T
timestamps
The result should be similar to this:
IMPORTANT: timestamp successfully requested
certificate subjects:
/CN=Demo TSS Stamp /O=Open Text Corporation/OU=ECM/C=CA
/CN=Demo TSS CA/O=Open Text Corporation/OU=ECM/C=CA
/CN=Demo TSS Root/O=Open Text Corporation/OU=ECM/C=CA
Timestamps From the command line, enter the following command: dsSign -t
(old)
The result should be similar to this:
IMPORTANT: about to mount server WORM on host localhost, port 0, mount point /views_hs
IMPORTANT: about to mount server CDROM on host localhost, port 0, mount point /views_hs
Success!
Date/Time: Thu Jun 18 09:41:48 2015
cert 0:
expired: Wed Apr 01 02:00:00 2020
signer: /CN=Demo TSS Stamp /O=Open Text Corporation/OU=ECM/C=CA

cert 1:
expired: Tue Apr 01 02:00:00 2025
signer: /CN=Demo TSS CA/O=Open Text Corporation/OU=ECM/C=CA

cert 2:
expired: Tue Apr 01 02:00:00 2025
signer: /CN=Demo TSS Root/O=Open Text Corporation/OU=ECM/C=CA

AR100500-01-ACN-EN-04
Chapter 16
Configuring users, groups, and policies
Archive Server needs a few specific administrative users for proper work. They are
managed in the System object of the Archive Server. The required settings are preset
during installation. Use the user management in the following cases:
• You want to change the password of the dsadmin administrator of the Archive
Server.
Important
See “Password security and settings” below for additional information on
passwords.
• You want to change settings of users, groups, or policies.
• You need a user with specific rights.
The users of the leading application are managed in other user management
systems, for example OpenText Directory Services (OTDS). To set up a connection to
Directory Services, see “Connecting to Directory Services” on page 198.
16.1 Password security and settings

Introduction To secure the system, OpenText strongly recommends the following:
• Change the password for the administrative users after installation, for example,
dsadmin and dp*, if pipelines are in use.
• Change the password regularly.
• In case the administrator password has been lost: Contact OpenText Customer
Support to create an initial password for the archive administrator.
Important
Changing the password of dsadmin is also required in the OTDS scenario!
Although signing in as dsadmin into Administration Client is not possible if
OTDS is used, dsadmin is still used by other components.
Changing A standard change password dialog for dsadmin users is provided in the
password for Administration Client to change their password, for example, after first login.
dsadmin
Depending on the kind of user management (OTDS or Archive Server’s built-in
system), you find the dialog at a different place.
To change the password of the dsadmin user (OTDS):
1. Sign in to Administration Client as an OTDS user with administrator rights (for

example, otadmin@otds.admin)

AR100500-01-ACN-EN-04
Chapter 16 Configuring users, groups, and policies
2. In the console tree, open the Archive Server > System > Users and Groups
node, and in the result pane, select the Users tab.
3. Open the Properties of the dsadmin user and change the password.
To change the password of the dsadmin user (built-in user management):
1. Start Administration Client and sign in to the Archive Server.
2. In the console tree, select Archive Server and in the action pane, click Set
Password.
3. Enter the old and the new password, confirm the new password and then click
OK.
Password You can specify a minimum length for passwords, if a user is locked out after
settings several unsuccessful logons and how long the lockout is to be.
Minimum length You can define a minimum character length for passwords. If you do not set this
for passwords property, the default value is eight.
To configure the minimum password length:
Min. password length variable (internal name: AS.DS.DS_MIN_PASSWD_LEN).
2. In the Properties window of the variable, change the Value as required.
Lock out after You can define that a user is locked out after a specified number of failed attempts to
failed logons log on; default is 0 (no lockout).
Note: The dsadmin user will never be locked out.
To configure user lockout:
Max. retries before disabling variable (internal name: AS.
DS.DS_MAX_BAD_PASSWD).
2. In the Properties window of the variable, change the Value as required (in
number of retries).
A value of 0 means that users will never be locked out.
4. Enter the following line (or modify it if present already):

=<number of failed attempts>
Unlock after You can define how long a user is locked out after a failed attempt; default is zero
failed logons seconds.

AR100500-01-ACN-EN-04
16.2. Concept
Note: The dsadmin user will never be locked out.
To configure user lockout time:
Time after which bad passwords are forgotten variable (internal name: AS.
DS.DS_BAD_PASSWD_ELAPS).
2. In the Properties window of the variable, change the Value as required (in
seconds).
A value of 0 means that users will never be locked out.
16.2 Concept
Modules To keep administrative effort as low as possible, the rights are combined in policies
and users are combined in user groups. The concept consists of three modules:
User groups
A user group is a set of users who have been granted the same rights. Users are
assigned to a user group as members. Policies are also assigned to a user group.
The rights defined in the policy apply to every member of the user group.
Users
A user is assigned to one or more user groups, and he is allowed to perform the
functions that are defined in the policies of these groups. It is not possible to
assign individual rights to individual users.
Policies
A policy is a set of rights, i.e. actions that a user with this policy is allowed to
carry out. You can define your own policies in addition to using predefined and
unmodifiable policies.
Standard users During the installation of Archive Server, some standard users, user groups, and
policies are configured:
dsadmin in aradmins group

This is the administrator of the archive system. The group has the
“ALL_ADMS” policy and can perform all administration tasks, view accounting
information, and start/stop the Spawner. After installation, the password is
empty, change it as soon as possible; see “Creating and modifying users”
on page 192.
Do not delete this user!
dpuser in dpusers group

This user controls the DocTools of the Document Pipelines. The group has the
“DPinfoDocToolAdministration” policy. The password is set by the dsadmin
user; see “Creating and modifying users” on page 192.

AR100500-01-ACN-EN-04
dpadmin in dpadmins group

This user controls the DocTools of the Document Pipelines and the documents in
the queues. The group has the “ALL_DPINFO” policy. The password is set by
the dsadmin user; see “Creating and modifying users” on page 192.
Tenants Tenants are special user groups intended for OpenText Archive Center. For more
information, see “Creating tenants” on page 195.
16.3 Configuring users and their rights

If you need an additional user with specific rights – for example, if the administrator
of OpenText DesktopLink is not allowed to use the dsadmin user to upload the
client's configuration profiles – carry out the following steps:
1. Create and configure the policy; see “Creating and modifying policies”
on page 191.
2. Create the user; see “Checking, creating, or modifying users” on page 192.
3. Create and configure the user group and add the users and the policies; see
“Checking, creating, or modifying user groups” on page 193.
16.4 Checking, creating, or modifying policies

In a policy, you define which functions are allowed to be carried out. You can create
your own policies and associate them with a combination of rights of your choice.
When creating or modifying a policy, consider that the configuration applies to all
members of user groups to which the policy is assigned (group concept).
Note: The standard policies are write-protected (read only) and cannot be
modified or deleted.
16.4.1 Available rights to create policies

A policy is a set of rights. The available rights are combined in groups and
subgroups. For new policies, only rights of the ALL_WSADM (Administrative
WebServices) policy should be used. The following table provides a short
description of available rights.
Table 16-1: Administrative WebServices
Group Description
Archive Administration Summary of rights to control creation, configuration and deletion
of logical archives.
Archive Users Summary of rights to control creation, configuration and deletion
of users and groups and their associated policies.
Notifications Summary of rights to control creation, configuration and deletion
of notifications and events.

AR100500-01-ACN-EN-04
16.4. Checking, creating, or modifying policies
Group Description
Policies Summary of rights to control creation, configuration and deletion
of policies.
Important
Rights out of the following policy groups should no longer be used. These
rights are still available to ensure compatibility to policies created for former
versions of Archive Server.
• Accounting
• Administration Server
• DPinfo
• Scanning Client
• Spawner
16.4.2 Checking policies

To check policies:
1. Select Policies in the System object in the console tree to check, create, modify
and delete policies. All available policies are listed in the top area of the result
pane. In the bottom area the assigned rights are shown as a tree view.
2. To check a policy, select it in the top area of the result pane. The assigned rights
are listed in the bottom area.
3. To create and modify a policy, see “Creating and modifying policies”

on page 191.
16.4.3 Creating and modifying policies

To create a policy:
1. Select Policies in the System object in the console tree. All available policies are
listed in the top area of the result pane.
2. Click New Policy in the action pane. The window to create a new policy opens.
3. Enter a name and description for the new policy.
Name
Name of the policy. Spaces are not allowed. The name cannot be modified
after creation.
Description
Short description of the role the user can assume by means of this policy.
4. The Available Rights tree view shows all rights that are currently not
associated with the policy. Select a single right or a group of rights that should
be assigned to the policy and click Add >>.

AR100500-01-ACN-EN-04
5. To remove a right or a group of rights, select it in the Assigned Rights tree view
and click << Remove.
Modifying a To modify a self-defined policy, select the policy in the top area of the result pane
policy and click Edit Policy in the action pane. Proceed in the same way as when creating a
new policy. The name of the policy cannot be changed.
Deleting a To delete a self-defined policy, select the policy in the top area of the result pane and
policy click Delete in the action pane. The rights themselves are not lost, only the set of
them that makes up the policy. Pre-defined policies cannot be deleted.
Related Topics
• “Checking, creating, or modifying users” on page 192
• “Checking, creating, or modifying user groups” on page 193
• “Concept” on page 189
16.5 Checking, creating, or modifying users

16.5.1 Checking users
To check users:
1. Select Users and Groups in the System object in the console tree to check,
create, modify and delete users.
2. Select the Users tab in the top area of the result pane to list all users.
3. To check a user, select the entry in the top area of the result pane. The groups
which the user is assigned to are listed in the bottom area.
4. To create and modify a user, see “Creating and modifying users” on page 192.
16.5.2 Creating and modifying users

A user can be member of several groups. The user has all rights that are defined in
the policies for these groups.
To create a user:
1. Select Users and Groups in the System object in the console tree.
2. Select the Users tab in the result pane. All available users are listed in the top
3. Click New User in the action pane. The window to create a new user opens.
4. Enter the user name and the password.
Username
Name of the user to administer the Archive Server. The name can be a
maximum of 14 characters in length. Spaces are not permitted. This name
cannot be changed subsequently.

AR100500-01-ACN-EN-04
16.6. Checking, creating, or modifying user groups
Password
Password for the specified user.
Note: All printable ASCII characters are allowed within a password

except: “;”, “'” and “"”.
Confirm password
Enter exactly the same input as you have already entered under Password.
Click Next.
5. Select the groups the user should be assigned to. Click Finish.
Modifying user To modify a user's settings, select the user and click Properties in the action pane.
settings Proceed in the same way as when creating a new user. The name of the user cannot
be changed.
Deleting users To delete a user, select the user and click Delete in the action pane.
Related Topics
• “Creating and modifying policies” on page 191

• “Checking, creating, or modifying user groups” on page 193
16.6 Checking, creating, or modifying user groups

16.6.1 Checking user groups
To check user groups:
1. Select Users and Groups in the System object in the console tree to check,
create, modify and delete user groups.
2. Select the Groups tab in the top area of the result pane to list all groups.
3. To check a user group, select the entry in the top area of the result pane.
Depending on the tab you selected, additional information is listed in the
bottom area:
Members tab
List of users who are members of the selected group.
Policies tab
List of policies which are assigned to the selected group.
4. To create and modify a user group, see “Creating and modifying user groups”
on page 194.

AR100500-01-ACN-EN-04
16.6.2 Creating and modifying user groups

To create a user group:
2. Select the Groups tab in the top area of the result pane. All available groups are
3. Click New Group in the action pane. The window to create a new group opens.
4. Enter the name of the group.
Name
A name that clearly identifies each user group. The name can be a
maximum of 14 characters in length. Spaces are not permitted.
Implicit
Implicit groups are used for the central administration of clients. If a group
is configured as implicit, all users are automatically members. If users who
have not been explicitly assigned to a user group log on to a client, they are
considered to be members of the implicit group and the client configuration
corresponding to the implicit group is used. If several implicit groups are
defined, the user at the client can select which profile is to be used.
5. Click Finish.
Modifying group To modify the settings of a group, select it and click Properties in the action pane.
settings Proceed in the same way as when creating a user group.
Deleting a user To delete a user group, select it and click Delete in the action pane. Neither users
group nor policies are lost, only the assignments are deleted.
Related Topics
• “Creating and modifying policies” on page 191
• “Checking, creating, or modifying users” on page 192
• “Adding users and policies to a user group” on page 194
16.6.3 Adding users and policies to a user group

To add users and policies to a user group:
1. Select the user group in the top area of the result pane for which users and
policies should be added.
2. Select the Members tab in the bottom area. Click Add User in the action pane. A
window with available users opens.
3. Select the users which should be added to the group and click OK.

AR100500-01-ACN-EN-04
16.7. Creating tenants
4. Select the Policies tab in the bottom area. Click Add Policy in the action pane. A
window with available policies opens.
5. Select the policies which should be added to the group and click OK.
Removing To remove a user or a policy, select it in the bottom area and click Remove in the
users and action pane.
policies
16.7 Creating tenants

A tenant is defined by a user group with an associated, dedicated policy. Tenants are
required by OpenText Archive Center. By default, the policy is
“BusinessAdministration” and is created automatically. The policy to be used by the
tenants can be configured as described in “Configuring a policy for tenants”
on page 196 below.
Note: Tenant groups were introduced with Archive Server Update 2013.2.
Groups On Archive Server, the tenant <name> is defined by the following DS user groups:
• <name> (with policy BusinessAdministration)
• <name>_ED (with policy ArchiveAccess)
• <name>_UG (with policy MyArchive)
Groups of the same name (<name>, <name>_ED, <name>_UG) are created within the
partition OTInternal in OpenText Directory Services.
Users who belong to <name> are allowed to work with the Archive Center
Administration client.
Users who belong to <name>_ED are allowed to work with the Archive Center Access
client.
Users who belong to <name>_UG are allowed to work with the My Archive client.
For the Email scenarios, all IMAP users who are allowed to access their personal
archives must be added to the <name>_UG group. To get emails archived at all, this
user must also be a member of the group (or any subgroup) of the OTDS group
specified in the For Group field in Archive Center Administration.
Important
The <name>_SU group is intended for technical users only. Do not add any
human users to this group as these users would have access to ACLs and the
BCC fields of emails.
On-premises In the on-premises scenario, only one tenant is allowed per installation of Archive
Center. The scenario is defined in the Operating Mode configuration variable
(internal name: AS.AS.BIZ_OPERATING_MODE).
To create a tenant user group:

AR100500-01-ACN-EN-04
2. Click New Tenant in the action pane. The window to create a new tenant opens.
3. Enter the Tenant name and a Short name.
Tip: The short name is used as a prefix for the names of this tenant’s
logical archives, buffers, and jobs. Thereby, you can easily sort the
corresponding lists by tenants.
The following restriction apply to short names:
• They cannot exceed five characters.

• They must be unique over all tenants.
• You cannot change the short name after the tenant has been created.
4. Optional Cloud operating modes only: In the Contract ID field, you can enter any
unique, arbitrary text. This ID is used to identify the tenant when exporting the
billing information (XML file).
5. Optional Additionally to creating the tenant group, you can create the following
users:
Administration User
This user is added to the new tenant, with assigned policy
“BusinessAdministration,” and thereby is allowed to perform all tasks
related to Archive Center Administration.
Access User
This user is added to a new user group. The new group has the name <new
tenant>_ED and the assigned policy “ArchiveAccess,” and thereby is
allowed to perform all tasks related to Archive Center Access. This policy
enables the eDiscovery user to search for holds and create EDRM exports,
for example. The policy does not allow writing to archives; in particular,
setting holds is not possible.
6. Click OK.
The tenant user group with assigned policy is created.
Configuring a policy for tenants

You can assign another policy to be used for tenants by changing a configuration
variable.
To change a policy for tenants:
1. If required, create a new policy as described in “Checking, creating, or

modifying policies” on page 190.
2. Depending on your needs, change the value of the following configuration

variables from the default value to the name of the new policy.

AR100500-01-ACN-EN-04
16.8. Checking a user’s rights
Variable name Internal name Default value

Policy Name for Business AS.AS.BIZ_POLICYNAM BusinessAdministrati
Administrator E on
Policy Name for Archive AS.AS.BIZ_ACCESS_POL ArchiveAccess
Access ICYNAME
Policy Name for My AS.AS.BIZ_MYARCHIVE MyArchive
Archive _POLICYNAME

Related Topics
• “Configuring miscellaneous Archive Center options“ on page 61
16.8 Checking a user’s rights

You cannot see the rights of an individual user directly because they are assigned
indirectly via policies to user groups and not to individual users. Proceed as follows
to ascertain a user's rights.
To check a user’s rights:
1. Select Users and Groups in the System object of the console tree.
2. Select the Users tab in the top area of the result pane and select the user. Note
the groups listed under Members in the bottom area.
3. Select the Groups tab in the top area of the result pane and select Policies in the
bottom area of the result pane.
4. Select one of the groups you noted and note also the assigned policies listed in
the bottom area.
5. Select Policies in the System object.
6. Select one of the policies you noted. The associated groups of rights and
individual rights appear in the bottom area. Make a note of these.
7. Repeat Step 6 for all policies that you noted for the user group.
8. Repeat steps 4 to 7 for the other user groups which the user is a member of.

AR100500-01-ACN-EN-04
16.9 Connecting to Directory Services

You can use OpenText Directory Services (OTDS) as user management system for
Archive Server. To connect Archive Server to OTDS, an OTDS resource is required.
You can easily set up and configure a new resource for OTDS in Administration
Client.
To connect Archive Server to OTDS:
1. Select Archive Server in the console tree.
2. In the action pane, click OTDS Connection.

The OTDS Connection wizard opens.
3. On the Connection page, enter the following:
OTDS server URL

Enter the server hosting OTDS as URL: <protocol>://<server>:<port>
For example, https://otds_server:8090
OTDS administrator
Enter the name of the OTDS administrator; default: otadmin@otds.admin
OTDS administrator password

Enter the password of the OTDS administrator.
Click Next.
4. On the Resource page, enter a resource name for Archive Server.
Note: Resource names must be unique.
Click Next.
5. On the Summary page, verify your entries and click Finish. The resource is
created.
Restart Archive Server to activate the new resource.
To modify it, you must sign on to Directory Services.
Securing If you configure Archive Server to connect to OTDS using SSL (that is using https
connection as <protocol>) the identity of the OTDS server will not be checked by default. For a
most secure connection, you can force Archive Server to trust the OTDS server only
if its server certificate has been issued by a trusted certification authority.
Note: The “strict” verification requires fully and properly set up trust and keys
stores at both Archive Server and OTDS application servers.
The default (“lazy”) verification performs basic validity checks of the provided
certificate and checks of the server’s host name against the information in the
certificate but does not require a corresponding trust store setup.

AR100500-01-ACN-EN-04
16.9. Connecting to Directory Services
To allow trusted certificates only:
1. Create an OTDS resource as shown above using an HTTPS connection, for

example, https://otds_server:8090.
2. Change the value of the Server Authentication Check Policy configuration

variable (internal name: AS.AS.OTDS_SSL_POLICY) to strict.
3. Restart Archive Server to activate strict verification.
Linking You can easily transfer the permissions and policies in Archive Server’s built-in user
permissions management to a corresponding user in OTDS as follows:
and policies
1. For a logged-in OTDS user, all OTDS groups are checked for whether there is a
group of the same name in the Archive Server’s built-in user management.
Note: Only the group name is important for the OTDS groups. The check
does not consider the user partition.
2. In case of matching groups, the policies assigned to the corresponding group in
the built-in user management are looked up.
3. It is checked whether the permission of the OTDS user allows to execute the
desired command.
To link OTDS users to permissions and policies of the Archive Server:
1. Create groups with the same group names in the Archive Server’s built-in user
management and in OTDS (in any user partition).
2. Assign the policies as required to the group in the built-in user management.
Further For details on OTDS, see OpenText Directory Services with the OpenText Administration
information Client - Installation and Administration Guide (OTDS-IGD).

AR100500-01-ACN-EN-04
Chapter 17
Connecting to SAP servers
If you use SAP as leading application, you configure the connection not only in the
SAP system but also in Administration Client. OpenText Document Pipeline for
DocuLink and OpenText Document Pipeline for SAP Solutions – in particular the
DocTools R3Insert, R3Formid, R3AidSel, and cfbx – require some connection
information. These Document Pipelines can send data back to the SAP server, for
example, the document ID in bar code scenarios. For these scenarios, Document
Pipeline for SAP Solutions must be installed. The basic and scenario customizing for
SAP is described in OpenText Archiving and Document Access for SAP Solutions -
Scenario Guide (ER-CCS). The configuration in the OpenText Administration Client
includes:
• “Creating and modifying SAP gateways” on page 203
• “Creating and modifying SAP system connections” on page 201
• “Assigning an SAP system to a logical archive” on page 204
17.1 Creating and modifying SAP system connections

The Document Pipeline connects the SAP server in some scenarios. You configure
which SAP system connections will be accessed.
To create an SAP system connection:
1. Select SAP Servers in the Environment object in the console tree.
2. Select the SAP System Connections tab in the result pane.
3. Click SAP System Connection in the action pane. A window to configure the
SAP system opens.
4. Enter the settings for the SAP system connection.
Connection name
SAP system connection name with which the administered server
communicates. You cannot modify the name later.
Description
Enter an optional description (restricted to 255 characters).
Server name
Name of the SAP server on which the logical archives are set up in the SAP
system.
Client
Three-digit number of the SAP client in which archiving occurs.

AR100500-01-ACN-EN-04
Chapter 17 Connecting to SAP servers
Feedback user
Feedback user in the SAP system. The cfbx process sends a notification
message back to this SAP user after a document has been archived using
asynchronous archiving. A separate feedback user (CPIC type) should be
set up in the SAP system for this purpose.
Password
Password for the SAP feedback user. This is entered, but not displayed,
when the SAP system is configured. The password for the feedback user
must be identical in the SAP system and in OpenText Administration
Client.
Instance number
Two-digit instance number for the SAP system. The value 00 is usually used
here. It is required for the sapdp<xx> service on the gateway server in order
to determine the number of the TCP/IP port (<xx> = instance number) being
used.
Codepage
Specifies the encoding of the document metadata fields as defined by the
ATTRIBUTES statements in the pipeline attribute definition file (IXATTR).
This is mainly relevant for free-text fields with characters outside the 7-bit
range. A four-digit number specifies the type of character set that is used by
the functions in SAP RFC libraries. These libraries convert the metadata
from the character set specified by this setting to the character set of the
SAP server. The default value is 1100 (ISO-8859-1). Other possible values
are, for example, 4110 (UTF-8) or 8000 (Shift-JIS).
Language
Language of the SAP system; default is English. If the SAP system is
installed exclusively in another language, enter the SAP language code here.
Test Connection
Click this button to test the connection to the SAP system. A window opens
and shows the test result.
5. Click Finish.
Modifying SAP To modify a SAP system, select it in the SAP System Connections tab and click
system Properties in the action pane. Proceed in the same way as when creating a SAP
connections
system connection.
Deleting SAP To delete a SAP system, select it in the SAP System Connections tab and click
system Delete in the action pane.
connection
Testing a SAP To test a SAP connection, select it in the SAP System Connections tab and click Test
connection Connection in the action pane. A window opens and shows the test result.

AR100500-01-ACN-EN-04
17.2. Creating and modifying SAP gateways
17.2 Creating and modifying SAP gateways

SAP gateways link the SAP system connection to the outside world. At least one
gateway must be defined for each SAP system. One gateway can also be used for
multiple SAP system connection.
Access to a specific SAP gateway depends on the subnet in which a Document

Pipeline or Enterprise Scan workstation is located. The Internet address is evaluated
for identification purposes.
To create an SAP gateway:
2. Select the SAP Gateways tab in the result pane.
3. Click New SAP Gateway in the action pane. A window to configure the SAP
gateway opens.
4. Enter the settings for the SAP gateway.
Subnet address
Specifies the address for the subnet in which an Archive Server or
Enterprise Scan is located. At least the first part of the address (for example,
NNN.0.0.0 in case of IPv4) must be specified. A gateway must be
established for each subnet.
IPv6
If you use IPv6, do not enclose the IPv6 address with square brackets.
Subnet mask / Length

Specifies the sections of the IP address that are evaluated. You can restrict
the evaluation to individual bits of the subnet address.
IPv4
Enter a subnet mask, for example 255.255.255.0.
IPv6
Enter the address length, i.e. the number of relevant bits, for example
64.
SAP system connection

SAP system connection name of the SAP system for which the gateway is
configured. If this is not specified, then the gateway is used for all SAP
system connections for which no gateway entry has been made. If subnets
overlap, the smaller network takes priority over the larger one. If the
networks are of the same size, the gateway to which a concrete SAP system
is assigned has priority over the default gateway that is valid for all the SAP
system connections.

AR100500-01-ACN-EN-04
Chapter 17 Connecting to SAP servers
Gateway address
Name of the server on which the SAP gateway runs. This is usually the SAP
server.
Gateway number
Two-digit instance number for the SAP system. The value 00 is usually used
here. It is required for the sapgwxx service on the gateway server to
determine the number of the TCP/IP port (xx = instance number; for
example, instance number = 00, sapgw00, port 3300).
5. Click Finish.
Modifying SAP To modify a SAP gateway, select it in the SAP Gateways tab and click Properties in
gateways the action pane. Proceed in the same way as when creating a SAP gateway.
Deleting SAP To delete a SAP gateway, select it in the SAP Gateways tab and click Delete in the
gateways action pane.
17.3 Assigning an SAP system to a logical archive

For archives used with SAP as leading application, specific information is required
for most archive scenarios. Enterprise Scan reads this information from the
Administration Server and stores it in the COMMANDS file. The cfbx DocTool needs
these settings to connect to the SAP system.
Requirements:
• The gateway to the SAP system is created and configured; see “Creating and
modifying SAP gateways” on page 203.
• The SAP system is created and configured; see “Creating and modifying SAP
system connections” on page 201.
To assign an SAP system to an archive:
2. Select the Archive Assignments tab in the result pane. All archives are listed in
the top area of the result pane.
3. Select the archive to which a SAP system should be assigned. Keep in mind, that
SAP system can be assigned only to original archives.
4. Click New Archive SAP Assignment in the action pane. A window to configure
the SAP archive assignment opens.
5. Enter the settings for SAP archive assignment:

SAP system connection name of the SAP system with which the logical
archive communicates.

AR100500-01-ACN-EN-04
17.3. Assigning an SAP system to a logical archive
Archive link version

The ArchiveLink version 4.5 for SAP R/3 version 4.5 and higher is currently
used.
Protocol
Communication protocol between the SAP application and Archive Server.
Fully configured protocols, which can be transported in the SAP system, are
supplied with the SAP products of OpenText.
Use as default SAP system connection

Selects the SAP system to which the return message with the barcode and
document ID is sent in the “Late Storing with Barcode” scenario. This
setting is only relevant if the archive is configured on multiple SAP
applications, for example, on a test and a production system.
6. Click Finish.
Modifying To modify an archive assignment, select it in the bottom area of the result pane and
archive click Properties in the action pane. Proceed in the same way as when assigning a
assignments
SAP system.
Removing To delete an archive assignment, select it in the bottom area of the result pane and
archive click Remove Assignment in the action pane.
assignments

AR100500-01-ACN-EN-04
Chapter 18
Configuring scan stations
There are archiving scenarios in which scan stations submit scanned content to
logical archives. For these scenarios, the scan stations needs information about the
archiving operation. They need to know to which logical archives the documents are
sent, and how the documents are to be indexed when archived. The archive mode
contains this information.
Archive modes are assigned to every scan station. When a scan station starts, it
queries the archive modes that are defined for it at the specified Archive Server. The
employee at the scan station assigns the appropriate archive mode to the scanned
documents in the course of archiving.
The following details must be configured correctly to archive from scan stations:
• Archive in which the documents are stored, scenario and conditions, workflow.
See “Adding and modifying archive modes” on page 209.
• Scan station to which an archive mode applies. See “Adding a new scan host and
assigning archive modes” on page 212.
• If SAP is the leading application: the SAP system to which the barcode and the
document ID are sent, and the communication protocol and version of the
ArchiveLink interface. See “Assigning an SAP system to a logical archive”
on page 204.
For more information about archiving scenarios, see “Scenarios and archive modes”
on page 207.
18.1 Scenarios and archive modes

Below you find some example settings for various archiving scenarios, sorted
according to the leading applications.
Suite for SAP Solutions
You need the Document Pipelines for SAP (R3SC) for all archiving scenarios.
Note: For scenarios in which archiving is started from the SAP GUI, you do not
need an archive mode.
Scenario (Opcode) Conditions Workflow Extended Conditions

Late storing with barcodes
See also OpenText Archiving and Document Access for SAP Solutions - Scenario Guide (ER-CCS).
Late_Archiving BARCODE n/a n/a

AR100500-01-ACN-EN-04
Chapter 18 Configuring scan stations
Scenario (Opcode) Conditions Workflow Extended Conditions

Specific scenarios
Early_Archiving n/a
Late_R3_Indexing n/a
Early_R3_Indexing n/a
DirectDS_R3 n/a
Transactional Content Processing
Scenario Conditions Workflow Extended Conditions

(Opcode)
Pre-indexing
Documents are indexed in Enterprise Scan first. The archiving process archives the
document to the Transactional Content Processing Servers.
DMS_Indexing n/a n/a n/a
Pre-indexing to Process Inbox of TCP GUI
document to the Transactional Content Processing Servers and starts a process with the
document.
DMS_Indexing n/a <processname> PS_MODE LEA_9_7_0
PS_ENCODING_BASE64_UTF8N 1
Pre-indexing to Tasks inbox of PDMS GUI
document to the Transactional Content Processing Servers and creates a task in the TCP
Application Server PDMS GUI inbox for a particular user, or for any user in a particular
group.
DMS_Indexing n/a n/a BIZ_ENCODING_BASE64_UTF8N
BIZ_APPLICATION<name>
User:
key = BIZ_DOC_RT_USER
value = <domain>\<name>
User group:
key = BIZ_DOC_RT_GROUP
Late indexing to Process Inbox of TCP GUI
Archives the document to the Transactional Content Processing Servers and starts a process
with the document in the TCP GUI inbox. Documents are indexed in TCP.
DMS_Indexing n/a <processname> PS_MODE LEA_9_7_0
PS_ENCODING_BASE64_UTF8N 1

AR100500-01-ACN-EN-04
18.2. Adding and modifying archive modes
Scenario Conditions Workflow Extended Conditions

(Opcode)
Late indexing to Indexing inbox of PDMS GUI
Archives the document to the Transactional Content Processing Servers and creates an
indexing item in the TCP Application Server PDMS GUI Indexing inbox. Documents are
indexed in TCP.
DMS_Indexing PILE_INDEX n/a BIZ_ENCODING_BASE64_UTF8N
BIZ_REG_INDEXING
Leave the values empty
Late indexing to Tasks inbox of PDMS GUI
Archives the document to the Transactional Content Processing Servers and creates a task in
the TCP Application Server PDMS GUI inbox for a particular user, or for any user in a
particular group. Documents are indexed in TCP.
User:
key = BIZ_DOC_RT_USER
User group:
key = BIZ_DOC_RT_GROUP
value = <domain>\<group>
Late indexing for plug-in event
Archives the document to the Transactional Content Processing Servers and calls a plug-in
event in the TCP Application Server. Documents are indexed in TCP.
BIZ_PLG_EVENT=<plugin>:
<event>
18.2 Adding and modifying archive modes

With archive mode settings, you define where the documents are stored, how they
are processed, and further actions that are triggered in the leading application. You
can find a list of archiving scenarios and their archive mode settings in “Scenarios
and archive modes” on page 207.
To add an archive mode:
1. Select Scan Stations in the Environment object in the console tree.

2. Select the Archive Modes tab in the result pane.
3. Click New Archive Mode in the action pane.

AR100500-01-ACN-EN-04
4. Enter the settings for the archive mode.

For details, see “Archive Modes properties” on page 210.
5. Click Finish.
Thus you can create several archive modes, for example, if you want to assign
document types to different archives.
Modifying an To modify the settings of an archive mode, select it in the Archive Modes tab in the
archive mode result pane and click Properties in the action pane. Proceed in the same way as
when adding an archive mode. For details, see “Archive Modes properties”
on page 210.
Deleting an To delete an archive mode, select it in the Archive Modes tab in the result pane.
archive mode Click Delete in the action pane. If the archive mode is assigned to a scan host, it
must be removed first, see “Removing assigned archive modes” on page 214.
Archive Modes properties

General tab
Archive mode name

Name of the archive mode. Do not use spaces. You cannot change the name of
the archive mode after creation.
Scenario
Name of the archiving scenario (also known by the technical name Opcode).
Scenarios apply to leading applications.
Archive name
Name of the logical archive, to which the document is sent.

SAP system connection name with which the administered server
communicates.
Pipeline Host tab
Pipeline Info
Use local Pipeline configuration: The Document Pipeline configuration
installed on the client is used (the actual pipeline to be used can be remote,
though).
Use the following Remote Pipeline: The Document Pipelines can be installed
on a separate computer. The pipeline is accessed via an HTTP interface. For this
configuration, the protocol, the pipeline host, and the port must be set.
Protocol
Protocol that is used for the communication with the pipeline host. For security
reasons, HTTPS is recommended.
Pipeline host
The computer where the Document Pipeline is installed.

AR100500-01-ACN-EN-04
18.2. Adding and modifying archive modes
Port
Port that is used for the communication with the pipeline host. Use 8080 for
HTTP or 8090 for HTTPS.
Advanced tab
Workflow
Name of the workflow that will be started in Enterprise Process Services when
the document is archived. For details concerning the creation of workflows, see
the Enterprise Process Services documentation.
Conditions
These archiving conditions are available:
R3EARLY
Early archiving with SAP.
BARCODE
If this option is activated, the document can only be archived if a barcode
was recognized. For Late Archiving, this is mandatory. For Early Archiving,
the behavior depends on your business process:
• If a barcode or index is required on every document, select the Barcode
condition. This makes sure that an index value is present before
archiving. The barcode is transferred to the leading application.
• If no barcode is needed, or it is not present on all documents, do not
select the Barcode condition. In this case, no barcode is transferred to the
leading application.
PILE_INDEX
Sorts the archived documents into piles for indexing according to certain
criteria. For example, the pile can be assigned to a document group, and the
access to a document pile in a leading application like Transactional Content
Processing can be restricted to a certain user group.
INDEXING
Indexing is done manually.
ENDORSER
Special setting for certain scanners. Only documents with a stamp are
stored.
Extended Conditions
This table is used to hand over archiving conditions to the COMMANDS file, for
example, to provide the user name so that the information is sent to the correct
task inbox. The extended conditions are key-value pairs. Click Add to enter a
new condition. To modify a extended condition select it and click Edit. Click
Remove to delete the selected condition.
Related Topics
• “Adding a new scan host and assigning archive modes” on page 212

AR100500-01-ACN-EN-04
• “Scenarios and archive modes” on page 207
18.3 Adding additional scan hosts

It is possible to assign more than one scan host to an archive mode.
To add scan hosts to an archive mode:
2. Select the Archive Modes tab in the result pane.
3. Select the archive mode to assign scan hosts.
4. Click Add Scan Host in the action pane. A window with available scan hosts
opens.
5. Select the designated scan hosts and click OK.
Related Topics
• “Adding and modifying archive modes” on page 209
• “Adding a new scan host and assigning archive modes” on page 212
18.4 Adding a new scan host and assigning archive

modes
The assignment of archive modes to scan hosts specifies which archive modes can be
used by a scan station. Multiple assignments are possible, i.e. you can operate with
several scanners and store documents in the same or different archives using
different scenarios. Further, a default mode for each scan host can be set. Enterprise
Scan reads the archive modes from the Administration Server when it is starting.
Therefore, you have to restart Enterprise Scan after assigning archive modes.
To add new scan hosts:
2. Select the Scan Hosts tab in the result pane.
3. Click New Scan Host in the action pane.
4. Enter the settings for the scan host:
Scan host name

Name of the scan station that is used to reference it in the network. Spaces
are not permitted. You can check the validity of the name by sending a ping
to the scan station. The name must be entered in exactly the same way as it
has been defined at operating system level.
Site
Describes the location of the scan host.

AR100500-01-ACN-EN-04
18.5. Adding additional archive modes
Description
Brief, self-explanatory description of the scan host.
Default archive mode

Archive mode assigned as default to the corresponding scan station.
5. Click Finish.
6. Add additional archive modes if needed (see “Adding additional archive

modes” on page 213).
Deleting an To delete an archive mode, select it in the Archive Mode tab in the result pane. Click
archive mode Delete in the action pane. If the archive mode is assigned to a scan host, it must be
removed first, see “Adding a new scan host and assigning archive modes”
on page 212.
Related Topics
• “Adding additional archive modes” on page 213
• “Archive Modes properties” on page 210
18.5 Adding additional archive modes

It is possible to assign more than one archive mode to a scan host to support
different scenarios.
To add archive modes to a scan host:
3. Select the scan host to assign archive modes.
4. Click Add Archive Mode in the action pane. A window with available archive
modes opens.
5. Select the archive modes and click OK.
Related Topics
• “Archive Modes properties” on page 210

AR100500-01-ACN-EN-04
18.6 Changing the default archive mode

You can assign more than one archive mode to a scan host. The default archive
mode is the preferred mode for scan clients, which are using this scan host. The first
assigned archive mode is the default mode, but can be changed if necessary.
To change the default archive mode:
3. Select the scan host for which you want to change the default archive mode.
4. Click Properties in the action pane.
5. Choose the new default archive mode and click OK.
18.7 Removing assigned archive modes

To remove assigned archive modes:
3. Select the scan host in the top area of the result pane.
4. Select the archive mode which you want to remove in the bottom area of the
result pane.
5. Click Remove in the action pane.
6. Click OK to confirm.

AR100500-01-ACN-EN-04
Chapter 19
Adding and modifying known servers
Known servers are used to realize remote standby scenarios to increase data
security. If a server is added as a known server to the environment, all archives of
this server can be checked in External Archives in the Archives object of the console
tree. If a logical archive of a known server is replicated to the original server, this
archive can be checked in Replicated Archives in the Archives object of the console
tree. See “Configuring remote standby scenarios“ on page 219.
19.1 Adding known servers

To add a known server:
2. Click New Known Server in the action pane.
3. Enter the known server parameters:
Remote server name

Name of the remote server to be added as known server.
Note: Instead of the host name, you can also use IPv4 addresses. IPv6
addresses are not supported.
Port, Secure port, Context path

Specifies the port, the secure port, and the context path that enables Archive
Server to create URLs of a designated Remote Standby Server.
Structure of the URLs:
http://<host>:<port><context>?...
https://<host>:<secure port><context>?...
Example: <host> = host03100

<port> = 8080
<secure port> = 8090
<context> = /archive
http://host03100:8080/archive?...
https://host03100:8090/archive?...
You can configure whether HTTP or HTTPS is used in the following way:
• If you only want to allow secure connections using HTTPS, set the value
of Port to 0 (zero) and specify the HTTPS port in Secure port.
• If you only want to allow connections using HTTP, set the value of
Secure port to 0 (zero) and specify the HTTP port in Port.

AR100500-01-ACN-EN-04
Chapter 19 Adding and modifying known servers
If both Port and Secure port are set to a value larger than 0, the
ADMS_KNOWN_SERVER_PROTOCOL variable is used to determine the used
protocol. At least one of the port values must be larger than 0.
4. Click OK. The new known server is added to the environment.
19.2 Enabling replication to known servers

If the known server should be used to replicate archives, for example, for remote
standby scenarios, you must enable replication to the known server added before.
This will also enable the encryption certificate of the known server.
To enable replication:
2. Select the known server in the result pane.
3. Click Enable Replication in the action pane.
4. In the dialog box, click OK to enable the encryption certificate of the known
server.
Disabling You can disable replication to a known server again by selecting the known server in
replication the result pane and clicking Disable Replication in the action pane. After you have
confirmed with OK, also the encryption certificate of the known server will be
disabled.
19.3 Checking and modifying known servers

To check a known server:
2. Select the server you want to check.
4. To modify the settings of a known server, proceed in the same way as when
adding a known server. Additional to the New known server window, you get
more information of the known server:
Version
The version number of the known server.
Startup time
The date and time when the known server was started last.
Build Information
Detailed information of the software build and revision of the known
server.

AR100500-01-ACN-EN-04
19.4. Synchronizing servers
Description
Shows the short description of the known server, if available.
5. Click OK.
Modifying To modify the settings of a known server, select it in the top area of the result pane
known server and click Properties in the action pane. Proceed in the same way as when adding a
settings
known server.
19.4 Synchronizing servers

The Synchronize Servers function transfers settings from known servers to the local
server. This is useful if settings on a known server are changed (for example,
replicated pools or buffers).
You can update the following:
• Settings of replicated archives
• Settings of replicated buffers
• Encryption certificates
• System keys
To synchronize known servers:
2. Click Synchronize Servers in the action pane.
3. Click OK to confirm. The synchronization is started.

AR100500-01-ACN-EN-04
Chapter 20
Configuring remote standby scenarios
In a remote standby scenario, a Remote Standby Server is configured as duplicate of

the original Archive Server. The Remote Standby Server and the Archive Server are
connected via LAN or WAN. To configure a remote standby scenario, the Remote
Standby Server must be added as a known server to the original Archive Server first
(see “Adding and modifying known servers“ on page 215). Thus, the Remote
Standby Server can transmit data from the original Archive Server.
Original Archive Server Remote Standby Server

Local Archive – Replicated Local Archive
Archive A1 Archive C1
Disk Volume(s) Buffer P1a Disk Volume(s) Buffer P3a

Pool 1a Pool 3a
Disk Volume(s) Buffer P1b Pool 1b Disk Volume(s) Buffer P3b Pool 3b
Local Archive – Not Replicated Replicate of Archive A1

Archive B1 Archive A1
Disk Volume(s) Buffer P2a Disk Volume(s) Buffer P1a

Pool 2a Pool 1a
Disk Volume(s) Buffer P2b Pool 2b Disk Volume(s) Buffer P1b Pool 1b
Key Store Key Store
Encryption Certificates Encryption Certificates
System Keys System Keys
Timestamp Certificates Timestamp Certificates
Storage Systems Storage Systems
Figure 20-1: Remote Standby scenario
In a remote standby scenario, all new and modified documents are asynchronously
transmitted from the original archive to the replicated archive of a known server.
This is done by the Synchronize_Replicates job on the Remote Standby Server.
The job physically copies the data on the storage media between these two servers.

AR100500-01-ACN-EN-04
Chapter 20 Configuring remote standby scenarios
Therefore, the Remote Standby Server provides more data security than the local
backup of media.
With a Remote Standby Server, not the entire server is replicated but just the logical
archives. Further, it is possible to use two servers crosswise, that is one Archive
Server is the Remote Standby Server of the other and vice versa.
The Remote Standby Server has the following advantages:

• The availability of the archive increases, since the Remote Standby Server is
accessed when the original server is not available.
• Backup media are located in greater distance from the original Archive Server,
providing security in case of fire, earthquake and other catastrophes.
There are also disadvantages:

• Only read access to the documents is possible; modifications to and archiving of
documents is not possible directly.
• A document may have been stored or modified on the original server, but not yet
transmitted to the Remote Standby Server.
• No minimization of downtime with regard to archiving new documents, since
only read access to the Remote Standby Server is possible.
Note: The usage of a Remote Standby Server depends on your backup

strategy. Contact OpenText Global Technical Services for the development of a
backup strategy that fits your needs.
20.1 Configuring original Archive Server and Remote

Standby Server
You have to perform several configuration steps on the original Archive Server and
on the Remote Standby Server to replicate data.
20.1.1 Configuring the original Archive Server

The original server must be configured such that the Remote Standby Server is
allowed to replicate the original server.
To configure the original server:
1. Sign in to the original Archive Server.
2. Add the Remote Standby Server as known server (see “Adding known servers”
on page 215). Ensure that Remote server is allowed to replicate from this host
is set.
3. Click OK. The Remote Standby Server is listed in Known Servers in the
Environment object of the console tree.

AR100500-01-ACN-EN-04
20.1. Configuring original Archive Server and Remote Standby Server
20.1.2 Configuring the Remote Standby Server

When the known server is added, the Remote Standby Server must be configured.
You have to configure the logical archives and the buffers that are to be replicated.
To replicate the data from the original server, matching devices and volumes must
be configured on the Remote Standby Server first.
Important
The replicate volumes must have the same names as the original volumes.
The replicate volumes need at least the same amount of disk space.
To configure the replicated archives:
1. Sign in to the Remote Standby Server.
2. Add the original server as known server (see “Adding known servers”
on page 215).
Unless the two servers mutually replicate each others’ archives, you must not
enable Remote server is allowed to replicate from this host.
3. Click Synchronize Servers in the action pane to synchronize settings between

known servers.
4. Select External Archives in the Archives object in the console tree. All logical
archives of the known servers are listed.
5. Select the archive which should be replicated in the result pane and click
Replicate in the action pane.
The archive is moved to Replicated Archives. A message is shown, that the
pools of the replicated archive must be configured (see “Backups on a Remote
Standby Server” on page 223).
6. Select the replicated archive, and then select the Server Priorities tab in the
result pane.
7. Click Change Server Priorities in the action pane. A wizard to assign the
sequence of server priorities opens (see “Changing the server priorities”
on page 139).
8. Assign the server priorities. The order should be: first the Remote Standby
Server, then the original server.
9. Select the Replicated Archives object in the console tree, and then click
Synchronize Servers in the action pane.
Correspondingly, set the server priorities of the archive to be replicated.
To set the server priorities on the original Archive Server:
1. Sign in to the original Archive Server.
2. In the action pane, click Synchronize Servers.

AR100500-01-ACN-EN-04
3. Select the archive to be replicated, and then select the Server Priorities tab in
the result pane.
4. Click Change Server Priorities in the action pane.
5. Assign the server priorities. The order should be: first the original server, then
the Remote Standby Server.
Configuring replicated pools and buffers

To configure pools of replicated archives:
1. On the Remote Standby Server, select the replicated archive, and then select the
Pools tab in the result pane.
2. Select the first pool in the top area. In the bottom area, the assigned volumes are
listed. Volumes that are not configured are labeled with the missing type.
3. Depending on the type of the volume, do one of the following:

Disk volumes
a. Select the first missing volume and click Attach or Create Missing Volume
in the action pane.
b. Enter Mount Path and Device Type and click OK. Repeat this for every
missing volume.
ISO volumes
ISO volumes will be replicated by the asynchronously running
Synchronize_Replicates job (see also “ISO volumes” on page 223).
a. Select Replicated Archives in the console tree and select the designated
archive.
b. Select a replicated pool in the console tree and click Properties in the action
pane.
c. Select the backup jukebox. For virtual jukeboxes with HD-WO media,
OpenText strongly recommends configuring the original and backup
jukeboxes on physically different storage systems.
d. Configure the Synchronize_Replicates job according to your needs (see
“Setting the start mode and scheduling of jobs” on page 148).
4. Schedule the replication job Synchronize_Replicates (see “Setting the start

mode and scheduling of jobs” on page 148).
Note: On the original Archive Server, the backup jobs can be disabled if
no additional backups should be written.
To configure replicated disk buffers:

AR100500-01-ACN-EN-04
20.2. Backups on a Remote Standby Server
2. Select the known server which disk buffer needs to be replicated in the top area
of the result pane. The assigned disk buffers are listen in the bottom area of the
result pane.
3. Select the disk buffer which needs to be replicated and click Replicate in the
action pane.
4. Enter the name of the disk buffer and click Next.
A message is shown, that the disk buffer gets replicated and a volume has to be
attached to this disk buffer.
6. Select the Replicated Disk Buffers tab in the result pane. The replicated buffers
are listed in the top area.
7. Select the replicated buffer in the top area. In the bottom area, the assigned
volumes are listed. Volumes which are not configured are labeled with the
missing type.
8. Select the first missing volume and click Attach or Create Missing Volume in
the action pane.
9. Enter Mount Path and click OK. Repeat this for every missing volume.
Related Topics
20.2 Backups on a Remote Standby Server

The backup procedure depends on the used media type.
Note: For backup and recovery of GS, ISO (HD-WO), and FS volumes, contact
OpenText Customer Support.
20.2.1 ISO volumes

The backup for ISO volumes on a Remote Standby Server – for ISO volumes on
storage systems – is done asynchronously by the Synchronize_Replicates job.
To backup ISO volumes:

2. Select Replicated Archives in the console tree and select the designated archive.
3. Select a replicated pool in the console tree and click Properties in the action
pane.
4. Select the Backup Jukebox (see “Write at once (ISO) pool settings”
on page 120).

AR100500-01-ACN-EN-04
5. Configure the Synchronize_Replicates job according to your needs (see

The Synchronize_Replicates job now backups the data of the original ISO
pool according to the scheduling.
Note: If problems occur, have a look at the protocol of the

Synchronize_Replicates job (see “Checking the execution of jobs”
on page 149).
20.2.2 Generalized Storage (GS) volumes with Vendor

Interface (VI)
The backup for GS volumes with vendor interface on a Remote Standby Server – for
GS single file volumes on storage systems – is done asynchronously by the
Synchronize_Replicates job.
To backup GS single file volumes:
2. Add a new EMC Centera or Hitachi HCP GS device as single file (VI) storage
device with a separate internal storage pool.
Note: For details, see the storage installation guides in the OpenText
Knowledge Center.
EMC Centera GS devices:
• See “EMC Centera (single file)” on page 82.

• See the Archive Server Knowledge Base in the Knowledge Center for
restrictions.
3. Select Replicated Archives in the console tree and select the designated archive.
4. Select a replicated pool in the console tree and click Properties in the action
pane.
5. Select the newly created GS single file device and confirm with OK.
6. Configure the Synchronize_Replicates job according to your needs (see

The Synchronize_Replicates job now backups the data of the original ISO
pool according to the scheduling.
Note: If problems occur, have a look at the protocol of the

Synchronize_Replicates job (see “Checking the execution of jobs”
on page 149).

AR100500-01-ACN-EN-04
Chapter 21
Configuring Archive Cache Server
Archive Cache Server distinguishes between read and write requests. In case of read
requests, the Archive Cache Server tries to satisfy the request from its local cache
instead of transferring the document via slow WAN from an Archive Server. If not
found in local cache, the document will be cached for later access.
In case of write requests, Archive Cache Server distinguishes between two

operational modes. This mode can be set per logical archive.
write through
In this mode, all documents are transferred to the Archive Server, but on the fly,
they are also cached in the local store to speed up later read requests.
write back
In this mode, all the documents are cached in the local store of the Archive
Cache Server. Archive Server just will be informed that there are new
documents residing on the Archive Cache Server. The configured Copy_Back job
will later transfer these documents to the Archive Server.
Typical scenario for using the “Write back” mode

You have a quite slow network connection between an Archive Cache Server and an
Archive Server. During the day, a lot of new documents are written to the Archive
Cache Server, which should not additionally burden the slow network connection.
Archive Server is just informed about new documents. During the night, the WAN is
much faster, because of reduced network traffic. The documents just stored by
Archive Cache Server on the Archive Cache Server can now be safely transferred to
the Archive Server in an efficient way. This can be achieved by appropriate
scheduling of the Copy_Back job. If this scenario does not exactly fit your
environment or your demands – for example, because you have full load round the
clock or you have high security demands – it is recommended to use “write
through” mode (see also “Restrictions using Archive Cache Server” on page 227).
The following figure shows a simple outlay of a scenario with only one Archive
Server and one Archive Cache Server. In real environments, one Archive Cache
Server can support more than one Archive Server and one Archive Server can have
more than one Archive Cache Server attached. Clients can also access the Archive
Server directly without using Archive Cache Server. This depends on the
configuration; see “Configuring access using an Archive Cache Server” on page 234.

AR100500-01-ACN-EN-04
Chapter 21 Configuring Archive Cache Server
Remote site
Clients
Archive Cache Server

Administration
Document
transfer
WAN
Administrative calls
Archive Server
Archive and Storage Administration
Document Service
Figure 21-1: Archive Cache Server scenario
As the diagram hints, the Administration Server is central to the coordination of the
cache scenario at large. Administration Client is used to configure the settings of
each Archive Cache Server and the associated clients and archives.
Important
To ensure accurate retention handling, the clock of the Archive Cache Server
must be synchronized with the clock of the Archive Server.

AR100500-01-ACN-EN-04
21.1. Restrictions using Archive Cache Server
21.1 Restrictions using Archive Cache Server

Archive Cache Server ideally is transparent to any client, which means it must
behave the same way as Archive Server. Especially for “write back” documents, this
paradigm cannot be followed completely. The following table shows all known
restrictions.
Table 21-1: Restrictions using Archive Cache Server
Topic Description
Restrictions valid for “write back”
MTA documents MTA documents can be stored but the single document in an
MTA document cannot be accessed until they are transferred
to an Archive Cache Server.
Attribute Search Attribute Search in print lists is not available until the content
is transferred from an Archive Cache Server to the related
Archive Server.
VerifySig The signature verification is processed for write back items but
the signer chain is not verified (no timestamp certificates are
available on related Archive Server).
Deletion behavior To avoid problems with deletion, do not use the following
archive settings:
• Original Archive > Properties > Security > Document
Deletion > Deletion is ignored (see also “Configuring the
archive security settings” on page 112)
• Archive Server > Modify Operation Mode > Documents
cannot be deleted, no errors are returned (see also “Setting
the operation mode of Archive Server” on page 350
Retention behavior As long as write back documents are just stored on the Archive
Cache Server, there is no protection based on the document
retention. After transferring documents to a related Archive
Server, the retention behavior gets effective. If there is no client
retention, the retention setting of the logical archive is used.
Audit There are no audit trails for documents as long as they are not
transferred to the related Archive Server.
Update Document This call is not supported for write back documents.
migrateDocument Results in an error if just the pool name or storage tier is
changed.
Important
Target archives must be enabled to be cached by this
Archive Cache Server, otherwise update calls will fail.

AR100500-01-ACN-EN-04
Topic Description
Versioning of components As long as components are just stored on the Archive Cache
Server, there is no version control! This means, after a
successful modification, the modified component is available,
but the version number will not be increment. A subsequent
info call still will deliver back version “1” of the just modified
component, until the component has been transferred to the
related Archive Server.
Transfer and commit Write-back documents are transferred to the related Archive
Server in a two-phase process:
Phase 1: document is requested

Phase 2: commit to previously requested document is sent
To avoid any inconsistency, any “update” client request that

comes in between phase 1 and 2 cannot be satisfied and an
HTTP_CONFLICT error is returned to the client.
Maintenance mode Documents cannot be accessed during maintenance mode.
Disabled archives Documents cannot be modified if the logical archive is
disabled.
Document protection Document protection cannot be set in write-back mode. If
document protection is set while creating the document, the
document protection will not be stored nor evaluated on the
Archive Cache Server.
Restrictions valid for “write through” and “write back”
Component name In write back mode, an error occurs if you try to create a
mapping component matching one of these names:
(in scenarios using • <n>.pg
Enterprise Library) • im
To support all component names, do the following:

1. In the <OT config>\Archive Cache Server\config\
setup directory, open the ACS.Setup file with an editor.
2. Delete the value of the ILLEGALCOMPONENTNAMES
variable (default: [0-9]+\\.pg|im).
3. Restart the application server.
Timestamp verification A mandatory signature check before reading can be configured
for each archive. This setting is ignored for cached documents.
Encryption, Compression, Content on the Archive Cache Server gets neither encrypted
Single Instance, Blobs nor compressed, regardless of the archive setting.
Destroy Documents are not destroyed on the Archive Cache Server,
regardless of the archive setting.

AR100500-01-ACN-EN-04
21.2. Configuring an Archive Cache Server in the environment
21.2 Configuring an Archive Cache Server in the

environment
21.2.1 Adding an Archive Cache Server to the environment
The first step for using an Archive Cache Server is to make it known to an Archive
Server using Administration Client. To do this, you have to add an Archive Cache
Server to the environment of the logical archive.
To add an Archive Cache Server:
1. Select Cache Servers in the Environment object in the console tree.
2. Click New Cache Server in the action pane.
3. Enter the Archive Cache Server parameters:
Cache server name

Unique name of the Archive Cache Server. This name is used throughout
the configuration and administration to refer to the Archive Cache Server.
Description
Brief, self-explanatory description of the Archive Cache Server.
Host (client)
Physical host name of the Archive Cache Server, used by a client when
accessing Archive Cache Server.
Note: Instead of the host name, you can also use IPv4 addresses.
However, IPv6 addresses are not supported.
'Copy back' job

Displays the associated Copy_Back job. This entry cannot be changed.
Host (archive server)

Physical host name of the Archive Cache Server, used by the Archive Server
to communicate with the Archive Cache Server. This name can be different
from the host name relating to client.
Note: Instead of the host name, you can also use IPv4 addresses.
However, IPv6 addresses are not supported.
The <name to use by ACS for itself> name and the Host (archive server)
name must be identical. Otherwise, problems will arise during the
write-back scenario.
Port, Secure port, Context path

Specifies the port, the secure port and the context path, that enables the
client to create URLs of the designated Archive Cache Server.
Structure of the URLs:

AR100500-01-ACN-EN-04
http://<host>:<port><context>?...
https://<host>:<secure port><context>?...
Example: <host> = csrv03100

<port> = 8080
<secure port> = 8090
<context> = /archive
http://csrv03100:8080/archive?...
https://csrv03100:8090/archive?...
4. Click Finish.
5. Configure the Copy_Back job. See also “Configuring jobs and checking job
protocol“ on page 141 and “Other jobs” on page 144.
Note: Be aware that this job is disabled by default. If you intend to use the
"write back" mode, enable this job.
6. Click Finish. The new Archive Cache Server is added to the environment.
Next step:
• “Configuring archive access using an Archive Cache Server” on page 235.
21.2.2 Modifying an Archive Cache Server

If required, Archive Cache Server parameters can be modified.
Note: If <name to use by ACS for itself> and Host (archive server) are different
from each other, it is required to rename one or the other to make them
identical. To rename the Archive Cache Server, change the value of the
MY_HOST_NAME variable in the ACS.Setup file to <name to use by ACS for
itself>.
Otherwise, problems will arise during the write-back scenario.
Caution
Do not modify the host name while writing back.
The following step ensures that pending write-back documents are

transferred to the related Archive Server. If this step fails, the Archive
Cache Server must not be deleted before the problem is solved.
To transfer pending write-back documents:
• Select the Copy_Back job that is assigned to the Archive Cache Server and click
Start in the action pane. The cached documents are transferred to the related
Archive Server. A window to watch the transfer status opens.

AR100500-01-ACN-EN-04
To modify an Archive Cache Server:
2. Select the Archive Cache Server you want to modify and click Properties in the
action pane.
3. Modify the Archive Cache Server parameters. See also “Adding an Archive
Cache Server to the environment” on page 229.
4. Click Finish.
21.2.3 Deleting an Archive Cache Server

An Archive Cache Server can only be deleted if it is not attached to any logical
archive. If so, you first have to detach the Archive Cache Server from logical
archives. See “Deleting an assigned Archive Cache Server” on page 238.
To delete an Archive Cache Server:
1. Detach the Archive Cache Server from all logical archives it is attached to. See
“Deleting an assigned Archive Cache Server” on page 238.
3. Select the Copy_Back job which is assigned to the Archive Cache Server and
click Start in the action pane. The cached documents are transferred to the
related Archive Server. A window to watch the transfer status opens.
Caution
This step ensures that pending write-back documents are transferred
to the related Archive Server. If this step fails, the Archive Cache
Server must not be deleted before the problem is solved.
5. Select the Archive Cache Server you want to delete.
6. Click Delete in the action pane. A warning message opens.
7. Click Yes to confirm. The Archive Cache Server is deleted from the
environment.

AR100500-01-ACN-EN-04
21.2.4 Configuring volumes of an Archive Cache Server

The cache volumes, write-through volume and write-back volume of an Archive
Cache Server are to be added or re-sized if the underlying disk partition has been
modified, i.e. decreased or increased. New cache volumes have to be added
manually.
For further information on write-back volumes and write-through volumes, see

“Configuring Archive Cache Server“ on page 225.
Adding cache Adding a write-back volume or write-through volumes involves the same steps.
volumes There can only be one write-back volume but several write-through volumes.
For each new cache volume, two new properties are required:
• Path where the volume is located
• Volume size
To add cache volumes:
1. In the <OT config>\Archive Cache Server\config\setup directory, open the

ACS.Setup file with an editor.
2. To add a write-back volume, do the following:
a. Volume path - Add the volume path name of the new volume to the WBVOL
variable. Make sure this path already exists.
b. Volume size - Add the volume size of the new volume (in MB) to the
WBSIZE variable.
3. To add a write-through volume, do the following:
a. Volume path - Add the volume path name of the new volume to the
VOL<n> variable, where <n> is the number of the first unassigned volume.
Make sure this path already exists.
b. Volume size - Add the volume size of the new volume (in MB) to the
SIZE<n> variable, where <n> is the number of the first unassigned volume.
4. Save the ACS.Setup file.
Note: The new volume is not yet available. See “Activating the
modification” on page 233.
Resizing cache You can change the size of existing cache volumes if necessary.
volumes
Caution
Danger of loss Make sure not to remove the write-back volume accidentally or to change
of data the path of the write-back volume.
In case of questions, contact OpenText Customer Support.

AR100500-01-ACN-EN-04
To resize volumes:
1. In the <OT config>\Archive Cache Server\config\setup directory, open the

2. To resize the write-back volume, change the volume size of the volume (in MB)
in the WBSIZE variable.
3. To resize a write-through volume, change the volume size of the volume (in
MB) in the SIZE<n> variable, where <n> is the number of the volume to be
changed.
4. Save the ACS.Setup file.
Note: The new volume size is not yet valid. See “Activating the
modification” on page 233.
Activating the modification

Modifications of the volume size or adding new volumes must be activated before
they can be used. Activating includes restarting Archive Cache Server and checking
the volume size using the cscommand command.
Note: Running cscommand requires that a JDK or JRE is included in the PATH
environment variable.
To activate the modification:
1. Restart the application server.
2. Open a terminal window and navigate to the <OT config>\Archive Cache

Server\bin directory.

cscommand -c listVolumes -u <user name> -p <user password>
Enter the user and user password of the corresponding Archive Server.
The result is a list of all volumes, split into data volume and volume reserved
for internal attributes per volume.
Note: Resized volumes can be viewed only after restart of the server.

AR100500-01-ACN-EN-04
21.2.5 Changing database files

The disk partition for the Archive Cache Server database files can turn out to be too
small. In this case, it is possible to change the location of the Archive Cache Server
database files.
To change database files:
1. Provide the new database.

Provide a new, sufficiently large disk partition for the database files.
2. Determine the current location of the Archive Cache Server database files:
In the <OT config>\Archive Cache Server\config\setup directory, open the
The current location is stored in the DERBY variable.
3. Stop the application server.
4. Copy all data from the current database location (see step 2) to the new location
(provided in step 1). The file permissions of the copy and the original must
match.
5. Configure the Archive Cache Server to use the new database location:
In the ACS.Setup file, change the value of the DERBY variable to the new
database directory name.
6. Start the application server.
21.3 Configuring access using an Archive Cache

Server
21.3.1 Subnet assignment of an Archive Cache Server
For each logical archive it is possible to configure one or more Archive Cache
Servers to speed up processing in case a slow WAN is between clients and Archive
Servers. The following steps are necessary to assign an Archive Cache Server to a
group (subnet) of clients per logical archive. This allows assigning different Archive
Cache Servers to different groups of clients. A client not contained in any of these
subnets will access Archive Server directly.

AR100500-01-ACN-EN-04
21.3. Configuring access using an Archive Cache Server
Subnet 123.144.130.0 (no caching)

Client 1 (123.144.130.21)
Client n (123.144.130.m)
Subnet 123.235.155.0
Client 1 (123.235.155.46)
Subnet 123.235.150.0 Subnet 123.240.144.0

Client 1 (123.235.150.21) Client 1 (123.240.144.12)
Client 2 (123.235.150.28) Client 2 (123.240.144.25)
Client n (123.235.150.m) Client n (123.240.144.m)
Archive Cache Server ACS 1 Archive Cache Server ACS 2

Subnet mask: 255.255.0.0 Subnet mask: 255.255.0.0
Subnet address: 123.235.0.0 Subnet address: 123.240.0.0
Archive Server
Archive 1 Archive 2 Archive 3
Figure 21-2: Example of subnet assignment of Archive Cache Servers
Important
The subnet configuration will only be evaluated by clients using the
OpenText Archive Server API.
Note: Archive Cache Server keeps track of any relevant changes to the archive
settings and is synchronized automatically.
21.3.2 Configuring archive access using an Archive Cache

Server
Note: To configure the access to a logical archive via an Archive Cache Server,
the Archive Cache Server must first be added to the environment. See “Adding
an Archive Cache Server to the environment” on page 229.
To configure archive access:

2. Select the logical archive to which the Archive Cache Server should get access.
3. Select the Cache Servers tab in the top area of the result pane and click Assign
Cache Server.

AR100500-01-ACN-EN-04
4. Enter settings:
Cache server
The name of the Archive Cache Server assigned to this archive.
Caching enabled
If caching is enabled, one of the following modes can be set.
Write through
The Archive Cache Server will operate in “write through” mode for this
logical archive.
Write back
The Archive Cache Server will operate in “write back” mode for this
logical archive.
Note: If caching is disabled, the Archive Cache Server does not cache any
new documents for this logical archive. Instead, it acts as a proxy and
forwards all requests to Archive Server. Outstanding write-back
documents can still be retrieved.
5. Click Next and enter settings for subnet address and subnet mask/length.
The combination of subnet mask and subnet address specifies a subnet. Clients
residing in this subnet will use the selected Archive Cache Server. Typically, the
Archive Cache Server resides in the same subnet. It is possible to add more than
one subnet definition to an Archive Cache Server; see also “Subnet assignment
of an Archive Cache Server” on page 234.
Several subnets
If a client belongs to more than one subnet, it will use the Archive Cache
Server that is assigned to the best matching subnet.
Subnet address
Specifies the address for the subnet in which a Archive Cache Server is
located. At least the first part of the address (for example, NNN.0.0.0 in case
of IPv4) must be specified. A gateway must be established for each subnet.
IPv6
If you use IPv6, do notenclose the IPv6 address with square brackets.
Subnet mask / Length

Specifies the sections of the IP address that are evaluated. You can restrict
the evaluation to individual bits of the subnet address.
IPv4
Enter a subnet mask, for example 255.255.255.0.
IPv6
Enter the address length, i.e. the number of relevant bits, for example
64.

AR100500-01-ACN-EN-04
21.3. Configuring access using an Archive Cache Server
6. Click Finish to complete.
Modifying To modify the settings of an Archive Cache Server, select it in the top area of the
cache server result pane and click Properties in the action pane. Proceed in the same way as
settings
when configuring an Archive Cache Server.
21.3.3 Configuring access for write-back scenario

To use the write-back scenario you must configure an Archive Cache Server
certificate and an Archive Server certificate.
Further For details on working with certificates, see “Certificates” on page 169.
information
To configure the certificates for write-back:
1. On the Archive Server enable the Archive Cache Server certificate named
CS_ACS_<archive_cache_server_hostname>.
Important
The certificate must be enabled regardless of the security settings of the
archive.
2. On the Archive Server import and enable the Archive Server certificate as global
authentication certificate unless this has already been done during the Archive
Server configuration.
Important
The certificate must be imported and enabled regardless of the security
settings of the archive.
The Archive Server certificate is located here:

<OT config AS>/config/setup/as.pem
21.3.4 Adding and modifying subnet definitions of an Archive

Cache Server
It is possible to configure more than one subnet definition for each Archive Cache
Server.
To add subnet definitions for an Archive Cache Server:
2. Select the logical archive which the Archive Cache Server is assigned to.
3. Select the Cache Servers tab in the top area of the result pane and select the
Archive Cache Server. In the bottom area, the subnet definitions are listed.
4. Click New Subnet Definition in the action pane and enter settings for subnet
mask and subnet address. See also “Configuring archive access using an
Archive Cache Server” on page 235

AR100500-01-ACN-EN-04
5. Click Finish.
To modify the subnet definitions of an Archive Cache Server:
2. Select the logical archive which the Archive Cache Server assigned to.
Archive Cache Server. In the bottom area, the subnet definitions are listed.
4. Select the subnet definitions in the bottom area of the result pane and click
Properties.
Modify the settings for subnet mask and subnet address. See also “Configuring
archive access using an Archive Cache Server” on page 235
5. Click Finish.
21.3.5 Deleting an assigned Archive Cache Server
Note: The steps 3 to 6 are only necessary if you use an Archive Cache Server
that operates in “write-back” mode.
To delete an Archive Cache Server:
2. Select the logical archive to which the Archive Cache Server is assigned.
Archive Cache Server you want to delete.
5. Deselect enabled to stop caching. See also “Configuring archive access using an
Archive Cache Server” on page 235.
7. Select the Copy_Back job which is assigned to the Archive Cache Server you
want to delete and click Start. The cached documents are transferred to the
related Archive Server. A window to watch the transfer status opens.
8. Select the Archive Cache Server you want to delete again and click Delete in the
action pane.
9. Click Yes to confirm. The Archive Cache Server is no longer assigned to the
logical archive.

AR100500-01-ACN-EN-04
Chapter 22
Scenario reports
The Reports node is used to generate reports comprising information on certain well
defined scenarios. Reports are based on scripts describing a specific scenario. A
scenario is a kind of template (or order form) describing the content and the layout
of a report. Running the script generates a report, an output file in html format.
Multiple reports can be generated per scenario. Currently, the Reports node is used
to generate reports comprising details of archives and pools currently available on
the Archive Server. You can use a report when asking for support. The information
provided by reports can be evaluated by the service personnel.
The Reports node comprises the Reports tab and the Scenarios tab.
To generate a report:
1. Select Reports in the System object in the console tree.
2. Select the Scenarios tab in the top area of the result pane.
3. Select the scenario for which you want to generate a report.

Currently only the reportArchive scenario is available.
4. Select the Run Scenario... action.

The resulting report is stored as HTML file and can be displayed in a standard
browser; see the “To display a report:“ on page 239 procedure.
Information The following information per report is displayed in the result pane:
about a report
Name Name of the report. The name is predefined, it is derived from the respective
scenario name extended by a serial number.
Date Date and time when the report was generated.
Format YYYY-MM-DD HH:MM:SS.
Size Size of the HTML file displayed in kB.
Deleting reports To delete a report, select it and click Delete in the action pane. Confirm the
displayed message with OK.
To display a report:
1. Select Reports in the System object in the console tree.
2. Select the Reports tab in the top area of the result pane.
3. Select the Refresh action.
4. Select a report in the Reports tab.

AR100500-01-ACN-EN-04
Chapter 22 Scenario reports
5. Select the Open Report... action.

The result HTML file can be displayed using your standard browser.
Information of a The following table lists the available pre-configured scenarios:

report
report Generates a report comprising details for all archives (Original Archives,
Archive Replicated Archives and External Archives) currently on the Archive Server.
These details include:

• Security
• Settings
• Retention
• Timestamps
• Pools, if defined

AR100500-01-ACN-EN-04
Chapter 23
Setting configuration variables
Within this object, you can set the configuration variables for:
• Archive Server
• Document Pipeline
• Email Cloud Archive (if OpenText Archive Center is installed)
• Monitoring Server
For a complete list including short descriptions of all configuration variables, see
“Configuration parameter reference” on page 357.
23.1 Setting and modifying the value of configuration

variables
You can set and modify configuration variables, i.e. change their values.
Note: Variables marked as “read-only” cannot be modified. For example,

Database System (AS.DBS.DBSYSTEM) and other variables set during
installation cannot be changed afterwards.
To set or modify configuration variables:
1. Select the Configuration object in the console tree.

2. Select one of the entries (Archive Server, Monitor Server or Document
Pipeline) of the Configuration object.
A list of related components is displayed in the result pane.
3. Select a component.
A list of related variables is displayed below the list of components.
4. Select a variable using double-click or using the Properties action in the action
pane.
The Configuration Variable Properties window opens, displaying two tabs:
General tab
Displays the name, the current value, a short description and information
on whether a server restart is required upon modifying this variable
Advanced tab
Displays the full qualified internal name of the variable
5. Select the General tab and modify the current value.

AR100500-01-ACN-EN-04
Chapter 23 Setting configuration variables
Working with lists

Some variables can hold more than one value. In this case, you can add
values to a list; see below.
a. Enter the value into the Variable field.

b. Click . The value is added to the list below.
c. Repeat the previous steps for each entry to be added to the list.
d. To delete a value from the list, select it and click .
6. Click OK .
Resetting to To reset a value to its default value, select it and click Reset to Default in the action
default value pane. This action is sensitive only if the value is currently not the default value.
Confirm confirmation dialog with OK.
Retrieving In the list of configuration variables, undefined values are marked with *** Value
unspecified not defined ***. In the properties window, undefined values are marked with an
values
icon:
23.2 Searching configuration variables

A search function allows searching for configuration variables by
• their name,
• their internal name (former dot notation), or
• by the value of a configuration variable.
Example: Search for port and you will get results with port as name, as internal name and,
if set, as value.
The search function starts at configuration level, searching the subdirectories

(Archive Server, Archive Monitoring Server and Document Pipeline).
To search for configuration variables:
1. Select the Configuration object.

2. Enter the variable name to be searched for in the search field in the result pane
and click on the search icon, located to the right of the search field (see figure
below).
You can also use the internal name as search string, if you remove the prefix of
the internal variable name.
Example: For the AS.ADMS.ADMS_ALRT_EXPIRE variable, enter ADMS_ALRT_EXPIRE
The search result (name = Duration after alerts expire) is displayed.
Example: If you enter port, the result, among others, can be the following:

AR100500-01-ACN-EN-04
23.3. Customizing configuration view
• Port of the Archive Server – AS_HTTP__PORT

• Server Port for RPC requests – SERVER_PORT
Note: Click on the arrow icon to the right of the search icon (see figure
below) and select Search All Configuration Variables to display all
configuration variables.
23.3 Customizing configuration view

You can customize the list of configuration variables. You can either list all
configuration variables – including the hidden variables – or just the set of standard
variables.
To customize the configuration view:
1. Select the Configuration object (or one of the objects assigned to it).
2. Click Customize Configuration View... in the action pane.

The Customize Configuration View window opens.
3. Select one of the following options:
Show standard variables (recommended)

Shows the standard variables only.
Show all (including hidden variables)

Shows all variables, including hidden variables.

AR100500-01-ACN-EN-04
Part 4
Maintenance
Chapter 24
Handling storage volumes
This chapter describes tasks that are relevant for storage systems: export and import,
consistency checks. If you archive documents with retention periods, you also have
to check for correct deletion of the documents and clear volumes whose documents
are deleted completely.
24.1 When the retention period has expired

If documents have been archived with retention periods, the leading application can
delete these documents when the retention period has expired. The deletion of
documents and resulting empty volumes depends on the pool type and storage
medium. For general information on retention, see “Retention” on page 103. In this
section, you find the details of deletion behavior and the tasks to keep your archive
system well organized.
Document When the leading application sends the delete request for a document, the archive
deletion system works as follows:
Single files (from HDSK, FS, VI pools)

1. Archive Server deletes the index information of the document from the
archive database. The document cannot be retrieved any longer, the
document is logically deleted.[1]
2. Archive Server propagates the delete request to the storage system.
3. The storage system deletes the document physically and the client gets a
success message. Not all storage systems release the free space after deletion
for new documents (see documentation for your storage system). If deletion
is not possible for technical reasons, the information with the storage
location of the document is written into the TO_BE_DELETED.log file. The
administrator can configure a notification.
Note: If the state of an FS volume (NetApp or NASFiler) is set to “write

locked”, components will not be removed from this volume when one
tries to delete them from Document Service. The case will be handled
as if the removal was prevented by the hardware (entry in
TO_BE_DELETED.log, notification, additional delete from archive
database if the request was a docDelete).
Container files (from ISO, BLOBs)

1. Archive Server deletes the index information of the document from the
archive database. The document cannot be retrieved any longer.
[1] Deletion of components works differently: If the storage system cannot delete a component physically,
the component remains, it is not deleted logically.

AR100500-01-ACN-EN-04
Chapter 24 Handling storage volumes
2. The delete request is not propagated to the storage system and the content
remains in the storage. Only logically empty volumes can be removed in a
separate step.
Delete empty If documents with retention periods are stored in container files, the container
partitions volume gets the retention period of the document with the longest retention. The
retention period of the volume is propagated to the storage subsystem if possible.
The volume – and the content of all its documents – can be deleted only if all
documents are deleted from the archive database. The volume is purged by the
Delete_Empty_Volumes job. It checks for logically empty volumes meeting the
conditions defined in Configuration (see “Searching configuration variables”
on page 242):
Delete volumes which have not been modified since days variable
(internal name: ADMS_DEL_VOL_NOT_MODIFIED_SINCE_DAYS)
Delete volumes which are more than percent full variable
(internal name: ADMS_DEL_VOL_AT_LEAST_FULL)
and deletes these volumes automatically. You can schedule the job and run it
automatically, or use the List Empty Volumes/Images utility to display the empty
volumes first and then start the deletion job manually (see “Checking for Empty
Volumes and Deleting Them Manually” on page 249).
Important
To ensure correct deletion, you must synchronize the clocks of the Archive
Server and the storage subsystem, including the devices for replication.
Summary The following table provides an overview of the deletion behavior:
Storage Pool type Delete from Delete content physically Destroy

mode archive DB content
Single file HDSK x x x (Destroy
storage unrecoverable)
FS and VI x x —
Container ISO on x Delete volume, when the last —
file storage storage document is deleted:
system Delete_Empty_Volumes
job
Notes
• Not all storage systems release the space of the deleted volumes (see
documentation for your storage system).
• Blobs are handled like container file archiving.

AR100500-01-ACN-EN-04
24.1. When the retention period has expired
24.1.1 Checking for Empty Volumes and Deleting Them

Manually
If you want to check for empty volumes before you delete them, you use the List
Empty Volumes/Images utility. It displays a list of volumes that are logically empty.
To check for empty volumes:
1. Select Original Archives in theArchives object in the console tree.
2. Click List Empty Volumes in the action pane. A window to start the utility
opens.
3. Enter settings.
Not modified since “xx” days

Number of days since the last modification. The parameter prevents that the
volume or image can be deleted very soon after the last document is
deleted.
More than “xx” percent full

Only relevant for non-finalized volumes. The parameter ensures that the
volume is filled with data at the given percentage (but logically, it is empty).
4. Click Run and check the resulting list.
5. To delete volumes, start the Delete_Empty_Volumes job manually.

Before you start the job, check the settings which specify the volumes that
should be deleted. They are configured in Configuration (see “Searching
configuration variables” on page 242):
Delete volumes which have not been modified since days variable
(internal name: ADMS_DEL_VOL_NOT_MODIFIED_SINCE_DAYS)
Delete volumes which are more than percent full variable
(internal name: ADMS_DEL_VOL_AT_LEAST_FULL)
and avoid that new, empty volumes can be deleted.
Select Jobs in the System object in the console tree.
6. Select the Delete_Empty_Volumes job and click Start in the action pane.

AR100500-01-ACN-EN-04
24.1.2 Deleting Empty Volumes Automatically

If you want to delete empty volumes automatically, proceed as follows:
To delete empty volumes automatically:
• Select Jobs in the System object in the console tree.

Schedule and enable the Delete_Empty_Volumes job; see also “Creating and
modifying jobs” on page 147 and “Enabling and disabling jobs” on page 146.
24.2 Exporting volumes

A volume can be exported when the stored documents are no longer accessed. Use
export, if
• the volume is defective or

• the volume contains data that is no longer needed.
During export, the entries about documents and their components on the volume
are deleted from the archive database. The volume gets the internal status exported
and is treated as nonexistent. After that, you remove the ISO medium together with
its local backups from the virtual jukebox. The database entries can be restored by
importing the volume.
Important
• Do not use the Export utility for volumes belonging to archives that are
configured for single instance archiving (SIA). A SIA reference to a
document may be created long after the document itself has been stored;
the reference is stored on a newer medium than the document. SIA
documents can be exported only when all references are outdated but the
Export utility does not analyze references to the documents.
• Volumes containing at least one document with non expired retention are
not exported.
To export volumes:
1. Select Utilities in the System object in the console tree. All available utilities are
2. Select the Export Volumes utility.
3. Click Run in the action pane.
4. Enter the export parameters.
Volume name(s)
Name of the volumes(s) to be exported. You can use wildcards to export
multiple volumes at the same time.

AR100500-01-ACN-EN-04
24.3. Importing volumes
Export from database

Enable this option when you export a defective volume. It causes the
database to be searched for entries for this volume, and the entries relating
to the contents of the volume are deleted. The volume itself is not accessed.
If this option is disabled, the command searches the volume directly and
deletes the associated entries from the database. Intact volumes that are no
longer needed are exported in this way. The volume must be in the jukebox.
5. Click Run. A protocol window shows the progress and the result of the export.
The export process can take some time.
Note: Volumes on storage systems can be deleted by means of the storage

system administration if provided.
Related Topics
• “Utilities“ on page 267
• “Checking utilities protocols” on page 268
24.3 Importing volumes

When a volume is imported, the entries in the archive database are restored from the
information that is stored on the volume.
For each pool type, an import utility is provided. Import a volume, if
• it was exported by mistake,

• it is moved to another Archive Server.
Note: To import ArchiSig documents with timestamps, the ArchiSig archive

must be imported first to avoid problems.
24.3.1 Importing ISO volumes

A utility imports ISO volumes. After import, you must attach the volume to the
correct pool manually.
To import ISO volumes:
2. Select the Import ISO Volume utility in the result pane and click Run in the
action pane.
3. Enter settings:
Volume name
Name of the volume(s) to be imported.

AR100500-01-ACN-EN-04
STORM server
Name of the STORM server by which the imported volume is managed.
Backup
The volume is imported as a backup volume and entered in the list of
volumes as a backup type. Not available for ISO volumes.
Arguments
Additional arguments. Not required for normal import, only for special
tasks like moving documents to another logical archive. Contact OpenText
Customer Support.
4. Click Run.
The import process can take some time. A message box shows the progress of
the import.
6. Select the designated archive and the pool.
7. Click Attach Volume in the action pane.
8. Select the volume and define the priority.
9. Click Finish to attach the imported volume to the pool.
Related Topics

24.3.2 Importing hard-disk volumes

The utility imports hard-disk volumes for use in HDSK and FS pools. After import,
you must attach the volume to the correct pool manually.
To import hard-disk volumes:
2. Select the Import HD Volume utility in the result pane and click Run in the
action pane.
3. Enter settings:
Volume name
Name of the hard-disk volume to be imported.
Base directory
Mount path of the volume.

AR100500-01-ACN-EN-04
24.3. Importing volumes
Backup
The volume is imported as a backup volume and entered in the list of
volumes as a backup type.
Read-only
The volume is imported as a write-protected volume.
Arguments
Additional Arguments. Not required for normal import, only for special
Customer Support.
4. Click Run.
the import.
6. Select the designated archive and the FS or HDSK pool.
9. Click Finish to attach the imported volume to the pool.
Related Topics
24.3.3 Importing GS volumes for Single File (VI) pool

The utility imports GS volumes for use in Singe File (VI) pools. After import, you
attach the volume to the correct pool manually.
To import GS volumes (VI):
2. Select the Import GS Volume utility in the result pane and click Run in the
action pane.
3. Enter settings:
Volume name
Name of the hard-disk volume to be imported.
Base directory
Mount path of the volume.
Read-only
The volume is imported as a write-protected volume.

AR100500-01-ACN-EN-04
Arguments
Additional arguments. Not required for normal import, only for special
Customer Support.
4. Click Run.
the import.
6. Select the designated archive and the VI pool.
9. Click Finish to attach the imported volume to the VI pool.
Related Topics
24.4 Consistency checks for storage volumes and

documents
The OpenText Administration Client provides utilities for various checks and
comparisons:
• Consistency checks of volumes and database

• Checking and counting documents and components
• Checking volumes
You can start the utilities in the System object in the console tree. When the utility is
started, a message window shows the progress of the utility.
24.4.1 Checking database against volume

The Check Database Against Volume utility determines whether the documents
and components that are known to the database are actually stored on the volume. It
detects missing documents on the storage volume. Use the utility
• after restoring an original volume from the backup.

• if you suspect the damage of a storage medium or volume.
The volume to be checked must be online. You can only check the volume, or try to
repair inconsistencies.

AR100500-01-ACN-EN-04
24.4. Consistency checks for storage volumes and documents
To check the database against a volume:
2. Select the Check Database Against Volume utility.
4. Type the volume name and specify how inconsistencies are to be handled.
Volume
Name of the volume that is to be checked.
copy document/component from other partition
The utility attempts to find the missing component on another volume. If
the component is found, it is copied to the checked volume. If not, the
component entry is deleted from the database, i.e. the component is
exported.
export component
The database entry for the missing component on the checked volume is
deleted.
Repair, if needed
Check this box if you really want to repair the inconsistencies.
If the option is deactivated, the test is performed and the result is displayed.
Nothing is copied and no changes are made to the database.
Important
Use this repair option only if you are sure that you do not need the
missing documents any longer! You may lose references to
document components that are still stored somewhere in the
archive. If in doubt, contact OpenText Customer Support.
5. Click Run.
A protocol window shows the progress and the result of the check.
Related Topics

AR100500-01-ACN-EN-04
24.4.2 Checking volume against database

The Check Volume Against Database utility checks whether all the documents and
components on the volume are entered in the database. It detects lost document
references in database. Use the utility
• for database recovery,
• if you suspect problems with the database contents.
The volume to be checked must be online. You can only check the volume, or try to
repair inconsistencies.
To check a volume against the database:
2. Select the Check Volume Against Database utility.
4. Type the volume name and specify how documents missing in the database are
to be handled.
Volume
Name of the volume that is to be checked.
Import documents if they are not in the database

Missing document or component entries are imported into the database.
5. Click Run.
Related Topics
24.4.3 Checking a document

The Check Document utility checks if a document is correctly on the medium as
known by the database. Use it to analyze trouble with document access. You can run
just the test or have the document repaired at the same time. The medium
containing the document must be online.
To check a document:
2. Select the Check Document utility.

AR100500-01-ACN-EN-04
24.4. Consistency checks for storage volumes and documents

4. Enter the document ID, the type and select whether the document should be
repaired.
DocID
Type the document ID accordingly to the Type setting.
You can determine the string form of the document ID by searching for the
document in the application (for example, on document type and object
type) and displaying the document information in Windows Viewer or in
Java Viewer.
Type
Select the type of document ID. The ID can be entered in numerical
(Number) or string (String) form.
Repair document, if needed
Check this box if you want to repair defective documents. The utility
attempts to copy the document from another volume. If this option is
deactivated, the utility simply performs the test and displays the result.
Important
Use this repair option only if you are sure that you do not need the
missing documents any longer! You may lose references to
document components that are still stored somewhere in the
archive. If in doubt, contact OpenText Customer Support.
5. Click Run.
Related Topics
24.4.4 Counting documents and components in a volume

The Count Documents/Components utility determines the number of components
and the number of documents on the volume.
To count documents and components:
2. Select the Count Documents/Components utility.
4. Enter the name of the volume.
5. Click Run.

AR100500-01-ACN-EN-04
A protocol window shows the progress and the result of the counting.
Related Topics
24.4.5 Checking a volume

The Check Volume utility checks a volume without accessing the information in the
database. It checks whether all documents have a consistent structure, whether there
are any damaged documents on the volume, whether every document has at least
one component and whether the file ATTRIB.ATR is in order. Use it when you
suspect any problem with a storage medium. The medium must be online and is
only tested, no repair option is available.
To check a volume:
2. Select the Check Volume utility.
4. Enter the name of the volume.
5. Click Run.
Related Topics
24.5 Backup for storage systems

Data is archived on a storage system if you use one of the following pools: Single
File (FS), Single File (VI), or ISO (with media type HD-WO). The backup and
recovery scenario depends on the storage system in use. The development of this
scenario is a complex and individual task, thus contact OpenText Global Technical
Services for support, and refer to the documentation of your storage system; see the
Knowledge Center (https://knowledge.opentext.com/knowledge/llisapi.dll/open/
12331031). This chapter describes only the general aspects.
Basically, you can backup archived data by means of the storage system or by means
of the Archive Server (local backup, Remote Standby). Some scenarios can be
restricted to one of these ways. The backup medium should be the same type as the
original medium. For detailed information, see the Storage Platform Release Notes
in the Knowledge Center (https://knowledge.opentext.com/knowledge/llisapi.dll/
open/12331031).

AR100500-01-ACN-EN-04
24.5. Backup for storage systems
Backup of ISO volumes on HD-WO

These volumes are managed in virtual jukeboxes. As the storage media of the
storage system cannot be removed and stored on another place, a backup system is
required, and the backup must be written by one of the backup jobs. The pool
configuration for the backup jobs is:
Number of Partitions 1
Number of Backups 1
Backup Jukebox Must be different from Original Jukebox
Backup On for Local_Backup job

AR100500-01-ACN-EN-04
Chapter 25
Backups and recovery
The backup concept used by Archive Server ensures that documents are protected
against data loss throughout their entire path to, through, and in the Archive Server.
Batch Input Scan COLD
ArchiveLink Server API Document Pipeline
Write Through ACS Data Write Back
Archive Server
Storage Manager Document Service

Disk Buffer Cache Area
Configuration Database
Storage
Systems
Figure 25-1: Backup-relevant areas
There are several parts that have to be protected against data loss:
Volumes
All hard-disk volumes that can hold the only instance of a document must be
protected against data loss by RAID. Which volumes have to be protected you
find in the “Installation overview” chapter of the installation guides for Archive
Server.

AR100500-01-ACN-EN-04
Chapter 25 Backups and recovery
Document Pipelines
The Document Pipeline of OpenText Imaging Enterprise Scan must be protected
against data loss; for details, see Section 19.2 “Backing up the Document Pipeline
directory” in OpenText Imaging Enterprise Scan - User and Administration Guide
(CLES-UGD).
Database
The database with the configuration for logical archives, pools, jobs, relations to
other Archive Servers, and leading applications must be protected against data
loss. The process depends on the type of database you are using (see “Backing
up the database” on page 262).
Storage Manager configuration
The configuration of the Storage Manager must be saved; see “Backing up and
restoring of the Storage Manager configuration” on page 264.
Data in storage systems
Data that is archived on storage systems like HSM, NAS, CAS also needs a
backup, either by means of the storage system or with Archive Server tools; see
“Backup for storage systems” on page 258.
If “write back” mode is enabled, the Archive Cache Server stores newly created
documents locally without saving them immediately to the destination. It is
recommended to perform regular backups of the Archive Cache Server data; see
“Backup and recovery of an Archive Cache Server” on page 264.
Directory Services
If OpenText Directory Services (OTDS) is used, OpenText recommends backing
up the OTDS server on a regular basis (for example, weekly).
Note: OTDS is required, for example, by Archive Center scenarios. Email

Cloud Archiving uses OTDS to store data for the IMAP access.
For general information about OTDS, see OpenText Directory Services with
the OpenText Administration Client - Installation and Administration Guide
(OTDS-IGD).
25.1 Backing up the database

All archived documents are administered in the Archive Server database. This
contains information about the documents themselves as well as about the storage
locations of the documents and their components. This database must be backed up
in a similar way as the archived documents.
To avoid data loss and extended down times you, as system administrator, should
back up the database regularly and in full, and complement this full backup with a
daily backup of the log files. In general: The more backups are performed, the safer
the system is. Backups should be performed at times of low system load.
It is advisable to back up the archive database at the same time as the database of the
leading application if possible.

AR100500-01-ACN-EN-04
25.1. Backing up the database
The database can be set up as an Oracle Database or as an Microsoft SQL Server

database. The procedure adopted for backups depends on which of these database
systems is used.
The database must be backed up at regular intervals. However, because its data
contents are constantly changing, all database operations are written to special files
(online and archived redo logs under Oracle, transaction logs for SQL Server). As a
result, the database can always be restored in full on the basis of the backup and
these files.
Important
During the configuration phase of installation, you can either select default
values for the database configuration or configure all relevant values. To
make sure that this guide remains easy to follow, the default values are used
below. If you configured the database with non-default values, replace these
defaults with your values.
25.1.1 Backing up an Oracle Database

The following links provide information how to backup and recover an Oracle
Database 11.2 with the Oracle utility Recovery Manager (RMAN):
• Introduction to Backup and Recovery (http://download.oracle.com/docs/cd/
E11882_01/backup.112/e10642/rcmintro.htm#g1025843)
• Getting Started with RMAN (http://download.oracle.com/docs/cd/E11882_01/
backup.112/e10642/rcmquick.htm#BABJAGIB)
25.1.2 Backing up a Microsoft SQL Server database

In SQL Server 2008 Books Online, see “Operations (Database Engine) >
Administration (Database Engine) > Managing Databases > Backing Up and
Restoring Databases in SQL Server”.
For details on password change, see “Changing the database user password”
on page 97.

AR100500-01-ACN-EN-04
25.2 Backing up and restoring of the Storage Manager

configuration
For details on backup and restoring of the Storage Manager configuration, see
Section 2 “Backup of the Storage Manager configuration” in OpenText Archive Center
- STORM Configuration Guide (AR-IST).
25.3 Backup and recovery of an Archive Cache Server

Caution
If “write back” mode is enabled, the Archive Cache Server stores newly
created documents locally without saving them immediately to the
destination. This means that “highly critical” data are hold on the local disk
of the related Archive Server. For security reasons, OpenText strongly
recommends storing data on a RAID system. For performing regular
backups of Archive Cache Server data, you should include relevant items
in your backup.
25.3.1 Backup of Archive Cache Server data

The so-called “maintenance mode” allows a backup if the write-back cache of the
Archive Cache Server is enabled. If maintenance mode is activated, the Archive
Cache Server still runs and handles requests, but does no longer access the local file
system so that backups can run without any conflicts. The Archive Cache Server acts
like a proxy and routes all requests directly to the Archive Server. Operations with
write-back items are not possible during this time.
Tip: To find out whether “maintenance mode” is active, start a command line
and enter
cscommand -c isOnline
or
cscommand -c getStatistics
cscommand With the Archive Cache Server installation comes a small utility (cscommand), which
utility allows to activate or deactivate the maintenance mode. The commands to activate
and deactivate maintenance mode can be called from any script or batch file.
Usually, the commands are added to the script that controls your backup. You can
find cscommand in the <OT config>\Archive Cache Server\bin directory.
To backup Archive Cache Server data:
1. Run Copy_Back jobs (recommended).
2. Activate maintenance mode:

AR100500-01-ACN-EN-04
25.3. Backup and recovery of an Archive Cache Server
cscommand -c setOffline -u <username> -p <password>
3. Start your backup. Make sure that all relevant directories are included.
4. Deactivate maintenance mode:
cscommand -c setOnline -u <username> -p <password>
Directories to be backed up
Note: The directories used by Archive Cache Server are configured during the
installation.
Cache volumes One or more cache volumes to be used for write through caching. Not
highly critical but useful for reducing time to rebuild cached data.
Write-back One single cache volume to be used for write back caching. This
volume volume contains the following subdirectories:
dat
Components are stored here.
idx
Per document, additional information is stored, which contains all
necessary information to reconstruct the data in case of a crash.
log
Special protocol files (one per day) are stored here. Containing
relevant info when a document is transferred to and committed by
the Document Service.
Important
Protocol files are not deleted automatically. Ensure regular
deletion of protocol files to avoid storage problems.
Path to store The absolute path to the volume where the Archive Cache Server stores
database files its metadata for the cached documents. Necessary to recover.
25.3.2 Recovery of Archive Cache Server data

In principle, two different recovery scenarios are supported:
• Complete loss of all volumes
• Data gets corrupt or partial loss of data volumes
As with “Backup of Archive Cache Server data” on page 264, you need the
cscommand in the <OT config>\Archive Cache Server\bin directory.
Recovery in case of complete loss of all volumes
This proceeding recovers the Archive Cache Server to the state of a previous backup.
This means all data in the time span between last backup and crash are lost.
Documents that are already transferred to the Archive Server are not affected.

AR100500-01-ACN-EN-04
To recover data (complete loss of all volumes):
1. Activate maintenance mode. Use

2. Copy your backup data to the correct location.
3. Activate consistency check. Use

cscommand -c checkVolume -u <username> -p <password>
4. Deactivate maintenance mode. Use

Recovery in case of corrupt data or partial loss of data
If successful, this proceeding recovers the actual state of the Archive Cache Server.
To recover data (corrupt data or partial loss of data):
1. Activate maintenance mode. Use

2. If the write-back volume is still available, rename the root directory of the write-
back volume (see Step 5, <location of write back data>).
3. Copy your backup of the data to the correct location to replace the corrupt one.
If you have also a partial loss of data volumes, copy the lost data from your
backup to the correct location.
4. Activate consistency check. Use

cscommand -c checkVolume -u <username> -p <password>
5. Start recovering of data. Use

cscommand -c recover <location of write back data> -u <username> -p
<password>.
Important
Each successfully recovered document is listed on the command line
and removed from <location of write back data>. This means that
the recover operation can just be processed once.
6. If you do not get any error messages, the renamed directory (<location of
write back data>) can be deleted. Any data left in this subtree is no longer
needed for operation.
Important
If you get error messages, do not delete any data. If you cannot fix the
problem, contact OpenText Customer Support.
7. Deactivate maintenance mode. Use


AR100500-01-ACN-EN-04
Chapter 26
Utilities
Utilities are tools that are started interactively by the administrator. The following
table provides an overview of all utilities that can be reached in Utilities in the
System object in the console tree. Cross references are leading to detailed
descriptions in the relevant chapters. You also find a description of how to start
utilities and how to check the utility protocol in this chapter.
Some utilities are assigned directly to objects and can be reached in the action pane.
Protocols of these utilities can also be reached in Utilities in the System object in the
console tree
Note: Some utilities need to enter the name of the STORM server. To
determine the name, select Storage Devices in the Infrastructure object in the
console tree. The name of the STORM server is displayed in brackets behind
the device name; for example:
WORM(STORM1)
Table 26-1: Overview of utilities
Utility Link
Check Database Against Volume “Checking database against volume” on page 254
Check Document “Checking a document” on page 256
Check Volume “Checking a volume” on page 258
Check Volume Against Database “Checking volume against database” on page 256
Count Documents/Components “Counting documents and components in a
volume” on page 257
Export Volumes “Exporting volumes” on page 250
Import GS Volume “Importing GS volumes for Single File (VI) pool”
on page 253
Import HD Volume “Importing hard-disk volumes” on page 252
Import ISO Volume “Importing ISO volumes” on page 251
Report Shadow Copy Errors “Handling shadow copy errors” on page 132
Review Attribute Migration Errors “Attribute migration“ on page 309
View Installed Archive Server Patches “Viewing installed Archive Server patches”
on page 344
VolMig Cancel Migration Job “Canceling a migration job” on page 302
VolMig Continue Migration Job “Continuing a migration job” on page 301

AR100500-01-ACN-EN-04
Chapter 26 Utilities
Utility Link
VolMig Fast Migration of ISO “Creating a local fast migration job for ISO
Volume volumes” on page 293
VolMig Fast Migration of remote ISO “Creating a remote fast migration job for ISO
Volume volumes” on page 294
VolMig Migrate Components on “Creating a local migration job” on page 287
Volume
VolMig Migrate Remote Volumes “Creating a remote migration job” on page 290
VolMig Pause Migration Job “Pausing a migration job” on page 301
VolMig Renew Migration Job “Renewing a migration job” on page 302
VolMig Status “Monitoring the migration progress“ on page 297
26.1 Starting utilities

To start a utility:
1. Select Utilities in the System object in the console tree.
2. Select the Utilities tab in the top area of the result pane. All available utilities
are listed in the top area of the result pane.
3. Select the utility you want to start.
5. Enter dedicated values.
6. Click Run to start the utility.
A window to monitor the results of the utility execution opens.
26.2 Checking utilities protocols

If you start a utility, a window opens to monitor the results. At the same time, a
protocol is created which can be checked later. You can check the results and
messages of a single utility or you check a protocol out of the protocol list where all
stored protocols are listed.
To check results and messages of a single utility:
2. Select the Utilities tab in the top area of the result pane. All available utilities
are listed in the top area of the result pane.
3. Select the utility you want to check.

The latest message of the utility is listed in the bottom area of the result pane.

AR100500-01-ACN-EN-04
26.2. Checking utilities protocols
4. Select the Results tab in the bottom area of the result pane to check whether the
execution of the utility was successful
or
select the Message tab in the bottom area of the result pane to check the
messages created during execution of the utility.
To check utilities protocols:
2. Select the Protocol tab in the top area of the result pane.
3. Select the protocol you want to check.

The messages created during the execution of the utility are listed in the bottom
To clear protocols:
3. Click Clear Protocol in the action pane.

All protocol entries are deleted.
Re-reading Utilities and jobs are read by Archive Server during the startup of the server. If
scripts utilities or jobs are added or modified, they can be re-read. This avoids a restart of
Archive Server.
To re-read scripts:
3. Click Reread Scripts in the action pane.

AR100500-01-ACN-EN-04
Part 5
Migration
Chapter 27
About migration
The very dynamic IT market makes it difficult to provide long-term archiving of

documents. Although currently known storage media have an expected life time of
up to 50 years, after such a long time there will be no devices that still can read these
storage media. Therefore, it is recommended to migrate all data periodically from
old to new storage media. OpenText delivers a reliable, secure, comfortable and
efficient solution for this challenge of volume migration.
You handle volume migration with two components:

• The volmig program, which is running permanently as a spawner service
controlling the actual migration procedure (VolMig Server).
• The vmclient program, which supplies an interface for other components that
need to interact with volume migration. See “Volume migration utilities“
on page 303.
To handle volume migration:
1. Create copy orders for the volume components, using the VolMig Migrate
Components on Volume utility.
2. Create and schedule a job for the Migrate_Volumes command. The

Migrate_Volumes job processes the copy orders.
a. See “Preparing the migration“ on page 281.

b. See “Creating a migration job“ on page 287.
3. Check the migration status using the VolMig Status utility. For more
information, see “Monitoring the migration progress“ on page 297.
4. Check whether the volume migration was successful.
Attribute Apart from the volume migration, you can use the attribute migration job to move
migration the metadata information that is stored in the ATTRIB.ATR files of archived
documents to the database; see “Attribute migration“ on page 309. In particular,
you must run the attribute migration job after upgrading to version 10.5.0.
Important
Attribute migration must be finished for all documents to be migrated.
Otherwise, the volume migration will fail.

AR100500-01-ACN-EN-04
Chapter 27 About migration
27.1 Features of volume migration

The volume migration suite has been designed to make media migration easier.
These are the features of volume migration:
• All kinds of storage systems are supported
Migration of documents from ISO, HD, or Single-File volumes to ISO or Single-
File pools
• Remote migration
Migration of documents from ISO volumes on a known server to the local server
using a network connection.
• Fast migration of ISO images
Migration of entire ISO images. This allows fast migration but no filtering of
components.
• Remote fast migration of ISO images
Migration of entire ISO images from a known server to the local server using a
network connection. This allows fast migration but no filtering of components.
• Filters
Selecting of documents within creation date ranges.
• Compression, encryption
Compression and/or encryption of documents before they are written to new
media.
• Retention
Setting of a retention period for documents during the migration process.
• Automatic Verification
Verifying of all migrated documents. A verification strategy can be defined for
each volume, specifying the verification procedure. Timestamps or different
checksums can be selected as well as a binary comparison.
27.2 Restrictions
The following restrictions are valid for the volume migration features:
• Remote single-file
Remote migration is only possible for volumes that are handled by STORM and
that can be mounted using NFS. Single-File volumes like HSM or HD volumes
cannot be migrated from a remote Archive Server.
• DBMS provider
Remote migration is only possible if the remote Archive Server uses the same
DBMS provider as the local Archive Server. For a cross-provider migration setup,
contact OpenText Global Technical Services.

AR100500-01-ACN-EN-04
27.2. Restrictions
• Fast migration of ISO images

It is not possible to filter components. Everything is copied regardless whether it
is very new, very old, or has been deleted logically. No changes are possible on
the documents, i.e. documents cannot be compressed, decompressed, or
encrypted. Further, retention periods cannot be applied. This holds for local and
remote Fast Migrations.
Caution
Consider that replication and backup settings are not transferred to the
target archive during migration. Therefore, the configuration for backup
and replicated archives must be performed for the migrated archive again.
See “Configuring remote standby scenarios“ on page 219 and “Creating
and modifying pools” on page 117.

AR100500-01-ACN-EN-04
Chapter 28
Setting parameters of volume migration
Configuration and logging parameters of volume migration can be specified. All

other necessary settings are delivered by the archive system, for example, the
temporary paths.
28.1 Setting configuration parameters of volume

migration
To set configuration parameters:
1. Select Configuration object in the console tree and search for the respective
variable (see “Searching configuration variables” on page 242).
2. Specify the configuration parameters for the volume migration:
Default hostname for the client to connect to variable

(Internal name: SERVER_HOST)
Specifies the host to which the vmclient will connect via RPC.
Default: localhost
Server Port for RPC requests variable

(Internal name: SERVER_PORT)
Specifies the server port of the host for the vmclient.
Default: 4038
Max. MB of documents to copy in one run variable

(Internal name: MEGABYTES_PER_NIGHT)
The volume migration is set to “stand-by”, after the given amount of data has
been ordered to be copied to the destination pool.
Default: 10000 (~10 GB)
Protocol Directory variable

(Internal name: PROTOCOL_DIRECTORY)
Defines the directory where the protocols of the volume migration are saved.
Default: $ECM_LOG_DIR/migration
Warn after how many days if component not written variable

(Internal name: MAX_DAYS_TO_COPY
The volume migration restarts an unfinished migration automatically and sends
a notification if any component is not successfully copied after the defined
number of days. A value of -1 disables this feature.
Default: 7 days

AR100500-01-ACN-EN-04
Chapter 28 Setting parameters of volume migration
List all DocID/CompID tuples in job protocol variable

(Internal name: DUMP_COMP_IDS)
Allows that the volmig server copies DocIDs and CompIDs for each component
in the job protocol.
Default: off
Lower process priority variable

(Internal name: PRIORITY_THROTTLE)
Allows the execution of volume migration with a lower process priority.
Default: off
Enable CRC32 checksum verification variable

(Internal name: VMIG_VERIFY_CRC32)
Allows CRC32 testing if checksum verification is specified for a migration job.
Default: on
Enable client-generated hash value verification variable

(Internal name: VMIG_VERIFY_CL_SIG)
Allows client-generated hash value testing if checksum verification is specified
for a migration job.
Default: on
Enable timestamp hash value verification variable

(Internal name: VMIG_VERIFY_SIG)
Allows timestamp hash value testing if checksum verification is specified for a
migration job.
Default: on
Enable ArchiSig timestamp SHA-1 hash value verification variable

(Internal name: VMIG_VERIFY_DIG2)
Allows ArchiSig timestamp SHA-1 hash value testing if checksum verification is
specified for a migration job.
Default: on
Enable ArchiSig timestamp RipeMD-160 hash value verification variable

Allows ArchiSig timestamp RipeMD-160 hash value testing if checksum
verification is specified for a migration job.
Default: on
Enable ArchiSig timestamp SHA256 hash value verification variable

Allows ArchiSig timestamp SHA256 hash value testing if checksum verification
is specified for a migration job.
Default: on
Enable ArchiSig timestamp SHA512 hash value verification variable


AR100500-01-ACN-EN-04
28.2. Setting logging parameters of volume migration
Allows ArchiSig timestamp SHA512 hash value testing if checksum verification

is specified for a migration job.
Default: on
28.2 Setting logging parameters of volume migration

To set logging parameters:
1. Select Configuration object in the console tree, search for the respective variable
(see “Searching configuration variables” on page 242).
2. Specify the logging parameters for the volume migration:
• Log DB Messages (internal name: LOG_DB)

• Log Debug Messages (internal name: LOG_DEBUG)
• Log Function Entry Messages (internal name: LOG_ENTRY)
• Log Info Messages (internal name: LOG_INFO)
• Log Result Messages (internal name: LOG_RESULT)
• Log RPC Messages (internal name: LOG_RPC)
• Log User Error Messages (internal name: LOG_UERROR)
• Log using relative time (internal name: LOG_REL)
• Log Warning Messages (internal name: LOG_WARNING)
• Max. size of a logfile (in bytes) (internal name: MAXLOGSIZE)
• Write error messages to Event Log syslog (internal name:
USE_EVENT_LOG)

AR100500-01-ACN-EN-04
Chapter 29
Preparing the migration
29.1 Preparing for local migration

To prepare for local migration:
1. If migrating from Archive Server before 10.5.0: Ensure that the attribute migration
is done for all documents to be migrated by running the
SYS_MIGRATE_ATTRIBUTES job; see “Attribute migration“ on page 309.
Important
Attribute migration must be finished for all documents to be migrated.
Otherwise, the volume migration will fail.
2. Start the Administration Client, select the dedicated logical archive and create a
new pool for the migration. See “Creating and modifying pools” on page 117.
3. Make sure that the media to be migrated are imported.
Note: Components not listed in the ds_comp table are ignored. To ensure
that all components of one medium are listed in the ds_comp table,
OpenText recommends that you call volck first.
4. Create and schedule a job in the OpenText Administration Client for the
Migrate_Volumes command. See “Configuring jobs and checking job protocol“
on page 141.
29.2 Preparing for remote migration

In addition to “Preparing for local migration” on page 281, the following steps are
necessary to prepare for migration from a remote Archive Server:
Preconditions
• The hostname of the “old” server is supposed to be oldarchive. The volumes to

be migrated are located on oldarchive. The volumes of the oldarchive are
listed in Storage Devices in the Infrastructure object of the console tree. This
server is also called “remote server.”
• The hostname of the new Archive Server (destination of migration) is supposed
to be newarchive. The target devices for remote migration are located on
newarchive. This server is also called “local server.”
• The newarchive is not a known server of oldarchive, and, vice versa,
oldarchive is not a known server of newarchive.

AR100500-01-ACN-EN-04
Chapter 29 Preparing the migration
To prepare for remote migration:
1. Normally, newarchive cannot access the volumes of oldarchive. Thus, you

have to make sure that the local server (newarchive) is configured in the
STORM’s hosts list on the remote server (oldarchive). This will allow access to
newarchive.
Modify the configuration file: <OT config AS>/storm/server.cfg
Add newarchive to the hosts { } section.
Example 29-1: Adapting server.cfg for remote migration

hosts {newarchive}
Separate multiple hosts with blanks:

hosts {newarchive host2 host3}
Restart the jbd on oldarchive after you made changes here.

> spawncmd stop jbd
> spawncmd start jbd
2. Oracle Database only: On the local server, extend the $TNS_ADMIN/tnsnames.ora

file to contain a section for the remote computer.
Example 29-2: Extending tnsnames.ora for remote migration

Old tnsnames.ora:
ECR =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = <target host>)
(PORT = 1521))
(ADDRESS = (PROTOCOL = IPC)(Key = ECR))
)
(CONNECT_DATA =
(SERVER = DEDICATED)
(SERVICE_NAME = ECR)
)
)
New tnsnames.ora with added section for the remote computer:

ECR =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = <target host>)
(PORT = 1521))
(ADDRESS = (PROTOCOL = IPC)(Key = ECR))
)
(CONNECT_DATA =
(SERVICE_NAME = ECR)
)

AR100500-01-ACN-EN-04
29.2. Preparing for remote migration
<source db> =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = <source host>)
(PORT = <source port>))
(ADDRESS = (PROTOCOL = IPC)(Key = <source key>))
)
(CONNECT_DATA =
(SERVICE_NAME = <source service name>)
)
)
3. The actual read access of the media is done via NFSSERVERs. To add access to
oldarchive media, set the corresponding variable: In Configuration, search for
the NFS Server n variable (internal name: NFSSERVER<N>; see “Searching
configuration variables” on page 242) on the local server newarchive.
Add an entry for each NFSSERVER on the remote computer (at least for those
that you intend to read from). This will create access to the media on
oldarchive.
Example 29-3: NFSSERVER mapping on UNIX platforms

On the remote computer (oldarchive), there are two NFSSERVER entries
NFSSERVER1 = WORM,localhost,4027,/views_hs
NFSSERVER2 = CDROM,localhost,4027,/views_hs
On the local computer, create the following entries:
NFSSERVER3 = WORM2,oldarchive,4027,/views_hs
NFSSERVER4 = CDROM2,oldarchive,4027,/views_hs
On Windows platforms, the port number is 0 instead of 4027.
4. Restart the application server and the dsaux service on newarchive:

> spawncmd restart dsaux
5. For the newarchive, select Archive Server > Configuration in the console tree.
6. Search for the List of mappings from remote NFSSERVER names to local
names variable in Configuration (internal name: AS.VMIG.NFSMAP_LIST;
see “Searching configuration variables” on page 242).
Open the Properties. For each remote NFSSERVER to read from, add an entry.
The syntax is:
<remote database server>:<remote NFSSERVER>:local:<local NFSSERVER
alias>

AR100500-01-ACN-EN-04
Example 29-4: VMIG NFSSERVER mapping after NFSSERVERs

WORM2 and CDROM2 have been created
database_server_of_old_archive:WORM:local:WORM2
database_server_of_old_archive:CDROM:local:CDROM2
The entry local is fixed syntax; it is not the name of the local server!
It is not necessary to do a mapping for both NFSSERVERs. Only those
are required for which a migration will be done. For example, if you
want to migrate only ISO images, the NFSSERVER CDROM is needed.
Named instance (SQL Server only)

If you have a named instance on SQL Server, the syntax must be changed
like this:
<remote DB server>\<instance>:<DB service>:<remote
NFSSERVER>:local:<local NFSSERVER alias>
Example: If the named instance is INST_A and the DB service is ECR, the example
from above would have to be changed to
database_server_of_old_archive\INST_A:ECR:WORM:local:WORM2
database_server_of_old_archive\INST_A:ECR:CDROM:local:CDROM2
7. Restart the Migration Server on newarchive:

> spawncmd restart migration
29.3 Preparing for local fast migration of ISO images

To prepare for local fast migration:
1. Create and schedule a job in the OpenText Administration Client for the
Migrate_Volumes command. See “Configuring jobs and checking job protocol“
on page 141.
2. Disable backup for the original pool to avoid that the server creates additional
(unwanted) backups in the original pool.

AR100500-01-ACN-EN-04
29.4. Preparing for remote fast migration of ISO images
29.4 Preparing for remote fast migration of ISO

images
In addition to “Preparing for local fast migration of ISO images” on page 284, the
following steps are necessary to prepare for migration from a remote Archive
Server:
To prepare for remote fast migration:
1. Depending on your database system, do one of the following:
ORACLE DATABASE
On the local server, extend $TNS_ADMIN/tnsnames.ora to contain a section
for the remote computer.
SQL SERVER
If the database of the remote Archive Server (oldarchive) is hosted on
another server (remote database), add an SQL Alias on the target Archive
Server (newarchive) using SQL Server Configuration Manager.
As Alias Name, enter the name of the Archive Server (oldarchive) that is
the source of the migration and that is used for the NFSSERVER mapping
and for the migration job; see below.
Add an alias for SQL Native Client 10.0 Configuration and for SQL Native
Client 10.0 Configuration (32 bit). The alias names must not end with a
blank.
2. On the target Archive Server (newarchive), create an additional NFSSERVER<N>

entry as described in “Preparing for remote migration” on page 281:
In Configuration, search for the NFS Server n variable (internal name:
NFSSERVER<N>; see “Searching configuration variables” on page 242). Add an
entry for each NFSSERVER on the remote computer (at least for those that you
intend to read from). This will create access to the media on oldarchive.
3. On the target Archive Server (newarchive), search for the List of mappings
from remote NFSSERVER names to local names variable in Configuration
(internal name: AS.VMIG.NFSMAP_LIST).
Open the Properties. For each remote NFSSERVER to read from, add an entry.
The syntax is:
<remote database server>:<remote NFSSERVER>:local:<local NFSSERVER
alias>
Named instance (SQL Server only)

If you have a named instance on SQL Server, the syntax must be changed
like this:
<remote DB server>\<instance>:<DB service>:<remote
NFSSERVER>:local:<local NFSSERVER alias>

AR100500-01-ACN-EN-04
4. Required only for remote server version 10.5 or later: On the local server (new
archive), call
vmclient -h <remote_server> -u dsadmin:<password> putCert
Thus, the certificate of the local server (in as.pem) is known at the remote
server.
5. Required only for remote server version 10.5 or later: On the remote server (old
archive), enable the new certificate with the name of the local server.
6. On the remote server (old archive), modify the DS configuration (<OT config
AS>/DS.Setup).
Add the variable
BACKUPSERVER1 = BKCD,<newarchive>, 0
where <newarchive> is the hostname of the target Archive Server.
Important
Do not use blanks and do not type the angle brackets in the value!
Note: For remote fast migration, remote server version 9.7.1 or later is
required.
7. Restart the backup server on the remote server:

> spawncmd restart bksrvr
Note: Only for Archive Server version 9.7.1 or later.
8. Check the modified configuration. If

bkClient remote_server
provides a prompt, the configuration is correct.
Note: In case of an error message, check and verify that the correct
certificate has been transferred previously. Compare fingerprints.
9. Disable backup for the original pool to avoid that the server creates additional
(unwanted) backups in the original pool.

AR100500-01-ACN-EN-04
Chapter 30
Creating a migration job
To allow no more data to be copied to the migrated volume, you can set the volume
to write locked. Read access is possible; write access is protected.
To write-lock a migration job:
2. Select the archive you want to migrate in the console tree.
3. Select the Pools tab in the top area of the result pane. The attached volumes are
listed in the bottom area of the result pane.
4. Select the volume to be write locked and click Properties in the action pane.
5. Select write locked in the properties windows and click OK.
30.1 Creating a local migration job

To create a local migration job:
2. Select the VolMig Migrate Components On Volume utility.
4. Enter appropriate settings to all fields (see Settings for local migration
on page 287).
Click Run.
A new migration job is added to the list of migration jobs.

The migration job is processed if:
• the scheduler of the Administration Server calls the job Migrate_Volumes and
• all previous jobs have been processed.
Settings for local migration
Source Volume
Specify the source volume(s) name. The following characters are provided
therefore:

AR100500-01-ACN-EN-04
Chapter 30 Creating a migration job
Character Description
* Wildcard: 0 to n arbitrary characters
For example, vol5*, matches all volumes that name begins with vol5;
for example, vol5a, vol5c78, vol52e4r
? Wildcard: exactly one arbitrary character
For example, volx?x, matches volxax to volxzx and volx0x to
volx9x
\ Is used to escape wildcards (*, ?), if they are used as “real” characters in
volume names.
[] Specifies a set of volume names:
• “[ ]” can be used only once
• “,” can be used to separate numbers
• “-” can be used to specify a range
For example, [001,005-099]
Target archive
Enter the target archive name.
Target pool
Enter the target pool name.
Migrate only components that were archived: On date or after
You can restrict the migration operation to components that were archived after
or on a given date. Specify the date here. The specified day is included.
Note: Specify the date in YYYY-MM-DD format, as indicated by the template.

If you do not enter a specific date, leave the YYYY-MM-DD template entry as
is. Do not delete the template entry.
Migrate only components that were archived: Before date

You can restrict the migration operation to components that were archived
before a given date. Specify the date here. The specified day is excluded.
Note: Specify the date in YYYY-MM-DD format, as indicated by the template.

If you do not enter a specific date, leave the YYYY-MM-DD template entry as
is. Do not delete the template entry.
Set retention in days

Enter the retention period in days. With this entry, you can change the retention
period that was set during archiving. The new retention period is added to the
archiving date of the document. The following settings are possible:
• > 0 (days)
• 0 (none)
• -1 (infinite)
• -8 (keep old value)

AR100500-01-ACN-EN-04
30.1. Creating a local migration job
Note: The retention date of migrated documents can only be kept or extended.
The following table provides allowed settings:
Current retention setting Allowed retention setting for migration

of the document
no retention any
retention date extended retention date (> 0) or infinite (-1)
infinite no change
Verification mode
Select the verification mode that should be applied for volume migration. The
following settings are possible:
• None
• Timestamp
• Checksum
• Binary Compare
• Timestamp or Checksum
• Timestamp or Binary Compare
• Checksum or Binary Compare
• Timestamp or Checksum or Binary Compare
Notes
• Many documents (including all BLOB documents) do not have a checksum
or a timestamp. When migrating a volume that contains such documents or
BLOBs, it is strictly recommended to select a mode that provides “binary
compare” as a last alternative.
• If a migration job cannot be finished because the source volume contains
documents that cannot be verified using the specified verification methods,
it is possible to change the verification mode. See “Modifying attributes of a
migration job” on page 304 (-v parameter).
Additional arguments
-e
Export source volumes after successful migration.
-k
Keep exported volume (export only the document entries, allow
dsPurgeVol to destroy this medium).
-i
Migrate only latest version, ignore older versions.

AR100500-01-ACN-EN-04
-A <archive>
Migrate components only from a certain archive.
30.2 Creating a remote migration job

Do the following on the target host to create a remote migration job.
To create a remote migration job:
2. Select the VolMig Migrate Remote Volumes utility.
4. Enter appropriate settings to all fields (see Settings for remote migration
on page 290). Click Run.

The migration job is processed if
• the scheduler of the Administration Server calls the Migrate_Volumes job and
Settings for remote migration
Server name (Remote server)

Enter the name of the server on which the database of the Archive Server
resides.
Database name (Remote server)

Enter the remote database name.
Database provider (Remote server)

Select the remote DBMS provider. This must be the same as the local DBMS
provider.
Database user (Remote server)

Enter the database user name.
Database password (Remote server)

Enter the database user password.
Source Volume
therefore:

AR100500-01-ACN-EN-04
30.2. Creating a remote migration job
volx9x
volume names.
For example, [001,005-099]
Target archive (Local server)

Target pool (Local server)

Migrate only components that were archived: On date or after

You can restrict the migration operation to components that were archived after
or on a given date. Specify the date. The specified day is included.
Migrate only components that were archived: Before date

You can restrict the migration operation to components that were archived
before a given date. Specify the date. The specified day is excluded.
Set retention in days

Enter the retention period in days. With this entry, you can change the retention
period that was set during archiving. The new retention period is added to the
archiving date of the document. The following settings are possible:
• > 0 (days)
• 0 (none)
• -1 (infinite)
• -8 (keep old value)
Note: The retention date of migrated documents can only be kept or extended.
The following table provides allowed settings:

of the document
no retention any

AR100500-01-ACN-EN-04

of the document
retention date extended retention date (> 0) or infinite (-1)
infinite no change
Verification mode
Select the verification mode that should be applied for volume migration. The
• None
• Timestamp
• Checksum
• Binary Compare
Notes
-i
Migrates only latest version, ignores older versions.
-A <archive>
Migrates components only from a certain archive.

AR100500-01-ACN-EN-04
30.3. Creating a local fast migration job for ISO volumes
30.3 Creating a local fast migration job for ISO

volumes
To create a local fast migration job:
2. Select the VolMig Fast Migration of ISO Volume utility.
4. Enter appropriate settings to all fields. Click Run.
Settings for local fast migration
Source Volume
therefore:
For example, vol5*, matches all volumes that name begins with
vol5; for example, vol5a, vol5c78, vol52e4r
volx9x
\ Is used to escape wildcards (*, ?), if they are used as “real”
characters in volume names.
For example, [001,005-099]
Use target jukebox from archive

Use target jukebox from pool

The migration job is processed if
The archive/pool specification is only necessary to determine the target jukebox

where the copy of the ISO image is to be written. The logical archive of the contained

AR100500-01-ACN-EN-04
documents is not changed. Verification of the entire ISO image is performed

automatically against the built-in ISO checksum.
30.4 Creating a remote fast migration job for ISO

volumes
Do the following on the target host to create a remote fast migration job.
To create a remote fast migration job:
2. Select the VolMig Fast Migration of remote ISO Volume utility.
4. Enter appropriate settings to all fields (see Settings for remote fast migration
on page 294). Click Run.

The migration job is processed if:
Settings for remote fast migration
Server name (Remote server)

Enter the remote server name.
Database name (Remote server)

Enter the remote database name.
Database provider (Remote server)

Select the remote DBMS provider. This must be the same as the local DBMS
provider.
Database user (Remote server)

Enter the database user name.
Database password (Remote server)

Enter the database user password.
Source volumes (Remote server)

therefore:

AR100500-01-ACN-EN-04
30.4. Creating a remote fast migration job for ISO volumes
volx9x
volume names.
For example, [001,005-099]
Target archive (Local server)

Target pool (Local server)
Verification mode
Select the verification mode which should be applied for volume migration. The
• None
• Timestamp
• Checksum
• Binary Compare
Notes

AR100500-01-ACN-EN-04
-d (dumb mode)
Import of document/component entries into local database by dsTools
instead of reading directly from the remote database. The dumb mode
disables automatic verification. Archive and retention settings cannot be
changed.
-A <archive>
Migrates components only from a certain archive. Does not work with dumb
mode (-d ).

AR100500-01-ACN-EN-04
Chapter 31
Monitoring the migration progress
You can display an overview of migration jobs to check the progress of migration.
Each migration job has a unique ID, optional flags and a status. This information is
also needed to manipulate migration jobs. See “Manipulating migration jobs“
on page 301
31.1 Starting monitoring

To start monitoring:
2. Select the VolMig Status utility.
4. Specify which migration jobs will be included in the overview.

Possible settings are:
• New
• In progress
• Finished
• Cancelled
• Error
5. Click Run.An overview of migration jobs with the demanded job status opens.

AR100500-01-ACN-EN-04
Chapter 31 Monitoring the migration progress
31.2 States of migration jobs

Each migration job is handled by volume migration (VolMig) and passes through a
number of processing steps. Many of these processing steps assign a new status to
the job. Depending on the migration strategy (job type), a different set of states and a
different order of processing steps can be observed.
• New (enqueued)
VolMig has not yet started to process this migration job.
• Impt (import remote DB entries)
VolMig has started replicating DB entries for archives, documents, components
and component types of volumes from a remote source.
• Prep (prepare component list)
VolMig has started to query the components on the current medium to be
migrated.
• Iso (create and write an ISO image file)
For fast migration jobs, entire ISO images are replicated at once. This state
indicates that VolMig is retrieving an ISO image file from a local or remote
volume or is writing that image file to the target storage.

AR100500-01-ACN-EN-04
31.2. States of migration jobs
• Copy (create write jobs)

VolMig is now instructing the DS to copy the components from the source
medium to the migration pool. Entries in the ds_activity table are created.
• Wait (wait for write jobs to become finished)
When the scheduler calls the Migrate_Volume job, VolMig checks for any
components that have been copied by dsCD, dsWorm or dsHdsk to a volume in the
target pool. When it finds some, it can optionally verify the integrity. This will be
done each time until all components from a volume are found (and verified) in
the destination pool. Until then, the migration job displays the Wait status.
• Fin (finished successfully)
The migration job is finished. This means that all selected components from the
source volume have been migrated successfully.
• Canc (job cancelled)
The migration job has been cancelled by the administrator (see “Canceling a
migration job” on page 302).
• Paus (job paused)
This migration job has been paused and will not be processed until the
administrator continues the job (see “Pausing a migration job” on page 301).
• Err (error processing job)
An error occurred during processing the migration job. To resume processing, fix
the error (check logfiles therefore) and continue the migration job afterwards (see
“Continuing a migration job” on page 301).

AR100500-01-ACN-EN-04
Chapter 32
Manipulating migration jobs
The volume migration provides utilities to manipulate running migration jobs, by

using Administration Client.
32.1 Pausing a migration job

You can pause a migration job and continue it later. See “Continuing a migration
job” on page 301. This can be useful to prefer other jobs.
To pause a migration job:
2. Determine the ID of the migration job you want to pause via the VolMig Status
utility; see “Monitoring the migration progress“ on page 297.
3. Select the VolMig Pause Migration Job utility.
5. Enter the ID of the migration job that you want to pause in the Migration Job
ID(s) field.
6. Click Run.The migration job is set to the Paus status.
32.2 Continuing a migration job

You can continue a paused job (Paus status) or a job that produced an error (Err
status) to resume migration.
To continue a migration job:
2. Determine the ID of the migration job you want to continue via the VolMig
Status utility; see “Monitoring the migration progress“ on page 297.
3. Select the VolMig Continue Migration Job utility.
5. Enter the ID of the migration job that you want to continue in the Migration Job
ID(s) field.

AR100500-01-ACN-EN-04
Chapter 32 Manipulating migration jobs
6. Click Run.A protocol window shows the progress and the result of the
migration. The migration job is set back to the status before it has been paused
or the error occurred.
32.3 Canceling a migration job

If you cancel a migration job, all copy jobs of this migration job are deleted as well. A
canceled migration job can be renewed to start the job from the beginning. See
“Renewing a migration job” on page 302.
To cancel a migration job:
2. Determine the ID of the migration job you want to cancel via the VolMig Status
utility. See “Monitoring the migration progress“ on page 297.
3. Select the VolMig Cancel Migration job utility.
5. Enter the ID of the migration job that you want to cancel in the Migration Job
ID(s) field.
6. Click Run.
A protocol window shows the progress and the result. The migration job is set
to the Canc status. All copy jobs for this migration job are deleted.
32.4 Renewing a migration job

You can renew any migration job to start it from the beginning (unless another
active job processes the same source volume).
To renew a migration job:
2. Determine the ID of the migration job you want to renew via the VolMig Status
utility. See “Monitoring the migration progress“ on page 297.
3. Select the VolMig Renew Migration job utility.
5. Enter the ID of the migration job that you want to renew in the Migration Job
ID(s) field.
6. Click Run.A protocol window shows the progress and the result of the
migration. The migration job is set to the New status and is started from the
beginning.

AR100500-01-ACN-EN-04
Chapter 33
Volume migration utilities
The volume migration suite provides additional utilities to support you to perform
your migration. These utilities must be executed in a command shell. The following
sections explains the most important vmclient commands with their corresponding
attributes.
To execute vmclient commands:
1. Open a command shell.
2. Enter > vmclient <command> <attribute> [<attribute>...]
To get help on vmclient commands:
1. Open a command shell.
2. Enter > vmclient -h to get help.
33.1 Deleting a migration job

This command deletes a migration job and removes any pending write jobs.
> vmclient deleteJob <jobID> [<jobID> ...]
jobID
The ID of the migration job to be deleted.
33.2 Finishing a migration job manually

If a migration job cannot be finished regularly, but you know for sure that all
required documents have been migrated, you can set the job to the Fin status
(finished successfully) manually.
> vmclient finishJob <jobID> [<jobID> ...]
jobID
The ID of the migration job to be finished.

AR100500-01-ACN-EN-04
Chapter 33 Volume migration utilities
33.3 Modifying attributes of a migration job

This command changes the attributes of a migration job. Depending on the current
status of the specified migration job, only some attributes can be modified, others
are unchangeable.
> vmclient updateJobFlags <jobID> <attribute> [<attribute>...]
jobID
The ID of the migration job to be modified.
attribute
The attributes which can be modified.
Note: Attributes with one hyphen (-) will be added/updated.

Attributes with two hyphens (--) will be removed.
-e (export)
Export source volumes after successful migration.
-k (keep)
Do not set the exported flag for the volume (so dsPurgeVol can destroy it).
-i (ignore old versions)

Migrate only the latest version of each component, ignore older versions.
-r <value> (retention)
Set a new value for the retention of the migrated documents.
Not supported in Fast Migration scenarios.
-v <value> (verification level)

Define how components should be verified by VolMig.
Example 33-1: Modifying attributes of a migration job
To add the export flag, execute > vmclient updateJobFlags <jobID> -e
To remove the export flag, execute > vmclient updateJobFlags <jobID>

--e
To change the archive flag, execute > vmclient updateJobFlags <jobID>

-A H4
To remove the archive flag, execute > vmclient updateJobFlags <jobID>

--A

AR100500-01-ACN-EN-04
33.4. Changing the target pool of write jobs
33.4 Changing the target pool of write jobs

While the migration is running, documents may still be archived into the source
pool. After the migration has been finished, the target pool may be intended to
become the new default pool. To have the documents that are archived during the
migration written into the target pool rather than the source pool, you can use this
command to update the Write jobs.
> vmclient updateDsJob <old poolname> <new poolname> -d|-v
old poolname
Is constructed by concatenating the source archive name, an underscore
character and the source pool name, for example, H4_worm.
new poolname
Is constructed by concatenating the target archive name, an underscore
character and the target pool name, for example, H4_iso.
-d
Update pools in ds_job only.
-v
Update pools in both, ds_job and vmig_jobs.
Note: This works only for local migration scenarios. Write jobs in a remote
migration environment remain on the remote server and cannot be moved to
the local machine.
33.5 Determining unmigrated components

As long as a migration job is in Wait status, there are components that have not yet
been successfully migrated to the target pool. To find those components, this
command is provided. It lists document IDs and component IDs for a deeper
investigation on those items.
> vmclient listMissingComps <jobID> <max results>
jobID
The ID of the migration job which components should be listed.
max results
How many components should be listed at most.

AR100500-01-ACN-EN-04
Chapter 33 Volume migration utilities
33.6 Switching component types of two pools

After the migration of all media of a pool has been successfully finished, it can be
useful to change the migration target pool to the new default pool. It is possible to
switch the component types (known as application types in former Archive Server
versions) as follows:
> vmclient switchAppTypes <archive> <pool 1> <pool 2>
archive
The archive name.
pool 1
Name of the first pool.
pool 2
Name of the second pool.
33.7 Adjusting the sequence number for new volumes

If volumes are detached from one pool and attached to another pool, be careful with
wiring new volumes for that pool. The counter for the volume names is not aware of
the sequence numbers of the attached volumes. With this command, you can set the
counter to a new value.
> vmclient setSequenceNumber <archive> <pool> <sequence number>

[<sequence letter>]
archive
The archive name.
pool
The pool name.
sequence number
New number of the sequence.
sequence letter
New letter (for ISO pools only).

AR100500-01-ACN-EN-04
33.8. Statistic about components on certain volumes
33.8 Statistic about components on certain volumes

This command displays a short statistic about components found on one volume
and about other volumes where copies of the same components reside.
> vmclient investigate <volume name> [<volume name>]
volume name
Name of the primary volume.
33.9 Collecting diagnostic information

This command collects information about the server configuration and prints it to
stdout or to the specified output file.
> vmclient diag <output file>
output file
File to write the output to instead of stdout.

AR100500-01-ACN-EN-04
Chapter 34
Attribute migration
Archive Server stores metadata of documents and components in an ATTRIB.ATR file

together with the corresponding component. Up to this version, the information in
the ATTRIB.ATR file was only written once in some scenarios. In these cases,
extending the retention period would lead to an outdated ATTRIB.ATR file, for
example.
Note: From version 10.5.0 on, all metadata information of a document’s

ATTRIB.ATR file is stored in the database. The database schema has been
changed accordingly.
For existing documents, this information must be migrated to the database to

achieve a consistent status between the database and the ATTRIB.ATR files.
“On the fly” The information within the document’s ATTRIB.ATR file is migrated to the database
migration upon the first access of the document. This automatic migration process does not
require any user interaction.
“Bulk” migration Additionally to the automatic migration mentioned before, a job exists that migrates
the metadata in the ATTRIB.ATR files to the database. By default, the job is scheduled
to run every Sunday at 0:30.
To start the attribute migration job:
• Follow the procedure in “Starting and stopping jobs” on page 146 to start the
attribute migration. The name of the job is SYS_MIGRATE_ATTRIBUTES.
The job runs the AttribAtrMigrate command, which requires the following
parameters:
AttribAtrMigrate { [-t <threads>] migrate {null|err} <time to run> |
report }
where
<threads> Number of threads to use; default: 10

null Processes unmigrated documents (default)
err Processes migrated documents with error (default for
SYS_RETRY_ATTRIBUTE_MIGRATION job; see below)
<time to Duration of the job to run in minutes; default: 60. The next run will
run> resume the migration.
report Creates a report showing the number of successfully migrated
documents, the failed migrations (according to the kind of error), and
the number of documents still to migrate

AR100500-01-ACN-EN-04
Chapter 34 Attribute migration
Note: The report is also shown after a run of AttribAtrMigrate in

migrate mode.
Migration The migration of a document results in one of the following states:

results
A Inconsistent attributes in files or from object
M Error while merging attributes
P Error while persisting attributes
F One unreadable attrib.atr file
G Several unreadable attrib.atr files
O One or more media offline
X Error in both files and attributes
Y Successfully migrated
Failed If the migration to the database failed for a document (states other than O or Y) you
migrations can run a job to retry the migration. If the error persists, the problem must be fixed
manually. Use the Review Attribute Migration Errors utility to list the failed
documents; see below.
To retry migration for failed migrations:
• Follow the procedure in “Starting and stopping jobs” on page 146 to start the
attribute migration. The name of the job is
SYS_RETRY_ATTRIBUTE_MIGRATION.
The job runs the AttribAtrMigrate command with the following parameters:
AttribAtrMigrate migrate err 60
Note: By default, the job is scheduled to run every Sunday at 1:45.
Review Attribute Migration Errors utility

You can use a utility to display migration errors. The utility lists the DocIDs of all
documents for which the migration failed. The problems that led to the failed
migration of these documents can then be fixed manually.
To run the Review Attribute Migration Errors utility:
1. To start the utility, follow the procedure in “Starting utilities” on page 268.
2. When requested, enter the number of errors to review or keep the field empty to
use the default value (1000).

AR100500-01-ACN-EN-04
Part 6
Monitoring
Chapter 35
Everyday monitoring of the archive system
To monitor the archiving system, you can use Administration Client, Archive Server
Monitoring, and Document Pipeline Info. Administration Client and Document
Pipeline Info must be installed on the administrator's computer and can connect to
different Archive Servers and Document Pipeline hosts via network. Archive
Monitoring Web Client is installed on the Archive Server and is performed in a
browser, accessible with an URL.
The utilities provides the following functions:
• Checking the success of jobs, in particular of the Write and Backup jobs
• Checking for notifications according to your configuration (emails, alerts,
execution of files; see “Monitoring with notifications“ on page 315)
• Checking free disk space
Archive Server Monitoring

• Checking statistics about archiving and retrieving activities and the Archive
Server‘s read/write performance.
• Checking the error queues of the Archive Server components.
• Checking reported quota limit violations.
For more information on Archive Server Monitoring, see “Using OpenText

Archive Server Monitoring“ on page 325.

• Checking the correct document flow in Archive Server
• Checking the correct document flow in Document Pipelines
• Locating problems
For detailed information about the Document Pipeline Info, see OpenText
Document Pipelines - Overview and Import Interfaces (AR-CDP).

AR100500-01-ACN-EN-04
Chapter 36
Monitoring with notifications
By setting up a notification service, you can reduce the amount of work associated
with monitoring the archive system. The Notification Server sends notifications
when certain predefined server events occur. You can define both the events and the
type and recipient of the notification. You can also restrict the time slot in which
particular notifications are sent. For example, you can define notifications sent to the
workstation during working hours and by email to the on-call service outside
working hours. Thus, you ensure that responsible persons are addressed directly
when a particular event occurs.
Setting up monitoring with notifications involves the following steps:
1. Define the events filter to which the system should respond; see “Creating and
modifying event filters” on page 315.
2. Create the type and settings of the notifications and assign them specific event
filters; see “Creating and modifying notifications” on page 319.
36.1 Creating and modifying event filters

Defining an event filter means specifying the conditions that have to be met, before a
notification is triggered. If a system event (for example, an error or warning) occurs,
the system checks whether it complies with one of the defined event conditions. If it
does, the assigned notification is sent. It contains the complete message, the origin
and the time.
Some important event filters are already predefined. You can change them and
define new event filters.
To create an event filter:
1. Select Events and Notifications in the System object in the console tree.
2. Select the Event Filters tab. All available event filters are listed in the top area of
the result pane.
3. Click New Event Filter in the action pane. The window to create a new event
filter opens.
4. Enter the conditions for the new event filter. See “Conditions for event filters”
on page 316.
5. Click Finish.
Modifying event To modify an event filter, select it in the top area of the result pane and click
filters Properties in the action pane. Proceed in the same way as when creating a new
event filter. The name of the event filter cannot be changed.

AR100500-01-ACN-EN-04
Chapter 36 Monitoring with notifications
Deleting event To delete an event filter, select it in the top area of the result pane and click Delete in
filters the action pane.
Related Topics
• “Conditions for event filters” on page 316
• “Available event filters” on page 318
• “Creating and modifying notifications” on page 319
• “Checking alerts” on page 323
36.1.1 Conditions for event filters

In the Event Filter properties window, you can define or modify the settings of an
event filter.
Name
A self-explaining name
Message class
Classifies and characterizes events
• Any (all classes are recorded)
• Administration: events that affect administration
• Database: database event
• Server: server event
Component
Specifies the software component that issues the message. If nothing is specified
here, all components are recorded (Any). The most important components are:
• Administration Server: mainly monitors the execution of the jobs
• Monitor Server: reports status changes of archive components, i.e. whenever
a status display changes in Archive Monitoring Web Client
• Document Service: monitors the jds, which provides archived documents
and archives documents
• Storage Manager: reports errors that occur when writing to storage media
• Archive Timestamp Server: reports errors that occur when creating or
administering timestamps
• High Availability: reports errors associated with High Availability software
and the cluster software it uses
• Volume Migration: reports errors that occur during volume migration
• BASE DocTools: reports errors associated with BASE DocTools
• R/3 DocTools: reports errors associated with R/3 DocTools (SAP)
• Filter Service: not used

AR100500-01-ACN-EN-04
36.1. Creating and modifying event filters
Severity
Specifies the importance.
• Any (all severities are recorded)

• Fatal Error
• Error
• Warning
• Important
• Information
Message codes
Specifies which message codes should be considered by the event filter. The
codes are used to filter out concrete events and are usually defined in a message
catalog, which belongs to a component. For each component, the catalog is
installed in
<OT config>\msgcat\<COMPNAME>_<lang>.cat
Example: ADMS_us.cat is the English message catalog for the Administration Server
component.
It is possible to enter the code number directly, but it is recommended and more
comfortable to use the Select button. This offers a window with current
available message codes and associated descriptions.
To select message codes:
1. Select Any if no filtering should be applied.

Select Specific or Range to configure designated message codes.
2. Click Select. A window with current available message codes opens. The
available message codes depend on the selected combination of message
class, component and severity.
3. Select the designated message code and click OK to resume. If you define a
range, select the first and the last message code (from – to).
Related Topics
• “Creating and modifying event filters” on page 315

• “Available event filters” on page 318

AR100500-01-ACN-EN-04
36.1.2 Available event filters

Preconfigured A number of preconfigured events are delivered with the installation of Archive
events Server. To use them, configure the notifications and assign the appropriate
notifications to each event. You can use these events:
Any Fatal Error

Includes all events of the Fatal Error type of all currently recorded event
classes and components
Any Message from Admin Server

Includes all events on the Administration Server
Any Message from Document Service

Includes all events occurring in the Document Service
Any Message from Monitor Server

Includes all status changes in Archive Monitoring Web Client
Any Message from Storage Manager

Includes all status changes in the Storage Manager
Any Non-Fatal Error

Includes all events of the type Error of all currently recorded event classes and
components
ISO volume has been written

Occurs when an ISO volume has been written successfully
Jukebox error: Jukebox detached

Occurs when the STORM cannot access the jukebox
User-defined In addition, you can define other events to get notifications if they occur. Useful
events events are:
Job Error
This event records errors that are listed in the job protocol and notifies you with
a particular message. Use this configuration:
Severity: Error
Message class: Server or <any>
Component: Administration Server
Message code: 1
Error from Monitor Server

This event occurs when an archive component indicates an error, for example,
when no more free storage space is available (red icon in Archive Monitoring
Web Client). Use this configuration:
Severity: Error
Component: Monitor Server
Message code: -

AR100500-01-ACN-EN-04
36.2. Creating and modifying notifications
Warning from Monitor Server

This event occurs when the monitor server issues a warning, for example when
the free storage space reaches a low level or when an attempt is made to access
an unavailable volume (yellow icon in Archive Monitoring Web Client). Use this
configuration:
Severity: Warning
Component: Monitor Server
Message code: -
Related Topics
• “Conditions for event filters” on page 316
36.2 Creating and modifying notifications

After defining the event filter, you can create a notification and assign one or more
event filters. You can select different types of notification:
• Alert, passive notification type, alerts must be checked by the administrator; see
“Checking alerts” on page 323
• Mail Message, active notification type, when the assigned event occurs, a
message is sent
• TCL Script, active notification type, when the assigned event occurs, a tcl script
is executed
• Message File, passive notification type, notifications are written in a specific file
• SNMP Trap, active notification type, notifications are sent to an external
monitoring system via the SNMP protocol
To create a notification:
1. Select Events and Notifications in the System object in the console tree.
2. Select the Notifications tab. All available notifications are listed in the top area
of the result pane.
3. Click New Notification in the action pane. The wizard to create a new
notification opens.
4. Enter the name and the type of the notification and click Next. Enter the
additional settings for the new notification event. See “Notification settings”
on page 320.
5. Click OK. The new notification is created.
6. Select the new notification in the top area of the result pane.

AR100500-01-ACN-EN-04
7. Click Add Event Filter in the action pane. A window with available event filters
opens.
8. Select the event filters which should be assigned to the notification and click
OK.
Testing notifica- There are two possibilities for testing of notifications:

tions
• Select the new notification in the top area of the result pane and click Test in the
action pane.
• Click the Test button in the notification window while creating or modifying
notifications.
Modifying notifi- To modify the notification settings, select the notification in the top area of the result
cations settings pane and click Edit in the action pane. Proceed in the same way as when creating a
new notification. The name of the notification cannot be changed.
Deleting notifi- To delete a notification, select the notification in the top area of the result pane and
cations click Delete in the action pane.
Adding event To add event filters, select the notification in the top area of the result pane. Click
filters Add Event Filter in the action pane. Proceed in the same way as when creating a
new notification.
Remove an To remove an event filter, select it in the bottom area of the result pane and click
event filter Remove in the action pane. The notification events are not lost, only the assignments
is deleted.
Related Topics
• “Notification settings” on page 320
• “Using variables in notifications” on page 322
36.2.1 Notification settings

In the first window of the Notification wizard, you define the type of the
notification. Depending on the type, additional settings are needed.
Name
The name should be unique and meaningful.
Notification Type
Select the type of notification and enter the specific settings. The following
notification types and settings are possible:
Alert
Alerts are notifications, which can be checked by using Administration
Client. They are displayed in Alerts in the System object in the console tree
(see “Checking alerts” on page 323).

AR100500-01-ACN-EN-04
36.2. Creating and modifying notifications
Mail Message
Emails can be sent to respond immediately to an event or in standby time. If
you want to send it via SMS, consider that the length of SMS text (includes
Subject and Additional text) is limited by most providers. Enter the
following additional settings:
• Sender address: Email address of the sender. It appears in the from field
in the inbox of the recipient. The entry is mandatory.
• Mail host: Name of the target mail server. The mail server is connected
via SMTP. The entry is mandatory.
• Recipient address: Email address of the recipient. If you want to specify
more than one recipient, separate them by a semicolon. The entry is
mandatory.
• Subject of the mail, $ variables can be used (see “Using variables in
notifications” on page 322). If not specified, the subject is $SEVERITY
message from $HOSTNAME/$USERNAME($TIME).
• Include Standard Text: If selected, you get an introduction in the
notification: “The preceding notification message was generated by ...”.
This introduction is followed by the message text. If you send SMS
messages, clear this check box.
• Max. Length of mail message text: Use this setting to restrict the number
of characters in the email body. If you send notifications as SMS
message, thus you can enter a value according to the limitation of your
provider.
TCL Sript
Enter the name and the path of the tcl script. It will be executed if the event
occurs.
Message File
The notification is written to a file. Enter name and path of the target file or
click Browse to open the file browser. Select the designated message file and
click OK to confirm.
Enter also the maximum size of the message file in bytes.
SNMP Trap
Provides an interface to an external monitoring system that supports the
SNMP protocol. Enter the information on the target system.
Text
Free text field with the maximum length of 255 characters. $ variables can be
used (see “Using variables in notifications” on page 322).
Active Period
Weekdays and time of the day at which the notification is to be sent.
Related Topics

AR100500-01-ACN-EN-04

• “Using variables in notifications” on page 322
36.2.2 Using variables in notifications

When configuring notifications, variables can be used as placeholders. The variables
are replaced by the current value when the notification is sent. For example, the
$HOST variable is replaced by the name of the host at which the event was triggered.
With variables, you can keep the subject line and the body text of the notification
generic, for example, $SEVERITY message from $HOST.
The following variables can be used:
$CLASS
Message class, characterizes the event
$COMP
Component that has output the message
$SEVERITY
Type of message, characterizes the importance
$TIME
Date and time when the message was output from the component (system time
of the computer on which the component is installed)
$HOST
Name of the computer on which the reported event occurred. For server
processes, “daemon” is output
$USER
Name of the user under which the processes run on the $HOST machine
$MSGTEXT
Message text from the message catalog. Important messages are listed first. If
there is no catalog message, the default text provided by the component is used
$MSGNO
Code number from the message catalog
Related Topics
• “Notification settings” on page 320

AR100500-01-ACN-EN-04
36.3. Checking alerts
36.3 Checking alerts

Notifications of the alert type must be checked by using Administration Client.
To check alerts:
1. Select Alerts in the System object in the console tree. All notifications of the
alert type are listed in the top area of the result pane.
2. Select the alert to be checked in the top area of the result pane. Alert details are
displayed in the bottom area of the result pane. The yellow icon of the alert
entry turns to grey if read.
Marking To mark all messages as read click Mark All as Read in the action pane. The yellow
messages as icons of the alert entries turn to grey.
read

AR100500-01-ACN-EN-04
Chapter 37
Using OpenText Archive Server Monitoring
Tasks The OpenText Archive Server Monitoring Web Client provides the following
monitoring functions:
• Archive Server Statistics - Checking the archiving and retrieving activities and
the Archive Server’s read/write performance.
• Archive Server Health Status - Checking the status of the Archive Server
components.
• Checking free storage space in the log directories
• Checking free storage space in pools and volumes
• Checking the Document Service and access to unavailable volumes
• Checking the Storage Manager
• Archive Server Threat Detection - Checking quota limit violations reported for
Archive Server users.
OpenText Archive Server Monitoring is used solely to observe the global system and
to identify problem areas. Monitoring collects information about the status of
Archive Server components at regular intervals.
Monitoring cannot be used to eliminate errors, modify the configuration, or start and
stop processes.
OpenText Archive Server Monitoring can be started using the URL of the Archive
Server host, for example,
https://alpha.opentext.com:8090/archive/monitoring (see “Starting the
Archive Monitoring Web Client” on page 329).
Warning and With Administration Client, you can configure warning and error messages that are
error messages sent when the status of Archive Server components changes (see “Monitoring with
notifications“ on page 315). You can also use external system management tools
within the scope of special project solutions.
Note: The default certificates delivered for Archive Timestamp Server expired
on 2015-05-28. To avoid error messages, you can replace the certificate files. For
more information, see “Renewing expired certificates” on page 182.
Alternatively, you can switch off the monitoring of the timestamp service by
setting the What kind of timestamp-server the script should expect
configuration variable (internal name: AS.TSTP.IXTWATCH_TS_SYSTEM) to
none.
Security
• The Archive Monitoring Web Client requires authentication.

AR100500-01-ACN-EN-04
Chapter 37 Using OpenText Archive Server Monitoring
• As the Archive Monitoring Web Client uses basic authentication, it is strongly

recommended to use the HTTPS protocol.
37.1 Access permission for the Archive Monitoring

Web Client
Two dedicated policies are provided that include the required permissions for
change access and read-only access to the Archive Monitoring Web Client.
Assigning the policies to a dedicated user group depends on the user management
configuration:
• Built-in OpenText User Management system: see “Creating a dedicated group for
the Archive Monitoring Web Client (built-in OpenText User Management)”
on page 326
• OpenText Directory Services (OTDS): see “Creating a dedicated group for the
Archive Monitoring Web Client (OTDS)” on page 327
37.1.1 Creating a dedicated group for the Archive Monitoring

Web Client (built-in OpenText User Management)
See below how to create a user in built-in user management who is has full access or
read-only access to the Archive Monitoring Web Client.
To create a dedicated user and group for Archive Monitoring Web Client (built-
in user management):
1. Connect to the Archive Server.

2. Create a new group and assign the access-specific policies.
a. Full access:
Create a new group and assign the MonitoringChangeAccess and
MonitoringReadAccess policies to it:
i. In the console tree, select Archive Server > System > Users and Groups
ii. In the action pane, click New Group.
iii. Enter a Group name and click OK.
iv. In the result pane, on the Groups tab, select the group you just created.
In the action pane, click Add Policy.
v. Select the MonitoringChangeAccess and MonitoringReadAccess
policies and click OK.
b. Read-only access:
Create a new group and assign the MonitoringReadAccess policy to it:

AR100500-01-ACN-EN-04
37.1. Access permission for the Archive Monitoring Web Client
v. Select the MonitoringReadAccess policy and click OK.
3. Do one of the following:
• Assign an existing user to the group.

a. In the action pane, click Add User.
b. Select the user and click OK.
or
• Create a new user and add the user to the group.
a. In the action pane, click New User.
b. Enter user name and password, and, on the next page, select the group
you’ve just created before.
Click Finish.
The user now has full access or read-only access to the Archive Monitoring Web
Client.
37.1.2 Creating a dedicated group for the Archive Monitoring

Web Client (OTDS)
As groups in built-in user management are mapped to the corresponding groups in
OTDS, you can also use the MonitoringChangeAccess and MonitoringReadAccess
policies to control access to the Archive Monitoring Web Client. See below how to
create a user in OTDS who is allowed to use the Archive Monitoring Web Client.
To create a dedicated user and group for uploading (OTDS):
1. Connect to the Archive Server.
2. Create a new group and assign the access-specific policies.
a. Full access:
Create a new group and assign the MonitoringChangeAccess and
MonitoringReadAccess policies to it:
v. Select the MonitoringChangeAccess and MonitoringReadAccess
policies and click OK.
b. Read-only access:
Create a new group and assign the MonitoringReadAccess policy to it:

AR100500-01-ACN-EN-04
v. Select the MonitoringReadAccess policy and click OK.
3. Connect to the server on which OTDS is installed.
4. Create a new (OTDS) group and name it exactly as the group in built-in user
management you created before. The user partition of the new group must be a
member of the access role for the Archive Server resource:
a. In the console tree, select Directory Services > User Partitions > <your user
partition>.
Tip: To verify that the user partition is a member of the access role for
the Archive Server resource, select Directory Services > Access Roles >
<your access role>. In the result pane, the user partition must be listed in
the Members tab.
b. In the action pane, click New Group.
c. Enter the same Group name as in Step 2 before.

Click Next, and then click Finish.
5. You can add an existing user to the group or create a new one. In case of a non-
synchronized resource, you can create a user in the following way:
a. In the console tree, select Directory Services > User Partitions > <your user
partition> and in the action pane, click New User.
b. In the New User wizard, specify all required information and click Finish.
6. In the result pane, on the Groups tab, select the group you’ve just created.
7. In the action pane, click Edit Members.

Search for the user and click Add to Group. Then click OK.
The user now has full access or read-only access to the Archive Monitoring Web
Client.

AR100500-01-ACN-EN-04
37.2. Starting the Archive Monitoring Web Client
37.2 Starting the Archive Monitoring Web Client

To start Archive Server Monitoring from Windows, click
Start > All Programs > OpenText > Archive Monitoring.
To start Archive Server Monitoring in your browser, enter the address

<prot>://<server>.[<domain>]:[<port>]/archive/monitoring
Variable Description Example

<prot> Protocol https orhttp
(not recommend
<server> Name of the administered Archive Server alpha
<domain> Domain at which the server is registered .opentext.co
<port> Port at which Archive Monitoring Server receives HTTPS: 8090,
requests HTTP: 8080
archive/monitoring Command archive/moni
Example: https://archiveserver.example.com:8090/archive/monitoring
After signing in, the Archive Server Monitoring main page displays the links to the
monitoring menus:
• Archive Server Statistics
see “Archive Server Statistics” on page 329
• Archive Server Health Status
see “Archive Server Health Status” on page 330
• Archive Server Threat Detection
see “Threats” on page 332
37.3 Archive Server Statistics

The monitor reports the Archive Server activities for Archiving and Retrieving
documents.
Diagrams show the number of Components and the Data volume handled by the
Archive Server during a specific period of time, as well as the read/write
Performance.
Note: The monitor does not provide archive-specific statistics. The monitor
diagrams refer to all Archive Server activities.
• Supported diagrams:
• Number of components handled by the Archive Server (read/write)
• Data volume (MB) handled by the Archive Server (read/write)

AR100500-01-ACN-EN-04
• Read/write performance (MB/s) of the Archive Server

• Supported time periods:
• Last 24 hours (hourly)

• Last 7 days (daily)
• Last 30 days (daily)
• Last 26 weeks (weekly)
• Last 12 months (monthly)
• Last 36 months (monthly)
• Enabling/disabling the Archive Server statistics
• To enable the Archive Server statistics, the <AS.DS.STATISTIC> and

<AS.DS.USE_ACCOUNTING> variables must be set to on.
• The Archive Server statistics is enabled by default.
• To disable the Archive Server statistics, the <AS.DS.STATISTIC> variable
must be set to off.
• SYS_CONDENSE_STATISTICS job
The SYS_CONDENSE_STATISTICS job compresses the statistics data that are

retrieved per minute (configurable by the <AS.DS.STATISTIC_INTERVAL>
variable) for the hourly, daily, weekly, and monthly statistics display. To get
hourly statistics correctly displayed, the SYS_CONDENSE_STATISTICS job must be
scheduled to run every hour (see “Configuring jobs and checking job protocol“
on page 141).
37.4 Archive Server Health Status

The monitor checks the status and error queues of the Archive Server components
and displays a summary of the status reports.
The component status can be Ok, Warning and Error. Details are displayed for the
following groups:
• “Database” on page 331

• “Storage Manager” on page 331
• “Services” on page 331
• “Pools and Volumes” on page 332
Note: Depending on the installed Document Pipelines and the current Archive
Server configuration, the Health Status can report more status change groups.

AR100500-01-ACN-EN-04
37.4. Archive Server Health Status
37.4.1 Database
The monitor checks the logfiles of tools for database errors.
A warning or error message is issued if, for example, insufficient database

tablespace is detected.
37.4.2 Storage Manager

The monitor checks the Storage Manager (STORM) which administers the jukeboxes
and media: the status of the jbd STORM process is displayed together with an
overview of the volumes in the connected jukebox(es). Physical and virtual fill levels
are shown in the same way.
<jukebox_name>
Provides an overview of the volumes for each attached jukebox. The possible
status specifications are Ok, Warning or Error. Warning means that there are no
writeable volumes or no empty slots in the jukebox. Error is displayed if at least
one corrupt medium is found in a jukebox (display -bad- in Devices in
OpenText Administration Client).
The following information is displayed in Details:
Empty Number of empty slots

Bad Number of faulty (unreadable) volumes
Written Number of written volumes
37.4.3 Services
The monitor checks the Document Service, the Archive Server component that
archives documents and delivers them for display. The monitor checks comprise the
following services:
• Read and write component (jds)

• Administration server (admsrv)
• Backup server (bksrvr)
• Auxiliary server (auxsrvr)
• Timestamp server (tstp)
• Migration component (vmig)
• Storage Manager (jbd)
• Indication whether document processes have been started
• Indication whether a user has tried to access unavailable volumes
• Archive Center scenario: Status of Email services (Email_<xxx>)

AR100500-01-ACN-EN-04
The status of admsrv, bksrvr, tstp, and auxsrvr is Active or Error. Error means that
the component cannot be executed and must be restarted.
The status of the Storage Manager is Active if the server is running. A status of
either Can't call server, Can't connect to server, or Not active indicates that the
server is either not reachable or not running. Check the jbd.log log file for errors. If
necessary, solve the problem and start the Storage Manager again.
The status of unavailable volumes is OK or Warning. Warning means that a

document has been requested from an unavailable volume. The number of
unavailable volumes is displayed in Details. To find out the names of these
volumes, select the Devices directory followed by the Unavailable command in
OpenText Administration Client.
Note: Unavailable volumes can also be seen in Administration Client (see

“Searching configuration variables” on page 242).
37.4.4 Pools and Volumes

The monitor checks the free storage space which is available to the pools (and
therefore the logical archives). The pools and buffers are listed. The availability of
the components depends on two factors. Volumes must be assigned and there must
be sufficient free storage space in the individual volumes.
• The Ok status specifies that volumes are present and sufficient storage space is
available.
• The Error status together with the No volumes present message means that a
volume needs to be assigned to this buffer or pool.
• The Full status refers to disk buffers or hard disk pools and means that there is
no free storage space on the volume. In the case of a hard disk pool, create a new
volume and assign it to this pool.
In the case of a disk buffer, check whether the Purge_Buffer job has been
processed successfully and whether the parameters for this job are set correctly.
37.5 Threats
For each user, the monitor reports the number of components and the data volume
(number of bytes) downloaded per day during the last 30 days.
Note: The period of 30 days can be modified via the AS.

DS.DEFAULT_PERIOD_DAY variable. However, it is strongly recommended to
contact OpenText before modifying the variable setting.
When a defined download quota limit per day and per user is exceeded, a threat
report (event) is created.
• Only one threat report will be sent per day and per user, unless the Threat
Settings are changed during the day.

AR100500-01-ACN-EN-04
37.5. Threats
• The threat report can be forwarded to an email account

• A configurable option allows to block further downloads for the rest of the day if
a user has exceeded the download quota limit.
• Archive Server Threat Detection is disabled by default. It is automatically
enabled if the Threat Settings are customized in the Archive Monitoring Web
Client.
Defining the quota limits
1. In the Threats menu, click on the Settings button (gear icon).

The Threat Settings dialog displays the following options:
• Component quota
• Data volume quota (MB)
• Block user
• Notify to
2. Specify the quota limits that, if exceeded, trigger a threat report that is displayed
in the Threats menu.
Click the Back button after each change to the Settings.
• Component quota
Maximum number of components a user has downloaded per day.
• Data volume quota (MB)
Maximum data volume in MB a user has downloaded per day.
• Block user
Specify whether a user is blocked from further downloading, when a quota
limit is exceeded.
Move the slider to the On or Off position.
• Notify to
Specify the E-MAIL SETTINGS for sending a notification message if a user
has exceeded the quota limit.
• By specifying an email address, including sender and email host, the

Threat Detection Email notification is created. The notification is
triggered by the Threat Alert event.
• It is recommended to specify the server name of the Archive Server as
sender. The email host typically uses this name as sender of the email.
3. Click the Back button when all changes to the Settings in the Threat Settings
dialog are complete.
User history list The Threats menu displays the list of users who have exceeded the specified quota
limits.

AR100500-01-ACN-EN-04
• If Block user is set to Off for the quota limit, a warning is displayed.
• If Block user is set to On for the quota limit, further downloading activities are
blocked until midnight..
You can unblock a user’s downloading activities if the specified quota limits
were exceeded:
• Set Block user to Off for the quota limits.
• Specify higher quota limits.
• At midnight, all users’ downloading activities are automatically unblocked.
For each USER HISTORY, the record of retrieving and downloading activities is
displayed in Charts and in Table format.

AR100500-01-ACN-EN-04
Chapter 38
Auditing, accounting, and statistics
38.1 Auditing
The auditing feature of Archive Server traces events of two aspects:
• It records the document lifecycle, or history of a document, when the document

was created, modified, migrated, deleted etc. These are the events of the
Document Service.
• It records administrative jobs performed with Administration Client.
Important
Administrative changes are only recorded if they are done with
Administration Client. To get complete audit trails, make sure that other
ways of configuration cannot be used, for example, editing configuration
files directly. At least, such tasks must be logged by other means.
The auditing data is collected in separate database tables and can be extracted from
there with the exportAudit command to files, which can be evaluated in different
ways.
38.1.1 Configuring auditing

The administrative auditing is permanently active. You cannot switch it off.
To audit the lifecycle of the documents, activate the Auditing option of the archive.
As the auditing mode is related to logical archives, enable it for each archive that is
subject to auditing.
38.1.2 Accessing auditing information

The auditing information is stored in the database, in two specific tables – one for
the document-related information, the other for administration-related information.
You can extract the data into files and then evaluate the files.
Cleanup job
Administrative audit information is kept in the database. If you never want

to evaluate it, you can delete it from the database with the
SYS_CLEANUP_ADMAUDIT job (Audit_Sweeper command). The job is normally
deactivated and deletes data that is older than the number of days
configured in Configuration. Search for the Time to keep audit records in
database variable (internal name: ADMS_AUDIT_MAX_RECORD_AGE).

AR100500-01-ACN-EN-04
Chapter 38 Auditing, accounting, and statistics
Note: If you need database reports adapted to your requirements, contact

OpenText Global Technical Services.
exportAudit To extract the data of the document-related information to files, use the command
exportAudit -S
To extract the data of the administration-related information to files, use the
command
exportAudit -A
The files are stored in the <OT var>/audit directory.
Options With further options, you can adapt the output to your needs. For example, you
should probably define the timeframe for data extraction (-s and -e options).
Without these dates, you get all audit data until the current date and time, which
could result in very big files and exporting times.
Run exportAudit /? to get a list of all options.
Example 38-1: Microsoft Excel output of document audit information
Command:
exportAudit -S -s 2005/07/14:12:00:00 -e 2005/07/19:08:00:00 -o
csv -h -a
The result of an extraction of document-related audit information in Excel

looks like shown in the graphic. The options -S -o csv -a -h were set,
which results in a filename like this:
STR-2005_07_04_12_00_00-2005_07_19_08_00_00-ALL.csv
The time is displayed in seconds since 1970/1/1. To convert it to a more

readable format (“TT/MM/JJJJ hh:mm”) you can use this Excel function:
=sum(<timestamp cell>/86400;25569)
The following table gives an overview of the logged events.
Event Description
EVENT_CREATE_DOC Document created
EVENT_CREATE_COMP Document component created on volid1
EVENT_UPDATE_ATTR Attributes updated
EVENT_TIMESTAMPED Document timestamped on volid1 (dsSign,
dsHashTree)

AR100500-01-ACN-EN-04
38.2. Accounting
Event Description
EVENT_TIMESTAMP_VERIFIED Timestamp verified on volid1
EVENT_TIMESTAMP_VERIF_FAILED Timestamp verification failed on volid1
EVENT_COMP_MOVED Document component moved from HDSK volid1
to volid2 (dsCD etc. with -d)
EVENT_COMP_COPIED Document component copied from volid1 to
volid2 (dsCD etc. without -d)
EVENT_COMP_PURGED Document component purged from HDSK volid1
(dsHdskRm)
EVENT_COMP_DELETED Component deleted from volid1
EVENT_COMP_DELETE_FAILED Component deletion from volid1 failed
EVENT_COMP_DESTROYED Component destroyed from volid1
EVENT_DOC_DELETED Document deleted
EVENT_DOC_MIGRATED Document migrated
EVENT_DOC_SET_EVENT setDocFlag with retention called
EVENT_DOC_SECURITY Security error when attempting to read doc
Related Topics
• “Searching configuration variables” on page 242
38.2 Accounting
Archive Server allows collecting of accounting data for further analysis and billing.
To use accounting:
1. Enable the Accounting option and configure accounting in Configuration; see

“Settings for accounting” on page 338.
The Document Service writes the accounting information into accounting files.
2. Evaluate the accounting data; see “Evaluating accounting data” on page 338.
3. Schedule the Organize_Accounting_Data job to remove the old accounting

data (see “Setting the start mode and scheduling of jobs” on page 148).

AR100500-01-ACN-EN-04
38.2.1 Settings for accounting

The settings for accounting and for the Organize_Accounting_Data job are defined
in the Configuration node. Search for the following variables (see “Searching
configuration variables” on page 242):
• Accounting Library variable (internal name: ACC_LIBNAME)
• Days until organizing accounting files variable (internal name:
ACC_DATA_AS_FILE)
• Enable Accounting variable (internal name: USE_ACCOUNTING)
Note: By default, accounting is enabled. To deactivate accounting, set the

Enable Accounting variable to OFF.
• Loglevel for extracting accounting data variable (internal name:
ACC_CGI_LOGLEVEL)
• Method to organize old accounting files variable (internal name:
ACC_DATA_METHOD)
• Path to accounting data files variable (internal name: ACC_DATA_PATH)
• Pool for the accounting data variable (internal name: ACC_DATA_POOL)
• Separator for columns in accounting files variable (internal name:
ACC_COL_SEPARATOR)
Suppressed Accounting is disabled for the following jobs by default: INFO (7), ADMINFO (25),
jobs and SRVINFO (26). If you want to enable accounting for any of these jobs, you must
add the configuration variable ACC_SUPPRESSED_JOBS to the DS.setup file. The
value of the variable must hold all job numbers that are to be disabled for
accounting, separated by commas. A value of 0 means that no job is disabled. For
details, see the Knowledge Base article 15666398 (https://knowledge.opentext.com/
knowledge/llisapi.dll/Open/15666398).
Further For detailed information on configuration settings, see “Configuration parameter

information reference” on page 357.
38.2.2 Evaluating accounting data

Accounting files are CSV files; the data columns are separated by tabs. You can
evaluate small files directly in a spreadsheet program like Microsoft Excel.
Normally, you import the data from the files into a database like Microsoft Access
and use reports for evaluation. Make sure that you configure and schedule the
Organize_Accounting_Data job in a way that only evaluated data is deleted or
archived.

AR100500-01-ACN-EN-04
38.2. Accounting
Table 38-1: Fields in accounting files
Name Description Example

TimeStamp Time of the request in seconds after 1261926317
01/01/1970 (i.e. 2009/12/27 16:05:17)
JobNumber Internal request number; see table 24
below
RequestTime Time to complete the execution of the 422
request in 1/1000 s
Client IP address of the client (or proxy 127.0.0.1
Address server)
ContentServer ID of the logical archive DD
UserId Actual or automatically generated <user name>
user ID or something like
149.235.35.28.20010912.10.44.54
ApplicationId ID of the application that sent the dsh
request
DocumentId ID of the document that was affected E429B8ED8FA6D511A0630050D
by the request A78D510
NumComponents Number of components involved in 2
the request
ComponentId Component ID of one of the data
components involved in this request
ContentLength Data size of the request in bytes
Table 38-2: Job numbers and names of requests
Job name Job number Job name Job number

GETCOMP 2 MCREATE 23
PUTCOMP 3 PUTCERT 24
CREATCOMP 4 ADMINFO 25
UPDCOMP 5 SRVINFO 26
APPCOMP 6 CSRVINFO 27
INFO 7 VALIDUSER 28
PUT 8 VERIFYSIG 29
CREATE 9 SIGNURL 31
UPDATE 10 GETCERT 32
LOCK 11 ANALYZE_SEC 34
UNLOCK 12 RESERVEID 35
SEARCHATTR 13 SETDOCFLAG 36

AR100500-01-ACN-EN-04
Job name Job number Job name Job number

SEARCH 14 ADS_GETATS 37
SEARCHFREE 15 ADS_VERIFYATS 38
DGET 16 ADS_MIGRATE 39
GETATTR 17 ADS_DOCHISTOR 40
Y
SETATT 18 ADS_CREPLACEH 41
DELATTR 19 ADS_CSRVINFO2 42
DELETE 20
If you archive the old accounting data, you can also access the archived files. The
Organize_Accounting_Data job writes the DocIDs of the archived accounting files
into the ACC_STORE.CNT file which is located in the accounting directory (defined in
Path to accounting data files).
To restore archived accounting files, you can use the command
dsAccTool -r -f <target directory>
The tool saves the files in the <target directory> where you can use them as usual.
38.3 Storage Manager statistics

For Storage Manager statistics, see OpenText Archive Center - STORM Configuration
Guide (AR-IST) in the Knowledge Center (https://knowledge.opentext.com/
knowledge/llisapi.dll/open/12331031).

AR100500-01-ACN-EN-04
Part 7
Troubleshooting
Chapter 39
Basics
This part is written as an introduction to troubleshooting and error analysis. It presents

tools and methods that can help you to find out the cause of a problem. It does not
explain solutions for a single problem or error. This kind of information and a lot of
useful hints and tips can be found in the KC (https://knowledge.opentext.com/
knowledge/llisapi.dll/Open/12331031) and the Knowledge Base (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/Knowledge).
39.1 Avoiding problems

It is still the better strategy to avoid problems than to solve them. Therefore, you
should consider these hints in your daily work.
• Backup the storage media, the database, and the STORM configuration files
regularly.
• Use the Archive Monitoring Web Client to monitor Archive Server. Thereby, you
can react quickly if a problem occurs.
• Check the job protocol in the OpenText Administration Client.
• Make sure that there is enough space available (storage media, disk buffers,
database, exchange directory, etc.).
• Configure notifications that will be sent in case of problems (see “Monitoring
with notifications“ on page 315).
• Follow the major upgrades of the software.
• Train your archive administrators and users.
• Take care for regularly maintenance of your hardware. Hardware service
contracts can help.
This documentation provides detailed instructions for configuration, maintenance,

and monitoring. If you maintain and administer your archive system in the
described way, you can avoid many problems or recognize occurring problems at
the beginning.

AR100500-01-ACN-EN-04
Chapter 39 Basics
39.2 Viewing installed Archive Server patches

This utility lists all the patches installed on the Archive Server. If you are searching
for a specific patch, the utility can be restricted to individual Archive Server
software packages.
This list is useful when you contact the OpenText Customer Support.
To view installed patches:
2. Select the View Installed Archive Server Patches utility.
4. In the field View patches for packages enter the package whose patches you
want to list. Leave the field empty to view all packages.
5. Click Run to start the utility.
A window with the installed patches opens.
Related Topics
39.3 Correcting wrong installation settings

The installation guides state the following about the directories for assembling the
ISO images:
“The CDDIR and CDIMG directories must be different.

The VAR directory must not be a subdirectory of either these directories.”
If, however, any of these parameters have been chosen inappropriately, you still can
correct them by taking the following steps:
To correct the path of the CDDIR or CDIMG directories:
1. Create the two correct directories in the file system and make sure that they are
owned and writeable by the Archive Spawner user.
2. Correct the directory settings in the configuration:
a. Start Administration Client and log on to the Archive Server.

b. In Configuration, search for the respective variables (see “Searching
c. In the result pane, right-click Directory where ISO trees are built (internal
name: CDDIR), select Properties and set the Global Value to the correct
absolute path of the CDDIR directory.

AR100500-01-ACN-EN-04
39.4. Monitoring and administration tools
Click OK.
d. Analogously, right-click Directory where ISO images are built (internal

name: CDIMG), select Properties and set the Global Value to the correct
absolute path of the CDIMG directory.
Click OK.
3. Restart the Archive Spawner processes (for details, see “Starting and stopping
Archive Server“ on page 347).
39.4 Monitoring and administration tools

To monitor the archive system and to recognize problems, you use the Archive
Administration Utilities and tools delivered with the operation system.
Archive The Archive Administration Utilities are Archive Monitoring Web Client, Document
Administration Pipeline Info, and Administration Client. You can find a short summary of their use
Utilities
in “Everyday monitoring of the archive system“ on page 313.
System tools The most important error messages are also displayed in the Windows Event Viewer
or in the UNIX syslog. This information is a subset of the information generated in
the log files. Use these tools to see the error messages for all components at one
place.
You can prevent the transfer of error messages to the system tools in general or for
single components with the setting Write error messages to Event Log / syslog; see
“Log settings for Archive Server components (Except STORM)” on page 354.
To start the Windows Event Viewer, click

Start > Control Planel > Administrative Tools > Event Viewer.
The syslog file for UNIX is configured in the /etc/syslog.conf file.
39.5 Deleting log files

Archive Server log files
Log files record the jobs of the archive components. The number of log entries and
thus the size of the log files depend on the log level that has been set. Check the size
of the log files regularly and delete larger files. They will be automatically recreated
when Archive Server is started.
The log files for Archive Server can be found in the directory<OT logging>.
Important
Stop the Spawner before you delete the log files!
On client workstations, other log files are used. For more information, refer to the
Imaging documentation.

AR100500-01-ACN-EN-04
Chapter 39 Basics
Oracle database log files
The Oracle database also generates log and trace files for diagnostic purposes. As
administrator, you should regularly check the size of the following files and delete
them from time to time:
Windows
<ORACLE_HOME>\network\log\listener.log (log file)<ORACLE_HOME>
\network\trace\* (trace file)<ORACLE_HOME>\rdbms\trace\*trc
UNIX
$ORACLE_HOME/network/log/listener.log (log file)$ORACLE_HOME/network/
trace (trace file)$ORACLE_HOME/rdbms/log/*.trc/* (trace files)

AR100500-01-ACN-EN-04
Chapter 40
Starting and stopping Archive Server
Archive Server and the database are automatically started by the operating system
when the hardware is started. However, there are situations in which you have to
start or stop Archive Server components manually without shutting down the
hardware, for example, when you back up the system data or when you perform
system administration tasks that require a manual stop of Archive Server
components. A restart can also help to figure out the reason of a problem.
After the restart, read the log file spawner.log in the directory <OT logging>. You
can see whether all the processes have started correctly (see also “Spawner log file”
on page 351).
You can simply use the OpenText Administration Client to start and stop Archive
Server components. If the tool is not available, you can use the Windows Services, or
command line calls. Note that the order in which the components are started or
stopped is important. Call the commands in the given order.
Note: The following commands are not valid for installations in cluster
environments.
40.1 Starting and stopping under Windows

Under Windows, you can use the Services window or the command line to start and
stop the components of Archive Server.
Starting
Windows To start Archive Server using the Windows Services, proceed as follows:
Services
1. To open the Windows Services, do one of the following:
• On the desktop, right-click the My Computer icon and select Manage.

Then open the Services and Applications directory and click Services.
• Open the Control Panel, select Administrative Tools and then Services.
2. Right-click the following entries in the given order and select Start:
• OracleServiceECR or MSSQLSERVER (Oracle Database or SQL Server)

• Oracle<ORA_HOME>TNSListener (only Oracle Database)
• Archive Spawner (archive components)
Command line To start Archive Server from the command line, enter the following commands in
this order:

AR100500-01-ACN-EN-04
Chapter 40 Starting and stopping Archive Server
net start OracleServiceECR (Oracle Database) or net start mssqlserver (SQL

Server)
net start Oracle<ORA_HOME>TNSListener (Oracle Database)
net start spawner (archive components)
Stopping
Windows To stop Archive Server components using the Windows Services, proceed as
Services follows:
1. On the desktop, right-click the My Computer icon and select Manage.

The Computer Management window now opens.
2. Open the Services and Applications directory and click Services.
3. Right-click the following entries in the given order and select Stop:
• Archive Spawner (archive components)

• Oracle<ORA_HOME>TNSListener (Oracle Database)
• OracleServiceECR (Oracle Database) or MSSQLSERVER (SQL Server)
Command line To stop Archive Server components from the command line, enter the following
commands in this order:
net stop spawner (archive components)

net stop Oracle<ORA_HOME>TNSListener (Oracle database)
net stop OracleServiceECR (Oracle Database) or net stop mssqlserver (SQL
Server)
40.2 Starting and stopping under UNIX/Linux

The commands used to start and stop Archive Server differ slightly depending on
the UNIX platform. You call a special script, that calls component-specific scripts
contained in the <OT install SPAWNER>/rc directory, for example:
S15MORA_ECR start (Oracle Database, as user root)
S18BASE start ( Archive Server, as user root)
Starting
Use the commands listed below to restart Archive Server after the archive system
has been stopped without shutting down the hardware.
To start the archive system:
1. Log on as root.
2. Start the archive system including the corresponding database instance with:
HP-UX /sbin/rc3.d/S910spawner
start

AR100500-01-ACN-EN-04
40.3. Starting and stopping single services with spawncmd
AIX /etc/rc.spawner start

Solaris /etc/rc3.d/S910spawner
start
Linux /etc/init.d/spawner start
Stopping
Enter the commands below to terminate Archive Server manually.
To stop the archive system:
1. Log on as root.
2. Terminate the archive system and the database instance with:
HP-UX /sbin/rc3.d/S910spawner
stop
AIX /etc/rc.spawner stop
Solaris /etc/rc3.d/S910spawner
stop
Linux /etc/init.d/spawner stop
Automatically terminating Archive Server on reboot or shutdown
Linux, HP-UX, Under Linux, HP-UX, and Solaris, symbolic links to the startup scripts ensure that
Solaris the archive system is automatically terminated when the host is shut down or
rebooted.
AIX Under AIX, insert the line sh /etc/rc.spawner stop into the /etc/rc.shutdown
script to ensure automatic termination. After a new installation of AIXthis script
does not exist; the system administrator must create it.
40.3 Starting and stopping single services with

spawncmd
Sometimes it can be helpful to start and stop only a single Archive Server process.
To start or stop single services:
1. Under UNIX/Linux, load the Archive Server environment first: <OT config
AS>/setup/profile
2. Check the status of the process with spawncmd status (see “Analyzing
processes with spawncmd” on page 351).
3. Enter the command:

spawncmd {start|stop} <process>

AR100500-01-ACN-EN-04
Chapter 40 Starting and stopping Archive Server
Description of parameters
{start|stop}
To start or stop the specified process.
<process>
The process you want to start or stop. The name appears in the first column of
the output generated by spawncmd status.
Important
You cannot simply restart a process if it was stopped, regardless of the
reason. This is especially true for Document Service, since its processes must
be started in a defined sequence. If a Document Service process was stopped,
it is best to stop all the processes and then restart them in the defined
sequence. Inconsistencies can also occur when you start and stop the monitor
program or the Document Pipelines this way.
Example 40-1: Starting the Notification Server
spawncmd start notifSrvr
40.4 Setting the operation mode of Archive Server

Besides the normal operation mode, maintenance modes are available. Thus, you
can restrict the access to the Archive Server when performing maintenance tasks or
troubleshooting.
To set the operation mode:
1. Open the Archive Server object in the console tree.
2. Click Modify Operation Mode in the action pane.

Select the operation mode.
No maintenance mode
No restrictions to access the server.
Documents cannot be deleted, errors are returned

Deletion is prohibited for all archives, no matter what is defined for the
archive access. Errors are returned and a message informs about deletion
requests.
Use full maintenance mode

Clients cannot access Archive Server, and thus not display and archive
documents. Only administration and access via the Administration Client is
possible.
3. Click OK.

AR100500-01-ACN-EN-04
Chapter 41
Analyzing problems
Note: The following commands and paths for log files are not valid for
installations in cluster environments.
41.1 Spawner log file

The Spawner log file spawner.log provides an overview of all processes running on
the Archive Server. It is created upon the first Spawner start; when the file exists,
new information is appended. After a restart, check this file to make sure all the
processes were started correctly. You can review this information also in the Archive
Monitoring Web Client, but under certain conditions you have faster access to the
information in the log file. You can set the log level for this file in the <OT inst
Spawner>/config/setup/SPAWNER.Setup file.
41.2 Analyzing processes with spawncmd

The Archive Spawner starts all archive processes. By the same token, when the
Spawner is shut down, the archive processes are shut down. You can also query the
status of the archive processes, and stop and restart individual processes. This can
be useful when you are performing diagnostic analysis of the archive processes.
Note: The Spawner must be running on the computer for these commands to
take effect.
Command Under UNIX/Linux, load Archive Server environment first: <OT config AS>/setup/
profile. Under all environments, open a command line.
To run a command, enter spawncmd <command>.

To display a list of all Spawner commands, just enter spawncmd.
The commands include:
• exit
• reread
• restart <service>
• start <service>
• stop <service>
• startall
• status
• stopall
spawncmd The following table briefly lists the description of some processes. Enter spawncmd
status status to get the current status.

AR100500-01-ACN-EN-04
Chapter 41 Analyzing problems
Process Description
bksrvr Backup server process
Clnt_dp Client to monitor the Document Pipelines
Clnt_ds Client to monitor the Document Service
dp Document Pipelines
ixmonSvc Monitor server process
jbd STORM daemon
notifSrvr Notification server process
timestamp Timestamp Server
doctods, Various DocTools
docrm, ...
You get a result list with the following content:
• Process name, for example, Clnt_dp.

• Process status:
• R means the process is running. All processes should have this status with the
exception of chkw (checkWorms), stockist and dsstockist; and under
Windows, additionally db.
• T means the process was terminated. This is the normal status of the
processes chkw (check worms), stockist, and dsstockist; and under
Windows, additionally db. If any other process has the status T, it indicates a
possible problem.
The processes chkw and db are validation processes; stockist and
dsstockist are initializing processes. They are terminated automatically as
soon as they finished their task.
• S means the Spawner waits for the process to synchronize.
• Process ID, start and stop time.
The information provided by this command is similar to that displayed by the

Archive Monitoring Web Client. Invoking the information with this command can
be faster, depending on your work environment. Although the Monitor displays
more information about the objects, its information is not always completely up-to-
date. On the other hand, the Spawner does not have detailed information about the
started processes, but its information about whether the processes are running or not
is always up-to-date.
You can find information about the DocTools in Document Pipeline Info. This
interface allows you to start and stop single DocTools and to resubmit documents
for processing.

AR100500-01-ACN-EN-04
41.3. Working with log files
41.3 Working with log files

Log files are generated by the different components of Archive Server to report on
their operations. Log files are also generated for each DocTool as well as for the read
and write components of the Document Service. The result is a wealth of diagnostic
information.
41.3.1 About log files

Location All log files of Archive Server components but the as.log file – including STORM –
are located in the same directory: <OT logging>. as.log is located in the Tomcat
home/logs directory.
The log file names indicate the processes.
If you have a If a problem arises, carry out the following steps:

problem
1. Check in the Archive Monitoring Web Client in which component of Archive
Server the problem has occurred.
2. Locate the corresponding log file in the filesystem. The protocol is written
chronologically and the last messages are at the end of the file.
Note: The system might write several log files for a single component, or
several components are affected by a problem. To make sure you have the
most recent log files, sort them by the date.
Log file analysis When analyzing log files, consider the following:
• The message class, that is the error type, is shown at the beginning of a log entry.
• The latest messages are at the end of the file.
Note: In jbd.log, old messages are overwritten if the file size limit is
reached. In this case, check the date and time to find the latest messages.
• Messages with identical time label normally belong to the same incident.
• The final error message denotes which action has failed. The messages before
often show the reason of the failure.
• A system component can fail due to a previous failure of another component.
Check all log files that have been changed at the same or similar time. The time
labels of the messages help you to track the causal relationship.

AR100500-01-ACN-EN-04
Chapter 41 Analyzing problems
41.3.2 Setting log levels

You can set the log levels using Administration Client.
The logging of the Storage Manager differs from the logging of other archive
components. To configure the STORM log levels, see OpenText Archive Center -
STORM Configuration Guide (AR-IST).
To change log levels:
1. Start Administration Client and sign in to Archive Server.
2. In the console tree, select Archive Server > Configuration.
3. In the result pane, expand Logging. To change the log level for a certain
component, edit the configuration variable for the corresponding component in
the lower part of the result pane.
Note: If log levels are changed, the component must be restarted.
41.3.3 Log settings for Archive Server components (Except

STORM)
The log settings are configured for each component of Archive Server. Default
values are set during installation.
Permanent log The following incidents are always written to the log files, and usually also to the
levels Event Viewer or Syslog. You cannot switch off the corresponding log levels.
• Fatal errors indicate fatal application errors that mostly lead to server crashes
(message type FTL).
• Important errors (message type IMP).
• Security errors indicate security violations such as invalid signatures (message
type SEC).
• Errors indicate serious application errors (message type ERR).
• Warnings indicate potential problem causes (message type WRN).
Log levels for The following log levels are relevant for troubleshooting. You can change them in
troubleshooting the Server Configuration; see “Setting log levels” on page 354.
Important
Higher log levels can generate a large amount of data and even can slow
down the archive system. Reset the log levels to the default values as soon as
you have solved the problem. Delete the log files only after you have
stopped the Spawner.

AR100500-01-ACN-EN-04
41.3. Working with log files
Setting in Server Default Description Message Variable

Configuration type
Maximum size of a log depends If the log file exceeds this MAXLOGSIZE
file on size, it is renamed to
compon <filename>.old and a
ent new log file is created. If
there is an old
<filename>.old, it is
dropped.
Log Info Messages off Read configuration INF LOG_INFO
entries and received
commands. Most useful
for troubleshooting and
detection configuration
faults.
Log Database Debug off All jobs concerning the DB LOG_DB
messages database.
Caution: High amount of
logging information,
huge log files,
performance loss!
Log HTTP Data off Traces data transmitted no type, LOG_HTTP
only for Document via HTTP no time
Service (persistent) label
Log Error Messages on Serious application ERR LOG_ERROR
only for BASE package errors.
Do not switch off!
Log Warning Messages on Conditions that cause WRN LOG_WARN
only for BASE package problems.
and Document Service Do not switch off!
(persistent)
Log Debug Messages off Debug information. DBG LOG_DEBUG
Caution: High amount of
logging information,
huge log files,
performance loss!
Log RPC Messages off RPC Calls RPC LOG_RPC
Log Entry/Leave off Messages if a function is ENT LOG_ENTRY
Messages entered or left
Time setting Additionally to the log levels, you can define the time label in the log file for each
component. Normally, the time is given in hours:minutes:seconds. If you select
Log using relative time, the time elapsed between one log entry and the next is
given in milliseconds instead of the date, additionally to the normal time label. This
is used for debugging and fine tuning.

AR100500-01-ACN-EN-04
Part 8
Configuration parameter reference
Chapter 42
Introduction
This is a reference of all parameters (also called variables) that are relevant for the
administration of
• Archive Server
• Document Pipeline
• Email Cloud Archiving (Archive Center scenarios)
• File Archiving (Archive Center scenarios)
• Archive Monitoring Server
• Archive Cache Server
Notes
• Parameters that are listed by the administration client, but are not described
in this reference, are provided for service purposes only and should not be
modified.
• The configuration parameter documentation uses a modular approach.
Therefore, the order of the documented components does not appear in an
alphabetical order like in the dialogs, but is grouped by certain functional
aspects.
For the individual components and building blocks described in this documentation
module, the reference lists all relevant configuration parameters and usually
provides the following information for each of them:
• Storage location: The file where the parameter is stored. This information is
for your reference; note that you should preferably access the configuration
parameters via the administration client to ensure that your settings are
consistent. See “Configuration Files” on page 360 for details.
• Variable name: The name of the parameter
• Description: The meaning of the parameter
• Type: Data type of the variable, often with upper and/or lower limit
• Predefined value
• Allowed value: Lists all allowed values, if there is a specific set of allowed
values. Note that an allowed value range can also be specified by the limits noted
with the Type information (see above).
• Protection status: Some variables are read-only for the administration client,
i.e. they can be displayed there, but cannot be changed. This is specified via the

AR100500-01-ACN-EN-04
Chapter 42 Introduction
protection status. If no protection status is specified for a variable, it can be read

and written by the Server Configuration.
42.1 Configuration Files

Preferably, all settings should be viewed and edited using the provided
administration software. However, for Document Pipeline and Archive Monitoring
Server, the settings are written to configuration files which are accessible as well. In
these files, parameter definitions have the format PARAMETER=VALUE. Lines that
begin with “#” are comments.
Therefore, the references for the related paramaters specify this storage location at the
beginning of each page; it applies to al parameters listed on that page.
The path specified in the storage location refers to the following variables:
ECM_ARCHIVE_SERVER_CONF
Installation folder of Archive Server; the folder used on your system is listed in
the file C:\ProgramData\Open Text\conf_dirs\10AS.conf (Windows) or /
etc/opentext/conf_dirs/10AS.conf (UNIX).
ECM_DOCUMENT_PIPELINE_CONF
Installation folder of Document Pipelines; the folder used on your system is
listed in the file C:\ProgramData\Open Text\conf_dirs\20DP.conf
(Windows) or /etc/opentext/conf_dirs/20DP.conf (UNIX).
ECM_MONITOR_SERVER_CONF
Installation folder of Monitor Server; the folder used on your system is listed in
the file C:\ProgramData\Open Text\conf_dirs\80MONS.conf (Windows) or /
etc/opentext/conf_dirs/80MONS.conf (UNIX).
ECM_CACHE_SERVER_CONF
Installation folder of Cache Server; the folder used on your system is listed in the
file C:\ProgramData\Open Text\conf_dirs\30AS.conf (Windows) or /etc/
opentext/conf_dirs/30AS.conf (UNIX).
42.2 Priorities
Although some parameters can be defined in more than one place, the parameter
with the highest priority will have precedence over the same parameter with a lower
priority. The priorities are listed here.
First priority (highest):

The Administration Server (ADMS) configuration parameters.
Second priority:
The Document Service (DS) configuration parameters.
Third priority:
The COMMON configuration parameters.

AR100500-01-ACN-EN-04
42.3. General Installation Variables
Fourth priority (lowest):

Process environment variables.
The listed default values are values included in the program codes. Some of these
values are not set in the setup files during the installation process. The default values
will be used if configuration parameters are missing or have no value in the registry
or in the setup files.
42.3 General Installation Variables

Package installed on
• Read-only variable
• Variable name: INSTALL_DATE
• Description: Date of installation/configuration: dd-mm-yyyy
Installation type
• Variable name: INSTALL_TYPE
• Description: Type of installation/configuration: “INSTALL” or “UPGRADE”
Installed version
• Variable name: INSTALL_VERS
• Description: Version as found in the version.txt file of the corresponding
package.
42.4 Configuration of Log Files

Log Debug Messages
• Variable name: LOG_DEBUG
• Allowed value: off, on
• Default value: off
• Description: These define the log levels of the DEBUG type which are output
to the log files. The log levels LOG_FATAL, LOG_ERROR and LOG_IMPOT are
always set and cannot be disabled. In the case of LOG_FATAL and LOG_ERROR,
a message is output to the system logger (i.e. to syslog in UNIX or to the
Event Logger in NT) in addition to that entered in the log file, provided the
USE_EVENT_LOG parameter is not set to 0. The levels LOG_WARNING to
LOG_ENTRY are normally not set, although there is no harm in setting
LOG_WARNING and LOG_RESULT. A log level can be switched on using
LOG_WARNING=on .
Log Database Debug Messages

• Variable name: LOG_DB

AR100500-01-ACN-EN-04

• Description: These define the log levels of the DB type (database related
debug messages) which are output to the log files. The log levels LOG_FATAL,
LOG_ERROR, LOG_IMPOT, and LOG_SECU are always set and cannot be
disabled. In the case of LOG_FATAL and LOG_ERROR, a message is output to
the system logger (i.e. to syslog in UNIX or to the Event Logger in NT) in
addition to that entered in the log file, provided the USE_EVENT_LOG
parameter is not set to 0. The levels LOG_WARNING to LOG_ENTRY are normally
not set, although there is no harm in setting LOG_WARNING and LOG_RESULT.
A log level can be switched on using LOG_WARNING=on.
Log Function Entry Messages

• Variable name: LOG_ENTRY
• Description: These define the log levels of the ENTRY type which are output
to the log files. Messages of this type are generated at every function call-up
and therefore fill the log file very quickly. The log levels LOG_FATAL,
LOG_ERROR, LOG_IMPOT, and LOG_SECU are always set and cannot be
disabled. In the case of LOG_FATAL and LOG_ERROR, a message is output to
the system logger (i.e. to syslog in UNIX or to the Event Logger in NT) in
addition to that entered in the log file, provided the USE_EVENT_LOG
parameter is not set to 0. The levels LOG_WARNING to LOG_ENTRY are normally
not set, although there is no harm in setting LOG_WARNING and LOG_RESULT.
A log level can be switched on using LOG_WARNING=on.
Log Info Messages

• Variable name: LOG_INFO
• Description: These define the log levels of the INFO type which are output to
the log files. Messages of this type are output for important processing steps.
The log levels LOG_FATAL, LOG_ERROR, LOG_IMPOT, and LOG_SECU are
always set and cannot be disabled. In the case of LOG_FATAL and LOG_ERROR,
a message is output to the system logger (i.e. to syslog in UNIX or to the
Event Logger in NT) in addition to that entered in the log file, provided the
USE_EVENT_LOG parameter is not set to 0. The levels LOG_WARNING to
LOG_ENTRY are normally not set, although there is no harm in setting
LOG_WARNING and LOG_RESULT. A log level can be switched on using
LOG_WARNING=on .
Log using relative time

• Variable name: LOG_REL
• Description: If this parameter is set to on, the time difference in milliseconds
between each message and its predecessor will be recorded in the log files
instead of the date. This is used for debugging and tuning purposes.

AR100500-01-ACN-EN-04
42.4. Configuration of Log Files
Log Result Messages

• Variable name: LOG_RESULT
• Description: These define the log levels of the RESULT type which are output
to the log files. The log levels LOG_FATAL, LOG_ERROR, LOG_IMPOT, and
LOG_SECU are always set and cannot be disabled. In the case of LOG_FATAL
and LOG_ERROR, a message is output to the system logger (i.e. to syslog in
UNIX or to the Event Logger in NT) in addition to that entered in the log file,
provided the USE_EVENT_LOG parameter is not set to 0. The levels
LOG_WARNING to LOG_ENTRY are normally not set, although there is no harm
in setting LOG_WARNING and LOG_RESULT. A log level can be switched on
using LOG_WARNING=on.
Log RPC Debug Messages

• Variable name: LOG_RPC
• Description: Specifies whether messages of the RPC type (debug messages
related to remote procedure call details) which are output to the log files.
If set to on, RPC messages and low level socket operation for HTTP are
logged.
Log User Error Messages

• Variable name: LOG_UERROR
• Description: These define the log levels of UERROR type which are output to
the log files. The log levels LOG_FATAL, LOG_ERROR, LOG_IMPOT, and
LOG_SECU are always set and cannot be disabled. In the case of LOG_FATAL
and LOG_ERROR, a message is output to the system logger (i.e. to syslog in
UNIX or to the Event Logger in NT) in addition to that entered in the log file,
provided the USE_EVENT_LOG parameter is not set to 0. The levels
LOG_WARNING to LOG_ENTRY are normally not set, although there is no harm
in setting LOG_WARNING and LOG_RESULT. A log level can be switched on
using LOG_WARNING=on.
Log HTTP data

• Variable name: LOG_HTTP_DATA
• Description: If on, incoming and outgoing HTTP data will be logged with
loglevel LOG_DEBUG. LOG_DEBUG must also be set.
Write error messages to Event Log / syslog

• Variable name: USE_EVENT_LOG

AR100500-01-ACN-EN-04

• Description: If this parameter is set to off, no error messages are written to
the system log (syslog in UNIX, Event Log in Windows NT and 2000).
Maximum size of a logfile (in bytes)

• Variable name: MAXLOGSIZE
• Default value: 1000000, unit: bytes
• Description: This specifies the maximum size of a log file. Once this size is
exceeded, the old log file is renamed filename.old and a new log file is
started.

AR100500-01-ACN-EN-04
Chapter 43
Archive Server
43.1 Administration Server (ADMS)

Storage location:
- Windows: Configuration file: <ECM_ARCHIVE_SERVER_CONF>\config\setup
\ADMS.Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/ADMS.
Setup
Port of the Administration Server (ADMS_PORT)
• Variable name: AS.ADMS.ADMS_PORT

• Protection: Read-only variable
• Description:
This variable specifies the RPC port number on which the Administration
Server listens.
• Type: Integer (min: 0, max: 65535)
• Predefined Value: 4034
Protocol used in communication with known servers

(ADMS_KNOWN_SERVER_PROTOCOL)
• Variable name: AS.ADMS.ADMS_KNOWN_SERVER_PROTOCOL

• Description:
This variable specifies the protocol used for communication between
different Administration Servers.
• Type: Enum
• Predefined Value: http
• Allowed Value:
• http ("http")
• https ("https")
Timeout for RPCs to Document Service (ADMS_DS_TIMEOUT)
• Variable name: AS.ADMS.ADMS_DS_TIMEOUT

• Description:
This variable specifies the timeout for remote procedure calls from the
administration server to the Document Service.

AR100500-01-ACN-EN-04
43.1.1 Jobs and Commands

Storage location:
\ADMS.Setup
Setup
Extra delay for jobs on current node (ADMS_JOB_NODE_DELAY)

• Variable name: AS.ADMS.ADMS_JOB_NODE_DELAY
• Description:
This variable specifies the number a seconds by which scheduled jobs are
delayed on the current node. Setting this value may be useful in a cluster to
avoid starting jobs on multiple cluster nodes at the same time.
43.1.1.1 SYS_CLEANUP_PROTOCOL
Storage location:
\ADMS.Setup
Setup
Duration after job protocol entries expire (ADMS_PROTOCOL_MAX_AGE)

• Variable name: AS.ADMS.ADMS_PROTOCOL_MAX_AGE
Max. number of job protocol entries (ADMS_PROTOCOL_MAX_SIZE)

• Variable name: AS.ADMS.ADMS_PROTOCOL_MAX_SIZE

AR100500-01-ACN-EN-04
43.1. Administration Server (ADMS)
43.1.1.2 Local_backup
Storage location:
\ADMS.Setup
Setup
Allow backups (MAYBACKUP)

• Variable name: AS.ADMS.MAYBACKUP
• Description:
This variable controls whether or not backups are allowed. The administrator
can set this variable instead of disabling all backup jobs.
• Type: Flag
• Predefined Value: on
• Allowed Value:
• on
• off
43.1.1.3 Delete_Empty_Volumes
Storage location:
\ADMS.Setup
Setup
Delete volumes which are more than 'percent' full

(ADMS_DEL_VOL_AT_LEAST_FULL)
• Variable name: AS.ADMS.ADMS_DEL_VOL_AT_LEAST_FULL
• Description:
This variable specifies the default value for the “-f” option of the program
dsPurgeVol which is called by the Delete_Empty_Volumes job. See
dsPurgeVol usage for further information.
Delete volumes which have not been modified since 'days'

(ADMS_DEL_VOL_NOT_MODIFIED_SINCE_DAYS)
• Variable name: AS.ADMS.ADMS_DEL_VOL_NOT_MODIFIED_SINCE_DAYS
• Description:
This variable specifies the default value for the “-a” option of the program
dsPurgeVol which is called by the Delete_Empty_Volumes job. See
dsPurgeVol usage for further information.

AR100500-01-ACN-EN-04
43.1.1.4 SYS_EXPIRE_ALERTS
Storage location:
\ADMS.Setup
Setup
Duration after alerts expire (ADMS_ALRT_EXPIRE)

• Variable name: AS.ADMS.ADMS_ALRT_EXPIRE
• Description:
This variable specifies the duration in hours after an alert expires. Expired
alerts will be deleted by the SYS_EXPIRE_ALERTS job.
43.1.1.5 SYS_CLEANUP_ADMAUDIT
Storage location:
\ADMS.Setup
Setup
Time to keep audit records in database (ADMS_AUDIT_MAX_RECORD_AGE)

• Variable name: AS.ADMS.ADMS_AUDIT_MAX_RECORD_AGE
• Description:
Sets the number of days an audit record must be kept in the database before
it may be removed by the SYS_CLEANUP_ADMAUDIT job.
43.1.2 Buffers
Storage location:
\ADMS.Setup
Setup

AR100500-01-ACN-EN-04
43.1.3 Archives
Storage location:
\ADMS.Setup
Setup
43.1.3.1 Security
Storage location:
\ADMS.Setup
Setup
Authentication (SecKey) required to (ADMS_ARCH_PROT_LEVEL)
• Variable name: AS.ADMS.ADMS_ARCH_PROT_LEVEL

• Description:
This variable specifies the default authentication settings (SecKeys) for new
created archives. This setting can be changed in the archive properties.
Use these flags:
• “r” for Read documents

• “c” for Create documents
• “u” for Update documents
• “d” for Delete documents
Use this syntax: @P=flags

• Type: String
• Predefined Value: @P=rcud
Document deletion (ADMS_ARCH_DOC_DEL)
• Variable name: AS.ADMS.ADMS_ARCH_DOC_DEL

• Description:
Default value for the “Document Deletion behavior” property assigned to
newly created archives. The archive's flag can later be changed in the
Archive Administration.
• Type: Enum
• Predefined Value: @DD=y
• Allowed Value:
• @DD=y ("Deletion is allowed")

• @DD=n ("Deletion causes error")
• @DD=i ("Deletion is ignored")

AR100500-01-ACN-EN-04
Security level (ADMS_ARCH_SSL)
• Variable name: AS.ADMS.ADMS_ARCH_SSL

• Description:
This variable specifies the default security setting for new created archives.
This setting can be changed later in the archive properties.
• Type: Enum
• Predefined Value: @S=m
• Allowed Value:
• @S=m ("May use SSL")

• @S=y ("Use SSL")
• @S=n ("Do not use SSL")
43.1.3.2 Settings
Storage location:
\ADMS.Setup
Setup
Automatic delete (ADMS_ARCH_AUTO_DELETE)
• Variable name: AS.ADMS.ADMS_ARCH_AUTO_DELETE

• Description:
This variable specifies the default value for the archive property “Automatic
Delete” assigned to newly created archives.
• Type: Enum
• Predefined Value: @AD=n
• Allowed Value:
• @AD=y ("on")
• @AD=n ("off")
Blobs (ADMS_ARCH_BLOBS)
• Variable name: AS.ADMS.ADMS_ARCH_BLOBS

• Description:
This variable specifies the default value for the archive property “Blobs”
assigned to new created archives. This setting can be changed later in the
archive properties.
• Type: Enum
• Predefined Value: @B=n
• Allowed Value:
• @B=y ("on")
• @B=n ("off")

AR100500-01-ACN-EN-04
Caching mode (ADMS_ARCH_CACHE)

• Variable name: AS.ADMS.ADMS_ARCH_CACHE
• Description:
This variable specifies the default value for the archive property “Cache
enabled” assigned to new created archives. This setting can be changed later
in the archive properties.
• Type: Enum
• Predefined Value: @C=n
• Allowed Value:
• @C=y ("on")
• @C=n ("off")
Compression (ADMS_ARCH_CMP)
• Variable name: AS.ADMS.ADMS_ARCH_CMP
• Description:
This variable specifies the default value for the archive property
“Compression” assigned to new created archives. This setting can be
changed later in the archive properties.
• Type: Enum
• Predefined Value: @Cmp=y
• Allowed Value:
• @Cmp=y ("on")
• @Cmp=n ("off")
Delayed archiving (ADMS_ARCH_DELAY)

• Variable name: AS.ADMS.ADMS_ARCH_DELAY
• Description:
This variable specifies the default value for the archive property “Delayed
archiving” assigned to new created archives. This setting can be changed
later in the archive properties.
• Type: Enum
• Predefined Value: @DA=n
• Allowed Value:
• @DA=y ("on")
• @DA=n ("off")
Encryption (ADMS_ARCH_ENC)
• Variable name: AS.ADMS.ADMS_ARCH_ENC
• Description:
This variable specifies the default value for the archive property
“Encryption” assigned to new created archives. This setting can be changed
later in the archive properties.

AR100500-01-ACN-EN-04
• Type: Enum
• Predefined Value: @E=n
• Allowed Value:
• @E=y ("on")
• @E=n ("off")
Hold (ADMS_ARCH_HOLD)
• Variable name: AS.ADMS.ADMS_ARCH_HOLD
• Description:
This variable specifies the default value for the archive property “Hold”
assigned to newly created archives.
• Type: Enum
• Predefined Value: @HLD=n
• Allowed Value:
• @HLD=y ("on")
• @HLD=n ("off")
Old timestamps (ADMS_ARCH_TIMESTMP)

• Variable name: AS.ADMS.ADMS_ARCH_TIMESTMP
• Description:
This is one of three configuration variables which specifies the default value
for the archive property “Timestamps” assigned to new created archives.
This variable specifies if old timestamps are enabled for new created
archives.
This variable is no longer supported and must not be changed.
• Type: Enum
• Predefined Value: @T=n
• Allowed Value:
• @T=y ("on")
• @T=n ("off")
Single instance (ADMS_ARCH_SI)

• Variable name: AS.ADMS.ADMS_ARCH_SI
• Description:
This variable specifies the default value for the archive property “Single
instance” assigned to new created archives. This setting can be changed later
in the archive properties.
• Type: Enum
• Predefined Value: @SI=n
• Allowed Value:
• @SI=y ("on")

AR100500-01-ACN-EN-04
• @SI=n ("off")
Timestamp verification (ADMS_ARCH_TIMESTMP_VER)
• Variable name: AS.ADMS.ADMS_ARCH_TIMESTMP_VER

• Description:
If the variable “Signature renewal mode” (ADMS_ARCH_SIGN) is enabled,
this variable controls one of the three values for the archive property
“Timestamps” assigned to new created archives.
• Strict: ArchiSig timestamps with strict timestamp verification

• Relaxed: ArchiSig timestamps with relaxed timestamp verification
• No verification: ArchiSig timestamps with no timestamp verification

• Type: Enum
• Predefined Value: @TSV=n
• Allowed Value:
• @TSV=s ("Strict")
• @TSV=r ("Relaxed")
• @TSV=n ("No verification")
43.1.3.3 Retention
Storage location:
\ADMS.Setup
Setup
Purge behavior (ADMS_ARCH_RET_PURGE)
• Variable name: AS.ADMS.ADMS_ARCH_RET_PURGE

• Description:
This variable specifies the default “retention purge behavior”for new created
archives. This setting can be changed later in the archive properties.
• Type: Enum
• Predefined Value: @Purge=del
• Allowed Value:
• @Purge=del ("Delete only")

• @Purge=des ("Destroy (overwrite) after deletion if possible")
Retention mode (ADMS_ARCH_RET_MODE)
• Variable name: AS.ADMS.ADMS_ARCH_RET_MODE

• Description:

AR100500-01-ACN-EN-04
This variable specifies the default “retention mode” for new created archives.
• Type: Enum
• Predefined Value: @Mode=ncmpl
• Allowed Value:
• @Mode=cmpl ("Compliance")
• @Mode=ncmpl ("Noncompliance")
• @Mode= ("None")
Retention mode extra arguments (ADMS_ARCH_RET_EXTRA_ARGS)

• Variable name: AS.ADMS.ADMS_ARCH_RET_EXTRA_ARGS
• Description:
This variable specifies extra arguments for retention configuration of an
archive. This string will be appended to the other retention configuration
flags.
• Type: String
• Predefined Value: <empty>
Retention period (ADMS_ARCH_RET_PERIOD)

• Variable name: AS.ADMS.ADMS_ARCH_RET_PERIOD
• Description:
This variable specifies the default “retention period” for new created
archives.
• @RP=0: None
• @RP=-1: Never Delete (infinite)
• @RP=-9: Event based retention
• @RP=n: n days retention

• Type: String
• Predefined Value: @RP=0

AR100500-01-ACN-EN-04
43.1.4 Pools
Storage location:
\ADMS.Setup
Setup
Volume name pattern (ADMS_DEFAULT_VOLUME_PATTERN)

• Variable name: AS.ADMS.ADMS_DEFAULT_VOLUME_PATTERN
• Description:
This variable specifies the default volume name pattern to be applied to new
ISO pools. This setting can be changed later in the pool properties.
• Type: String
• Predefined Value: $(PREF)_$(ARCHIVE)_$(POOL)_$(SEQ)
Volume name prefix (ADMS_PART_PREFIX)

• Variable name: AS.ADMS.ADMS_PART_PREFIX
• Description:
This variable specifies the default volume name prefix to be applied to the
volume pattern variable $(PREF). When generating new volume names, the
administration server replaces any occurrences of “$(PREF)” in the pool's
volume name pattern with the string specified here.
• Type: String (maxSize: 8)
• Predefined Value: VOL
43.1.4.1 Write through (HDSK)

Storage location:
\ADMS.Setup
Setup
Max. number of parallel Write_HDSK jobs (ADMS_HDSK_MAX_WRITERS)

• Variable name: AS.ADMS.ADMS_HDSK_MAX_WRITERS
• Description:
This variable specifies the maximum number of parallel Single File (FS) write
jobs which are allowed to run. This value can be increased if there are
multiple write devices.
Min. free space on volumes in HDSK pool (ADMS_DK_PART_PERCENT_FREE)

• Variable name: AS.ADMS.ADMS_DK_PART_PERCENT_FREE

AR100500-01-ACN-EN-04

Write to Single File (FS) volumes allowed (MAYWRITEHDSK)
• Variable name: AS.ADMS.MAYWRITEHDSK

• Description:
This variable controls whether or not hard disk volumes connected via disk
buffers are allowed to be written. The administrator can set this variable
instead of disabling all Write_HDSK jobs.
• Type: Flag
• Allowed Value:
• on
• off
43.1.4.2 Write at-once (ISO)

Storage location:
\ADMS.Setup
Setup
Create backups for ISO pools (ADMS_BACKUP_CD)
• Variable name: AS.ADMS.ADMS_BACKUP_CD

• Description:
This variable specifies the value for the “Backup enabled” property in the
“New Pool” dialog of an ISO pool.
• Type: Flag
• Predefined Value: off
• Allowed Value:
• on
• off
Max. number of parallel Write_CD jobs (ADMS_CD_MAX_WRITERS)
• Variable name: AS.ADMS.ADMS_CD_MAX_WRITERS

• Description:
This variable specifies the maximum number of parallel ISO write jobs which
are allowed to run. The user can increase this if there are multiple write
devices and enough space to hold images for multiple ISO volumes.

AR100500-01-ACN-EN-04
Min. amount of data to be burnt on ISO volume (ADMS_CP_CDMIN)

• Variable name: AS.ADMS.ADMS_CP_CDMIN
• Description:
This variable specifies the value for the “Minimum amount of data” property
in the “New Pool” dialog of an ISO pool.
Write to ISO volumes (MAYWRITECD)

• Variable name: AS.ADMS.MAYWRITECD
• Description:
This variable controls whether or not ISO volumes are allowed to be written.
The user can set this parameter instead of disabling all Write_CD jobs.
• Type: Flag
• Allowed Value:
• on
• off
43.1.4.3 Single file (VI)

Storage location:
\ADMS.Setup
Setup
Max. number of parallel Write_GS jobs (ADMS_GS_MAX_WRITERS)

• Variable name: AS.ADMS.ADMS_GS_MAX_WRITERS
• Description:
This variable specifies the maximum number of parallel Single File (VI) write
jobs which are allowed to run. The user can increase this if there are multiple
write devices.
Min. free space on volumes in GS pool (ADMS_GS_PART_PERCENT_FREE)

• Variable name: AS.ADMS.ADMS_GS_PART_PERCENT_FREE
• Description:
This variable specifies the percentage of a GS volume that is to remain free.
This is useful for marking a volume as full yet leaving a bit of space for
future changes to the documents located on the volume.

AR100500-01-ACN-EN-04
Number of writer threads per GS write job (ADMS_DEFAULT_GS_WRITERTHREADS)
• Variable name: AS.ADMS.ADMS_DEFAULT_GS_WRITERTHREADS

Write to Single File (VI) volumes allowed (MAYWRITEGS)
• Variable name: AS.ADMS.MAYWRITEGS

• Description:
This variable controls whether or not Single File volumes connected through
a Vendor Interface (GS) are allowed to be written. The user can set this
parameter instead of disabling all Write_GS jobs.
• Type: Flag
• Allowed Value:
• on
• off
43.1.5 Cache servers

Storage location:
\ADMS.Setup
Setup
Port of cache server (ADMS_CSRV_PORT)
• Variable name: AS.ADMS.ADMS_CSRV_PORT

• Description:
This variable is for future use.
Protocol used by cache server (ADMS_CSRV_PROT)
• Variable name: AS.ADMS.ADMS_CSRV_PROT

• Description:
This variable is for future use.
• Type: Enum
• Allowed Value:
• http ("http")
• https ("https")

AR100500-01-ACN-EN-04
43.1.6 Certificates
Storage location:
\ADMS.Setup
Setup
Allow to replace certificates (ADMS_ALLOW_CERT_REPLACE)

• Variable name: AS.ADMS.ADMS_ALLOW_CERT_REPLACE
• Description:
This variable specifies whether the server allows to replace a certificate with
an ID for which a certificate already exists.
• Type: Flag
• Allowed Value:
• on
• off
Enable certificate usage (ADMS_USE_CERTIFICATES)

• Variable name: AS.ADMS.ADMS_USE_CERTIFICATES
• Description:
This variable controls whether or not certificates are allowed. In the current
version, no values other than “on” are allowed.
• Type: Flag
• Allowed Value:
• on
• off
Max. number of certificates (ADMS_MAX_NUM_CERT)

• Variable name: AS.ADMS.ADMS_MAX_NUM_CERT
• Description:
This variable specifies the maximum number of certificates allowed by the
archive server.

AR100500-01-ACN-EN-04
43.1.7 Notifications
Storage location:
\ADMS.Setup
Setup
Host name of the Mail Server (ADMS_NOTS_EMAIL_MAILHOST)

• Variable name: AS.ADMS.ADMS_NOTS_EMAIL_MAILHOST
• Description:
This variable specifies the name of the mail server used by the threat
detection.
• Type: String
Name of the sender of an email notification (ADMS_NOTS_EMAIL_SENDER)

• Variable name: AS.ADMS.ADMS_NOTS_EMAIL_SENDER
• Description:
This variable specifies the name of the originator of an email notification
used by the threat detection.
• Type: String
Name of the threat alert email notification (ADMS_THREAT_EMAIL_NOTIFICATION)

• Variable name: AS.ADMS.ADMS_THREAT_EMAIL_NOTIFICATION
• Description:
This variable specifies the name of the email notification used by the threat
detection.
• Type: String
• Predefined Value: Threat Detection Email
43.1.8 Connection Parameters

Storage location:
\ADMS.Setup
Setup
Port of the Archive Server (AS_HTTP_PORT)

• Variable name: AS.ADMS.AS_HTTP_PORT
• Description:
This variable specifies the port number on which the Archive Server listens
for HTTP requests.

AR100500-01-ACN-EN-04
This value must be equal to the port of the application server which runs on
the same machine.
Port of the Archive Server (SSL) (AS_HTTPS_PORT)

• Variable name: AS.ADMS.AS_HTTPS_PORT
• Description:
This variable specifies the port number on which the Archive Server listens
for secure connections (SSL/HTTPS).
This value must be equal to the port of the application server which runs on
the same machine.
URL path to access documents (AS_HTTP_CONTEXT_PATH)

• Variable name: AS.ADMS.AS_HTTP_CONTEXT_PATH
• Description:
This variable specifies the context path portion of URLs used to access the
server's documents using HTTP or HTTPS.
• Type: String
• Predefined Value: /archive
43.1.9 Directories
Storage location:
\ADMS.Setup
Setup
Directory of client configuration files (ADMS_CLIENT_FILE_DIR)

• Variable name: AS.ADMS.ADMS_CLIENT_FILE_DIR
• Description:
This variable specifies the directory in which a search for so-called client files
takes place. The Enterprise Scan uses this directory for download of central
configuration files. The Client Configuration Client uses this directory for
upload and download of central configuration files.
• Type: Path
Directory of TCL scripts (ADMS_SCRIPT_FILE_DIR)

• Variable name: AS.ADMS.ADMS_SCRIPT_FILE_DIR

AR100500-01-ACN-EN-04

• Description:
This variable specifies the directory in which the script files for the job
command scripts, utility command scripts and GUI utility dialog scripts are
located. When the administration server is started, a search takes place in this
directory for files with the extensions “.tcl”, “.utl” and “.gutl”.
• Type: Path
43.1.10 System Keys

Storage location:
\ADMS.Setup
Setup
Number of tokens created by exporting a keystore

(ADMS_KEYSTORE_EXPORT_TOKEN_COUNT)
• Variable name: AS.ADMS.ADMS_KEYSTORE_EXPORT_TOKEN_COUNT

• Description:
This variable specifies the number of tokens (files) created by the
Administration Server when exporting a keystore.
ADMS_KEYSTORE_RECOVER_TOKEN_REQUIRED of these will be
required to recover the keystore.
Number of tokens required to recover a keystore

(ADMS_KEYSTORE_RECOVER_TOKEN_REQUIRED)
• Variable name: AS.ADMS.ADMS_KEYSTORE_RECOVER_TOKEN_REQUIRED

• Description:
This variable specifies the number of tokens (files) from an exported keystore
required to recover that keystore. The value must not exceed
ADMS_KEYSTORE_EXPORT_TOKEN_COUNT.
Target folder for keystore exports (ADMS_KEYSTORE_EXPORT_FOLDER)
• Variable name: AS.ADMS.ADMS_KEYSTORE_EXPORT_FOLDER

• Description:
This variable specifies the folder on the server that keystores exported by the
administration server are written to.
• Type: Path

AR100500-01-ACN-EN-04
43.2. Document Service (DS)
43.2 Document Service (DS)

Storage location:
- Windows: Configuration file: <ECM_ARCHIVE_SERVER_CONF>\config\setup\DS.
Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/DS.
Setup
43.2.1 Document Service related settings

Storage location:
Setup
Setup
Disable attribute migration (DISABLE_ATTRIBUTE_MIGRATION)
• Variable name: AS.DS.DISABLE_ATTRIBUTE_MIGRATION

• Description:
If set to on, no more attribute migration will be done (no attribute migration
on the fly and no attribute migration during SYS_MIGRATE_ATTRIBUTES
job.
Schema migration is not disabled by this flag.
• Type: Flag
• Allowed Value:
• on
• off
External Frontend Host to contact Archive Server (e.g. fully qualified

Loadbalancer address) (EXTERNAL_FRONTEND_HOST_NAME)
• Variable name: AS.DS.EXTERNAL_FRONTEND_HOST_NAME

• Description:
The external frontend address can be specified by this setting, e.g. the
Loadbalancer address which forwards requests to Archive Server. Must be
fully qualified.
• Type: String
External Frontend Plain Text Port to contact Archive Server (e.g. Loadbalancer)
(EXTERNAL_FRONTEND_HOST_PORT)
• Variable name: AS.DS.EXTERNAL_FRONTEND_HOST_PORT

• Description:

AR100500-01-ACN-EN-04
The external plain text port for the frontend address can be specified by this
setting, e.g. the Loadbalancer address which forwards requests to Archive
Server.
• Type: String
External Frontend SSL Port to contact Archive Server (e.g. Loadbalancer)

(EXTERNAL_FRONTEND_HOST_SSL_PORT)
• Variable name: AS.DS.EXTERNAL_FRONTEND_HOST_SSL_PORT
• Description:
The external SSL port for the frontend address can be specified by this
setting, e.g. the Loadbalancer address which forwards requests to Archive
Server.
• Type: String
43.2.2 Accounting and Statistics

Storage location:
Setup
Setup
Accounting Library (ACC_LIBNAME)

• Variable name: AS.DS.ACC_LIBNAME
• Description:
Name of the accounting library. This must only be changed within a project
solution.
• Type: String
• Predefined Value: libdsAcc
Days until organizing accounting files (ACC_DATA_AS_FILE)

• Variable name: AS.DS.ACC_DATA_AS_FILE
• Description:
The accounting data may be deleted or archived by an ADMS job. The period
for this action is configured here.
• Type: Integer
Enable accounting (USE_ACCOUNTING)

• Variable name: AS.DS.USE_ACCOUNTING
• Description:
If set to on, each HTTP request is logged into an accounting file. To avoid
this, switch the parameter to off.
• Type: Flag

AR100500-01-ACN-EN-04
• Allowed Value:
• on
• off
Enable detailed transaction logs (TRANSACTIONLOG)
• Variable name: AS.DS.TRANSACTIONLOG

• Description:
If set to on every ArchiveLink and CMIS request is logged into a transaction
log file. A scheduled job SYS_EXPORT_TRANSACTIONLOG runs every 15
minutes (default) and writes the transactions to CSV formatted files (one file
per archive and day). Above files are stored in ECM_VAR_DIR/statistics/
[archive]/[YYYY]/[MM]/details as [YYYYMMDD]-[archive].dtl.csv. The
transactions will be additionally be aggregated in the database table
jds_accounting.
• Type: Flag
• Allowed Value:
• on
• off
Enable storage allocation (STORAGE_ALLOCATION)
• Variable name: AS.DS.STORAGE_ALLOCATION

• Description:
If set to on the amount of storage allocated to hold user data (including
copies) is collected once per day by job
SYS_SNAPSHOT_STORAGE_ALLOCATION. When job
SYS_EXPORT_ARCHIVE_UTILIZATION is run both storage allocation and
statistics are exported to CSV formatted files, one file per month and type.
Above files are created in ECM_VAR_DIR/statistics/[archive]/[YYYY]/[MM]/
as [YYYYMM]-[archive].usage.csv (storage) and [YYYYMM]-[archive].atl.csv
(statistics).
• Type: Flag
• Allowed Value:
• on
• off
Method to organize old accounting files (ACC_DATA_METHOD)
• Variable name: AS.DS.ACC_DATA_METHOD

• Description:
The accounting data may be deleted or archived by an ADMS job. Here it is
configured, what kind of action the ADMS job has to perform:

AR100500-01-ACN-EN-04
• 0: Let the account files stay in the file system.

• 1: Archive them to the ACC_DATA_POOL.
• 2: Delete them.
• Type: Enum
• Allowed Value:
• 0 ("Let them stay in file system")

• 1 ("Archive into given pool")
• 2 ("Delete them")
Path to accounting data files (ACC_DATA_PATH)
• Variable name: AS.DS.ACC_DATA_PATH

• Description:
Path to the accounting files.
• Type: Path
Pool for the accounting data (ACC_DATA_POOL)
• Variable name: AS.DS.ACC_DATA_POOL

• Description:
The accounting data may be archived automatically by an ADMS job. Here
the pool for the accounting data is configured.
• Type: String
Separator for columns in accounting files (ACC_COL_SEPARATOR)
• Variable name: AS.DS.ACC_COL_SEPARATOR

• Description:
The column separator for accounting files.
• Type: String
• Predefined Value: TAB
43.2.2.1 Cookie exclusion list

Storage location:
\Cookies.Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/
Cookies.Setup
List of hosts for which cookies are not set (NOCOOK_HOSTS)
• Variable name: AS.Cookies.NOCOOK_HOSTS

• Description:

AR100500-01-ACN-EN-04
List of host names, which are allowed to send requests without a user
identification (w/o cookie), if USER_COOKIE_INTEGRATION is set to 1 or 2.
These names may be added/changed to reflect the customer environment.
• Type: Structure, consisting of subvariables - see below for details
• Sub variables:
IP Address
• Variable name: host

• Type: String
43.2.3 Backup configuration

Storage location:
Setup
Setup
Days after which change log files are removed (HDSK_MAX_AGE)
• Variable name: AS.DS.HDSK_MAX_AGE

• Description:
The protocol files written by HDSK_LOG=1 will be preserved for a maximum
duration of HDSK_MAX_AGE days. Within this time period, the remote standby
server must perform an incremental backup.
• Type: Integer
Max. number of backup jobs executed in parallel (BK_MAXPROC)
• Variable name: AS.DS.BK_MAXPROC

• Description:
This is the maximum number of bkCD, bkWorm, bkHdsk or bkDel programs
that can be run simultaneously by bkupSrvr.
• Type: Integer
Max. size of a HDSK volume for which full backups are started
(HDSK_MAX_FULL_BKUP_SIZE)
• Variable name: AS.DS.HDSK_MAX_FULL_BKUP_SIZE

• Description:
For smaller volumes a full backup is started implicitly once every
HDSK_MAX_AGE/2 days. Not so if they are larger than this parameter in
GB. Here, a full backup must be started explicitly.
• Type: Integer

AR100500-01-ACN-EN-04
This system is backed up by other systems (HDSK_LOG)

• Variable name: AS.DS.HDSK_LOG
• Description:
If this parameter is set to 1, all changes made on HDSK volumes and all
deletions of documents or components are logged. These logs are used by
bkHdsk and bkDel when doing an incremental backup. This parameter must
be set on an original system if it is backed up by a remote standby system.
• Type: Flag
• Allowed Value:
• 0
• 1
43.2.4 Cache configuration

Storage location:
Setup
Setup
Size in MB of a component that are at most cached (DS_MAX_CACHE_COMP_SIZE)

• Variable name: AS.DS.DS_MAX_CACHE_COMP_SIZE
• Type: Integer
Space in MB to leave free in cache partition (DS_CACHE_FREE_AMOUNT)

• Variable name: AS.DS.DS_CACHE_FREE_AMOUNT
• Description:
The number of Megabytes a cache volume must keep free. Must not be less
than 16. Can be made larger, if the OS gets problems, when the volume gets
too full.
• Type: Integer

AR100500-01-ACN-EN-04
43.2.5 Component settings

Storage location:
Setup
Setup
Max. content size if no content-length was specified

(HTTP_DEFAULT_CONTENT_SIZE)
• Variable name: AS.DS.HTTP_DEFAULT_CONTENT_SIZE
• Description:
If the client does not provide a content length (like it does in some browser
upload scenarios) this is the maximal size of the component length in bytes.
• Type: Integer
43.2.5.1 Compression
Storage location:
Setup
Setup
compress incoming data immediately, on the fly.. (COMPR_IMMED)

• Variable name: AS.DS.COMPR_IMMED
• Description:
If on, components will be immediately compressed if the archive
compression is on, and if the content length is known.
• Type: Flag
• Allowed Value:
• on
• off

AR100500-01-ACN-EN-04
43.2.5.2 Blobs
Storage location:
Setup
Setup
Max. number of files in a blob (MAX_BLOB_FILES)

• Variable name: AS.DS.MAX_BLOB_FILES
• Description:
Maximum number of files put into a blob, before the blob is closed.
• Type: Integer
Max. size of a blob in bytes (MAX_BLOB_SIZE)

• Variable name: AS.DS.MAX_BLOB_SIZE
• Description:
If a blob gets larger than MAX_BLOB_SIZE bytes, it will be closed.
• Type: Integer
Max. size of a file in a blob in bytes (BLOB_LENGTH_LIMIT)

• Variable name: AS.DS.BLOB_LENGTH_LIMIT
• Description:
All components with a size less than BLOB_LENGTH_LIMIT bytes will be
stored in blob files. BLOB_LENGTH_LIMIT cannot be larger than 65536.
Max. sum of free store in a blob in kb (MAX_BLOB_FREE_SUM)

• Variable name: AS.DS.MAX_BLOB_FREE_SUM
• Description:
If a blob has more free kbytes than MAX_BLOB_FREE_SUM, it is not closed.
• Type: Integer

AR100500-01-ACN-EN-04
43.2.5.3 Encryption
Storage location:
Setup
Setup
encrypt incoming data immediately, on the fly.. (CRYPT_IMMED)

• Variable name: AS.DS.CRYPT_IMMED
• Description:
If on, components will be immediately encrypted, if the archive encryption is
on, and if the content length is known. As a consequence, the components
cannot be compressed later.
• Type: Flag
• Allowed Value:
• on
• off
Length in bits of (AES) encryption key (CRYPT_KEY_LENGTH)

• Variable name: AS.DS.CRYPT_KEY_LENGTH
• Description:
The symmetric key size in bits used for document encryption. We are using
the AES (Rijndael) algorithm for encryption, thus lengths 128, 192 and 256
are accepted. 256 bits are only a bit slower than 128.
• Type: Enum
• Allowed Value:
• 128 ("128")
• 192 ("192")
• 256 ("256")
43.2.5.4 Timestamps (old)

Storage location:
Setup
Setup
Hash Alg used for Timestamps (TIME_STAMP_HASHALG)

• Variable name: AS.DS.TIME_STAMP_HASHALG
• Description:
Supported algorithms for secure hash creation.

AR100500-01-ACN-EN-04
• Type: Enum
• Predefined Value: SHA256
• Allowed Value:
• SHA1 ("SHA-1 (160 bit, deprecated)")
• RMD160 ("RIPEMD160 (160 bit)")
• MD5 ("MD5 (128 bit)")
• SHA256 ("SHA256 (256 bit)")
• SHA512 ("SHA512 (512 bit)")
Host of the Timestamp Server (TIME_STAMP_SERVER_HOST)

• Variable name: AS.DS.TIME_STAMP_SERVER_HOST
• Description:
The dsSign program retrieves signatures from the specified system, which
must be running a time stamp server. Multiple Hosts can be specified in the
format: <host1>:<port1>;<host2>:<port2>
• Type: String
• Predefined Value: localhost
Max. number of connections to the Timestamp Server (MAX_TSS_CONNECTIONS)

• Variable name: AS.DS.MAX_TSS_CONNECTIONS
• Description:
The program dsSign sends timestamp requests simultaneously over
MAX_TSS_CONNECTIONS TCP/IP-connections to the timestamp server. A
hardware implementation of the TSS supports 8 chip cards, and dsSign tries
to make full parallel use of these chip cards.
• Type: Integer
Mode of the Timestamp Server (TIME_STAMP_MODE)

• Variable name: AS.DS.TIME_STAMP_MODE
• Description:
The DS handles the (old) SIGIA4 timestamp format and the (new) IETF (RFC
3161) format. The "+" means send HTTP header, "-" means no HTTP header.
• Type: Enum
• Predefined Value: -IETF
• Allowed Value:
• +SIGIA4 ("SIGIA4 with HTTP header")
• -SIGIA4 ("SIGIA4 without HTTP header")
• +IETF ("RFC 3161 (IETF) with HTTP header")
• -IETF ("RFC 3161 (IETF) without HTTP header")
Number of dsSign threads (DSSIGN_NTHREADS)

• Variable name: AS.DS.DSSIGN_NTHREADS
• Description:

AR100500-01-ACN-EN-04
Each thread computes the checksums of files on one volume.

• Type: Integer
Password for HTTP Timestamp request (TIME_STAMP_AUTH_PASSWORD)

• Variable name: AS.DS.TIME_STAMP_AUTH_PASSWORD
• Description:
When requesting timestamps via HTTP the password for basic HTTP
Authorization can be specified with this setting. A line “Authorization” must
be entered under “Headers for HTTP TS requests”.
• Type: String
Path for HTTP Timestamp request URLs (TIME_STAMP_HTTP_PATH)

• Variable name: AS.DS.TIME_STAMP_HTTP_PATH
• Description:
When requesting timestamps via HTTP the path of the URL can be specified
with this setting.
• Type: String
SHA1 timestamps as URL parameters are rejected (DS_REJECT_SHA1)

• Variable name: AS.DS.DS_REJECT_SHA1
• Description:
A client is by default no longer allowed to provide SHA1 timestamps as
ixCheckSum URL parameter.
• Type: Flag
• Allowed Value:
• on
• off
Special dsSign logfile (DSSIGN_LOG_TS)

• Variable name: AS.DS.DSSIGN_LOG_TS
• Description:
If on, a special logfile dsSign.log.YYYYMMDD is written. It contains lines
with "date time docid/compname;version hash-value".
• Type: Flag
• Allowed Value:
• on
• off
Timestamp server port (TIME_STAMP_SERVER_PORT)

• Variable name: AS.DS.TIME_STAMP_SERVER_PORT

AR100500-01-ACN-EN-04
• Description:
This is the TCP port number of the time stamp server. Popular port numbers
are 318 and 32001.
User for HTTP Timestamp request (TIME_STAMP_AUTH_USER)

• Variable name: AS.DS.TIME_STAMP_AUTH_USER
• Description:
When requesting timestamps via HTTP the user name for basic HTTP
Authorization can be specified with this setting. A line “Authorization” must
be entered under “Headers for HTTP TS requests”.
• Type: String
43.2.5.4.1 Headers for HTTP TS requests
Storage location:
\TstpHttp.Setup
TstpHttp.Setup
Header-fields that are used in HTTP Timestamp-Requests (TSTP_HTTP_HEADERS)

• Variable name: AS.TstpHttp.TSTP_HTTP_HEADERS
• Sub variables:
Header field
• Variable name: headerfield
• Type: String
• Predefined Value: headerfield=Host
• Predefined Value: headerfield=Content-Type
• Predefined Value: headerfield=Content-Length
43.2.5.5 ArchiSig Timestamps

Storage location:
Setup
Setup
Additional hash algorithm (TS_HASHALG2)

• Variable name: AS.DS.TS_HASHALG2
• Description:
The secondary hash algorithm used for ArchiSig hash trees

AR100500-01-ACN-EN-04
• Type: Enum
• Predefined Value: RMD160
• Allowed Value:
• <empty> ("- None -")

• RMD160 ("RIPEMD160 (160 bit)")
• MD5 ("MD5 (128 bit)")
• SHA256 ("SHA256 (256 bit)")
• SHA512 ("SHA512 (512 bit)")
Connection method (TS_CONNECTION)
• Variable name: AS.DS.TS_CONNECTION

• Description:
Protocol used for the connection to the timestamp server.
• Type: Enum
• Predefined Value: TCP
• Allowed Value:
• TCP ("Plain TCP connection")

• http ("HTTP")
• https ("HTTPS (HTTP over SSL)")
Define a proxy to use for timestamp requests (TS_PROXY)
• Variable name: AS.DS.TS_PROXY

• Description:
Use String [proxy hostname]:[proxy port] to specify connection parameters
for an HTTP proxy. A numerical IPv6 address must be written within
[brackets].
• Type: String
File with certificate (TS_REQ_CERTFILE)
• Variable name: AS.DS.TS_REQ_CERTFILE

• Description:
The filename of the file containing the certificate used to sign timestamp
requests, in the config/setup directory. See TS_SIGN.
• Type: Path
File with private key (TS_REQ_PRIVKEYFILE)
• Variable name: AS.DS.TS_REQ_PRIVKEYFILE

• Description:
The filename of the file containing the private key used to sign timestamp
requests, in the config/setup directory. See TS_SIGN.
• Type: Path

AR100500-01-ACN-EN-04
Format of used timestamps (TS_FORMAT)
• Variable name: AS.DS.TS_FORMAT

• Description:
Format of the used timestamps
• Type: Enum
• Predefined Value: ietf
• Allowed Value:
• pkcs7 ("Pkcs#7")
• ietf ("RFC 3161 (IETF)")
Hostname of the timestamp server (TS_HOST)
• Variable name: AS.DS.TS_HOST

• Description:
This is the hostname of the time stamp server
Main hash algorithm (TS_HASHALG)
• Variable name: AS.DS.TS_HASHALG

• Description:
The primary hash algorithm used for ArchiSig hash trees
• Type: Enum
• Predefined Value: SHA256
• Allowed Value:

• RMD160 ("RIPEMD160 (160 bit)")
• MD5 ("MD5 (128 bit)")
• SHA256 ("SHA256 (256 bit)")
• SHA512 ("SHA512 (512 bit)")
Map incoming VerifySig requests to VerifyATS requests

(TS_VERIFYSIG_EMULATION)
• Variable name: AS.DS.TS_VERIFYSIG_EMULATION

• Description:
When switched on, incoming classic timestamp-verification requests will
actually perform an archive-timestamp-verification. For compatibility with
clients that don't support the verifyATS call.
• Type: Flag
• Allowed Value:
• on
• off

AR100500-01-ACN-EN-04
Max. number of components per hashtree (-1 = unlimited) (TS_MAXCNT)

• Variable name: AS.DS.TS_MAXCNT
• Description:
If -1, no maximum, else limits the number of component hash values
stamped together
• Type: Integer
Min. number of components per hashtree (TS_MINCNT)

• Variable name: AS.DS.TS_MINCNT
• Description:
The minimum number of component hash values required to create a new
timestamp
• Type: Integer
Password for HTTP Timestamp request (TS_AUTH_PASSWORD)

• Variable name: AS.DS.TS_AUTH_PASSWORD
• Description:
When requesting timestamps via HTTP the password for basic HTTP
Authorization can be specified with this setting.
• Type: String
Path for HTTP Timestamp request URLs (TS_HTTP_PATH)

• Variable name: AS.DS.TS_HTTP_PATH
• Description:
When requesting timestamps via HTTP the path of the URL can be specified
with this setting.
• Type: String
Pool for ATS components (for rehashing) (TS_ATSCPOOL)

• Variable name: AS.DS.TS_ATSCPOOL
• Description:
The name of the pool into which Archive timestamp components are
archived (for rehashing)
• Type: String
• Predefined Value: ATSC_POOL
Pool for timestamps (TS_POOL)

• Variable name: AS.DS.TS_POOL
• Description:
The name of the pool into which timestamps are archived
• Type: String

AR100500-01-ACN-EN-04
• Predefined Value: ATS_POOL
Set of digests forming hash chains (TS_DIGESTFAMILIES)
• Variable name: AS.DS.TS_DIGESTFAMILIES

• Description:
This setting defines a familiy of "related" digests for verification of ArchiSig
timestamps. If for example TS_DIGESTFAMILIES is set to SHA then
documents having been timestamped using a SHA-1 (or SHA-256) digest can
be verified even if TS_HASHALG is currently set to SHA-512. Verification of
documents can be performed using both verifySig and verifyATS. Which
digest is used for timestamping is governed by "main/additional hash
algorithm". Supported values (besides empty): SHA (includes SHA-1 and
SHA-2 digests)
• Type: String
• Predefined Value: SHA
SSL client authentication (TS_SSLCLIENTAUTH)
• Variable name: AS.DS.TS_SSLCLIENTAUTH

• Description:
SSL Client authentication
• Type: Flag
• Allowed Value:
• on
• off
Timestamp server port (TS_PORT)
• Variable name: AS.DS.TS_PORT

• Description:
This is the TCP port number of the time stamp server. Popular port numbers
are 318 and 32001.
Timestamps must be signed (TS_SIGN)
• Variable name: AS.DS.TS_SIGN

• Description:
On if timestamp requests must be signed
• Type: Flag
• Allowed Value:
• on
• off

AR100500-01-ACN-EN-04
User for HTTP Timestamp request (TS_AUTH_USER)
• Variable name: AS.DS.TS_AUTH_USER

• Description:
When requesting timestamps via HTTP the user name for basic HTTP
Authorization can be specified with this setting.
• Type: String
User name and password to use for proxy authentication (TS_NTLM)
• Variable name: AS.DS.TS_NTLM

• Description:
Use the string [proxy user]:[proxy password] to specify credentials for an
HTTP proxy. The combined string consisting of the proxy user, the
character : and the proxy password must be encrypted using AC encryption.
This can be accomplished with the command enc of the tool dsClient. Also
see TS_PROXY.
• Type: String
43.2.5.6 Single Instance Archiving

Storage location:
Setup
Setup
43.2.5.6.1 Component or application types that prohibit(!) single instance archiving
Storage location:
\SiaType.Setup
SiaType.Setup
List of component/application types that are NOT using SIA (SIA_TYPES)
• Variable name: AS.SiaType.SIA_TYPES

• Sub variables:
Component or MIME or application type
• Variable name: comptype

• Type: String
• Predefined Value: comptype=application/msoutlook
• Predefined Value: comptype=message/rfc822
• Predefined Value: comptype=application/vnd.lotus-notes

AR100500-01-ACN-EN-04
43.2.5.6.2 Component names that prohibit(!) single instance archiving
Storage location:
\SiaName.Setup
SiaName.Setup
List of component names that are NOT stored using SIA (SIA_NAMES)
• Variable name: AS.SiaName.SIA_NAMES
• Sub variables:
Component name
• Variable name: compname
• Type: String
• Predefined Value: compname=REFERENCES
• Predefined Value: compname=REFERENCES2
• Predefined Value: compname=REFERENCES3
• Predefined Value: compname=INFO.TXT
• Predefined Value: compname=DATA.XML
• Predefined Value: compname=META_DOCUMENT
• Predefined Value: compname=META_DOCUMENT_INDEX
43.2.5.7 Settings for big components

Storage location:
Setup
Setup
Max. size of a component after which it is split into parts (BIGSIZE)

• Variable name: AS.DS.BIGSIZE
• Description:
A component larger than BIGSIZE is split into parts, where all parts except
the last have size BIGSIZE.
• Type: Integer (max: 2047)

AR100500-01-ACN-EN-04
43.2.6 Directories
Storage location:
Setup
Setup
Cache paths (DS_CACHE_PATH)
• Variable name: AS.DS.DS_CACHE_PATH

• Description:
This contains a list of directories separated by : on Unix or a ; on Windows,
e.g. DS_CACHE_PATH=/cache1:/cache2:/cache3. This is the default cache
path, which is used when the archive is enabled for caching, but has no
specific cache path. If this list is modified, the existing cache becomes invalid.
May be empty if caching is not used.
• Type: String
DS temp directory (DS_TMP_DIR)
• Variable name: AS.DS.DS_TMP_DIR

• Description:
This specifies the name of a directory under which DS creates further
directories for various temporary files.
• Type: Path
43.2.7 Document settings

Storage location:
Setup
Setup
Max. time a document is locked (minutes) (DS_LOCK_MAX_TIME)
• Variable name: AS.DS.DS_LOCK_MAX_TIME

• Description:
This specifies the number of minutes after which a document lock becomes
invalid. Once this period has expired, it is assumed that the program that set
the lock has crashed or terminated otherwise without releasing the lock.
• Type: Integer

AR100500-01-ACN-EN-04
43.2.8 HTTP settings

Storage location:
Setup
Setup
Number of counters to detect docId attacks (HTTP_LOG_NOTFOUND_CNTS)

• Variable name: AS.DS.HTTP_LOG_NOTFOUND_CNTS
• Description:
This parameter defines how many docId attacks can be tracked in parallel.
• Type: Integer
Timeout after which the counter is reset (HTTP_LOG_NOTFOUND_RESET_TIME)

• Variable name: AS.DS.HTTP_LOG_NOTFOUND_RESET_TIME
• Description:
This parameter defines the timeout after which the counter for a client which
sends requests with a not existing docId is reset.
• Type: Integer
43.2.9 Media configuration

Storage location:
Setup
Setup
43.2.9.1 ISO settings

Storage location:
Setup
Setup
Directory where ISO images are built (CDIMG)

• Variable name: AS.DS.CDIMG
• Description:
This is the name of the directory in which the iso9660 program called by
dsCD is to save the binary image with the same name as the volume to be

AR100500-01-ACN-EN-04
written. This image will then be copied to the peripheral storage. It is

recommended that the size of this directory be of the order of Gigabytes, so
that it can accommodate several images. The images in CDIMG are not deleted
unless this is required for space reasons, and are kept in reserve for backup
purposes.
• Type: Path
Directory where ISO trees are built (CDDIR)
• Variable name: AS.DS.CDDIR

• Description:
This is the directory in which the dsCD program will create the file tree with
the root cdname, which will subsequently be converted into a binary image
in ISO 9660 format using the iso9660 program.
• Type: Path
Intended size of ISO image for HSM systems, e.g. EMC (EMC_SIZE)
• Variable name: AS.DS.EMC_SIZE

• Description:
Size of images written to very large emulated blank volume, normally
overwritten by dsCD -E option.
• Type: Integer
Max. size of image in percent of volume capacity (CDMAXPERC)
• Variable name: AS.DS.CDMAXPERC

• Description:
This specifies the maximum size of the image to be copied by dsCD to an ISO
image, in percent of the capacity of the medium. If there are more data
waiting to be burned, the remaining data is burnt the next time dsCD is
called.
• Type: Integer
Min. size of blank volumes (MB, used e.g. for EMC) (CDMINBLANK)
• Variable name: AS.DS.CDMINBLANK

• Description:
A blank volume smaller than this value is not written.
• Type: Integer
Min. size of image in percent of volume capacity (CDMINPERC)
• Variable name: AS.DS.CDMINPERC

• Description:

AR100500-01-ACN-EN-04
This specifies the minimum size of the image to be copied by dsCD to an ISO
image, in percent of the capacity of the medium. If the available data is less
than this size, dsCD terminates with exit code 2, without burning the image.
• Type: Integer
Min. size of pool necessary to start dsCD (CDMINPOOLSIZE)

• Variable name: AS.DS.CDMINPOOLSIZE
• Description:
An ISO image is not created/written until the size of the documents waiting
to be burned exceeds the number of Megabytes specified in CDMINPOOLSIZE.
If e.g. CDMINPOOLSIZE is 3000, then 3000 Megabytes must be available, before
an ISO image is created and written.
• Type: Integer
Number of image write-attempts before giving up (CDMAXNUMTRIES)

• Variable name: AS.DS.CDMAXNUMTRIES
• Description:
This specifies how many times dsCD and bkCD try to burn an image before
giving up.
• Type: Integer
percent of CDIMG capacity that shall remain free (CDIMG_PERC)

• Variable name: AS.DS.CDIMG_PERC
• Description:
This specifies the percentage of the CDIMG capacity that shall remain free.
• Type: Integer
Speed up access to storage by suppressing stat() (NO_STAT_ON_CD)

• Variable name: AS.DS.NO_STAT_ON_CD
• Description:
The document service does a stat() request on a file to determine size,
modification time and it's existence. This requires unfortunately an access to
the file on storage, even though the file may be cached. When
NO_STAT_ON_CD is set to on, the stat() is suppressed for files on GS and ISO
devices. Instead, the length is determined from the database entry ds_comp.
clength, the modification time is assumed to be the time when the image
was written, and the existence is taken as granted. This reduces storage I/O
for ISO and GS devices.
• Type: Flag
• Allowed Value:

AR100500-01-ACN-EN-04
• off
• on
43.2.9.2 HDSK settings

Storage location:
Setup
Setup
Write volumes in HDSK pool round robin (USE_ROUND_ROBIN)
• Variable name: AS.DS.USE_ROUND_ROBIN

• Description:
If off, HDSK volumes in a HDSK-Pool are filled one after another, depending
on the priority of the volume in the pool.
If on, the documents are distributed in a round-robin fashion over the
volumes.
• Type: Flag
• Allowed Value:
• on
• off
43.2.9.3 HSM settings

Storage location:
Setup
Setup
If on, read/write EBADF errors are retried (HSM_RETRY)
• Variable name: AS.DS.HSM_RETRY

• Type: Flag
• Allowed Value:
• on
• off
Timeout in seconds after which hanging reads/writes are reported

(HSM_WATCH_TIMO)
• Variable name: AS.DS.HSM_WATCH_TIMO

• Type: Integer

AR100500-01-ACN-EN-04
43.2.9.4 IXW settings

Storage location:
Setup
Setup
Max. number of jobs read by dsWorm (MAXJOBS)
• Variable name: AS.DS.MAXJOBS

• Description:
This specifies the maximum number of job entries (copy requests) read out
by dsWorm, dsCD, dsHdsk and dsGs from the ds_job table at a time.
• Type: Integer
Temp directory for compressed files, used by dsWorm, dsHdsk and dsGs
(COMPR_DIR)
• Variable name: AS.DS.COMPR_DIR

• Description:
This parameter is used by dsWorm, dsHdsk and dsGs for specifying a
temporary directory in which they can compress files which cannot be
compressed at their original location, either due to a lack of space or because
their original location is a WORM or an ISO image.
• Type: Path
Time (secs) after which NFS write requests time out (NFS_WRTIMO)
• Variable name: AS.DS.NFS_WRTIMO

• Description:
Time after which an NFS write request to WORM times out.
• Type: Integer
43.2.9.5 Generalized Store

Storage location:
Setup
Setup
Number of threads able to access GS devices in parallel (GS_THREADS)
• Variable name: AS.DS.GS_THREADS

• Type: Integer

AR100500-01-ACN-EN-04
43.2.10 Logging
Storage location:
Setup
Setup
43.2.10.1 Administration and Document Service

Storage location:
Setup
Setup
Log HTTP data (LOG_HTTP_DATA)

• Variable name: AS.DS.LOG_HTTP_DATA
• Description:
If on, incoming and outgoing HTTP data will be logged with log level
LOG_DEBUG. LOG_DEBUG must also be set.
• Type: Flag
• Allowed Value:
• on
• off
43.2.11 Security settings

Storage location:
Setup
Setup
43.2.11.1 Global security settings for HTTP

Storage location:
Setup
Setup
Ignore Document Protection (SEC_DEFAULTPROTECTIONMODE)

• Variable name: AS.DS.SEC_DEFAULTPROTECTIONMODE
• Description:
Allowed values:

AR100500-01-ACN-EN-04
• on (= ADMIN): Document protection is ignored, archive protection is

used in any case.
• off (= IXOS): Document protection overrides archive protection.
• Type: Flag
• Predefined Value: IXOS
• Allowed Value:
• ADMIN ("on")
• IXOS ("off")
43.2.11.2 Global security settings for RPC

Storage location:
Setup
Setup
Hours after which idle logon expires (LOGON_EXPHOURS)

• Variable name: AS.DS.LOGON_EXPHOURS
• Description:
This defines the maximum number of hours for which client programs may
be inactive before they are automatically logged out from the DS. The DS
may not necessarily be aware that a client has terminated. Consequently,
inactive sessions that take up valuable storage space must be closed
automatically after a certain period.
• Type: Integer
Max. retries before disabling (DS_MAX_BAD_PASSWD)

• Variable name: AS.DS.DS_MAX_BAD_PASSWD
• Description:
If 0, users are never disabled. Otherwise, users are disabled if they logon
more than DS_MAX_BAD_PASSWD times within
DS_BAD_PASSWD_ELAPS seconds.
• Type: Integer
Min. password length (DS_MIN_PASSWD_LEN)

• Variable name: AS.DS.DS_MIN_PASSWD_LEN
• Type: Integer
Time after which bad passwords are forgotten (DS_BAD_PASSWD_ELAPS)

• Variable name: AS.DS.DS_BAD_PASSWD_ELAPS
• Description:

AR100500-01-ACN-EN-04
If 0, users are never disabled. Otherwise, users are disabled if they logon
more than DS_MAX_BAD_PASSWD times within
DS_BAD_PASSWD_ELAPS seconds.
• Type: Integer
43.2.12 STORM communication

Storage location:
Setup
Setup
Drive Scheduling used (USE_DS_SCHED)

• Variable name: AS.DS.USE_DS_SCHED
• Description:
The dsSched service synchronizes jukebox accesses for dsWorm, dsCD, etc, if
on.
• Type: Flag
• Allowed Value:
• on
• off
Number of retries for backup read/write requests (NFS_RETRIES)

• Variable name: AS.DS.NFS_RETRIES
• Description:
A NFS-request from a backup program to read/write a volume physically is
repeated up to NFS_RETRIES times before giving up. Each of these retries is
itself repeated every second for 5 minutes, so we timeout after approx.
15*5=75 minutes.
• Type: Integer

AR100500-01-ACN-EN-04
43.2.12.1 NFS Server

Storage location:
Setup
Setup
43.2.12.1.1 NFS Server
Storage location:
Setup
Setup
NFS Server 1 (NFSSERVER1)

• Variable name: AS.DS.NFSSERVER1
• Description:
The installation sets two NFSSERVER entries by default: NFSSERVER1=CDROM,
localhost,ppp,/views_hs and NFSSERVER2=WORM,localhost,ppp,/
views_hs, where ppp is 0 for Windows or 4027 for Unix. These parameters
are used to inform the DS on how to address the STORM server. They are
specified in the following format:
NFSSERVERi=servname,servhost,servport,servpoint where i is a value
greater than or equal to 1, which is incremented for each STORM server.
Gaps are not permitted.
servname stands for the server name. The server name must be unique and
begin with CDROM or WORM. The DS and the STORM server quite
frequently run on the same system. If this is the case, servhost can be set to
localhost. servport is the port number of the server. If this is 0, the default
value 2049 is used for NFS mounts. The value 0 is normally entered on NT/
W2K, as these systems do not normally run an NFS mount daemon and the
server can reuse free port numbers. The STORM server on UNIX uses the
port number 4027.
servpoint is the name of the mount point of the server. For the CD server and
the NT WORM server, this name is defined in the server.cfg file and is
usually /views_hs, i.e. the same as the mount point for the High Sierra view.
• Type: String
• Predefined Value: WORM,localhost,0,/views_hs

• Description:
A DS can attach to more than one STORM server. You may specify
additional STORM servers with NFSSERVER2, NFSSERVER3 etc. The
numbers must be consecutive.

AR100500-01-ACN-EN-04
• Type: String
• Predefined Value: CDROM,localhost,0,/views_hs
43.2.12.1.2 Additional NFS Servers
Storage location:
Setup
Setup

• Description:
A DS can attach to more than one STORM server. You may specify
additional STORM servers with NFSSERVER2, NFSSERVER3 etc. The
numbers must be consecutive.
• Type: String

• Type: String

• Type: String

• Type: String
43.2.13 System settings

Storage location:
Setup
Setup
Default runlevel (DS_RUNLEVEL)

• Variable name: AS.DS.DS_RUNLEVEL
• Description:
Or-conjunction of the following bits:
• 1: NO_RUN_REMOTE

AR100500-01-ACN-EN-04
• 2: NO_DSADMIN
• 4: NO_HTTP
• 8: NO_RPC
• 16: NO_DELETE
• 32: NO_DELETE_NO_ERROR
43.2.13.1 Database (fine tuning)

Storage location:
Setup
Setup
Max. DB connections for C++ programs (DBDSMAXCONN)

• Variable name: AS.DS.DBDSMAXCONN
• Description:
The number of DB connections that are pooled by a multithreaded C++
programs (bkupSrvr, dsAuxServer).
• Type: Integer
Use MSSQL full text index (DB_MSSQL_USE_FULL_TEXT_INDEX)

• Variable name: AS.DS.DB_MSSQL_USE_FULL_TEXT_INDEX
• Description:
Turn this variable on, if the MSSQL database is running with an full text
index.
• Type: Flag
• Allowed Value:
• on
• off

AR100500-01-ACN-EN-04
43.2.14 Special cs2ds settings

Storage location:
Setup
Setup
Host of the DS to which cs2ds transfers documents (CS2DS_DSHOST)

• Variable name: AS.DS.CS2DS_DSHOST
• Description:
The cs2ds program reads from different cache servers and sends the
documents to the DS on the specified system
Minimum document age (CS2DS_DAYS)

• Variable name: AS.DS.CS2DS_DAYS
• Description:
Documents older than this number of days are ignored by cs2ds
• Type: Integer
Port of the DS to which cs2ds transfers documents (CS2DS_DSPORT)

• Variable name: AS.DS.CS2DS_DSPORT
• Description:
This is the TCP port number of the DS for non-SSL requests
SSL Port of the DS to which cs2ds transfers documents (CS2DS_DSSSLPORT)

• Variable name: AS.DS.CS2DS_DSSSLPORT
• Description:
This is the TCP port number of the DS for SSL requests

AR100500-01-ACN-EN-04
43.2.15 Special pagelist settings

Storage location:
Setup
Setup
Client certificate file (DSH_CERTIFICATE_FILE)

• Variable name: AS.DS.DSH_CERTIFICATE_FILE
• Description:
This variable specifies the absolute path of the certificate file used by
pagelist. It is needed when authentication (SecKey) is required to access the
logical archive.
• Type: Path
Client private key file (DSH_PRIVATE_KEY_FILE)

• Variable name: AS.DS.DSH_PRIVATE_KEY_FILE
• Description:
This variable specifies the absolute path of the private key file used by
pagelist. It is needed when authentication (SecKey) is required to access the
logical archive.
• Type: Path
43.3 Database Server (DBS)

Storage location:
- Windows: Configuration file: <ECM_ARCHIVE_SERVER_CONF>\config\setup\DBS.
Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/DBS.
Setup
Database name or Oracle service name (DBNAME)

• Variable name: AS.DBS.DBNAME
• Description:
This variable specifies the database name. For Oracle the TNS service name
has to be given.
• Type: String
Database System (DBSYSTEM)

• Variable name: AS.DBS.DBSYSTEM
• Description:
This variable specifies which database system is used.

AR100500-01-ACN-EN-04
43.3. Database Server (DBS)
• Type: Enum
• Allowed Value:
• Oracle ("Oracle")
• MS SQL Server ("MS SQL Server")
• SAP HANA ("SAP HANA")
• PostgreSQL ("PostgreSQL")
Directory for all Oracle configuration files (TNS_ADMIN) (TNS_ADMIN)

• Variable name: AS.DBS.TNS_ADMIN
• Description:
Applies for Oracle only. This variable specifies the directory of the SQL*Net
configuration files.
• Type: Path
Directory where Oracle software was installed (ORACLE_HOME) (ORACLE_HOME)

• Variable name: AS.DBS.ORACLE_HOME
• Description:
Applies for Oracle only. This variable specifies the directory where the
Oracle software has been installed.
• Type: Path
JDBC port used for the connection with Java (JDBC_PORT)

• Variable name: AS.DBS.JDBC_PORT
• Description:
This variable specifies the port used to connect to the database by jdbc.
Maximum number of connections to the database made by JDS (MAXCONNECTIONS)

• Variable name: AS.DBS.MAXCONNECTIONS
• Description:
This variable specifies the maximum number of connections to the database
made by JDS. For Oracle please verify that the instance parameter 'processes'
is at least MAXCONNECTIONS+50.
• Type: Integer (min: 20)
Number of minutes to wait for reconnect (MAXWAITTIMETORECONNECTMINUTES)

• Variable name: AS.DBS.MAXWAITTIMETORECONNECTMINUTES
• Description:
This variable specifies the maximum number of minutes to try to reconnect
to the database by JDS.

AR100500-01-ACN-EN-04
Oracle SID be used in connect string (SID)
• Variable name: AS.DBS.SID

• Description:
Applies for Oracle only. This variable specifies the database SID.
• Type: String
Server where the database resides on (DBSERVER)
• Variable name: AS.DBS.DBSERVER

• Description:
This variable specifies the name of the database server. 'localhost' is not
allowed.
• Type: String
User of database (DBLOGIN)
• Variable name: AS.DBS.DBLOGIN

• Description:
This variable specifies the database user.
• Type: String
User password of database (DBPASSWORD)
• Variable name: AS.DBS.DBPASSWORD

• Description:
This variable specifies the password of the database user. For MS SQL Server
no ';' is allowed.
• Type: String
43.4 Notification Server (NOTS)

Storage location:
\NOTS.Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/NOTS.
Setup
Directory for storing event files (EVENTDIR)
• Variable name: AS.NOTS.EVENTDIR

• Description:

AR100500-01-ACN-EN-04
43.4. Notification Server (NOTS)
Directory for event files (*.evt). Default is $IXOS_ARCHIVE_ROOT/config/

notifconf
• Type: Path
Max. number of counts a notification can be resent (RESENDNOTIFCOUNT)

• Variable name: AS.NOTS.RESENDNOTIFCOUNT
• Description:
Maximal number of counts an unsuccessful notification is tried to be resent.
Max. number of message threads (MAXMSGTHREADS)

• Variable name: AS.NOTS.MAXMSGTHREADS
• Description:
Maximal number of message threads in the thread pool
“MessageThreadPool”
Message catalogs directory (MSGCATDIR)

• Variable name: AS.NOTS.MSGCATDIR
• Description:
Directory for message catalog files (*.cat). Default is $IXOS_ARCHIVE_ROOT/
config/msgcat
• Type: Path
Notification configuration directory (NOTIFCONFDIR)

• Variable name: AS.NOTS.NOTIFCONFDIR
• Description:
Directory for notification configuration files (*.nots). Default is
$IXOS_ARCHIVE_ROOT/config/notifconf
• Type: Path
Notification server port (DEFAULT_NOTS_PORT)

• Variable name: AS.NOTS.DEFAULT_NOTS_PORT
• Description:
Port of the notification server.
Timeout for reoccurring messages in seconds (DEFAULT_NOTS_REOCC)

• Variable name: AS.NOTS.DEFAULT_NOTS_REOCC

AR100500-01-ACN-EN-04
• Description:
Time in seconds; a message occurring several times will be prevented from
being mapped to a notification until the message has not occurred for
<DEFAULT_NOTS_REOCC> seconds. If the class of the message is SRV, the
identification key for this message is class-comp-msgno-hostname-
msgtext, else the identification key is class-comp-msgno.
Timeout for RPC requests to ADMS in seconds (DEFAULT_NOTS_TIMEOUT)
• Variable name: AS.NOTS.DEFAULT_NOTS_TIMEOUT

• Description:
Time in seconds; sets the timeout for RPC requests to ADMS to
<DEFAULT_NOTS_TIMEOUT> seconds.
Background: During startup ADMS takes some time before being ready for
answering connection requests from the Notification Server (= notifSrvr).
Wait time in seconds before a notification is resent (RESENDNOTIFWAIT)
• Variable name: AS.NOTS.RESENDNOTIFWAIT

• Description:
Time in seconds; Time the notification server waits before an unsuccessful
notification is resent.
43.5 Key Export Tool (RCIO)

Storage location:
\RCIO.Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/RCIO.
Setup
Path of the exported key store (DEFAULT_PEM_PATH)
• Variable name: AS.RCIO.DEFAULT_PEM_PATH

• Description:
Default path where the exported key store is written/read. The export/import
tool suggests this default path every time the user is asked for a filename to
read a token from/write a token to.
• Type: Path

AR100500-01-ACN-EN-04
43.6. Storage Manager (STORM)
43.6 Storage Manager (STORM)

Storage location:
- Windows: Configuration file: <ECM_ARCHIVE_SERVER_CONF>\config\storm
\server.cfg
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/storm/server.
cfg
43.6.1 Configuration STORM (file server.cfg)

Storage location:
\server.cfg
cfg
43.6.1.1 Parameters Sizing STORM Server

Storage location:
\server.cfg
cfg
Timeout for drive access operations (in seconds) (parameters.iotimo)

• Variable name: AS.STORM.parameters.iotimo
• Description:
IO Timeout: Maximum time to retrieve information from a drive (in
seconds). This parameter may be set online.
43.6.1.2 Parameter SCSI report

Storage location:
\server.cfg
cfg
SCSI report level (parameters.report)

• Variable name: AS.STORM.parameters.report
• Description:
SCSI Report Level (can be set dynamically):
• 0: no logging
• 1: logging SCSI errors

AR100500-01-ACN-EN-04
• 2: tracing of nearly all SCSI commands
Note: This parameter is effective only if the trace level for the
component scsi is at least 1!
• Type: Enum
• Allowed Value:
• 0 ("0: no logging")
• 1 ("1: logging SCSI errors")
• 2 ("2: tracing of nearly all SCSI commands")
43.6.1.3 Parameters jbd scheduler

Storage location:
\server.cfg
cfg
Disable parallel testing of media in one jukebox (parameters.noParTst)

• Variable name: AS.STORM.parameters.noParTst
• Type: Flag
• Allowed Value:
• 0 ("Parallel testing")
• 1 ("No parallel testing")
43.6.1.4 Parameters ISO9660 Finalization

Storage location:
\server.cfg
cfg
Loglevel (fin_volid.log) (finalization.Loglev)

• Variable name: AS.STORM.finalization.Loglev
• Description:
Loglevel of program fin, which writes trace info to file fin_-VOLID-.log

AR100500-01-ACN-EN-04
43.6.1.5 Parameters Logging Filenames/Dirs/Limits

Storage location:
\server.cfg
cfg
Directory to locate the logfiles (logfile.originalPathDirectory)

• Variable name: AS.STORM.logfile.originalPathDirectory
• Description:
Directory to locate the logfiles. This parameter is typically not set for IXOS-
eCONserver installations, because this path is set as commandline parameter
for JBD. Note: The commandline parameter has higher priority than this
entry! If either this parameter is not set nor set in the commandline, then the
JBD configuration root directory is taken as location for the logfiles.
• Type: Path
Directory to locate the logfiles of a backup run (logfile.backupPathDirectory)

• Variable name: AS.STORM.logfile.backupPathDirectory
• Description:
Directory to locate the logfiles of a backup run (check program of inode files
on backup destination). The same as for originalPathDirectory applies: The
parameter is set as commandline parameter by the IXOS-eCONserver
installation. If either this parameter is not set nor set in the commandline,
then the JBD backup configuration root directory is taken as location for the
logfiles.
• Type: Path
File name for errors and important messages (logfile.logfileNamePrefix)

• Variable name: AS.STORM.logfile.logfileNamePrefix
• Description:
Name of the error file. The default is jbd. For a backuprun back is appended
before this prefix. The postfix is always .log.
• Type: Path
• Predefined Value: jbd
File name for last words (logfile.lwordsfileNamePrefix)

• Variable name: AS.STORM.logfile.lwordsfileNamePrefix
• Description:
Name of the lwords file. The default is jbd_lwords. For a backuprun back is
appended before this prefix. The postfix is always .log.
• Type: Path

AR100500-01-ACN-EN-04
• Predefined Value: jbd_lwords
File name for logging hardware errors (logfile.HWerrorLog)

• Variable name: AS.STORM.logfile.HWerrorLog
• Description:
Filename to protocol hardware errors detected by reading or writing to
media. This setting is optional.
Default: The configured path for the logfiles, filename: hw_errors.log.
• Type: Path
• Predefined Value: hw_errors.log
File name for traces (logfile.tracefileNamePrefix)

• Variable name: AS.STORM.logfile.tracefileNamePrefix
• Description:
Name of the trace file. The default is jbd_trace. The postfix is always .log.
• Type: Path
• Predefined Value: jbd_trace
Limit (MB) of error logfile (logfile.sizeMBerrFile)

• Variable name: AS.STORM.logfile.sizeMBerrFile
• Description:
Specifies size limitation of error file. The value is interpreted as MB value.
Limit (MB) of trace logfile (logfile.sizeMB)

• Variable name: AS.STORM.logfile.sizeMB
• Description:
Specifies size limitation of trace file. The value is interpreted as MB value.
Number of saved logging file versions after jbd restart (includes logfile of current
jbd run) (logfile.cyclicNo)
• Variable name: AS.STORM.logfile.cyclicNo
• Description:
Specifies number of logfiles to create. For every start of JBD a new logfile is
created. Old logfiles are renamed from *.log to .000, .001,... This number is
valid for the tracefile, the lastwords and the error file. The minimum value is
0, that means no cyclic logfiles. If a logfile already exists messages are
appended, else they are written in the common way (if the value is set below
0, then 1 is taken). A value of 1 creates exactly one logfile (.log) which is
erased and new created by every start of JBD.

AR100500-01-ACN-EN-04

43.6.1.6 Logging Trace Levels

Storage location:
\server.cfg
cfg
43.6.1.6.1 Defaults Logging Trace Levels
Storage location:
\server.cfg
cfg
Default trace level (loglevels.defaults.trace)
• Variable name: AS.STORM.loglevels.defaults.trace

Default trace level of last words logging file (loglevels.defaults.lwords)
• Variable name: AS.STORM.loglevels.defaults.lwords

43.6.1.6.2 Logging trace levels STORM internal components
Storage location:
\server.cfg
cfg
Trace levels of single jbd components (loglevels.

components.listLogCompNames)
• Variable name: AS.STORM.loglevels.components.listLogCompNames

• Sub variables:
[ID]
• Variable name: ID
• Type: String § §

AR100500-01-ACN-EN-04
Trace level
• Variable name: trace
Loglevel for last words trace file

• Variable name: lwords
• Predefined Value:
• ID=sched
• trace=1
• lwords=4
• ID=corecomp
• trace=1
• lwords=4
• ID=nfs
• trace=1
• lwords=4
• ID=pres
• trace=1
• lwords=4
• ID=rpc
• trace=1
• lwords=4
• ID=fsiso
• trace=1
• lwords=4
• ID=fsisocore
• trace=1
• lwords=4
• ID=fsraw
• trace=1
• lwords=4

AR100500-01-ACN-EN-04
• ID=ixwuser
• trace=1
• lwords=4
• ID=ixwmedia
• trace=1
• lwords=4
• ID=ixwinout
• trace=1
• lwords=4
• ID=ixwcache
• trace=1
• lwords=4
• ID=cache
• trace=1
• lwords=4
• ID=glow
• trace=1
• lwords=4
• ID=io
• trace=1
• lwords=4
• ID=hal
• trace=1
• lwords=4
• ID=serial
• trace=1
• lwords=4
• ID=scsi
• trace=1
• lwords=4

AR100500-01-ACN-EN-04
• ID=doscsi
• trace=1
• lwords=4
• ID=journal
• trace=1
• lwords=4
• ID=voldb
• trace=1
• lwords=4
• ID=file
• trace=1
• lwords=4
• ID=config
• trace=1
• lwords=4
• ID=utils
• trace=1
• lwords=4
• ID=backup
• trace=1
• lwords=4
• ID=rfs
• trace=1
• lwords=4
• ID=jbd
• trace=1
• lwords=4
• ID=devctl
• trace=1
• lwords=4
• ID=fsifs

AR100500-01-ACN-EN-04
• trace=1
• lwords=4
• ID=dyn
• trace=1
• lwords=4
• ID=nots
• trace=0
• lwords=4
• ID=watch
• trace=0
• lwords=4
43.6.1.7 Parameters Notification server connection (NOTS)

Storage location:
\server.cfg
cfg
Disable sending of messages to NOTS server (archenv.nonotsserver)
• Variable name: AS.STORM.archenv.nonotsserver

• Description:
Disables the send functionality to NOTS. The rest of the code, except send is
executed and send is simulated to be always successful. Example:
nonotsserver { 1 } switches sending messages over NFS to NOTS off.
• Type: Flag
• Allowed Value:
• 0
• 1 ("Send to NOTS disabled")
NOTS server name (hostname) (archenv.nots)
• Variable name: AS.STORM.archenv.nots

• Description:
The server name of the notification server.
• Type: String

AR100500-01-ACN-EN-04
43.6.1.8 STORM Internals

Storage location:
\server.cfg
cfg
Path name STORM control files (vol_jbd, journal, ...) (internals.path)

• Variable name: AS.STORM.internals.path
• Description:
Defines the location of the STORM internal files in a section.
• Type: Path
• Predefined Value: database
43.6.1.9 Parameters STORM Statistics

Storage location:
\server.cfg
cfg
Collect statistics every n seconds (statistics.Periodic)

• Variable name: AS.STORM.statistics.Periodic
Enable Statistics (statistics.Enable)

• Variable name: AS.STORM.statistics.Enable
• Type: Flag
• Allowed Value:
• 0 ("Disable")
• 1 ("Enable")
Filename of Statistics file (without suffix) (statistics.Name)

• Variable name: AS.STORM.statistics.Name
• Type: Path
• Predefined Value: jbd_stat
Keep previous versions of statistics (statistics.Preserve)

• Variable name: AS.STORM.statistics.Preserve
• Type: Flag

AR100500-01-ACN-EN-04
• Allowed Value:
• 0 ("No preserve")
• 1 ("Preserve")
Path to files containing the statistics information (statistics.Path)

• Variable name: AS.STORM.statistics.Path
• Type: Path
• Predefined Value: notdefined
43.6.1.10 Parameters ISO9660 Filesystem

Storage location:
\server.cfg
cfg
Size (MB) of ISO9660 file attributes cache (iso9660.CacheMBsize)

• Variable name: AS.STORM.iso9660.CacheMBsize
• Description:
Size of directory cache in MB.
43.6.1.11 Device Configuration

Storage location:
\server.cfg
cfg
Note: All sub variables of the device variable with a name starting with devfile_*
are not stored at the storage location specified above, but in a file according to the
following pattern:
%IXOS_ARCHIVE_ROOT%\config\storm\devices\<device>.dev (Windows) or
$IXOS_ARCHIVE_ROOT/config/storm/devices/<device>.dev (UNIX)
where <device> means the string specified in the device name sub variable.
Devices (devices.list)
• Variable name: AS.STORM.devices.list
• Sub variables:
ID

AR100500-01-ACN-EN-04
• Description:
ID
• Type: String
Path to device definition file
• Variable name: path

• Description:
Filename of the hash or inode file (never network attached).
• Type: Path
Configuration of groups (nodes) - used to group device definition files of a

jukebox for each cluster node
• Variable name: nodes

• Sub variables:
ID of (cluster) node
• Type: String
Path and file name of device definition file of a node

• Type: Path
List of pathes of alternate device definition files for a node
• Variable name: alternatePaths

• Type: Structure, consisting of subvariables - see below for
details
• Sub variables:
Alternate Path

• Type: String
Path to save file of device
• Variable name: save

• Description:
File path of the save file of the device. The save file is used by JBD to
avoid testing all slots after attaching a jukebox. Note: If this entry is
missing, then no save file is created and hence there will be a
complete testing of the jukebox slots for every attach!
• Type: Path

AR100500-01-ACN-EN-04
Path to status file of device
• Variable name: status

• Type: Path
Path and name to TOC file of device
• Variable name: tocfile

• Description:
File path of TOC file. The TOC file is used by JBD to store slot access
pathes or information. The parameter is needed only for virtual
jukeboxes, which do not have real magazine slots (Example: Centera,
TSM (Tivoli), HSM device definitions) Note: If this entry is missing,
then attach of virtual jukeboxes aborts with error.
• Type: Path
• Predefined Value: notdefined
Device startup type
• Variable name: startup

• Description:
How to attach the jukebox. manual: Means manual attaching of
jukebox. Automatic means automatic attach during JBD startup (This
is the usual case for IXOS-eCONtext).
• Type: Enum
• Allowed Value:
• automatic
• manual
Comment
• Variable name: devfile_comment

• Sub variables:
Comment Text
• Variable name: text

• Type: String
Device Name
• Variable name: devfile_device

• Type: String
Robot
• Variable name: devfile_robot

• Type: String

AR100500-01-ACN-EN-04
Drives
• Variable name: devfile_drive

• Sub variables:
SCSI Path for Jukeboxes or address path for virtual jukeboxes
• Variable name: scsiId

• Type: String
Detach behaviour in case of volumes getting bad (param nobad)
• Variable name: devfile_nobad

• Type: Enum
• Allowed Value:
• 0 ("No Detach (default)")

• 1 ("Detach")
Timeout (sec) for automatic mailslot close (param trayto)
• Variable name: devfile_trayto

Retention class or number (days or special values -1 and -2)
• Variable name: devfile_retention

• Type: String (minSize: 1)
Size of blank medium for virtual jukeboxes
• Variable name: devfile_blanksize

Maximum number of slots (param maxslots)
• Variable name: devfile_maxslots

Attach/Detach REZERO UNIT behaviour (param rezero)
• Variable name: devfile_rezero

• Type: Enum
• Allowed Value:
• 1 ("REZERO UNIT only during attach")

• 2 ("REZERO UNIT only during detach")
• 0 ("REZERO UNIT during attach and detach")
• 3 ("No REZERO UNIT")

AR100500-01-ACN-EN-04
Slot range (Example: 3-12,14,18-234)

• Variable name: devfile_slots
• Type: String (minSize: 1)
Double sided medium support (param sides)

• Variable name: devfile_sides
• Type: Enum
• Allowed Value:
• 1 ("Single sided medium support")
• 2 ("Double sided medium support")
List of pathes of alternate device definition files

• Variable name: alternatePaths
• Sub variables:
Alternate Path
• Type: String
43.6.1.12 NFS VIEWS Definition

Storage location:
\server.cfg
cfg
Configurable volume trees (views.list)

• Variable name: AS.STORM.views.list
• Description:
ID
• Sub variables:
[ID]
• Description:
ID
• Type: String
Format
• Variable name: format

AR100500-01-ACN-EN-04

• Type: Enum
• Allowed Value:
• hs ("HighSierra")
• pc ("PC")
• rr ("RockRidge")
Raw access
• Variable name: raw
• Type: Enum
• Allowed Value:
• 0
• 1 ("enabled")
Use for finalization

• Variable name: fin
• Type: Enum
• Allowed Value:
• 0
• 1 ("enabled")
• ID=views_hs
• format=hs
• raw=0
• fin=1
• ID=views_raw
• format=rr
• raw=1
• fin=1
Restrict NFS access to hosts (hosts)

• Variable name: AS.STORM.hosts
• Description:
Only these hosts can communicate with JBD.
• Sub variables:
[HOST]
• Variable name: HOST

AR100500-01-ACN-EN-04
• Type: String
• Predefined Value: HOST=localhost
• Predefined Value: HOST=<empty>
• Predefined Value: HOST=<empty>
43.6.1.13 Backup STORM control files

Storage location:
\server.cfg
cfg
Backup Directories (backup.list)

• Variable name: AS.STORM.backup.list
• Description:
ID
The maximum allowed size of the file in MegaByte.
List of directories to save backup (described in the subsections dest1 .. destn
with pathname and size).
• Sub variables:
ID
• Description:
ID
• Type: String
Path to Backup Destination

• Description:
• Type: Path
Limit of space usage (in MB) for backup (space must be free in defined
path)
• Variable name: size
• Description:

AR100500-01-ACN-EN-04
• ID=dest1
• path=<empty>
• size=1024
Backup root directory (backup.backuproot)
• Variable name: AS.STORM.backup.backuproot

• Description:
Backuproot is one special directory of the list of backups which is considered
as root for the backups.
• Type: String
• Predefined Value: dest1
43.6.1.14 WORM Filesystem

Storage location:
\server.cfg
cfg
Accept of also non-ISO9660 format (e.g. more than 64KB Directories) (ixworm.
isoFinNonStandard)
• Variable name: AS.STORM.ixworm.isoFinNonStandard

• Description:
Accept of also non-ISO9660 format (e.g. more than 64KB Directories). Note:
the place for finalizing is always reserved (independent of this parameter
value).
• Type: Enum
• Allowed Value:
• 0
• 1 ("enabled")
Cache File Path for accumulated blocks (ixworm.CacheFilePath)
• Variable name: AS.STORM.ixworm.CacheFilePath

• Description:
Directory path for accumulated FCB blocks (optional parameter). Needs 10
Megabytes space. Without definition of this parameter the default of
directory path is “DataFilePath”. IXW filesystem stores temporary certain
blocks for simultaneous written media like WORMs. These blocks
accumulate FCB information for a WORM and if the block is full, then it is
written. The cache file path should never be a network attached HD.
• Type: Path

AR100500-01-ACN-EN-04
Data File Path (ixworm.DataFilePath)
• Variable name: AS.STORM.ixworm.DataFilePath

• Description:
Directory path to the temporary files stored on disc while the files are written
by the clients. The path should never be a network attached HD. Note: There
must be enough space to hold (worst case) “maxOpenDatafiles” <max.
fileSize of one WORM file>.
• Type: Path
Limit of rehashes after which a warning is generated (ixworm.rehashWarning)
• Variable name: AS.STORM.ixworm.rehashWarning

• Description:
If the WORM file system is getting full, then there will be more and more
rehashes for a new entry. This values is set to the limit after which a warning
is generated. (the log level for the warning message is output at: MAX (9 +
(value of this parameter -<number of rehashes> ), 0) ), but only if the number
of rehashes is > rehashWarning.
Maximum Number of Inodes (ixworm.numInodes)
• Variable name: AS.STORM.ixworm.numInodes

• Description:
Maximum number of inodes (total files and directories). For one IXOS-
eCONtext document, there may be about 8 inodes. This value determines the
actually used sizes for the different chunks configured in the cache
subsection.
Depending on the WORM file system size, this parameter has different
default values:
Small WORM file system:
- Original hash chunk size: 35 MB,
- inode chunk size: 600 MB,
- inode number default:
$DefaultValue{STORM##STORM:WormFS_Small:ixworm.numInodes}
Medium WORM file system:
$DefaultValue{STORM##STORM:WormFS_Medium:ixworm.numInodes}
Large WORM file system:
$DefaultValue{STORM##STORM:WormFS_Large:ixworm.numInodes}

AR100500-01-ACN-EN-04

Maximum number of open files for writing concurrently (ixworm.

maxOpenDatafiles)
• Variable name: AS.STORM.ixworm.maxOpenDatafiles

• Description:
Maximum number of open files to write for the WORM file system. This sets
the number of clients which can concurrently write to different files in the
WORM-FS, i. e. not more than “maxOpenDatafile”s can concurrently be
written to by different (or the same) clients.
43.6.1.14.1 Definition for hashing directories
Storage location:
\server.cfg
cfg
Definition of hashdir chunks (ixworm.ixwhashdir.files)
• Variable name: AS.STORM.ixworm.ixwhashdir.files

• Description:
List of files wich are referenced later in their own subsections.
• Sub variables:
ID
• Description:
ID
• Type: String
Path and file name of hashdir chunk

• Description:
• Type: Path

AR100500-01-ACN-EN-04
Size (in MB)

• Description:
File opening mode

• Variable name: mode
• Description:
Memory mapped (mapped) or not (file). If a file cannot be memory
mapped due to system restrictions, file mode is used independant of
the parameter setting.
• Type: Enum
• Allowed Value:
• file ("file")
• mapped ("mapped")
Size of entry in hashdir (ixworm.ixwhashdir.nodesize)

• Variable name: AS.STORM.ixworm.ixwhashdir.nodesize
• Description:
Size of one hash entry: 4 bytes for hash, 64 for inodes. Don't modify this
value!
43.6.1.14.2 Definition of hashing file names
Storage location:
\server.cfg
cfg
Definition of hashname chunks (ixworm.ixwhashname.files)

• Variable name: AS.STORM.ixworm.ixwhashname.files
• Sub variables:
ID

AR100500-01-ACN-EN-04

• Description:
ID
• Type: String
Path and file name of hashname chunk

• Description:
• Type: Path
Size (in MB)

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
43.6.1.14.3 Definition of hashing file IDs
Storage location:
\server.cfg
cfg
Definition of hashfile chunks (ixworm.ixwhashfile.files)

• Variable name: AS.STORM.ixworm.ixwhashfile.files
• Sub variables:

AR100500-01-ACN-EN-04
ID
• Description:
ID
• Type: String
Path and file name of hashfile chunk

• Description:
• Type: Path
Size (in MB)

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")

AR100500-01-ACN-EN-04
43.6.1.14.4 Definition of files to store inodes
Storage location:
\server.cfg
cfg
Definition of inode chunks (ixworm.ixwinodes.files)
• Variable name: AS.STORM.ixworm.ixwinodes.files

• Sub variables:
ID
• Description:
ID
• Type: String
Path and file name of inode chunk

• Description:
• Type: Path
Size (in MB)

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04
• file ("file")
43.6.1.15 WORM Filesystem (Small: original hash chunk size 35 MB - inode

chunk size 600 MB)
Storage location:
\server.cfg
cfg
isoFinNonStandard)

• Description:
value).
• Type: Enum
• Allowed Value:
• 0
• 1 ("enabled")

• Description:
• Type: Path

• Description:
• Type: Path

AR100500-01-ACN-EN-04

• Description:

• Description:
eCONtext document there may be about 8 inodes. This value determines the
subsection.
default values: Small WORM file system: - Original hash chunk size: 35 MB, -
inode chunk size: 600 MB, - inode number default:
Medium WORM file system: - Original hash chunk size: 200 MB, - inode
chunk size: 600 MB, - inode number default:
Large WORM file system: - Original hash chunk size: 700 MB, - inode chunk
size: 800 MB, - inode number default:

maxOpenDatafiles)

• Description:

AR100500-01-ACN-EN-04
43.6.1.15.1 Definition of hashing directories
Storage location:
\server.cfg
cfg

• Description:
ID
Memory mapped (mapped) or not (file). If a file cannot be memory mapped
due to system restrictions, file mode is used independant of the parameter
setting.
• Sub variables:
ID
• Description:
ID
• Type: String

• Description:
• Type: Path
Size (in MB)

• Description:

AR100500-01-ACN-EN-04
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• path=REPLACE_WITH_HASH_DIR_PATH/hashdir
• size=35
• mode=mapped

• Description:
value!
Storage location:
\server.cfg
cfg

• Description:
ID
setting.

AR100500-01-ACN-EN-04

• Sub variables:
ID
• Description:
ID
• Type: String

• Description:
• Type: Path
Size (in MB)

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• path=REPLACE_WITH_HASH_NAME_PATH/hashname
• size=35
• mode=mapped

AR100500-01-ACN-EN-04
Storage location:
\server.cfg
cfg

• Description:
ID
setting.
• Sub variables:
ID
• Description:
ID
• Type: String

• Description:
• Type: Path
Size (in MB)

• Description:

AR100500-01-ACN-EN-04
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• path=REPLACE_WITH_HASH_FILE_PATH/hashfile
• size=35
• mode=mapped
Storage location:
\server.cfg
cfg

• Description:
ID
setting.
• Sub variables:
ID
• Description:
ID
• Type: String

AR100500-01-ACN-EN-04

• Description:
• Type: Path
Size (in MB)

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• path=REPLACE_WITH_INODE_PATH/inodes
• size=600
• mode=file

AR100500-01-ACN-EN-04
43.6.1.16 WORM Filesystem (Medium: original hash chunk size 200 MB -

inode chunk size 600 MB)
Storage location:
\server.cfg
cfg
isoFinNonStandard)

• Description:
value).
• Type: Enum
• Allowed Value:
• 0
• 1 ("enabled")

• Description:
• Type: Path

• Description:
• Type: Path


AR100500-01-ACN-EN-04
• Description:

• Description:
subsection.

maxOpenDatafiles)

• Description:

AR100500-01-ACN-EN-04
Storage location:
\server.cfg
cfg

• Description:
ID
setting.
• Sub variables:
ID
• Description:
ID
• Type: String

• Description:
• Type: Path
Size (in MB)

• Description:

AR100500-01-ACN-EN-04
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• size=200
• mode=mapped

• Description:
value!
Storage location:
\server.cfg
cfg

• Description:
ID
setting.

AR100500-01-ACN-EN-04

• Sub variables:
ID
• Description:
ID
• Type: String

• Description:
• Type: Path
Size (in MB)

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• size=200
• mode=mapped

AR100500-01-ACN-EN-04
Storage location:
\server.cfg
cfg

• Description:
ID
setting.
• Sub variables:
ID
• Description:
ID
• Type: String

• Description:
• Type: Path
Size (in MB)

• Description:

AR100500-01-ACN-EN-04
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• size=200
• mode=mapped
Storage location:
\server.cfg
cfg

• Description:
ID
setting.
• Sub variables:
ID
• Description:
ID
• Type: String

AR100500-01-ACN-EN-04

• Description:
• Type: Path
Size (in MB)

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• path=REPLACE_WITH_INODE_PATH/inodes1
• size=600
• mode=file
• ID=chunk2
• size=600
• mode=file
• ID=chunk3
• size=600
• mode=file

AR100500-01-ACN-EN-04
• ID=chunk4
• size=600
• mode=file
• ID=chunk5
• size=600
• mode=file
43.6.1.17 WORM Filesystem (Large: original hash chunk size 700 MB -

inode chunk size 800 MB)
Storage location:
\server.cfg
cfg
isoFinNonStandard)

• Description:
value).
• Type: Enum
• Allowed Value:
• 0
• 1 ("enabled")

• Description:
• Type: Path


AR100500-01-ACN-EN-04
• Description:
• Type: Path

• Description:

• Description:
subsection.

maxOpenDatafiles)

• Description:

AR100500-01-ACN-EN-04

Storage location:
\server.cfg
cfg

• Description:
ID
setting.
• Sub variables:
ID
• Description:
ID
• Type: String

• Description:
• Type: Path
Size (in MB)


AR100500-01-ACN-EN-04

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• size=700
• mode=file

• Description:
value!
Storage location:
\server.cfg
cfg

• Description:
ID

AR100500-01-ACN-EN-04

setting.
• Sub variables:
ID
• Description:
ID
• Type: String

• Description:
• Type: Path
Size (in MB)

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• size=700

AR100500-01-ACN-EN-04
• mode=file
Storage location:
\server.cfg
cfg

• Description:
ID
setting.
• Sub variables:
ID
• Description:
ID
• Type: String

• Description:
• Type: Path
Size (in MB)

• Description:

AR100500-01-ACN-EN-04
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• size=700
• mode=file
Storage location:
\server.cfg
cfg

• Description:
ID
setting.
• Sub variables:
ID
• Description:
ID
• Type: String

AR100500-01-ACN-EN-04

• Description:
• Type: Path
Size (in MB)

• Description:
File opening mode

• Description:
• Type: Enum
• Allowed Value:
• file ("file")
• ID=chunk1
• size=800
• mode=file
• ID=chunk2
• size=800
• mode=file
• ID=chunk3
• size=800
• mode=file

AR100500-01-ACN-EN-04
• ID=chunk4
• size=800
• mode=file
• ID=chunk5
• size=800
• mode=file
• ID=chunk6
• size=800
• mode=file
• ID=chunk7
• size=800
• mode=file
• ID=chunk8
• size=800
• mode=file
• ID=chunk9
• size=800
• mode=file
• ID=chunk10
• size=800
• mode=file
• ID=chunk11
• size=800
• mode=file
• ID=chunk12
• size=800

AR100500-01-ACN-EN-04
• mode=file
• ID=chunk13
• size=800
• mode=file
43.7 Timestamp Server (TSTP)

Storage location:
\TSTP.Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/TSTP.
Setup
Allow remote administration from any host (TSTP_PUBLIC_ADMIN)

• Variable name: AS.TSTP.TSTP_PUBLIC_ADMIN
• Description:
Setting this checkbox to “on” will cause the service to accept configuration-
requests from any host.
• Type: Flag
• Allowed Value:
• on
• off
Days to warn before a certificate expires (TSTP_CERT_EXPIRE_WARN)

• Variable name: AS.TSTP.TSTP_CERT_EXPIRE_WARN
• Description:
If a certificate is going to expire, the timestamp server can send a notification
every 24 hours. This parameters specifies how many days before the date of
expiration the sending of notifications should start.
Enforce usage of the following hash-algorithm for TS signatures

(TSTP_FORCE_HASH_ALG)
• Variable name: AS.TSTP.TSTP_FORCE_HASH_ALG
• Description:
Usually the timestamp-server signs the timestamp using the same hash-
algorithm as the one used in the TS-Request. This parameter can overwrite
the behavior and enforce the usage of a certain algorithm.
• Type: Enum
• Predefined Value: none

AR100500-01-ACN-EN-04
43.7. Timestamp Server (TSTP)
• Allowed Value:
• none ("same as in TS request")
• MD5 ("MD5")
• SHA1 ("SHA1")
• RMD160 ("RipeMD160")
• SHA256 ("SHA256")
• SHA512 ("SHA512")
File for the timestamp-protocol (TSTP_PROTOCOL_FILE)

• Variable name: AS.TSTP.TSTP_PROTOCOL_FILE
• Description:
For each issued timestamp an entry is made into this file.
• Type: Path
Host to accept configuration-requests from (TSTP_ADMIN_HOSTS)

• Variable name: AS.TSTP.TSTP_ADMIN_HOSTS
• Description:
The Timestamp Server Administration can be installed on a different
computer to initialize the service on this server. If a hostname is specified
here, configuration-requests from that host will be accepted. If no hostname
is supplied, only local initialization is possible.
• Type: String
Max. size of the protocol-file (Kilobytes) (TSTP_PROTOCOL_MAX_KB)

• Variable name: AS.TSTP.TSTP_PROTOCOL_MAX_KB
• Description:
The protocol-file is moved to .old and a new protocol is started if the
specified size is exceeded. The previous .old file is overwritten. A value of 0
disables this feature.
Policy OID for IETF-Timestamps (TSTP_POLICY_OID)

• Variable name: AS.TSTP.TSTP_POLICY_OID
• Description:
Timestamps in the PKIX format (RFC 3161) contain an object identifier (OID)
which defines a timestamp policy. Leave the default value (1.3.6.1.5.7.7.2)
unless you know exactly what you need.
• Type: String
• Predefined Value: 1.3.6.1.5.7.7.2
Timeout - how long the system-clock is trusted (TSTP_ACK_INTERVAL)

• Variable name: AS.TSTP.TSTP_ACK_INTERVAL

AR100500-01-ACN-EN-04
• Description:
Because the internal clock of a computer has limited precision, this setting
provides a possibility to set a timeout period in hours after which the service
refuses to timestamp incoming requests. The timeout counter is reset every
time you transmit the signing key. A timeout setting of “0” will disable this
feature and leave the server running unlimited.
Timestamp server port (TSTP_SERVER_PORT)

• Variable name: AS.TSTP.TSTP_SERVER_PORT
• Description:
The one and only communication interface of the running service is a TCP
port. Timestamp requests sent to this address will be processed if the service
is running and configured. Therefore you must specify the port number. The
default value is “32001”; any number between “1” and “65535” might work
unless another service is already running on that port. When in doubt,
contact your system administrator.
When to warn before the timeout is reached (TSTP_ACK_WARN)

• Variable name: AS.TSTP.TSTP_ACK_WARN
• Description:
A notification will be sent to the notification server a given number of hours
before the timeout is reached. The status of the Timestamp Service icon in the
Archive Web Monitor will change to “warning”'. A setting of “0” disables
this feature.
43.7.1 Configuration for Autostart

Storage location:
\TSTP.Setup
Setup
Passphrase for the private-key (TSTP_KEY_PASSPHRASE)

• Variable name: AS.TSTP.TSTP_KEY_PASSPHRASE
• Description:
The passphrase with which the signature key is protected in encrypted
format.
• Type: String

AR100500-01-ACN-EN-04
43.7. Timestamp Server (TSTP)
Path to the certificate 1 (TSTP_CERTIFICATE00)

• Variable name: AS.TSTP.TSTP_CERTIFICATE00
• Description:
The root certificate.
• Type: Path

• Description:
(Optional) Subsequent certificate from the hierarchy.
• Type: Path

• Description:
• Type: Path

• Description:
• Type: Path
Path to the private-key file (TSTP_SIGNATURE_KEY)

• Variable name: AS.TSTP.TSTP_SIGNATURE_KEY
• Description:
Where the signature key is stored in PEM format.
• Type: Path
Plaintext Passphrase for the private-key (TSTP_PLAIN_PASSPHRASE)

• Variable name: AS.TSTP.TSTP_PLAIN_PASSPHRASE
• Description:
The passphrase with which the signature key is protected in plain-text. It is
recommended to not use this setting anymore. Rather use
“StampKeyProtection”
• Type: String

AR100500-01-ACN-EN-04
43.7.2 Script for the Archive Web Monitor

Storage location:
\TSTP.Setup
Setup
Hostname of the timestamp-server (TSTP_HOST)

• Variable name: AS.TSTP.TSTP_HOST
• Description:
Where the script should try to contact the Timestamp Server. This can be a
remote machine. If this item is not set, localhost is tried instead.
• Type: String
What kind of timestamp-server the script should expect (IXTWATCH_TS_SYSTEM)

• Variable name: AS.TSTP.IXTWATCH_TS_SYSTEM
• Description:
The Archive Web Monitor can display the status of either a Timestamp
Service, a timeproof TSS80 system, an AuthentiDate or of a KeyOn
timestamp system.
• Type: Enum
• Predefined Value: IXOS
• Allowed Value:
• IXOS ("Timestamp Server")
• timeproof ("Timeproof TSS compatible")
• AuthentiDate ("AuthentiDate")
• KeyOn ("KeyOn")
• none ("Don't use monitor-script")
43.8 Volume Migration (VMIG)

Storage location:
\VMIG.Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/VMIG.
Setup
Check duration of calls to external components of volmig (TIME_MEASUREMENT)

• Variable name: AS.VMIG.TIME_MEASUREMENT
• Description:
time measurement of volmig calls to components DB (local + remote),
STORM (local + remote) and DS
• Type: Flag

AR100500-01-ACN-EN-04
43.8. Volume Migration (VMIG)
• Allowed Value:
• on
• off
Check number of migrated docs/comps in DB between remote and local

(USE_IMPORT_COUNTS)
• Variable name: AS.VMIG.USE_IMPORT_COUNTS

• Description:
check number of imported docs and components between remote and local
DB
• Type: Flag
• Allowed Value:
• on
• off
Default hostname for the client to connect to (SERVER_HOST)
• Variable name: AS.VMIG.SERVER_HOST

• Type: String
Don't abort the job if import counts are different (IGNORE_IMPORT_COUNTS)
• Variable name: AS.VMIG.IGNORE_IMPORT_COUNTS

• Description:
ignore the result of the IMPORT_COUNT_CHECK, write error message only
• Type: Flag
• Allowed Value:
• on
• off
Enable ArchiSig timestamp RipeMD-160 hash value verification

(VMIG_VERIFY_DIG4)
• Variable name: AS.VMIG.VMIG_VERIFY_DIG4

• Description:
Allow usage of a component's ArchiSig timestamp's hash value for checksum
verification if it is a RipeMD-160 digest.
• Type: Flag
• Allowed Value:
• on
• off

AR100500-01-ACN-EN-04
Enable ArchiSig timestamp SHA-1 hash value verification (VMIG_VERIFY_DIG2)

• Description:
verification if it is a SHA-1 digest.
• Type: Flag
• Allowed Value:
• on
• off
Enable ArchiSig timestamp SHA256 hash value verification (VMIG_VERIFY_DIG5)

• Description:
verification if it is a SHA256 digest.
• Type: Flag
• Allowed Value:
• on
• off
Enable ArchiSig timestamp SHA512 hash value verification (VMIG_VERIFY_DIG6)

• Description:
verification if it is a SHA512 digest.
• Type: Flag
• Allowed Value:
• on
• off
Enable client-generated hash value verification (VMIG_VERIFY_CL_SIG)

• Variable name: AS.VMIG.VMIG_VERIFY_CL_SIG
• Description:
Allow usage of a component's client generated hash value for checksum
verification. Documents archived with libdsh-based applications (e. g.
pipeline) have such an attribute. Usually this is a SHA-1 digest.
• Type: Flag
• Allowed Value:

AR100500-01-ACN-EN-04
43.8. Volume Migration (VMIG)
• on
• off
Enable CRC32 checksum verification (VMIG_VERIFY_CRC32)

• Variable name: AS.VMIG.VMIG_VERIFY_CRC32
• Description:
Allow usage of the CRC32 checksum for checksum verification. Documents
archived with Server Version 9.6 or later have such an attribute.
• Type: Flag
• Allowed Value:
• on
• off
Enable timestamp hash value verification (VMIG_VERIFY_SIG)

• Variable name: AS.VMIG.VMIG_VERIFY_SIG
• Description:
Allow usage of a component's timestamp's hash value for checksum
verification. Usually this is a SHA1 digest.
• Type: Flag
• Allowed Value:
• on
• off
List all DocID/CompID tuples in job protocol (DUMP_COMP_IDS)

• Variable name: AS.VMIG.DUMP_COMP_IDS
• Description:
If on, the server adds each component to the job protocol as soon as a copy
job has been created for it.
• Type: Flag
• Allowed Value:
• on
• off
Lower process priority (PRIORITY_THROTTLE)

• Variable name: AS.VMIG.PRIORITY_THROTTLE
• Description:
If on, the process priority of VolMig is set to a low value:
UNIX: NZERO-1, i.e. lowest priority;
Windows: IDLE_PRIORITY_CLASS (corresponds to Low in the task manager)

AR100500-01-ACN-EN-04
• Type: Flag
• Allowed Value:
• on
• off
Max. MB of documents to copy in one run (MEGABYTES_PER_NIGHT)
• Variable name: AS.VMIG.MEGABYTES_PER_NIGHT

• Description:
This parameter limits the amount of data that is put into the queue to be
written to an optical medium in the assigned target pool. As soon as the total
data size in this queue exceeds the value specified here, the migration server
stops enqueueing further components.
Protocol directory (PROTOCOL_DIRECTORY)
• Variable name: AS.VMIG.PROTOCOL_DIRECTORY

• Description:
In this directory, all components that have successfully been migrated are
listed, using one file per source medium.
• Type: Path
Warn after how many days if component not written (MAX_DAYS_TO_COPY)
• Variable name: AS.VMIG.MAX_DAYS_TO_COPY

• Description:
If a component has not been written to a medium in the target pool after the
number of days specified here, the copy job is repeated. The administrator
should check the respective dsCD/dsWorm jobs (a notification is sent)
• Type: Integer (min: -1, max: 365)
43.8.1 Mapping of NFSSERVER names

Storage location:
\VmigNFSmap.Setup
VmigNFSmap.Setup
NFSSERVER mappings (nfsmap)
• Variable name: AS.VmigNFSmap.nfsmap

• Type: String

AR100500-01-ACN-EN-04
43.9. Archive Server settings (JDS)
43.9 Archive Server settings (JDS)

Storage location:
- Windows: Configuration file: <ECM_ARCHIVE_SERVER_CONF>\config\setup\AS.
Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/AS.
Setup
43.9.1 Document Service related settings

Storage location:
Setup
Setup
Desired mimimum time since last update request

(JDS_ADM_REFRESH_MINIMUM_REQUEST_GAP)
• Variable name: AS.AS.JDS_ADM_REFRESH_MINIMUM_REQUEST_GAP

• Description:
Number of seconds to be elapsed since last update request. If another update
event is received in the interim, JDS waits another
“JDS_ADM_REFRESH_INTERVAL” seconds before updating its
administrative state.
Distribution timeout (DISTRIBUTE_TIMEOUT_BASE)
• Variable name: AS.AS.DISTRIBUTE_TIMEOUT_BASE

• Description:
Base timeout for content distribution from one cluster node to the other in
milliseconds. See “DISTRIBUTE_TIMEOUT_PER_MB”.
Distribution timeout per MB (DISTRIBUTE_TIMEOUT_PER_MB)
• Variable name: AS.AS.DISTRIBUTE_TIMEOUT_PER_MB

• Description:
Milliseconds to be added per MB to the base timeout for content distribution
from one cluster node to the other. See “DISTRIBUTE_TIMEOUT_BASE”.

AR100500-01-ACN-EN-04
Enable CRC32 check (WRITE_ATTRIBATR_WITH_CRC32_CHECK)

• Variable name: AS.AS.WRITE_ATTRIBATR_WITH_CRC32_CHECK
• Description:
Enable the check for CRC32 checksum. This feature can only be enabled if no
old documents are in the Archive Server.
• Type: Flag
• Predefined Value: false
• Allowed Value:
• true
• false
Grace period for disposal of expired documents (DISPOSE_GRACE_PERIOD)

• Variable name: AS.AS.DISPOSE_GRACE_PERIOD
• Description:
Number of days that must have been expired since the expiry date of the
documents retention.
Interval for remote administration server job updates

(ADM_JOB_UPDATE_INTERVAL)
• Variable name: AS.AS.ADM_JOB_UPDATE_INTERVAL
• Description:
Number of seconds between checks for changes to administration server job
specifications caused by remote nodes.
Main Component Names (DS_MAIN_COMP_NAME_LIST)

• Variable name: AS.AS.DS_MAIN_COMP_NAME_LIST
• Description:
This setting specifies all component names which the Archive Server
recognizes as so called “main” components. These further means that a
component named like this is returned if the client did not specify a
component name with an “ArchiveLink get” request. “Internal” setting only,
do not modify until otherwise instructed!
• Type: String
• Predefined Value: data data1 1.pg
Map onTape to offline (MAP_ON_TAPE_TO_OFFLINE)

• Variable name: AS.AS.MAP_ON_TAPE_TO_OFFLINE

AR100500-01-ACN-EN-04
• Description:
If true use “offline” instead of “onTape” state if request accesses a
component which is stored on a tape. This is for “old” only, default is “false”.
“Internal” setting only, do not modify until otherwise instructed!
• Type: Flag
• Allowed Value:
• true
• false
Output directory for billing reports (BILLING_REPORT_DIR)

• Variable name: AS.AS.BILLING_REPORT_DIR
• Description:
Output directory for Archive Center billing reports.
• Type: Path
Refresh interval for administrative information (JDS_ADM_REFRESH_INTERVAL)

• Variable name: AS.AS.JDS_ADM_REFRESH_INTERVAL
• Description:
Number of seconds between checks for changes originated at the
administration service.
Tape Pool jobs (TAPE_JOBS)

• Variable name: AS.AS.TAPE_JOBS
• Description:
Number of parallel restoring jobs.
Tape Pool restoring queue size (TAPE_QUEUESIZE)

• Variable name: AS.AS.TAPE_QUEUESIZE
• Description:
Maximum number of entries in restoring queue.
Time interval during which a pending update request may be delayed further
(JDS_ADM_REFRESH_MAXIMUM_DELAY)
• Variable name: AS.AS.JDS_ADM_REFRESH_MAXIMUM_DELAY

AR100500-01-ACN-EN-04
• Description:
After “JDS_ADM_REFRESH_MAXIMUM_DELAY” seconds a pending
update request will not be delayed further by successive update requests.
Use External Hostname (USE_EXTERN_HOST_NAME)
• Variable name: AS.AS.USE_EXTERN_HOST_NAME

• Description:
If true the Archive Server uses the Server Name as it is specified in other
Configuration Settings, e.g.: DSHOST, MY_HOST_NAME, etc. If set to false a
normalized server name (= lower case letters, stripping domain information)
is used. “Internal” setting only, do not modify until otherwise instructed!
• Type: Flag
• Predefined Value: true
• Allowed Value:
• true
• false
Use MimeType Derivation (USE_MIMETYPE_DERIVATION)
• Variable name: AS.AS.USE_MIMETYPE_DERIVATION

• Description:
If false use “old-style” mime types just used for SAP Certification. Default is
“true”. “Internal” setting only, do not modify until otherwise instructed!
• Type: Flag
• Allowed Value:
• true
• false
Use Notifications in Document Service (USE_NOTS)
• Variable name: AS.AS.USE_NOTS

• Description:
If true the Archive Server sends notifications in case of special events, e.g.:
threat detection, etc. To use this feature please check the Administration
guide for setting up notifications.
• Type: Flag
• Allowed Value:
• on
• off

AR100500-01-ACN-EN-04
Use old creation date (USE_OLD_CREATION_DATE)

• Variable name: AS.AS.USE_OLD_CREATION_DATE
• Description:
If true use “old-style” creation date just used for SAP Certification. Default is
“false”. “Internal” setting only, do not modify until otherwise instructed!
• Type: Flag
• Allowed Value:
• true
• false
43.9.1.1 Alias name for Retrieval Requests

Storage location:
\AliasGet.Setup
AliasGet.Setup
List of (read) Alias Names: aliasName mimeType componentName

(GET_ALIAS_TYPES)
• Variable name: AS.AliasGet.GET_ALIAS_TYPES
• Description:
Alias names for the component names on retrieval requests
• Sub variables:
Alias Name (+ MimeType)

• Variable name: compalias
• Type: String
• Predefined Value: compalias=note application/x-note im
• compalias=<empty>
• compalias=DefaultValue
• Predefined Value: compalias=data image/tiff 1.pg
• Predefined Value: compalias=data image/jpeg 1.pg
• compalias=<empty>
• compalias=DefaultValue

AR100500-01-ACN-EN-04
43.9.1.2 Alias name for Storage Requests

Storage location:
\AliasPut.Setup
AliasPut.Setup
List of (write) Alias Names: aliasName mimeType componentName

(PUT_ALIAS_TYPES)
• Variable name: AS.AliasPut.PUT_ALIAS_TYPES
• Description:
Alias names for the component names on storage requests
• Sub variables:
Alias Name (+ MimeType)

• Variable name: compalias
• Type: String
• Predefined Value: compalias=comp1 application/x-appl comp2
43.9.1.3 Tape Pools and Volumes

Storage location:
\TapePoolVolume.Setup
TapePoolVolume.Setup
List of Tape Pools and Volumes: archiveName poolName volumeName

(AS_TAPE_POOL_VOL)
• Variable name: AS.TapePoolVolume.AS_TAPE_POOL_VOL
• Description:
Add an entry for each Archive, Pool with the corresponding CacheVolume
(used to restore the documents from tape.) The format is archiveName
poolName volumeName
• Sub variables:
Archive and Pool and Volume)

• Variable name: archpoolvol
• Type: String

AR100500-01-ACN-EN-04
43.9.2 Notification Clients

Storage location:
Setup
Setup
Hostname of Notification Service (NOTIFHOST)

• Variable name: AS.AS.NOTIFHOST
• Description:
• Type: String
Nots Port (DEFAULT_NOTS_PORT)

• Variable name: AS.AS.DEFAULT_NOTS_PORT
• Description:
Use Secure Protocol (DEFAULT_NOTS_SECURE)

• Variable name: AS.AS.DEFAULT_NOTS_SECURE
• Description:
• Type: Flag
• Allowed Value:
• on
• off
43.9.3 Filter settings

Storage location:
Setup
Setup
Case sensitivity flag for original email message names

(EA_MSG_CASE_INSENSITIVE)
• Variable name: AS.AS.EA_MSG_CASE_INSENSITIVE

AR100500-01-ACN-EN-04
• Description:
Case sensitivity flag for original email message names (default=on).
• Type: String
Case sensitivity flag for original email message names (composer)

(EA_COMPOSER_MSG_CASE_INSENSITIVE)
• Variable name: AS.AS.EA_COMPOSER_MSG_CASE_INSENSITIVE

• Description:
Case sensitivity flag for original email message names (composer). If value is
set (not empty), it supersedes value of EA_MSG_CASE_INSENSITIVE
(internal name). “Internal” setting only, do not modify until otherwise
instructed!
• Type: String
Case sensitivity flag for original email message names (decomposer)

(EA_DECOMPOSER_MSG_CASE_INSENSITIVE)
• Variable name: AS.AS.EA_DECOMPOSER_MSG_CASE_INSENSITIVE

• Description:
Case sensitivity flag for original email message names (decomposer). If value
is set (not empty), it supersedes value of EA_MSG_CASE_INSENSITIVE
instructed!
• Type: String
Checking attachment names (composer) (EA_COMPOSER_CHECK_ATTACHMENT_NAME)
• Variable name: AS.AS.EA_COMPOSER_CHECK_ATTACHMENT_NAME

• Description:
Checking attachment names when composing emails (default=on). “Internal”
setting only, do not modify until otherwise instructed!
• Type: Flag
• Allowed Value:
• on
• off
Component names of original email message (EA_MSG_NAMES)
• Variable name: AS.AS.EA_MSG_NAMES

• Description:

AR100500-01-ACN-EN-04
Component names (separated by comma) of original email message which

triggers the email processing (default=DATA.MSG). “Internal” setting only,
• Type: String
Component names of original email message (composer)

(EA_COMPOSER_MSG_NAMES)
• Variable name: AS.AS.EA_COMPOSER_MSG_NAMES
• Description:
triggers the email composer processing. If value is set, it supersedes value of
EA_MSG_NAMES (internal name). “Internal” setting only, do not modify
until otherwise instructed!
• Type: String
Component names of original email message (decomposer)

(EA_DECOMPOSER_MSG_NAMES)
• Variable name: AS.AS.EA_DECOMPOSER_MSG_NAMES
• Description:
triggers the email decomposer processing. If value is set, it supersedes value
of EA_MSG_NAMES (internal name). “Internal” setting only, do not modify
• Type: String
Component types of original email message (decomposer)

(EA_DECOMPOSER_MSG_TYPES)
• Variable name: AS.AS.EA_DECOMPOSER_MSG_TYPES
• Description:
Component types (separated by comma) of original email message which
triggers the email decomposer processing (default=application/
msoutlook,application/vnd.ms-outlook). “Internal” setting only, do not
modify until otherwise instructed!
• Type: String
Email Composer class (PRE_FILTER)

• Variable name: AS.AS.PRE_FILTER
• Description:
This variable specifies the Java implementation of the email composer filter
(default=com.opentext.ecm.lea.filter.email.composer.EmailComposerFilter).

AR100500-01-ACN-EN-04
• Type: String
• Predefined Value: com.opentext.ecm.lea.filter.email.composer.
EmailComposerFilter
Email Decomposer class (SIA_PRE_FILTER)
• Variable name: AS.AS.SIA_PRE_FILTER

• Description:
This variable specifies the Java implementation of the email decomposer
filter
(default=com.opentext.ecm.lea.filter.email.decomposer.EmailDecomposerFilt
er). “Internal” setting only, do not modify until otherwise instructed!
• Type: String
• Predefined Value: com.opentext.ecm.lea.filter.email.decomposer.
EmailDecomposerFilter
Main component of an email document (EA_MAIN_COMPONENT)
• Variable name: AS.AS.EA_MAIN_COMPONENT

• Description:
Main component name of an email document which will be returned in
document info request (default=DATA.MSG). “Internal” setting only, do not
• Type: String
Maximum number of retries for memory allocation

(EA_MAX_TOTAL_MSG_SIZE_RETRIES)
• Variable name: AS.AS.EA_MAX_TOTAL_MSG_SIZE_RETRIES

• Description:
Maximum number of retries for memory allocation (default=0). “Internal”
Maximum size of an email held in memory (EA_STORE_TO_FILE_SIZE)
• Variable name: AS.AS.EA_STORE_TO_FILE_SIZE

• Description:
Maximum size of an email where composing/decomposing will totally be
done in memory. If size of email exceeds this limit, then email will
temporarily be stored on file system to de-/compose (default=10000000).
• Type: Integer

AR100500-01-ACN-EN-04
Maximum size of an email held in memory by composer

(EA_COMPOSER_STORE_TO_FILE_SIZE)
• Variable name: AS.AS.EA_COMPOSER_STORE_TO_FILE_SIZE
• Description:
Maximum size of an email where composing will totally be done in memory.
If value is set, it supersedes value of EA_STORE_TO_FILE_SIZE (internal
name). “Internal” setting only, do not modify until otherwise instructed!
• Type: Integer
Maximum size of an email held in memory by decomposer

(EA_DECOMPOSER_STORE_TO_FILE_SIZE)
• Variable name: AS.AS.EA_DECOMPOSER_STORE_TO_FILE_SIZE
• Description:
Maximum size of an email where decomposing will totally be done in
memory. If value is set, it supersedes value of EA_STORE_TO_FILE_SIZE
instructed!
• Type: Integer
Maximum size of an email message, which will be decomposed

(EA_DECOMPOSER_MAX_MSG_SIZE_MB)
• Variable name: AS.AS.EA_DECOMPOSER_MAX_MSG_SIZE_MB
• Description:
Maximum size of an email message, which will be decomposed
(default=200). Bigger emails won't be decomposed!
• Type: Integer
Maximum size of simultaneously processed email messages

(EA_MAX_TOTAL_MSG_SIZE_MB)
• Variable name: AS.AS.EA_MAX_TOTAL_MSG_SIZE_MB
• Description:
Maximum size of simultaneously processed email messages
(default=10000000). “Internal” setting only, do not modify until otherwise
instructed!
• Type: Integer
Minimum size of an EML attachment needed to decompose

(EA_EML_MIN_ATTACH_LEN)
• Variable name: AS.AS.EA_EML_MIN_ATTACH_LEN

AR100500-01-ACN-EN-04
• Description:
Attachments in eml files smaller than this parameter will not be extracted/
decomposed!
• Type: Integer
Pattern describing component name of email message (EA_MSG_PATTERN)
• Variable name: AS.AS.EA_MSG_PATTERN

• Description:
Pattern describing component name of email message which triggers the
email processing (default=^DATA.MSG$). “Internal” setting only, do not
• Type: String
Pattern describing component name of email message (composer)

(EA_COMPOSER_MSG_PATTERN)
• Variable name: AS.AS.EA_COMPOSER_MSG_PATTERN

• Description:
email processing. If value is set, it supersedes value of EA_MSG_PATTERN
instructed!
• Type: String
Pattern describing component name of email message (decomposer)

(EA_DECOMPOSER_MSG_PATTERN)
• Variable name: AS.AS.EA_DECOMPOSER_MSG_PATTERN

• Description:
email decomposer processing. If value is set, it supersedes value of
EA_MSG_PATTERN (internal name). “Internal” setting only, do not modify
• Type: String
Pattern describing component types of email message (decomposer)

(EA_DECOMPOSER_MSG_TYPE_PATTERN)
• Variable name: AS.AS.EA_DECOMPOSER_MSG_TYPE_PATTERN

• Description:
Pattern describing component types of email message which triggers the
email decomposer processing (default=^(application/msoutlook)|

AR100500-01-ACN-EN-04
(application/vnd.ms-outlook)$). “Internal” setting only, do not modify until

otherwise instructed!
• Type: String
Pattern describing internal component names of an email

(EA_INTERNAL_COMPONENT_NAMES_PATTERN)
• Variable name: AS.AS.EA_INTERNAL_COMPONENT_NAMES_PATTERN
• Description:
Pattern describing internal component names created by email decomposer
filter (default=^(DATA2.MSG|REFERENCES3|ATTACH[0-9][0-9][0-9][0-9]
[0-9])$). “Internal” setting only, do not modify until otherwise instructed!
• Type: String
Temporary directory to compose emails (EA_COMPOSER_TMP_DIR)

• Variable name: AS.AS.EA_COMPOSER_TMP_DIR
• Description:
Temporary directory to compose emails. If value is set, it supersedes value of
EA_TMP_DIR (internal name). “Internal” setting only, do not modify until
• Type: Path
Temporary directory to de-/compose emails (EA_TMP_DIR)

• Variable name: AS.AS.EA_TMP_DIR
• Description:
Temporary directory to de-/compose large emails (default=value of java
property java.io.tmpdir).
• Type: Path
Temporary directory to decompose emails (EA_DECOMPOSER_TMP_DIR)

• Variable name: AS.AS.EA_DECOMPOSER_TMP_DIR
• Description:
Temporary directory to decompose emails. If value is set, it supersedes value
of EA_TMP_DIR (internal name). “Internal” setting only, do not modify until
• Type: Path
Wait timeout if EA_MAX_TOTAL_MSG_SIZE_MB exceeded

(EA_MAX_TOTAL_MSG_SIZE_TIMEOUT_NS)
• Variable name: AS.AS.EA_MAX_TOTAL_MSG_SIZE_TIMEOUT_NS
• Description:

AR100500-01-ACN-EN-04
Wait timeout, required if maximum total size of simultaneously processed

emails exceeded (default=1000000000). “Internal” setting only, do not modify
• Type: Integer
43.9.4 Administration Service

Storage location:
Setup
Setup
43.9.4.1 Database
Storage location:
Setup
Setup
Logging level for database access (ADS_Database_LogLevel)

• Variable name: AS.AS.ADS_Database_LogLevel
• Description:
This setting specifies the log level for the database access of the
administration service.
• Type: Enum
• Predefined Value: INFO
• Allowed Value:
• CONFIG ("CONFIG")
• FINE ("FINE")
• FINER ("FINER")
• FINEST ("FINEST")
• INFO ("INFO")
• WARNING ("WARNING")
• SERVERE ("SERVERE")

AR100500-01-ACN-EN-04
43.9.4.2 Command
Storage location:
Setup
Setup
Maximum number of protocols before purging will occur

(ADS_Command_MaxInstances)
• Variable name: AS.AS.ADS_Command_MaxInstances
• Description:
This settings specifies the maximum number of protocols before purging will
occur. If a command will be executed a protocol will be written. This
protocol will be stored in the database tables “adm_command_instance” and
“adm_protocol_entry”.
Percentage of protocols to purge (ADS_Command_DeletionFactor)

• Variable name: AS.AS.ADS_Command_DeletionFactor
• Description:
This variable is related to the variable “ADS_Command_MaxInstances”. If
the maximum number of protocols is exceeded this setting specifies how
much old protocols will be purged in the database.
43.9.4.3 Audit
Storage location:
Setup
Setup
Controls whether to audit error requests (ADS_Audit_Errors)

• Variable name: AS.AS.ADS_Audit_Errors
• Description:
This setting specifies whether requests to the Administration Service which
fail are audited or not.
A request to the Administration Service is a webservice call to
http//:<host>:<port>/ot-ads/services/Administration?wsdl
• Type: Flag
• Allowed Value:

AR100500-01-ACN-EN-04
• true
• false
Controls whether to audit read requests (ADS_Audit_Reads)

• Variable name: AS.AS.ADS_Audit_Reads
• Description:
This setting specifies whether read requests to the Administration Service are
audited or not.
• Type: Flag
• Allowed Value:
• true
• false
43.9.4.4 OTDSconnection
Storage location:
Setup
Setup
Name of an internal OTDS user allowed to upload documents (OTDS_SYS_USER)

• Variable name: AS.AS.OTDS_SYS_USER
• Description:
This setting specifies the name of the OTDS user who is allowed to upload
documents.
• Type: String
• Predefined Value: system.cmis
Name of the OTDS query field: domain name (user or group) (OTDS_QUERY_NAME)
• Variable name: AS.AS.OTDS_QUERY_NAME
• Description:
This setting specifies the name of the field containing the Active Directory
attribute for the domain name, user or group.
• Type: String
• Predefined Value: oTExternalID4
Name of the OTDS query field: SID (OTDS_QUERY_SID)

• Variable name: AS.AS.OTDS_QUERY_SID
• Description:

AR100500-01-ACN-EN-04
This setting specifies the name of the field containing the Active Directory
attribute 'objectSid'.
• Type: String
• Predefined Value: oTExternalSID
Name of the OTDS user partition of business administrators

(OTDS_SYS_PARTITION)
• Variable name: AS.AS.OTDS_SYS_PARTITION
• Description:
This setting specifies the name of the OTDS user partition. This user partition
contains per tenant two user groups and one technical user. The following
naming convention for the tenant <tenant> is definied:
• Group of business administrators: <tenant>
• Group of users for the alternative access: <tenant>_ED
• Technical user for uploading documents: sys.<tenant>
• Type: String
• Predefined Value: OTInternal
Port of the existing Directory Services installation (OTDS_PORT)

• Variable name: AS.AS.OTDS_PORT
• Description:
This setting specifies the port number of of the Directory Services
installation.
Protocol of the existing Directory Services installation (OTDS_PROTOCOL)

• Variable name: AS.AS.OTDS_PROTOCOL
• Description:
This setting specifies the protocol of the Directory Services installation.
• Type: Enum
• Predefined Value: https
• Allowed Value:
• https ("HTTPS")
• http ("HTTP")
Resource ID assigned to this Archive Services installation (OTDS_RESOURCE)

• Variable name: AS.AS.OTDS_RESOURCE
• Description:
This setting is the resource ID assigned to this Archive Services in Directory
Services.
• Type: String

AR100500-01-ACN-EN-04
Resource key (OTDS_KEY)
• Variable name: AS.AS.OTDS_KEY

• Description:
Internal setting required when using Directory Services. Should never be
changed without explicit advice by OpenText.
• Type: String
Server Authentication Check Policy (OTDS_SSL_POLICY)
• Variable name: AS.AS.OTDS_SSL_POLICY

• Description:
This setting controls how strict the Directory Services SSL/TLS certificate
should be checked.
Strict verification requires fully and properly set up trust and keys stores at
both - Archive Server and Directory Services web application server - so
Archive Server can properly check the identity of the server hosting
Directory Services.
Lazy verification performs basic validity checks of the certificate it provides
during SSL/TLS handshake and lenient checks of the server's host name
against the information in the certificate but does not require a
corresponding trust store setup.
• Type: Enum
• Predefined Value: lazy
• Allowed Value:
• lazy ("lazy")
• strict ("strict")
Server name of the existing Directory Services installation (OTDS_SERVER_NAME)
• Variable name: AS.AS.OTDS_SERVER_NAME

• Description:
This setting specifies the host name of of the Directory Services installation.
• Type: String
TTL for OTDS Ticket (OTDS_TICKET_TTL)
• Variable name: AS.AS.OTDS_TICKET_TTL

• Description:
This setting specified the "time to live" for an authentication token (in
seconds). If a session stays idle for longer than the specified time re-
authentication is required.

AR100500-01-ACN-EN-04
43.9.4.5 AllowedUsers
Storage location:
Setup
Setup
admuser1 (ADS_AllowedUsers_admuser1)
• Variable name: AS.AS.ADS_AllowedUsers_admuser1
• Description:
This setting specifies a user or group. The value of this variable must match
the pattern “<UMS>/<USERGROUP>/<NAME>” with
• UMS can be OTDS or DS
• USERGROUP can be USER or GROUP
• NAME is the concrete user or group name
• Type: String
• Description:
• Type: String
• Description:
• Type: String

AR100500-01-ACN-EN-04
• Description:
• Type: String
• Description:
• Type: String
aradmins (ADS_AllowedUsers_aradmins)
• Variable name: AS.AS.ADS_AllowedUsers_aradmins
• Description:
• Type: String
• Predefined Value: DS/GROUP/aradmins
dsadmin (ADS_AllowedUsers_dsadmin)
• Variable name: AS.AS.ADS_AllowedUsers_dsadmin
• Description:

AR100500-01-ACN-EN-04

• Type: String
• Predefined Value: DS/USER/dsadmin
ldadmins (ADS_AllowedUsers_ldadmins)
• Variable name: AS.AS.ADS_AllowedUsers_ldadmins
• Description:
• Type: String
• Predefined Value: DS/GROUP/ldadmins
ldagents (ADS_AllowedUsers_ldagents)
• Variable name: AS.AS.ADS_AllowedUsers_ldagents
• Description:
• Type: String
• Predefined Value: DS/GROUP/ldagents
otadsadmins (ADS_AllowedUsers_otadsadmins)
• Variable name: AS.AS.ADS_AllowedUsers_otadsadmins
• Description:
• Type: String
• Predefined Value: OTDS/GROUP/otadsadmins@otds.admin
otasadmins (ADS_AllowedUsers_otasadmins)
• Variable name: AS.AS.ADS_AllowedUsers_otasadmins

AR100500-01-ACN-EN-04
• Description:
• Type: String
• Predefined Value: OTDS/GROUP/otasadmins@otds.admin
otldadmins (ADS_AllowedUsers_otldadmins)
• Variable name: AS.AS.ADS_AllowedUsers_otldadmins
• Description:
• Type: String
• Predefined Value: OTDS/GROUP/otldadmins@otds.admin
otldagents (ADS_AllowedUsers_otldagents)
• Variable name: AS.AS.ADS_AllowedUsers_otldagents
• Description:
• Type: String
• Predefined Value: OTDS/GROUP/otldagents@otds.admin

AR100500-01-ACN-EN-04
43.9.4.6 Policy
Storage location:
Setup
Setup
43.9.4.6.1 Assignments
Storage location:
Setup
Setup
List of users allowed to administrate the Solution Registry

(ADS_PolicyAssignments_LDAdmin)
• Variable name: AS.AS.ADS_PolicyAssignments_LDAdmin

• Description:
This setting specifies a comma separated list of “users” which are allowed to
administration the Solution Registry. This list is only valid, if no right was
found in the user's groups.
A user is described by a configuration variable under the node
“Administration Service / AllowedUsers” which is named
“ADS_AllowedUsers_<user>”. The value of this variable must match the
pattern “<UMS>/<USERGROUP>/<NAME>” with


• Type: String
• Predefined Value: otldadmins,ldadmins,otadsadmins,dsadmin,aradmins
List of users allowed to start Solution Registry Agent

(ADS_PolicyAssignments_LDAgent)
• Variable name: AS.AS.ADS_PolicyAssignments_LDAgent

• Description:
run the Solution Registry Agent. This list is only valid, if no right was found
in the user's groups.

AR100500-01-ACN-EN-04

If no authentication is required to run the Solution Registry Agent, set the

variable to “%%%NO_AUTHENTICATION%%%”
• Type: String
• Predefined Value: otldagents,ldagents,otadsadmins,dsadmin,aradmins
List of users allowed to use the Administration Service

(ADS_PolicyAssignments_ADSAdmin)
• Variable name: AS.AS.ADS_PolicyAssignments_ADSAdmin
• Description:
use the Administration Service without any restrictions. This list is only
valid, if no right was found in the user's groups.

• Type: String
• Predefined Value: otadsadmins,dsadmin,aradmins,otasadmins
43.9.4.7 Reports
Storage location:
Setup
Setup
Controls the maximum size of a report (ADS_Reports__Control_MaxSize)

• Variable name: AS.AS.ADS_Reports__Control_MaxSize
• Description:

AR100500-01-ACN-EN-04
This setting controls the maximum size in kB of a report.

Controls whether the report prints additional messages

(ADS_Reports__Control_Debug)
• Variable name: AS.AS.ADS_Reports__Control_Debug
• Description:
This setting controls whether the report prints additional logging messages.
Normally set for trouble shooting.
• Type: Flag
• Allowed Value:
• true
• false
43.9.4.7.1 Archive Report
Storage location:
Setup
Setup
Maximum number of volumes per device

(ADS_Reports_Archive_MaxVolumesPerDevice)
• Variable name: AS.AS.ADS_Reports_Archive_MaxVolumesPerDevice
• Description:
This setting specifies the maximum of volumes per device which are printed
by the report.
Maximum number of volumes per pool

(ADS_Reports_Archive_MaxVolumesPerPool)
• Variable name: AS.AS.ADS_Reports_Archive_MaxVolumesPerPool
• Description:
This setting specifies the maximum of volumes per pool which are printed
by the report.

AR100500-01-ACN-EN-04
43.9.4.8 SolutionRegistry
Storage location:
Setup
Setup
Controls whether this host provides the Solution Registry

(ADS_SolutionRegistry_Enabled)
• Variable name: AS.AS.ADS_SolutionRegistry_Enabled
• Description:
Controls whether this host provides the Solution Registry. The Solution
Registry entry in the Administration Client is added to the console tree (or
removed, if disabled) after signing out and in again to the host.
• Type: Flag
• Allowed Value:
• true
• false
43.9.4.8.1 SAP System Landscape Directory
Storage location:
Setup
Setup
Connection string of the SAP System Landscape Directory

(ADS_SolutionRegistry_SLDUrl)
• Variable name: AS.AS.ADS_SolutionRegistry_SLDUrl
• Description:
Connection string of the SAP System Landscape Directory.
Contact your SAP administrator for the connection parameters to the SAP
System Landscape Directory.
• Type: String
Controls whether to upload data to the SAP SLD

(ADS_SolutionRegistry_SLDEnabled)
• Variable name: AS.AS.ADS_SolutionRegistry_SLDEnabled
• Description:
Controls whether to upload data to the SAP System Landscape Directory.
The upload from the OpenText Solution Registry to the SAP System
Landscape Directory is provided by the action "Upload to SAP SLD" in the

AR100500-01-ACN-EN-04
Administration Client (Navigation path: Solution Registry / SAP Landscape

Directory).
In this case the variable must be set to “true” and valid connection
parameters for the variables ADS_SolutionRegistry_SLDUrl,
ADS_SolutionRegistry_SLDUser and ADS_SolutionRegistry_SLDPassword
must be provided.
• Type: Flag
• Allowed Value:
• true
• false
Password used to access the SAP System Landscape Directory

(ADS_SolutionRegistry_SLDPassword)
• Variable name: AS.AS.ADS_SolutionRegistry_SLDPassword

• Description:
Password used to access the SAP System Landscape Directory.
• Type: String
User name used to access the SAP System Landscape Directory

(ADS_SolutionRegistry_SLDUser)
• Variable name: AS.AS.ADS_SolutionRegistry_SLDUser

• Description:
User name used to access the SAP System Landscape Directory.
• Type: String
43.9.5 Search Service

Storage location:
Setup
Setup
Directory for the Elastic Search index and data (ES_DATA_DIRECTORY)
• Variable name: AS.AS.ES_DATA_DIRECTORY

• Description:

AR100500-01-ACN-EN-04
This setting specifies the directory where all elastic index and config data is
stored. If this variable is empty the default directory will $ECM_VAR_DIR/
es.
• Type: Path
43.9.6 MDF Rendition Service

Storage location:
Setup
Setup
Controls the maximum size any MDF rendition is held in memory.

(RENDITION_MAX_IN_MEM_SIZE)
• Variable name: AS.AS.RENDITION_MAX_IN_MEM_SIZE
• Description:
This setting controls the maximum size in kB until any MDF rendition is
hold in memory.
43.9.7 Archive Administration Service

Storage location:
Setup
Setup
OTDS Archive Administrator group (ADM_OTDS_AS_ADMIN_GROUP)

• Variable name: AS.AS.ADM_OTDS_AS_ADMIN_GROUP
• Description:
This variable specifies an OTDS group. OTDS users which are member of
this group are allowed to administrate the complete Archive Server.
If the current user is not member of this group or this value will be erased,
the Archive Server will check the rights resp. policies of the OTDS user
which are assigned to a corresponding DS group.
The corresponding DS group will be determined by the following algorithm:
The OTDS group name will be extracted from the group id
<groupname>@<partition_name>. If this group name will then be found in
the built-in User Management System (Document Service) the assigned
policies defines the rights of the OTDS user.
Remark: This kind of group mapping works only for OTDS group names
which contain not other characters than [a-zA-Z0-9].
• Type: String

AR100500-01-ACN-EN-04
• Predefined Value: otasadmins@otds.admin
43.9.7.1 Contact Information

Storage location:
Setup
Setup
Email Address of the Archive Administrator (ADM_ADMINISTRATOR_EMAIL)

• Variable name: AS.AS.ADM_ADMINISTRATOR_EMAIL
• Description:
This setting specifies the email address of the Archive Administrator. This
information will be displayed in the Business Administration Web Client.
• Type: String
Name of the Archive Administrator (ADM_ADMINISTRATOR_NAME)

• Variable name: AS.AS.ADM_ADMINISTRATOR_NAME
• Description:
This setting specifies the real name of the Archive Administrator. This
• Type: String
Phone number of the Archive Administrator (ADM_ADMINISTRATOR_PHONENO)

• Variable name: AS.AS.ADM_ADMINISTRATOR_PHONENO
• Description:
This setting specifies the phone number of the Archive Administrator. This
• Type: String
43.9.8 Logging
Storage location:
Setup
Setup

AR100500-01-ACN-EN-04
43.9.8.1 Application Server

Storage location:
Setup
Setup
Administration (LOG_ADMIN)
• Variable name: AS.AS.LOG_ADMIN
• Description:
This setting specifies the log level for “Administration” category. See also
key: “LOG_ADMIN_GROUP” There are 4 distinct settings which add
additional logging from top to bottom.
• Type: Enum
• Predefined Value: Warn
• Allowed Value:
• Warn ("Errors and Warnings")
• Info ("Errors, Warnings and Info")
• Debug ("Errors, Warnings, Info and Debug")
• Trace ("Errors, Warnings, Info, Debug and Trace")
CMIS Interface (LOG_CMIS)

• Variable name: AS.AS.LOG_CMIS
• Description:
This setting specifies the log level for the category “CMIS Interface”. See also
key: “LOG_CMIS_GROUP”. There are 4 distinct settings with increased
logging from top to bottom.
• Type: Enum
• Allowed Value:
Document Service (LOG_JDS)

• Variable name: AS.AS.LOG_JDS
• Description:
This setting specifies the log level for “Document Service” category. See also
key: “LOG_JDS_GROUP” There are 4 distinct settings which add additional
• Type: Enum

AR100500-01-ACN-EN-04
• Allowed Value:

Document Service Database (LOG_JDSDB)
• Variable name: AS.AS.LOG_JDSDB

• Description:
This setting specifies the log level for “Document Service Database”
category. See also key: “LOG_JDSDB_GROUP” There are 4 distinct settings
which add additional logging from top to bottom.
• Type: Enum
• Allowed Value:

Metadata Layer (LOG_METADATA)
• Variable name: AS.AS.LOG_METADATA

• Description:
This setting specifies the log level for the category “Metadata Layer”. See also
key: “LOG_METADATA_GROUP”. There are 4 distinct settings with
increased logging from top to bottom.
• Type: Enum
• Allowed Value:

Notification Client (LOG_NOTSCLIENT)
• Variable name: AS.AS.LOG_NOTSCLIENT

• Description:
This setting specifies the log level for “Notification Client” category. See also
key: “LOG_NOTSCLIENT_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04

OTE System and Jobs (LOG_OTE)

• Variable name: AS.AS.LOG_OTE
• Description:
This setting specifies the log level for “OTE System and Jobs” category. There
are 4 distinct settings which add additional logging from top to bottom.
• Type: Enum
• Allowed Value:
Search Service (LOG_SEARCH)

• Variable name: AS.AS.LOG_SEARCH
• Description:
This setting specifies the log level for the category “Search Service”. See also
key: “LOG_SEARCH_GROUP”. There are 4 distinct settings with increased
• Type: Enum
• Allowed Value:
Storage Configuration (LOG_STORAGE)

• Variable name: AS.AS.LOG_STORAGE
• Description:
This setting specifies the log level for “Storage Configuration” category. See
also key: “LOG_STORAGE_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04
43.9.8.1.1 Group definitions
Storage location:
Setup
Setup
Administration (LOG_ADMIN_GROUP)
• Variable name: AS.AS.LOG_ADMIN_GROUP
• Description:
This setting specifies an own log category for the “Administration” by
listening all related java packages. “Internal” setting only, do not modify
• Type: String
• Predefined Value: com.opentext.ecm.admin,com.opentext.ecm.api,com.
opentext.ecm.archiveadmin,com.opentext.ecm.container,com.
opentext.ecm.exceptions,com.opentext.ecm.rcs.script,
com.opentext.ecm.services.administration,com.opentext.ecm.
services.adminroot,com.opentext.ecm.services.archiveadmin,com.
opentext.ecm.services.asm,com.opentext.ecm.services.
leaauthentication,com.opentext.ecm.services.leaauthorization,
com.opentext.ecm.services.leanotifications,com.opentext.ecm.
services.leausergroup,com.opentext.ecm.api.srws.impl,
com.opentext.ecm.asm.webclient,com.opentext.ecm.asm.bizadmin,
com.opentext.ecm.asm.bizconfig,com.opentext.ecm.asm.bizutil,
com.opentext.ecm.services.tenantmgmt,com.opentext.ecm.as.cmis.
client
CMIS Interface (LOG_CMIS_GROUP)

• Variable name: AS.AS.LOG_CMIS_GROUP
• Description:
This setting specifies a separate log category for the “CMIS Interface” by
listing all related java packages. “Internal” setting only, do not modify unless
instructed otherwise!
• Type: String
• Predefined Value: com.opentext.ecm.asm.cmis,org.apache.
chemistry.opencmis
Document Service (LOG_JDS_GROUP)

• Variable name: AS.AS.LOG_JDS_GROUP
• Description:

AR100500-01-ACN-EN-04
This setting specifies an own log category for the “Document Service” by
• Type: String
• Predefined Value: com.opentext.ecm.asm,com.opentext.ecm.mdf
Document Service Database (LOG_JDSDB_GROUP)
• Variable name: AS.AS.LOG_JDSDB_GROUP

• Description:
This setting specifies an own log category for the “Document Service
Database” by listening all related java packages. “Internal” setting only, do
not modify until otherwise instructed!
• Type: String
• Predefined Value: com.opentext.ecm.lea.db
Metadata Layer (LOG_METADATA_GROUP)
• Variable name: AS.AS.LOG_METADATA_GROUP

• Description:
This setting specifies a separate log category for the “Metadata Layer” by
• Type: String
• Predefined Value: com.opentext.ecm.asm.metadata
Notification Client (LOG_NOTSCLIENT_GROUP)
• Variable name: AS.AS.LOG_NOTSCLIENT_GROUP

• Description:
This setting specifies an own log category for the “Notification Client” by
• Type: String
• Predefined Value: ixos.w3nots,ixos.notifx
Search Service (LOG_SEARCH_GROUP)
• Variable name: AS.AS.LOG_SEARCH_GROUP

• Description:
This setting specifies a separate log category for the “Search Service” by
• Type: String

AR100500-01-ACN-EN-04
• Predefined Value: com.opentext.ecm.adm.search,com.opentext.

ecm.adm.query,org.elasticsearch
Storage Configuration (LOG_STORAGE_GROUP)
• Variable name: AS.AS.LOG_STORAGE_GROUP

• Description:
This setting specifies an own log category for the “Storage Configuration” by
• Type: String
• Predefined Value: com.opentext.ecm.asm.devconfig
43.9.9 Record Integration related settings (Elib)

Storage location:
Setup
Setup
43.9.10 Record Access Configuration

Storage location:
\RecordAccessInfo.Setup
RecordAccessInfo.Setup
List of Record Access Information (RECORDACCESSINFO)
• Variable name: AS.RecordAccessInfo.RECORDACCESSINFO

• Description:
List contains access information for documents which are elevated to
records. Please insert the information in the following format:
<Content server GUID>=<Content Server OTDS resource id>:<Content server
host name>:<Content server LAPI port>@<Content server OTDS user>
• Sub variables:
access information for records
• Variable name: ACCESSINFO

• Type: String
ACCESSINFO=cssystemguid=csotdsresourceid:cshost:cslapiport@csot
dsuser

AR100500-01-ACN-EN-04
43.10 CMIS settings

Storage location:
Setup
Setup
Mask property values for privacy (MASK_PRIVATE_PROPERTIES)
• Variable name: AS.AS.MASK_PRIVATE_PROPERTIES

• Description:
In log files, mask those property values, which are considered private (e.g.
email subject).
• Type: Flag
• Allowed Value:
• true ("enable")
• false ("disable")
43.10.1 OTDS integration settings for Email Archiving

Storage location:
Setup
Setup
Maximum lifetime of cached groups structure (minutes)

(OTDS_GROUPS_CACHE_TIMEOUT_MINUTES)
• Variable name: AS.AS.OTDS_GROUPS_CACHE_TIMEOUT_MINUTES

• Description:
The maximum lifetime (minutes) of the cached groups structure.
Maximum lifetime of cached user information (minutes)

(OTDS_USER_CACHE_TIMEOUT_MINUTES)
• Variable name: AS.AS.OTDS_USER_CACHE_TIMEOUT_MINUTES

• Description:
The maximum lifetime (minutes) of (1) the cached email address/user
mapping, and (2) the user's personal archiving is enabled status.

AR100500-01-ACN-EN-04
43.10. CMIS settings
Maximum lifetime of cached user personal archiving is disabled status (minutes)

(OTDS_ARCHIVING_CACHE_DISABLED_TIMEOUT_MINUTES)
• Variable name: AS.
AS.OTDS_ARCHIVING_CACHE_DISABLED_TIMEOUT_MINUTES
• Description:
The maximum lifetime (minutes) of the cached user's personal archiving is
disabled status.
OTDS attribute for CMIS repository of user's personal email archive

(CMIS_REPOSITORY_OTDS_ATTR)
• Variable name: AS.AS.CMIS_REPOSITORY_OTDS_ATTR
• Description:
OTDS attribute to store the recent CMIS repository ID of the user's personal
email archive.
• Type: String
• Predefined Value: oTACEmailCmisRepositoryId
OTDS attribute for history of CMIS repositories of user's personal email archives
(CMIS_REPOSITORY_HISTORY_OTDS_ATTR)
• Variable name: AS.AS.CMIS_REPOSITORY_HISTORY_OTDS_ATTR
• Description:
OTDS attribute to store the history of CMIS repository IDs of the user's
personal email archives.
• Type: String
• Predefined Value: oTACEmailCmisRepositoryIdHistory
Restrict the user lookup to users of this OTDS resource

(OTDS_LOOKUP_USE_RESOURCE_FILTER)
• Variable name: AS.AS.OTDS_LOOKUP_USE_RESOURCE_FILTER
• Description:
When looking-up the OTDS user from an email address: look only for users,
who have access to this OTDS resource (restrict), or look for any OTDS user
(don't restrict)?
• Type: Flag
• Allowed Value:
• true ("restrict")
• false ("don't restrict")
Size for the group structure cache (number of groups). (OTDS_GROUPS_CACHE_SIZE)

• Variable name: AS.AS.OTDS_GROUPS_CACHE_SIZE

AR100500-01-ACN-EN-04
• Description:
The number of groups that can be cached.
Size for the user information cache (number of users). (OTDS_USER_CACHE_SIZE)

• Variable name: AS.AS.OTDS_USER_CACHE_SIZE
• Description:
The number of users that can be cached.
Use smtp:// prefix for user lookup (CMIS_ADD_SMTP_FIRST)

• Variable name: AS.AS.CMIS_ADD_SMTP_FIRST
• Description:
There are two attempts when looking-up the OTDS user from an email
address: (1) with plain email address and (2) with prefixed email address.
With this setting it's possible to tell whether first or second attempt should
use the smtp:// prefix.
• Type: Flag
• Allowed Value:
• true ("1st attempt")
• false ("2nd attempt")
43.11 Business Administration

Storage location:
Setup
Setup
Accept SSL client certificates for authentication

(BIZ_ACCEPT_SSL_CLIENT_CERTIFICATE)
• Variable name: AS.AS.BIZ_ACCEPT_SSL_CLIENT_CERTIFICATE
• Description:
This setting specifies if the Archive Center accepts SSL client certificates for
authentication or not. If this value is set to 'on', ensure that the application
server accepts SSL client certificates.
• Type: Flag
• Allowed Value:
• on

AR100500-01-ACN-EN-04
43.11. Business Administration
• off
Directory for the generated EDRM-XML files (BIZ_EXPORT_DIRECTORY)

• Variable name: AS.AS.BIZ_EXPORT_DIRECTORY
• Description:
This setting specifies the directory where all the generated EDRM-XML files
are stored. If this variable is empty the default directory will
$ECM_VAR_DIR/exports.
• Type: Path
Domain name of the email data sources (BIZ_EMAIL_DOMAIN_NAME)

• Variable name: AS.AS.BIZ_EMAIL_DOMAIN_NAME
• Description:
This setting specifies the domain name for the email data sources. If this
value is empty, the default will be taken from MY_HOST_NAME.
• Type: String
Host Identifier (BIZ_HOST_IDENTIFIER)

• Variable name: AS.AS.BIZ_HOST_IDENTIFIER
• Description:
The host identifier will be used for archive names generated by the Business
Administration. The naming pattern for these archives is <Host Identifier>-
<num> with num=1,2,3,.. . The host identifier should not be longer than 5
characters. Allowed characters are [A-Za-z0-9].
• Type: String
List of mappings from appIds to internal names (BIZ_INTERNAL_CMIS_APP_IDS)

• Variable name: AS.AS.BIZ_INTERNAL_CMIS_APP_IDS
• Description:
Define the mapping of internal names used to type special cmis integrations
to the external required appId. The name/id must be separated by '':' while
the different applications must be separated by ','.
name1:id1,name2:id2
• Type: String
• Predefined Value: procsuite:80827967,infofusion:73787079
Maximum number of parallel exports per tenant (BIZ_EXPORT_MAX_PER_TENANT)

• Variable name: AS.AS.BIZ_EXPORT_MAX_PER_TENANT
• Description:
This setting specifies the maximum number of parallel exports per tenant.

AR100500-01-ACN-EN-04

Maximum number of parallel user exports per tenant

(BIZ_EXPORT_CONCURRENT_USER)
• Variable name: AS.AS.BIZ_EXPORT_CONCURRENT_USER

• Description:
This setting specifies the maximum number of parallel user exports per
tenant.
Maximum number of waiting user exports per tenant

(BIZ_EXPORT_WAITING_USER)
• Variable name: AS.AS.BIZ_EXPORT_WAITING_USER

• Description:
This setting specifies the maximum number of waiting user exports per
tenant.
Maximum size of export data for user exports (BIZ_EXPORT_MAX_SIZE)
• Variable name: AS.AS.BIZ_EXPORT_MAX_SIZE

• Description:
This setting specifies the maximum size of export data for user exports.
Name of country the Archive Server is running (BIZ_COUNTRY)
• Variable name: AS.AS.BIZ_COUNTRY

• Description:
The name of the country must be specified manually and will not be
computed automatically.
• Type: String
Operating Mode (BIZ_OPERATING_MODE)
• Variable name: AS.AS.BIZ_OPERATING_MODE

• Description:
This setting controls the operating mode of the Archive Server.
• Single Tenant: The Archive Server is operated in a single tenant mode.

• Multi Tenant: The Archive Server is operated in a multi tenant mode.

AR100500-01-ACN-EN-04
• Public Cloud: The Archive Server is operated in a public cloud.
This setting currently affects only the Business Administration.

• Type: Enum
• Predefined Value: OnPremises
• Allowed Value:
• OnPremises ("Single Tenant")

• PrivateCloud ("Multi Tenant")
• PublicCloud ("Public Cloud")
Policy Name for Archive Access (BIZ_ACCESS_POLICYNAME)
• Variable name: AS.AS.BIZ_ACCESS_POLICYNAME

• Description:
Name of policy that is used for tenants. A group with this policy assigned
acts as tenant user with read access to all documents.
• Type: String
• Predefined Value: ArchiveAccess
Policy Name for Business Administrator (BIZ_POLICYNAME)
• Variable name: AS.AS.BIZ_POLICYNAME

• Description:
acts as tenant administrator.
• Type: String
• Predefined Value: BusinessAdministration
Policy Name for My Archive (BIZ_MYARCHIVE_POLICYNAME)
• Variable name: AS.AS.BIZ_MYARCHIVE_POLICYNAME

• Description:
acts as tenant end user with read access to documents he is allowed to read.
• Type: String
• Predefined Value: MyArchive
Time after which an downloaded export is marked as deletable

(BIZ_EXPORT_EXPIRATION_DOWNLOADED)
• Variable name: AS.AS.BIZ_EXPORT_EXPIRATION_DOWNLOADED

• Description:
This setting specifies the time after which an downloaded export expires and
can be deleted by cleanup task.

AR100500-01-ACN-EN-04
Time after which an export expires and can be deleted by cleanup task
(BIZ_EXPORT_EXPIRATION)
• Variable name: AS.AS.BIZ_EXPORT_EXPIRATION
• Description:
This setting specifies the time after which an export expires and can be
deleted by cleanup task.
Time interval between status checks of the export tasks

(BIZ_EXPORT_SUPERVISOR_TIMEINTERVAL)
• Variable name: AS.AS.BIZ_EXPORT_SUPERVISOR_TIMEINTERVAL
• Description:
This setting specifies the time interval [sec] between the status checks of the
export tasks.
43.11.1 Default values for the administration web client

Storage location:
Setup
Setup
Default value of ChangesByPrivilegedUsers

(BIZ_ARCHIVE_DEFAULT_CHANGESBYPRIVILEGEDUSERS_VALUE)
AS.BIZ_ARCHIVE_DEFAULT_CHANGESBYPRIVILEGEDUSERS_VALUE
• Description:
This setting controls the default value for the "Changes by Privileged Users"
flag in the property dialogs of an archive.
• on: Sets the default value to "On".
• off: Sets the default value to "Off"
This setting affects only the Business Administration and will only be used if
the configuration variable BIZ_ARCHIVE_DEFAULTS_OVERWRITE is set
ot "on".
• Type: Flag
• Allowed Value:
• on
• off

AR100500-01-ACN-EN-04
Default value of compression flag (BIZ_ARCHIVE_DEFAULT_COMPRESSION)

• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_COMPRESSION
• Description:
This setting controls the default value for the compression flag in the
property dialogs of an archive.
ot "on".
• Type: Flag
• Allowed Value:
• on
• off
Default value of delete flag (BIZ_ARCHIVE_DEFAULT_DISPOSEAFTEREXPIRY)

• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_DISPOSEAFTEREXPIRY
• Description:
This setting controls the default value for the "Delete after Expiry" flag in the
ot "on".
• Type: Flag
• Allowed Value:
• on
• off
Default value of encryption flag (BIZ_ARCHIVE_DEFAULT_ENCRYPTION)

• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_ENCRYPTION
• Description:
This setting controls the default value for the "Encryption" flag in the

AR100500-01-ACN-EN-04
ot "on".
• Type: Flag
• Allowed Value:
• on
• off
Default value of number of additional copies

(BIZ_ARCHIVE_DEFAULT_ADDITIONALCOPIES)
• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_ADDITIONALCOPIES
• Description:
This setting controls the default value for the property "Additional copies"
(0,1,2) in the property dialogs of an archive.
ot "on".
Default value of ProtectionByStorage

(BIZ_ARCHIVE_DEFAULT_PROTECTIONBYSTORAGE_VALUE)
AS.BIZ_ARCHIVE_DEFAULT_PROTECTIONBYSTORAGE_VALUE
• Description:
This setting controls the default value for the "Protection by Storage" flag in
the property dialogs of an archive.
ot "on".
• Type: Flag
• Allowed Value:
• on
• off
Default value of proxy compression flag

(BIZ_ARCHIVE_DEFAULT_PROXY_COMPRESSION)
• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_PROXY_COMPRESSION

AR100500-01-ACN-EN-04
• Description:
This setting controls the default value for the compression flag in the
ot "on".
• Type: Flag
• Allowed Value:
• on
• off
Default value of proxy encryption flag

(BIZ_ARCHIVE_DEFAULT_PROXY_ENCRYPTION)
• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_PROXY_ENCRYPTION
• Description:
This setting controls the default value for the "Encryption" flag in the
to "on".
• Type: Flag
• Allowed Value:
• on
• off
Default value of retention (BIZ_ARCHIVE_DEFAULT_RETENTIONVALUE)

• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_RETENTIONVALUE
• Description:
This setting controls the default value for the property "Retention Period" in
the property dialogs of an archive. The unit of the period is specified in the
configuration variable BIZ_ARCHIVE_DEFAULT_RETENTIONUNIT.
ot "on".

AR100500-01-ACN-EN-04

Default value of retention unit (BIZ_ARCHIVE_DEFAULT_RETENTIONUNIT)

• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_RETENTIONUNIT
• Description:
This setting controls the default value for the "Retention Period" unit.
• Day: Sets the default value to "days".
• Month: Sets the default value to "month".
• Year: Sets the default value to "year".
ot "on".
• Type: Enum
• Predefined Value: Day
• Allowed Value:
• Day ("Day")
• Month ("Month")
• Year ("Year")
Default value of single instance flag (BIZ_ARCHIVE_DEFAULT_SINGLEINSTANCE)

• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_SINGLEINSTANCE
• Description:
This setting controls the default value for the "Single Instance" flag in the
ot "on".
• Type: Flag
• Allowed Value:
• on
• off
Default value of timestamp flag (BIZ_ARCHIVE_DEFAULT_TIMESTAMP)

• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_TIMESTAMP
• Description:

AR100500-01-ACN-EN-04
This setting controls the default value for the "Timestamps" flag in the
ot "on".
• Type: Flag
• Allowed Value:
• on
• off
Overwrite internal default values (BIZ_ARCHIVE_DEFAULTS_OVERWRITE)

• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULTS_OVERWRITE
• Description:
This setting controls whether the internal definitions for the administration
web client (Business Administration) should be used or should be
overwritten by the configuration variables listed under the node "Default
values for the administration web client.
The internal definitions depend on the value of the operating mode defined
in the configuration variable BIZ_OPERATING_MODE:
• Single Tenant: Compression=off, Single Instance=off, Additional
Copies=0, Encryption=off
• Multi Tenant: Compression=off, Single Instance=off, Additional Copies=0,
Encryption=off
• Public Cloud: Compression=on, Single Instance=on, Additional Copies=0,
Encryption=on (readonly)
This setting affects only the Business Administration.

• Type: Flag
• Allowed Value:
• on
• off
Quality of the additional copies property

(BIZ_ARCHIVE_DEFAULT_ADDITIONALCOPIES_QUALITY)
• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_ADDITIONALCOPIES_QUALITY
• Description:
This setting controls the appearance and behaviour of the "Additional
Copies" property in the property dialogs of an archive.

AR100500-01-ACN-EN-04
• supported: The flag is visible and can be changed.

• readonly: The flag is read-only and cannot be changed.
ot "on".
• Type: Enum
• Predefined Value: supported
• Allowed Value:
• supported ("supported")
• readonly ("readonly")
Quality of the ChangesByPrivilegedUsers parameter

(BIZ_ARCHIVE_DEFAULT_CHANGESBYPRIVILEGEDUSERS_QUALITY)
AS.BIZ_ARCHIVE_DEFAULT_CHANGESBYPRIVILEGEDUSERS_QUALITY
• Description:
This setting controls the appearance and behaviour of the "Changes by
Privileged Users" flag in the property dialogs of an archive.
ot "on".
• Type: Enum
• Allowed Value:
Quality of the compression flag (BIZ_ARCHIVE_DEFAULT_COMPRESSION_QUALITY)

• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_COMPRESSION_QUALITY
• Description:
This setting controls the appearance and behaviour of the "Compression" flag
in the property dialogs of an archive.
ot "on".

AR100500-01-ACN-EN-04
• Type: Enum
• Allowed Value:
Quality of the delete flag (BIZ_ARCHIVE_DEFAULT_DISPOSEAFTEREXPIRY_QUALITY)

AS.BIZ_ARCHIVE_DEFAULT_DISPOSEAFTEREXPIRY_QUALITY
• Description:
This setting controls the appearance and behaviour of the "Delete after
Expiry" flag in the property dialogs of an archive.

ot "on".
• Type: Enum
• Allowed Value:
Quality of the encryption flag (BIZ_ARCHIVE_DEFAULT_ENCRYPTION_QUALITY)
• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_ENCRYPTION_QUALITY

• Description:
This setting controls the appearance and behaviour of the "Encryption" flag

to "on".
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04
Quality of the ProtectionByStorage parameter

(BIZ_ARCHIVE_DEFAULT_PROTECTIONBYSTORAGE_QUALITY)
AS.BIZ_ARCHIVE_DEFAULT_PROTECTIONBYSTORAGE_QUALITY
• Description:
This setting controls the appearance and behaviour of the "Protection by
Storage" flag in the property dialogs of an archive.
ot "on".
• Type: Enum
• Allowed Value:
Quality of the proxy compression flag

(BIZ_ARCHIVE_DEFAULT_PROXY_COMPRESSION_QUALITY)
AS.BIZ_ARCHIVE_DEFAULT_PROXY_COMPRESSION_QUALITY
• Description:
This setting controls the appearance and behaviour of the "Compression" flag
ot "on".
• Type: Enum
• Allowed Value:
Quality of the proxy encryption flag

(BIZ_ARCHIVE_DEFAULT_PROXY_ENCRYPTION_QUALITY)
• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_PROXY_ENCRYPTION_QUALITY
• Description:

AR100500-01-ACN-EN-04
This setting controls the appearance and behaviour of the "Encryption" flag

ot "on".
• Type: Enum
• Allowed Value:
Quality of the single instance flag

(BIZ_ARCHIVE_DEFAULT_SINGLEINSTANCE_QUALITY)
• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_SINGLEINSTANCE_QUALITY

• Description:
This setting controls the appearance and behaviour of the "Single Instance"
flag in the property dialogs of an archive.

ot "on".
• Type: Enum
• Allowed Value:
Quality of the timestamps flag (BIZ_ARCHIVE_DEFAULT_TIMESTAMP_QUALITY)
• Variable name: AS.AS.BIZ_ARCHIVE_DEFAULT_TIMESTAMP_QUALITY

• Description:
This setting controls the appearance and behaviour of the "Timestamps" flag


AR100500-01-ACN-EN-04
ot "on".
• Type: Enum
• Allowed Value:
43.12 Integrated Common Service Settings (ICS)

Storage location:
- Windows: Configuration file: <ECM_ARCHIVE_SERVER_CONF>\config\setup\ICS.
Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/ICS.
Setup
Algorithm used to sign (DS_SIGNATURE_ALGORITHM)

• Variable name: AS.ICS.DS_SIGNATURE_ALGORITHM
• Description:
• Type: String
Alias names for backend host (frontend server only) (DS_HOST_ALIASES)

• Variable name: AS.ICS.DS_HOST_ALIASES
• Description:
This setting specifies any alias names of the backend server. See also key:
DSHOST. For “Archive Cache Server” scenario this setting can be used in case
the backend Archive Server has multiple host names. Setting this key in an
“Archive Server” scenario has NO effect.
• Type: String
Allow illegal content types (DS_ALLOW_ILLEGAL_CONTENTTYPE)

• Variable name: AS.ICS.DS_ALLOW_ILLEGAL_CONTENTTYPE
• Description:
If true the content type by the client will be checked for syntactical errors. In
this case an exception is thrown or in case replacing is allowed the content
type is replaced by any set default content type. See also key:
“DS_DEFAULT_CONTENTTYPE,
DS_REPLACE_ILLEGAL_CONTENTTYPE” Setting this key in an “Archive
Server” scenario has NO effect. “Internal” setting only, do not modify until

AR100500-01-ACN-EN-04
43.12. Integrated Common Service Settings (ICS)
• Type: Flag
• Allowed Value:
• true
• false
AuthId which is used in generated signatures (DS_SIGNATURE_SIGNER)

• Variable name: AS.ICS.DS_SIGNATURE_SIGNER
• Description:
This setting defines the URL parameter “authid” which is used in any signed
URL issued by this server.
• Type: String
Cache Settings are evaluated (Archive Cache Server only)

(DS_INIT_CACHESETTINGS)
• Variable name: AS.ICS.DS_INIT_CACHESETTINGS
• Description:
This setting is for the “Archive Cache Server” exclusively. It is responsible
for reading the Cache Settings for each logical archive. Setting this key in an
“Archive Server” scenario has NO effect. “Internal” setting only, do not
• Type: Flag
• Allowed Value:
• true
• false
Certificates are downloaded from BackupServer (frontend server only)

(DS_INIT_CERTIFICATES)
• Variable name: AS.ICS.DS_INIT_CERTIFICATES
• Description:
If true certificates are downloaded from any backend server to allow
verification of signed URLs on the frontend server. Setting this key in an
• Type: Flag
• Allowed Value:
• true
• false
Charset for outgoing requests (DS_CHARSET)

• Variable name: AS.ICS.DS_CHARSET

AR100500-01-ACN-EN-04

• Description:
This setting defines the charset used for URL encoding of any outgoing
request. Setting this key in an “Archive Server” scenario has NO effect.
• Type: String
Context Path of Servlet (DS_KEYWORD)
• Variable name: AS.ICS.DS_KEYWORD

• Description:
This setting specifies the context path of the web application. It is set during
installation. “Internal” setting only, do not modify until otherwise instructed!
• Type: String
Default application (DS_DEFAULTAPPLICATION)
• Variable name: AS.ICS.DS_DEFAULTAPPLICATION

• Description:
This setting specifies the default value of the URL parameter “ixAppl”,
which is used by internal request. Setting this key in an “Archive Server”
scenario has NO effect.
• Type: String
Default content type if not set by user (DS_DEFAULT_CONTENTTYPE)
• Variable name: AS.ICS.DS_DEFAULT_CONTENTTYPE

• Description:
If set this setting defines the default content type which is used by any
outgoing request, in case the original request did NOT set or sets an illegal
content type. Setting this key in an “Archive Server” scenario has NO effect.
• Type: String
Default user (DS_DEFAULTUSER)
• Variable name: AS.ICS.DS_DEFAULTUSER

• Description:
This setting specifies the default value of the URL parameter “ixUser”, which
is used by internal request. Setting this key in an “Archive Server” scenario
has NO effect.
• Type: String

AR100500-01-ACN-EN-04
DSBridge contacts configured Cache Server (do not set) (DS_INIT_CACHESERVERS)
• Variable name: AS.ICS.DS_INIT_CACHESERVERS

• Description:
If true this setting states that for any outgoing request a possible “Archive
Cache Server” is to be considered. Setting this key in an “Archive Server”
scenario has NO effect. “Internal” setting only, do not modify until otherwise
instructed!
• Type: Flag
• Allowed Value:
• true
• false
Expiration time of generated signed URLs (in minutes)

(DS_SIGNATURE_EXPIRATION)
• Variable name: AS.ICS.DS_SIGNATURE_EXPIRATION

• Description:
This setting defines the expiration time [min] of any signature issued by this
server.
• Type: Integer
Installed Scenario (ICS_SCENARIO)
• Variable name: AS.ICS.ICS_SCENARIO

• Description:
This setting specifies the installed scenario. It is set during installation.
• Type: Enum
• Allowed Value:
• LEA ("Archive Server")

• LEAADA ("Archive Server with ADA integration")
• ACS ("Archive Cache Server")
• EACS ("Extended Archive Cache Server")
• LEARMS ("Archive Server with RMS integration")
Maximum character value accepted to be used for a component name

(DS_MAX_CHAR_VALUE)
• Variable name: AS.ICS.DS_MAX_CHAR_VALUE

• Description:
• Type: Integer

AR100500-01-ACN-EN-04
Number of check phases before a full update is executed. (frontend server only)
(REINIT_AFTER_N_PERIODS)
• Variable name: AS.ICS.REINIT_AFTER_N_PERIODS
• Description:
This setting indicates how much check phases must pass before a full re-
initialization is triggered. See also key: “LAST_REINIT_PERIOD”. Setting
this key in an “Archive Server” scenario has NO effect. “Internal” setting
only, do not modify until otherwise instructed!
Recognized add-ons (ICS) (ADDONS)

• Variable name: AS.ICS.ADDONS
• Description:
This setting defines the names of all known add-on components as a comma
separated list. If not set a default list is used internally. See also key:
ADDON_NAMES in “Addons.Setup”. “Internal” setting only, do not modify
• Type: String
• Predefined Value: anno.brava,anno.ixos.bak,anno.ixos,anno.ole2,
descr,im,meta.xml,note,note.ixos,note.meta,ATTRIBUTES,ATTRLIST,
DPprotocol,PAGELIST,TATTRLIST
Remote Port (DS_RCPORT)

• Variable name: AS.ICS.DS_RCPORT
• Description:
This setting specifies port number of the backend server in dependence to the
scenario. This port is set by Installation.
By setting this value to 0, even all administrative requests are routed via the
SSL port.
• For Archive Server scenario this port is not evaluated and should point to
the local port.
• For Archive Cache Server scenario this port should point to the port of
the backend Archive Server.
See also key: ICS_SCENARIO, DSHOST, DS_RCSSLPORT.

Remote SSL Port (DS_RCSSLPORT)

• Variable name: AS.ICS.DS_RCSSLPORT
• Description:

AR100500-01-ACN-EN-04
This setting specifies SSL port number of the backend server in dependence
to the scenario. It is set by Installation.
the local SSL port.
• For Archive Cache Server scenario this port should point to the SSL port
of the backend Archive Server.
See also key: ICS_SCENARIO, DSHOST, DS_RCPORT.

Replace illegal content types with default content type

(DS_REPLACE_ILLEGAL_CONTENTTYPE)
• Variable name: AS.ICS.DS_REPLACE_ILLEGAL_CONTENTTYPE
• Description:
If true any illegal content type is replaced by the default content type. See
also key: “DS_DEFAULT_CONTENTTYPE,
DS_ALLOW_ILLEGAL_CONTENTTYPE” Setting this key in an “Archive
• Type: Flag
• Allowed Value:
• true
• false
Resign in any case, even if even if client signatures are to be reused

(DS_RESIGN_SIGNED_URLS)
• Variable name: AS.ICS.DS_RESIGN_SIGNED_URLS
• Description:
If true this setting is responsible that each outgoing request is signed with the
frontend servers own private key. This also overwrites any URL tunneling
configuration. See also key: “DS_REUSE_SIGNED_URLS”. Setting this key in
an “Archive Server” scenario has NO effect. “Internal” setting only, do not
• Type: Flag
• Allowed Value:
• true
• false
Reuse client signatures if possible (DS_REUSE_SIGNED_URLS)

• Variable name: AS.ICS.DS_REUSE_SIGNED_URLS

AR100500-01-ACN-EN-04

• Description:
If true this setting allows the so called URL tunneling, which means reusing
any client signature if possible. Setting this key in an “Archive Server”
instructed!
• Type: Flag
• Allowed Value:
• true
• false
Run Archive Server in presentation mode. (BIZ_DEMO_MODE)
• Variable name: AS.ICS.BIZ_DEMO_MODE

• Description:
This setting specifies the runtime behaviour and feature availability. This
setting must not be enabled in production. “Internal” setting only, do not
• Type: Flag
• Allowed Value:
• true
• false
Time period after which an offline backend server will be probed again
(ARCHIVEOFFLINETIME)
• Variable name: AS.ICS.ARCHIVEOFFLINETIME

• Description:
If any backend server is no longer available this setting specifies the time
period [ms] before probing it again. Setting this key in an “Archive Server”
instructed!
• Type: Integer
Time to pass when reinitializing thread checks for and administrative changes
(frontend server only) (LAST_REINIT_PERIOD)
• Variable name: AS.ICS.LAST_REINIT_PERIOD

• Description:
This setting specifies the time period [ms] passed before a background
thread checks for any administrative changes on the backend server. Setting

AR100500-01-ACN-EN-04

• Type: Integer
Warning if Archive Server is older than V9.6.1 (frontend server only)

(WARN_IF_OLD_AS)
• Variable name: AS.ICS.WARN_IF_OLD_AS
• Description:
If true a frontend server writes a warning to the log file in case it connects to
an backend server older than V9.6.1. Setting this key in an “Archive Server”
• Type: Flag
• Allowed Value:
• true
• false
43.12.1 Archive Link specific Settings (AL)

Storage location:
Setup
Setup
ADMS Cleanup interval (ADMS_RPC_SESSION_CLEANUP_INTERVAL)

• Variable name: AS.ICS.ADMS_RPC_SESSION_CLEANUP_INTERVAL
• Description:
If Administration Server on the local host is configured to receive dispatched
administrative requests (as is the case by default), this variable can be used to
alter the frequency of checks for inactive RPC connections to Administration
Server. There should normally be no need to set this value.
ADMS host name of legacy interface (ADMS_PROXY_HOST)

• Variable name: AS.ICS.ADMS_PROXY_HOST
• Description:
If configured, the name of a remote Archive Server expected to handle
incoming requests to administrative URLs. There should normally be no
need to set this value.
• Type: String

AR100500-01-ACN-EN-04
ADMS port of legacy interface (ADMS_PROXY_PORT)

• Variable name: AS.ICS.ADMS_PROXY_PORT
• Description:
administrative requests (as is the case by default), this variable must be set to
the RPC port number of Administration Server if that differs from the default
(4034). If a remote server is configured to handle administative requests, this
variable must be set to the port of the remote server. There should normally
be no need to set this value.
ADMS protocol (ADMS_PROXY_PROTOCOL)

• Variable name: AS.ICS.ADMS_PROXY_PROTOCOL
• Description:
If a remote server is expected to receive incoming administrative requests,
this variable must be used to configure the protocol (http or https) used to
forward requests to the target host. There should normally be no need to set
this value.
• Type: String
ADMS RPC session timeout (ADMS_RPC_SESSION_TIMEOUT)

• Variable name: AS.ICS.ADMS_RPC_SESSION_TIMEOUT
• Description:
administrative requests (as is the case by default), this value can be used to
alter the amount of time after which an RPC connection to Administration
Server is deemed inactive. There should normally be no need to set this
value.
ADMS servlet context Path of ADMS legacy interface (ADMS_PROXY_PATH)

• Variable name: AS.ICS.ADMS_PROXY_PATH
• Description:
If a remote server is configured to receive administrative requests, this
variable can be used to configure the request path used when forwarding
requests to the target host. There should normally be no need to set this
value.
• Type: String
AL charset used for incoming request (AL_URL_CHARSET)

• Variable name: AS.ICS.AL_URL_CHARSET

AR100500-01-ACN-EN-04

• Description:
This setting specifies the charset used for URL decoding of incoming
requests. Attention: Do not modify, otherwise you risk accessing data
already archived with an different charset!!
• Type: String
AL charset used for outgoing response (AL_OUT_CHARSET)

• Variable name: AS.ICS.AL_OUT_CHARSET
• Description:
This setting specifies the ArchiveLink charset used for outgoing responses.
• Type: String
AL checks for correct URL parameters (AL_STRICT_PARAMETER_CHECK)

• Variable name: AS.ICS.AL_STRICT_PARAMETER_CHECK
• Description:
If true any incoming request is checked for correctness of its parameters. In
case an URL unknown parameter is detected for a given command an
exception is thrown. If false this check is switched of and only parameters
which are associated to the command are evaluated. Unknown parameters
are ignored.
• Type: Flag
• Allowed Value:
• true
• false
ArchiveLink HTTP Port (AL_PROXYPORT)

• Variable name: AS.ICS.AL_PROXYPORT
• Description:
This setting specifies the HTTP port for ArchiveLink clients and must match
the Application Servers setting (server.xml).
ArchiveLink HTTPS Port (AL_PROXYSSLPORT)

• Variable name: AS.ICS.AL_PROXYSSLPORT
• Description:
This setting specifies the HTTPS port for ArchiveLink clients and must match

AR100500-01-ACN-EN-04
Check for 100 Continue (AL_CHECK_100CONT)

• Variable name: AS.ICS.AL_CHECK_100CONT
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Internal buffer size which used to write the AL response (AL_HTTP_BUFSIZE)

• Variable name: AS.ICS.AL_HTTP_BUFSIZE
• Description:
This setting specifies the buffer size which ArchiveLink uses to write
responses. “Internal” setting only, do not modify until otherwise instructed!
Pattern allowed and expected behind a signed URL (SIGN_URL_ENDING_CHARS)

• Variable name: AS.ICS.SIGN_URL_ENDING_CHARS
• Description:
• Type: String
Preference for collisions between HTTP and AL semantic (AL_PREFERENCE)

• Variable name: AS.ICS.AL_PREFERENCE
• Description:
This setting defines the preference between HTTP and AL semantic in case of
collisions.
• Throw exception
• Prefer AL semantic
• Prefer HTTP semantic
• Type: Enum
• Predefined Value: HTTP
• Allowed Value:
• NONE ("Throw exception")
• AL ("Prefer AL semantic")
• HTTP ("Prefer HTTP semantic")

AR100500-01-ACN-EN-04
Proxy server mode (PROXY_SERVER_MODE)

• Variable name: AS.ICS.PROXY_SERVER_MODE
• Description:
If true then each archive is reported to be hosted on current server instead of
its real location. This has effect for the ArchiveLink command “admInfo”.
• Type: Flag
• Allowed Value:
• true
• false
Switch on ADMS legacy interface (AL_ADMS_PROXY)

• Variable name: AS.ICS.AL_ADMS_PROXY
• Description:
If true incoming requests matching the respective URL pattern are
dispatched to Administration Server for further processing. In particular, this
is required to allow access from remote servers.
• Type: Flag
• Allowed Value:
• true
• false
Target for ADMS legacy interface (ADMS_EXEC_TARGET)

• Variable name: AS.ICS.ADMS_EXEC_TARGET
• Description:
Use localhost for processing on the local machine, or set to a partial URL
such as http://archive1.example.com:8080/archive to process requests on a
single node cluster-wide.
• Type: String
URL parameters which are to be ignored, Format: param1,paramn

(AL_PARAMETERS_TO_IGNORE)
• Variable name: AS.ICS.AL_PARAMETERS_TO_IGNORE
• Description:
With this setting it is possible to specify URL parameters which are ignored
for further processing. These parameters are evaluated for all ArchiveLink
commands. Single parameters are to be separated by a ,. Per default the
parameter: “compVers” and “compView” are ignored.

AR100500-01-ACN-EN-04
• Type: String
43.12.2 HTTP communication parameter

Storage location:
Setup
Setup
Allow secure sockets through proxies (HTTP_ENABLE_SSL_PROXY)

• Variable name: AS.ICS.HTTP_ENABLE_SSL_PROXY
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Buffer size for MP stream filter (HTTP_BUFSIZE)

• Variable name: AS.ICS.HTTP_BUFSIZE
• Description:
Client follows Redirect requests (HTTP_FOLLOW_REDIRECT)

• Variable name: AS.ICS.HTTP_FOLLOW_REDIRECT
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Default value to control initialize of SSL (HTTP_INIT_SSL)

• Variable name: AS.ICS.HTTP_INIT_SSL
• Description:
• Type: Flag

AR100500-01-ACN-EN-04
• Allowed Value:
• true
• false
Encoding of request/response headers (default = USACII)

(HTTP_HEADER_ENCODING)
• Variable name: AS.ICS.HTTP_HEADER_ENCODING
• Description:
• Type: String
HTTP Client checks for stale connections

(HTTP_ENABLE_CONNECTION_STALE_CHECKING)
• Variable name: AS.ICS.HTTP_ENABLE_CONNECTION_STALE_CHECKING
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Maximum number of outgoing HTTP connections

(HTTP_MAX_TOTAL_CONNECTIONS)
• Variable name: AS.ICS.HTTP_MAX_TOTAL_CONNECTIONS
• Description:
• Type: Integer
Maximum number of outgoing HTTP connections per Host

(HTTP_MAX_CONNECTIONS_PER_HOST)
• Variable name: AS.ICS.HTTP_MAX_CONNECTIONS_PER_HOST
• Description:
This setting defines the maximum number of outgoing HTTP connections
which can be active in parallel. Setting this key in an “Archive Server”
Number of retries, if recoverable Exception occurs (HTTP_NUMBER_OF_RETRIES)

• Variable name: AS.ICS.HTTP_NUMBER_OF_RETRIES

AR100500-01-ACN-EN-04

• Description:
• Type: Integer
Path to the IxosCrypto.properties file (DS_CRYPTO_PROPERTIES)

• Variable name: AS.ICS.DS_CRYPTO_PROPERTIES
• Description:
• Type: Path
Read (= socket) timeout (HTTP_TIMEOUT)

• Variable name: AS.ICS.HTTP_TIMEOUT
• Description:
This setting defines the socket (read) timeout [msec]. Setting this key in an
• Type: Integer
Set Cookie Policy (HTTP_PROTOCOL_COOKIE_POLICY)

• Variable name: AS.ICS.HTTP_PROTOCOL_COOKIE_POLICY
• Description:
• Type: String
Trust all certificates (HTTP_BUILTIN_SSL_TRUST_ALL_CERTIFICATES)

• Variable name: AS.ICS.HTTP_BUILTIN_SSL_TRUST_ALL_CERTIFICATES
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Trust certificates with wrong server names

(HTTP_BUILTIN_SSL_TRUST_WRONG_SERVER)
• Variable name: AS.ICS.HTTP_BUILTIN_SSL_TRUST_WRONG_SERVER
• Description:

AR100500-01-ACN-EN-04
• Type: Flag
• Allowed Value:
• true
• false
Use built-in IXOS key store (HTTP_BUILTIN_SSL_USE_IXOS_KEY_STORE)

• Variable name: AS.ICS.HTTP_BUILTIN_SSL_USE_IXOS_KEY_STORE
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Use BuiltIn SSL (HTTP_INIT_BUILTIN_SSL)

• Variable name: AS.ICS.HTTP_INIT_BUILTIN_SSL
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Use Expect-100-continue headers (HTTP_USE_EXPECT100)

• Variable name: AS.ICS.HTTP_USE_EXPECT100
• Description:
• Type: Flag
• Allowed Value:
• true
• false

AR100500-01-ACN-EN-04
43.12.3 Rights Management Services parameters

Storage location:
Setup
Setup
Class-ID of the Gigatrust protector (RMS_PROTECTOR_GIGATRUST_CLASSID)

• Variable name: AS.ICS.RMS_PROTECTOR_GIGATRUST_CLASSID
• Description:
COM Class-ID of the Gigatrust protector. Set to '{740AE583-
ABED-42A1-8510-97FC1E6B1B66}' if it is installed and shall be activated.
• Type: String
Class-ID of the protector for MS Office Open XML formats

(RMS_PROTECTOR_OPCIRM_CLASSID)
• Variable name: AS.ICS.RMS_PROTECTOR_OPCIRM_CLASSID
• Description:
COM Class-ID of the RMS protecor supporting MS Office Open XML
formats.
• Type: String
• Predefined Value: {81273702-956F-4CBD-9B16-43790558EE29}
Class-ID of the protector for older MS Office formats

(RMS_PROTECTOR_MSOIRM_CLASSID)
• Variable name: AS.ICS.RMS_PROTECTOR_MSOIRM_CLASSID
• Description:
COM Class-ID of the RMS protecor supporting older MS Office formats
(Office 2003 and older).
• Type: String
• Predefined Value: {2E4402B2-F2DA-4BC8-BB2C-41BECF0BDDDB}
Directory for temporary files (RMS_TEMPDIR)

• Variable name: AS.ICS.RMS_TEMPDIR
• Description:
Directory for temporary files created during RMS protection.
• Type: Path
• Predefined Value: ./temp
Directory where RMS templates are synchronized to (RMS_TEMPLATEPATH)

• Variable name: AS.ICS.RMS_TEMPLATEPATH
• Description:

AR100500-01-ACN-EN-04
Directory where the RMS templates are sysnchronized to.

• Type: Path
MIME-type patterns for Gigatrust (RMS_PROTECTOR_GIGATRUST_MIMETYPES)
• Variable name: AS.ICS.RMS_PROTECTOR_GIGATRUST_MIMETYPES

• Description:
Semicolon separated list of MIME-type patterns for which the GIGATRUST
protector is responsible for.
• Type: String
• Predefined Value: application/pdf;text/plain
MIME-type patterns of MS Office Open XML formats

(RMS_PROTECTOR_OPCIRM_MIMETYPES)
• Variable name: AS.ICS.RMS_PROTECTOR_OPCIRM_MIMETYPES

• Description:
Semicolon separated list of MIME-type patterns for which the OPCIRM
• Type: String
• Predefined Value: application/vnd\.ms-excel\..*\.macroEnabled\.12;
application/vnd\.ms-powerpoint\..*\.macroEnabled\.12;
application/vnd\.ms-word\..*\.macroEnabled\.12;application/vnd
\.openxmlformats-officedocument\..*
MIME-type patterns of older MS Office formats

(RMS_PROTECTOR_MSOIRM_MIMETYPES)
• Variable name: AS.ICS.RMS_PROTECTOR_MSOIRM_MIMETYPES

• Description:
Semicolon separated list of MIME-type patterns for which the MSOIRM
• Type: String
• Predefined Value: application/msword;application/vnd\.msword;
application/vnd\.ms-word;application/vnd\.ms-excel;application/
msexcel;application/vnd\.ms-powerpoint;application/
mspowerpoint;application/ms-powerpoint
Position of GIGATRUST protector in the order of protectors

(RMS_PROTECTOR_GIGATRUST_ORDER)
• Variable name: AS.ICS.RMS_PROTECTOR_GIGATRUST_ORDER

• Description:
Position of the GIGATRUST protector in the order of protectors. Protectors
with lower order are used first.
• Type: Integer

AR100500-01-ACN-EN-04
Position of MSOIRM protector in the order of protectors

(RMS_PROTECTOR_MSOIRM_ORDER)
• Variable name: AS.ICS.RMS_PROTECTOR_MSOIRM_ORDER
• Description:
Position of the MSOIRM protector in the order of protectors. Protectors with
lower order are used first.
• Type: Integer
Position of OPCIRM protector in the order of protectors

(RMS_PROTECTOR_OPCIRM_ORDER)
• Variable name: AS.ICS.RMS_PROTECTOR_OPCIRM_ORDER
• Description:
Position of the OPCIRM protector in the order of protectors. Protectors with
• Type: Integer
43.12.4 Logging
Storage location:
Setup
Setup

Storage location:
Setup
Setup
Authentication (LOG_AUTH)
• Variable name: AS.ICS.LOG_AUTH
• Description:
This setting specifies the log level for “Authentication” category. See also
key: “LOG_AUTH_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04

Everything else (LOG_ROOT)
• Variable name: AS.ICS.LOG_ROOT

• Description:
This setting specifies the log level for everything which does not have its
own log category. There are 4 distinct settings which add additional logging
from top to bottom.
• Type: Enum
• Allowed Value:

HTTP Client (LOG_HTTP)
• Variable name: AS.ICS.LOG_HTTP

• Description:
This setting specifies the log level for “HTTP Client” category. See also key:
“LOG_HTTP_GROUP” There are 4 distinct settings which add additional
• Type: Enum
• Allowed Value:

HTTP Client Wire (LOG_HTTPWIRE)
• Variable name: AS.ICS.LOG_HTTPWIRE

• Description:
This setting specifies the log level for “HTTP Client Wire” category. See also
key: “LOG_HTTPWIRE_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04

Integrated Content Service (LOG_ICS)

• Variable name: AS.ICS.LOG_ICS
• Description:
This setting specifies the log level for “Integrated Content Service” category.
See also key: “LOG_ICS_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:
Legacy (LOG_LEGACY)
• Variable name: AS.ICS.LOG_LEGACY
• Description:
This setting specifies the log level for “Legacy Code” category. See also key:
“LOG_LEGACY_GROUP” There are 4 distinct settings which add additional
• Type: Enum
• Allowed Value:
Rights Management (LOG_RMS)

• Variable name: AS.ICS.LOG_RMS
• Description:
This setting specifies the log level for “Rights Management” category. See
also key: “LOG_RMS_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04

Storage location:
Setup
Setup
Authentication (LOG_AUTH_GROUP)
• Variable name: AS.ICS.LOG_AUTH_GROUP

• Description:
This setting specifies an own log category for the “Authentication” by
• Type: String
• Predefined Value: com.opentext.ecm.components.webservices,
com.opentext.ecm.components.http,com.opentext.ecm.
components.security,com.opentext.ecm.api.authws,com.
opentext.ecm.components.otds,com.opentext.otds
HTTP Client (LOG_HTTP_GROUP)
• Variable name: AS.ICS.LOG_HTTP_GROUP

• Description:
This setting specifies an own log category for the “HTTP Client” by listening
all related java packages. Setting this key in an “Archive Server” scenario has
NO effect. “Internal” setting only, do not modify until otherwise instructed!
• Type: String
• Predefined Value: org.apache.http,com.opentext.ecm.httpclient
HTTP Client Wire (LOG_HTTPWIRE_GROUP)
• Variable name: AS.ICS.LOG_HTTPWIRE_GROUP

• Description:
This setting specifies an own log category for the “HTTP Client Wire” by
listening all related java packages. By setting the related log level to trace, all
outgoing (HTTP) payload is logged. Setting this key in an “Archive Server”
instructed!
• Type: String
• Predefined Value: httpclient.wire

AR100500-01-ACN-EN-04
Integrated Content Service (LOG_ICS_GROUP)

• Variable name: AS.ICS.LOG_ICS_GROUP
• Description:
This setting specifies an own log category for the “Integrated Content
Service” by listening all related java packages. “Internal” setting only, do not
• Type: String
• Predefined Value: com.opentext.ecm.services.lea,com.opentext.
ecm.api.lea,com.opentext.ecm.lea,com.opentext.ecm.services.al,
com.opentext.ecm.services.icsrecord,com.opentext.ecm.as.acs.
cryptcompress,com.opentext.ecm.asm.ada
Legacy Code (LOG_LEGACY_GROUP)

• Variable name: AS.ICS.LOG_LEGACY_GROUP
• Description:
This setting specifies an own log category for the “Legacy Code” by listening
all related java packages. “Internal” setting only, do not modify until
• Type: String
• Predefined Value: ixos
Rights Management (LOG_RMS_GROUP)

• Variable name: AS.ICS.LOG_RMS_GROUP
• Description:
This setting specifies an own log category for “Rights Management” by
listening all related java packages.
• Type: String
• Predefined Value: com.opentext.ecm.rms,com.opentext.ecm.
services.rms

AR100500-01-ACN-EN-04
Chapter 44
Document Pipeline
44.1 Common settings for Document Pipelines

Storage location:
\COMMON.Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/COMMON.
Setup
Client certificate file (DSH_CERTIFICATE_FILE)

• Variable name: DP.COMMON.DSH_CERTIFICATE_FILE
• Description:
This variable specifies the absolute path of the certificate file on the pipeline
server. It is needed when authentication (SecKey) is required to access the
logical archive.
• Type: Path
Client private key file (DSH_PRIVATE_KEY_FILE)

• Variable name: DP.COMMON.DSH_PRIVATE_KEY_FILE
• Description:
This variable specifies the absolute path of the private key file on the pipeline
server. It is needed when authentication (SecKey) is required to access the
logical archive.
• Type: Path
Configure send of notifications (NOTIFSEND)

• Variable name: DP.COMMON.NOTIFSEND
• Description:
This variable specifies a switch to turn on/off the sending of error messages
to Notification Server.
• Type: Flag
• Allowed Value:
• on ("on")
• off ("off")
Directory for documents inserted into the Document Pipeline (DPDIR)

• Variable name: DP.COMMON.DPDIR
• Description:

AR100500-01-ACN-EN-04
Chapter 44 Document Pipeline
This variable specifies the Document Pipeline directory to which documents

are copied by the enqueue tools. Each document has its own subdirectory
with all files belonging to this document.
• Type: Path
Host of the Archive Server (ALHOST)

• Variable name: DP.COMMON.ALHOST
• Description:
This variable specifies the server on which the Archive Administration
Server runs.
Host of the Document Pipeline (DPHOST)

• Variable name: DP.COMMON.DPHOST
• Description:
This variable specifies the server on which the Document Pipeline runs.
Host of the Notification Server (NOTIFHOST)

• Variable name: DP.COMMON.NOTIFHOST
• Description:
This variable specifies the server on which the notification server runs.
Max. number of documents in Document Pipeline (MAX_DP_DOCUMENTS)

• Variable name: DP.COMMON.MAX_DP_DOCUMENTS
• Description:
This variable specifies the maximum number of documents in the Document
Pipeline directory at the same time. The DP does not accept new documents
if the maximum number is reached. If the variable has a value of 0, no limit is
used.
• Type: Integer
Min. free disk space for cpfile DocTool (CPFILE_MIN_FREE_DISK_SPACE_MB)

• Variable name: DP.COMMON.CPFILE_MIN_FREE_DISK_SPACE_MB
• Description:
This variable specifies the minimum free space required to copy files into the
Document Pipeline directory by the DocTool cpfile.
• Type: Integer
Min. free disk space for DP (MIN_FREE_DPDIR_MB)

• Variable name: DP.COMMON.MIN_FREE_DPDIR_MB
• Description:

AR100500-01-ACN-EN-04
44.1. Common settings for Document Pipelines
This variable specifies the minimum size required to insert new documents
into the Document Pipeline directory. If the limit is reached, DP rejects
registration of new documents.
• Type: Integer
Port of the Archive Server (ALPORT)

• Variable name: DP.COMMON.ALPORT
• Description:
This variable specifies the port number on which the Archive Server listens.
Port of the Document Pipeline (DPPORT)

• Variable name: DP.COMMON.DPPORT
• Description:
This variable specifies the port number on which the Document Pipeline
process listens.
Port of the Notification Server (NOTIFHTTPPORT)

• Variable name: DP.COMMON.NOTIFHTTPPORT
• Description:
This variable specifies the port number on which the Notification Server
listens.
Timeout for DocTools (DTCTO)

• Variable name: DP.COMMON.DTCTO
• Description:
This variable specifies two parameters: p1/p2.
The parameter p1 is the so-called “call timeout”. This is the overall maximum
time (in seconds) a DocTool waits for an answer from the Document Pipeline
process. (default: 60 sec.). After this time, the call is no longer repeated and
marked as erroneous.
The parameter p2 represents a “retry timeout” (in seconds) which indicates
how long a DocTool waits for an answer from the Document Pipeline
process before it repeats the call (default: 2 sec.). In case of an error the call is
repeated as long as the “call timeout” is not yet reached.
• Type: String
• Predefined Value: 60/2
Timeout for DP (DPCTO)

• Variable name: DP.COMMON.DPCTO

AR100500-01-ACN-EN-04
• Description:
This variable specifies two parameters: p1/p2.
The parameter p1 is the so-called “call timeout”. This is the overall maximum
time (in seconds), the Document Pipeline process waits for an answer from a
DocTool he called (default: 5 sec.). After this period of time, the call is no
longer repeated and marked as erroneous.
The parameter p2 represents a “retry timeout” (in seconds) which indicates
how long the Document Pipeline process waits for an answer from a
DocTool before it repeats the call (default: 5 sec). In case of an error the call is
repeated as long as the “call timeout” is not yet reached.
• Type: String
• Predefined Value: 5/5
Unique client identifier for authentication (DSH_AUTH_ID)

• Variable name: DP.COMMON.DSH_AUTH_ID
• Description:
This variable specifies the unique identifier of DocTools used in accounting
information.
• Type: String
• Predefined Value: dsh
Use checksum in Archive Server communication (DSH_CHECKSUM)

• Variable name: DP.COMMON.DSH_CHECKSUM
• Description:
This variable specifies whether checksums are used for communication
between Document Pipeline and Archive Server. If set to on, files sent to the
archive get an additional checksum which is checked by the Archive Server
to avoid transmission errors. If set to off, no checksums are created. This
results in a faster transmission, but higher error risk. This setting does not
require a corresponding setting on Archive Server.
• Type: Flag
• Allowed Value:
• on
• off

AR100500-01-ACN-EN-04
44.1. Common settings for Document Pipelines
44.1.1 Logging
Storage location:
\COMMON.Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/COMMON.
Setup
Debug messages (LOG_DEBUG)
• Variable name: DP.COMMON.LOG_DEBUG

• Description:
This variable specifies if debug logging is enabled for the Document Pipeline.
• Type: Flag
• Allowed Value:
• on
• off
Entry messages (LOG_ENTRY)
• Variable name: DP.COMMON.LOG_ENTRY

• Description:
This variable specifies if logging for entering or leaving a function is enabled
for the Document Pipeline.
• Type: Flag
• Allowed Value:
• on
• off
HTTP messages (LOG_DSH)
• Variable name: DP.COMMON.LOG_DSH

• Description:
This variable specifies if HTTP logging is enabled for the Document Pipeline.
• Type: Flag
• Allowed Value:
• on
• off
Info messages (LOG_INFO)
• Variable name: DP.COMMON.LOG_INFO

• Description:

AR100500-01-ACN-EN-04
This variable specifies if info logging is enabled for the Document Pipeline.
• Type: Flag
• Allowed Value:
• on
• off
Max. size of the Document Pipeline log file (MAXLOGSIZE)

• Variable name: DP.COMMON.MAXLOGSIZE
• Description:
This variable specifies the maximum size of a log file. If the maximum size is
reached, the log file will rename to *.old and a new log file is created.
(default: 5 MB)
• Type: Integer
RPC messages (LOG_RPC)

• Variable name: DP.COMMON.LOG_RPC
• Description:
This variable specifies if RPC logging is enabled for the Document Pipeline.
• Type: Flag
• Allowed Value:
• on
• off
Use relative time (LOG_REL)

• Variable name: DP.COMMON.LOG_REL
• Description:
This variable specifies if logging with relative timestamps is enabled for the
Document Pipeline.
• Type: Flag
• Allowed Value:
• on
• off
Warning messages (LOG_WARNING)

• Variable name: DP.COMMON.LOG_WARNING
• Description:
This variable specifies if logging of warning messages is enabled for the
Document Pipeline.

AR100500-01-ACN-EN-04
44.2. Remote pipeline interface
• Type: Flag
• Allowed Value:
• on
• off
44.2 Remote pipeline interface

Storage location:
- Windows: Configuration file: <ECM_DOCUMENT_PIPELINE_CONF>\config\setup
\DPRI.Setup
- UNIX: Configuration file: <ECM_DOCUMENT_PIPELINE_CONF>/config/setup/
DPRI.Setup
Allowed hosts (DPRI_ALLOWED_HOSTS)

• Variable name: DP.DPRI.DPRI_ALLOWED_HOSTS
• Description:
This variable specifies the remote clients which are allowed to create
documents in the Document Pipeline.
You can specify one or more
• host names
• IP addresses
• Partly qualified IP addresses, e.g. 192.123
• *, to allow access for all clients
• Type: String
• Predefined Value: *
Directory for log files (LOG_DIR)

• Variable name: DP.DPRI.LOG_DIR
• Description:
This variable specifies the directory for the log file.
• Type: Path

AR100500-01-ACN-EN-04
44.2.1 Logging
Storage location:
\DPRI.Setup
DPRI.Setup
Remote pipeline interface log messages (LOG_LEVEL)

• Variable name: DP.DPRI.LOG_LEVEL
• Description:
This variable specifies the log level for the enqueue process of the remote
pipeline.
• Type: Enum
• Allowed Value:
• DEBUG ("debug")
• LVE ("leave")
• ENT ("entry")
• INFO ("info")
• WARN ("warning")
• ERROR ("error")
44.3 DocTool rendition

Storage location:
\DT_RENDITION.Setup
DT_RENDITION.Setup
Host of the Rendition Server (RENDITION_SRV_HOST)

• Variable name: DP.DT_RENDITION.RENDITION_SRV_HOST
• Description:
This variable specifies the server on which the Rendition Server runs.
Port of the Rendition Server (RENDITION_SRV_PORT)

• Variable name: DP.DT_RENDITION.RENDITION_SRV_PORT
• Description:
This variable specifies the port number on which the Rendition Server
listens.
Protocol of the Rendition Server (RENDITION_HTTP_PROTOCOL)

• Variable name: DP.DT_RENDITION.RENDITION_HTTP_PROTOCOL

AR100500-01-ACN-EN-04
44.4. DocTool timestampdt
• Description:
This variable specifies the communication protocol with the Rendition
Server.
• Type: Enum
• Allowed Value:
• http
• https
44.4 DocTool timestampdt

Storage location:
\DT_TIMESTAMPDT.Setup
DT_TIMESTAMPDT.Setup
Communication protocol of the timestamp server (TIMESTAMP_PROTOCOL)

• Variable name: DP.DT_TIMESTAMPDT.TIMESTAMP_PROTOCOL
• Description:
This variable specifies the communication protocol between the Document
Pipeline and the timestamp server (Default: http).
• Type: Enum
• Allowed Value:
• http
• https
Host of the timestamp server (TIMESTAMP_HOST)

• Variable name: DP.DT_TIMESTAMPDT.TIMESTAMP_HOST
• Description:
This variable specifies the server on which the timestamp server runs.
Path part of URL of the timestamp server (TIMESTAMP_URL_PATH)

• Variable name: DP.DT_TIMESTAMPDT.TIMESTAMP_URL_PATH
• Description:
This variable specifies the path used in the URL to communicate with the
timestamp server (Default: /).
• Type: String
• Predefined Value: /
Port of the timestamp server (TIMESTAMP_PORT)

• Variable name: DP.DT_TIMESTAMPDT.TIMESTAMP_PORT

AR100500-01-ACN-EN-04
• Description:
This variable specifies the port number on which the timestamp server
listens.
Timestamp server login: password (TIMESTAMP_PASSWORD)

• Variable name: DP.DT_TIMESTAMPDT.TIMESTAMP_PASSWORD
• Description:
This variable specifies the password required by timestamp server for
authentication.
• Type: String
Timestamp server login: user (TIMESTAMP_LOGIN)

• Variable name: DP.DT_TIMESTAMPDT.TIMESTAMP_LOGIN
• Description:
This variable specifies the user required by timestamp server for
authentication.
• Type: String
44.5 COLD for DocuLink (COR3)

Storage location:
\COR3.Setup
COR3.Setup
Configuration directory for COR3 pipeline (CONFIG_DIR)

• Variable name: DP.COR3.CONFIG_DIR
• Description:
The root directory for the batchimport configuration files (=
ECM_DOCUMENT_PIPELINE_CONF/config/batchimport).
• Type: Path
External directory for COR3 pipeline (DATA_DIR)

• Variable name: DP.COR3.DATA_DIR
• Description:
This variable specifies the input directory for COLD documents.
• Type: Path
Name of protocol file of Enqueco DocTool (PROTOCOL)

• Variable name: DP.COR3.PROTOCOL

AR100500-01-ACN-EN-04
44.6. Batch import for DocuLink (EXR3)
• Description:
This variable specifies the name of a protocol file for COLD pipelines. If a
name is specified, the path name of the data files in the external directory is
written into the file.
• Type: Path
Remove flag (COR3) (COLD_RM)

• Variable name: DP.COR3.COLD_RM
• Description:
Defines whether the files contained in the document directory should be
removed after the document is processed (remove: on). If the directory itself
should be removed as well, use with directory.
• Type: Enum
• Allowed Value:
• off ("off")
• on ("on")
• with directory ("with directory")
Target file of character encoding (FILES_TO_CONVERT)

• Variable name: DP.COR3.FILES_TO_CONVERT
• Description:
This variable specifies a regular expression for the target file when character
encoding is applied to the input data file (default: ^META_DOCUMENT$).
• Type: String
• Predefined Value: ^META_DOCUMENT$
44.6 Batch import for DocuLink (EXR3)

Storage location:
\EXR3.Setup
EXR3.Setup
External directory (EXR3) (EXT_DIR)

• Variable name: DP.EXR3.EXT_DIR
• Description:
This variable specifies the directory which contains the documents to be
enqueued.
• Type: Path
Files which must be copied (EXR3) (FILES_TO_COPY)

• Variable name: DP.EXR3.FILES_TO_COPY

AR100500-01-ACN-EN-04
• Description:
A regular pattern specifying all files that must be copied from external
directory (EXT_DIR) to document directory (DPDIR).
• Type: String
• Predefined Value: .*
Files which must be there (EXR3) (FILES_TO_BE_THERE)
• Variable name: DP.EXR3.FILES_TO_BE_THERE

• Description:
A regular pattern specifying all files that must exist in external directory
(EXT_DIR).
• Type: String
• Predefined Value: ^COMMANDS$
Files which must not be copied (EXR3) (FILES_NOT_TO_COPY)
• Variable name: DP.EXR3.FILES_NOT_TO_COPY

• Description:
A regular pattern specifying all files that must not to be copied from external
• Type: String
• Predefined Value: ^LOG$
Files which must not be there (EXR3) (FILES_NOT_TO_BE_THERE)
• Variable name: DP.EXR3.FILES_NOT_TO_BE_THERE

• Description:
A regular pattern specifying all files that must not exist in external directory
(EXT_DIR).
• Type: String
• Predefined Value: êrror$
Name of Indicator file (EXR3) (LOG_FILE)
• Variable name: DP.EXR3.LOG_FILE

• Description:
This file is used for deciding whether the DocTool should take the data. It is
known as LOG file. After document was enqueued, this file automatically was
removed by Enqueext DocTool.
• Type: String
• Predefined Value: LOG
Remove flag (EXR3) (EXT_RM)
• Variable name: DP.EXR3.EXT_RM

• Description:

AR100500-01-ACN-EN-04
44.7. Common settings for Project Pipelines
This variable specifies whether the files contained in the external directory
should be removed after the document is processed (remove: on). If the
directory itself should be removed as well, use with directory.
• Type: Enum
• Allowed Value:
• on
• off
• with directory
Target file(s) which must be convert in character set (EXR3) (FILES_TO_CONVERT)

• Variable name: DP.EXR3.FILES_TO_CONVERT
• Description:
A regular pattern specify the file(s) where it's necessary to convert the
encoding. The default target file is IXATTR.
• Type: String
• Predefined Value: ÎXATTR$
44.7 Common settings for Project Pipelines

Storage location:
\FILING.Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/FILING.
Setup
Create Multi-Page TIFF (CREATE_MULTIPAGE_TIFF)

• Variable name: DP.FILING.CREATE_MULTIPAGE_TIFF
• Description:
This variable specifies that single page tiff files are merged into multi page
tiff files. If set to on, this variable globally acts on all pipelines. Instead of
using the global variable, it is recommended to use pipeline specific
statements in the COMMANDS file.
• Type: Flag
• Allowed Value:
• on
• off
Directory for batch import (BASE_EXTERNAL_DIR)

• Variable name: DP.FILING.BASE_EXTERNAL_DIR
• Description:
This variable specifies the parent directory for batch import and COLD data.
• Type: Path

AR100500-01-ACN-EN-04
Locale information for character recognition (PRJ_CODE_PAGE)

• Variable name: DP.FILING.PRJ_CODE_PAGE
• Description:
This variable specifies the code page character sets to be used in multi-byte
environments to recognize the pipe symbol as separator. Specify “.932” for
Code page 932 / ShiftJIS.
• Type: String
Number of statements per RFC call (INSERTS_PER_RFC)

• Variable name: DP.FILING.INSERTS_PER_RFC
• Description:
This variable specifies number of statements per RFC call to SAP systems. It
is used by the DocTool R3Insert.
• Type: Integer
SAP configuration file 'saprfc.ini' (RFC_INI)

• Variable name: DP.FILING.RFC_INI
• Description:
This variable specifies the path of SAP configuration file saprfc.ini. If file
doesn't exist, connection parameters to SAP Servers will be read from
Archive Server. If file exists, connection parameters to SAP Servers will be
read from file instead of from Archive Server.
Note: The destination id specified in saprfc.ini must be defined as SID
parameter in Open Text Administration. SAP logon parameters (Feedback
user, Password, Client, Language and Codepage) must always be defined in
Archive Server.
• Type: Path
44.8 Batch load for XML documents (XMLBL)

Storage location:
\XMLBL.Setup
XMLBL.Setup
External directory (XMLBL) (EXT_DIR)

• Variable name: DP.XMLBL.EXT_DIR
• Description:
This variable specifies the directory which contains the documents to be
enqueued.

AR100500-01-ACN-EN-04
44.8. Batch load for XML documents (XMLBL)
• Type: Path
Files which must be copied (XMLBL) (FILES_TO_COPY)
• Variable name: DP.XMLBL.FILES_TO_COPY

• Description:
A regular pattern specifying all files that must be copied from external
• Type: String
• Predefined Value: .*
Files which must be there (XMLBL) (FILES_TO_BE_THERE)
• Variable name: DP.XMLBL.FILES_TO_BE_THERE

• Description:
A regular pattern specifying all files that must exist in external directory
(EXT_DIR).
• Type: String
• Predefined Value: ^COMMANDS$
Files which must not be copied (XMLBL) (FILES_NOT_TO_COPY)
• Variable name: DP.XMLBL.FILES_NOT_TO_COPY

• Description:
A regular pattern specifying all files that must not to be copied from external
• Type: String
• Predefined Value: ^LOG$
Files which must not be there (XMLBL) (FILES_NOT_TO_BE_THERE)
• Variable name: DP.XMLBL.FILES_NOT_TO_BE_THERE

• Description:
A regular pattern specifying all files that must not exist in external directory
(EXT_DIR).
• Type: String
• Predefined Value: êrror$
Name of Indicator file (XMLBL) (LOG_FILE)
• Variable name: DP.XMLBL.LOG_FILE

• Description:
This file is used for deciding whether the DocTool should take the data. It is
known as LOG file. After document was enqueued, this file automatically was
removed by Enqueext DocTool.
• Type: String
• Predefined Value: LOG

AR100500-01-ACN-EN-04
Remove flag (XMLBL) (EXT_RM)

• Variable name: DP.XMLBL.EXT_RM
• Description:
This variable specifies whether the files contained in the external directory
should be removed after the document is processed (remove: on). If the
directory itself should be removed as well, use with directory.
• Type: Enum
• Allowed Value:
• on
• off
• with directory
Target file(s) which must be convert in character set (XMLBL)

(FILES_TO_CONVERT)
• Variable name: DP.XMLBL.FILES_TO_CONVERT
• Description:
A regular pattern specify the file(s) where it's necessary to convert the
encoding. The default target file is IXATTR.
• Type: String
• Predefined Value: ÎXATTR$

AR100500-01-ACN-EN-04
Chapter 45
Email Cloud Archive
45.1 Email Archiving Services (ECA)

Storage location:
- Windows: Configuration file: <ECM_ARCHIVE_SERVER_CONF>\config\setup\ECA.
Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/ECA.
Setup
Enabled (enabled)
• Variable name: ECA.ECA.enabled
• Description:
Allows to disable the start of all email archiving services, for example due to
maintenance reasons.
• Type: Flag
• Allowed Value:
• true
• false
Status Interval (minutes) (statusInterval)

• Variable name: ECA.ECA.statusInterval
• Description:
Every so many minutes the Email job writes a status message into the job
protocol (default 8 hours).
45.1.1 Configuration
Storage location:
Setup
Setup

AR100500-01-ACN-EN-04
Chapter 45 Email Cloud Archive
45.1.1.1 Archive System

Storage location:
Setup
Setup
45.1.1.1.1 CMIS related settings
Storage location:
Setup
Setup
Allow insecure (self-signed) certificates (configuration.archivesystem.cmis.

acceptInsecureCertificate)
• Variable name: ECA.ECA.configuration.archivesystem.cmis.

acceptInsecureCertificate
• Description:
This variable specifies whether self-signed certificates are allowed to connect
to CMIS with SSL.
• Type: Flag
• Allowed Value:
• true
• false
CMIS server URL (configuration.archivesystem.cmis.server)
• Variable name: ECA.ECA.configuration.archivesystem.cmis.server

• Description:
Specifies the URL of the CMIS server used to archive emails. (Example:
https://mycomputer.mydomain.xyz:8443/as_cmis) .
• Type: String
• Predefined Value: https://localhost:8090/as_cmis
SSL Client Authentication (configuration.archivesystem.cmis.

sslauthentication)

sslauthentication
• Description:
Specifies whether SSL client authentication is customized to login to CMIS on
'Archive Proxy Server' or directly on 'Archive Server'. On Archive Server the
default value is 'false'. On Archive Proxy Server the default value is 'true',

AR100500-01-ACN-EN-04
45.1. Email Archiving Services (ECA)
because the 'Archive Server' trusts the 'Archive Proxy Server' using
certificates plus SSL protocol.
• Type: Flag
• Allowed Value:
• true
• false
SSL Client Authentication KeyStore (configuration.archivesystem.cmis.

sslauthkeystore)

sslauthkeystore
• Description:
File path of the 'KeyStore' containing the certificate, which is imported in the
'TrustStore' of the CMIS Server, so the CMIS server will trust the CMIS client.
It is needed only in case, that 'SSL Client Authentication' is enabled.
• Type: Path
SSL Client Authentication KeyStore Password (configuration.

archivesystem.cmis.sslauthkeystorepassword)

sslauthkeystorepassword
• Description:
This variable specifies the password of the 'KeyStore' for SSL Client
Authentication. It is needed only in case, that 'SSL Client Authentication' is
enabled.
• Type: String
SSL Client Authentication TrustStore (configuration.archivesystem.cmis.

sslauthtruststore)

sslauthtruststore
• Description:
File path of the 'TrustStore' containing the certificate, which is imported in
the 'KeyStore' of the CMIS Server, so the CMIS client processes will trust the
CMIS server. It is needed only in case, that 'SSL Client Authentication' is
enabled.
• Type: Path

AR100500-01-ACN-EN-04
SSL Client Authentication TrustStore Password (configuration.

archivesystem.cmis.sslauthtruststorepassword)

sslauthtruststorepassword
• Description:
This variable specifies the password of the 'TrustStore' for SSL Client
Authentication. It is needed only in case, that 'SSL Client Authentication' is
enabled.
• Type: String
Store display* fields (configuration.archivesystem.cmis.

storeDisplayFields)

storeDisplayFields
• Description:
When archiving emails into the CMIS repository, store participant display
names into the display* property fields? These fields are used for searching
in the Web UI and data contained there is duplicated from participant
display names.
• Type: Flag
• Allowed Value:
• true ("store")
• false ("don't store")
TCP connection timeout (configuration.archivesystem.cmis.

ConnectionTimeoutSeconds)

ConnectionTimeoutSeconds
• Description:
TCP connection timeout in seconds (maximum time to establish a
connection).
TCP read timeout (configuration.archivesystem.cmis.ReadTimeoutSeconds)

ReadTimeoutSeconds
• Description:
Read timeout in seconds (maximum time to wait for reading data from an
established connection).

AR100500-01-ACN-EN-04
Use CMIS Proxy (XPWD) (configuration.archivesystem.cmis.usecmisproxy)

usecmisproxy
• Description:
If the software is installed on CMIS Proxy servers, then value 'true' of this
variable enables a special authentication to CMIS (XPWD). So 'true' is the
default on CMIS proxy servers. If the software is running on systems with
installed 'Archive Server', then the default value is 'false'. In this case the
software uses the Archive Server OTDS Resource to authenticate against
CMIS.
• Type: Flag
• Allowed Value:
• true
• false
Use Cookies (configuration.archivesystem.cmis.usecookies)

usecookies
• Description:
Specifies whether cookies are enabled for CMIS sessions. The default value is
'true'. If the value is 'false', then it can slow down the performance using
CMIS proxy servers.
• Type: Flag
• Allowed Value:
• true
• false
45.1.1.1.2 OTDS related settings
Storage location:
Setup
Setup
Add SMTP first (configuration.archivesystem.otds.addsmtpfirst)

• Variable name: ECA.ECA.configuration.archivesystem.otds.
addsmtpfirst
• Description:
Set this to true, if the real email-addresses of users in OTDS start with a
"smtp:" prefix, otherwise set to false.
• Type: Flag

AR100500-01-ACN-EN-04
• Allowed Value:
• true
• false
Allow insecure (self-signed) certificates (configuration.archivesystem.otds.

acceptInsecureCertificate)

acceptInsecureCertificate
• Description:
This variable specifies whether self-signed certificates are allowed to connect
to OTDS with SSL.
• Type: Flag
• Allowed Value:
• true
• false
Cache duration (configuration.archivesystem.otds.cachedurationseconds)

cachedurationseconds
• Description:
The caching duration in seconds for user information from OTDS. Changes
in OTDS might take this long to become visible.
• Type: Integer
Cache size (configuration.archivesystem.otds.cachesize)
• Variable name: ECA.ECA.configuration.archivesystem.otds.cachesize

• Description:
The maximum number of OTDS users to cache. Set this much higher than the
actual number of active users unless you experience memory problems.
• Type: Integer
Groups partition (configuration.archivesystem.otds.groupspartition)

groupspartition
• Description:
Groups might be located in a separate OTDS partition. The name of such a
separate partition would be configured by entering a non-empty value.
• Type: String

AR100500-01-ACN-EN-04
OTDS Admin User (configuration.archivesystem.otds.otdsadmin)
• Variable name: ECA.ECA.configuration.archivesystem.otds.otdsadmin

• Description:
User has rights to create and modifiy other OTDS users. Needed to store
information in user attributes, such as the repository ID.
• Type: String
• Predefined Value: otadmin@otds.admin
OTDS Admin User Password (configuration.archivesystem.otds.

otdsadminpwd)

otdsadminpwd
• Description:
Password of the OTDS Admin user.
• Type: String
OTDS Server URL (configuration.archivesystem.otds.otdslocation)

otdslocation
• Description:
Local URL for the OTDS client connection.
• Type: String
• Predefined Value: https://localhost:8443
Repository attribute (configuration.archivesystem.otds.

repositoryattribute)

repositoryattribute
• Description:
OTDS user attribute holding the name of the users repositoryId.
• Type: String
• Predefined Value: oTACEmailCmisRepositoryId
Repository history attribute (configuration.archivesystem.otds.

repositoryhistoryattribute)

repositoryhistoryattribute
• Description:
OTDS user attribute holding the list of current and previous repositoryIds.
• Type: String
• Predefined Value: oTACEmailCmisRepositoryIdHistory

AR100500-01-ACN-EN-04
Use Impersonation (configuration.archivesystem.otds.useimpersonation)

useimpersonation
• Description:
If the key of the OTDS Resource or the OTDS resource are not available, then
value 'false' of this variable means, that no OTDS impersonation client is
created. A correct Administrator user name plus password are needed in the
configuration, too. In this case the authentication against CMIS is done with
an alternative method, which is the the case normally on CMIS proxy server.
The default value is 'true'.
• Type: Flag
• Allowed Value:
• true
• false
Use OTDS Proxy (configuration.archivesystem.otds.useotdsproxy)

useotdsproxy
• Description:
If the software should communicate with an Web App (REST API) to get
information about mail users and groups, then value 'true' of this variable
enable this. So 'true' means, that no direct OTDS client is created. This is
normally the case on CMIS proxy servers. If the software is running on
systems with installed 'Archive Server', then the default value is 'false'. In
this case the software communicates directly with the OTDS server.
• Type: Flag
• Allowed Value:
• true
• false
45.1.1.2 Audit Logs

Storage location:
Setup
Setup
Audit log enable (configuration.auditsystem.enabled)
• Variable name: ECA.ECA.configuration.auditsystem.enabled

• Description:

AR100500-01-ACN-EN-04
Enables or disables audit logs which contain information about each

processed email. Each archiving services writes a separate log per day as
CSV-formatted file.
• Type: Flag
• Allowed Value:
• true
• false
Audit log file (configuration.auditsystem.file)

• Variable name: ECA.ECA.configuration.auditsystem.file
• Description:
Specifies the name of the audit log files. As a new file is written each day, the
date is automatically appended to the specified name.
• Type: String
• Predefined Value: ${env.ECM_VAR_DIR}/eca/${service.name}.csv
Audit log separator (configuration.auditsystem.separator)

• Variable name: ECA.ECA.configuration.auditsystem.separator
• Description:
Specifies the character used to separate vaues in the audit logs.
• Type: String
• Predefined Value: ,
Days for which audit logs are retained (configuration.

auditsystem.backupdays)
• Variable name: ECA.ECA.configuration.auditsystem.backupdays

• Description:
Specifies the number of days the audit log files are retained. Older files are
automatically deleted.
• Type: Integer
45.1.1.3 Credential
Storage location:
Setup
Setup

AR100500-01-ACN-EN-04
45.1.1.4 Dispatcher
Storage location:
Setup
Setup
Items per processor (configuration.dispatcher.itemsperprocessor)
• Variable name: ECA.ECA.configuration.dispatcher.itemsperprocessor

• Description:
If the temporary 'Journal Processor xy' folder (queue) is empty, then move
this count of eMail items to the processor (= worker thread). The default
value is 100 eMail items.
• Type: Integer
Wait time (configuration.dispatcher.waittime)
• Variable name: ECA.ECA.configuration.dispatcher.waittime

• Description:
The default value is 5 seconds and the unit is milliseconds. The value means
the wait time until new eMail items are dispatched, if the queue was empty.
• Type: Integer
45.1.1.5 Email Source or Temporary Storage

Storage location:
Setup
Setup
Host Google Mailbox Scan (configuration.emailsystem.host)
• Variable name: ECA.ECA.configuration.emailsystem.host

• Description:
This parameter is evaluated only for Google mailbox scan. The default value
is imap.googlemail.com
• Type: String
• Predefined Value: imap.googlemail.com
oauth2scope Google Scan (configuration.emailsystem.oauth2scope)
• Variable name: ECA.ECA.configuration.emailsystem.oauth2scope

• Description:

AR100500-01-ACN-EN-04
This parameter is evaluated only for Google mailbox scan. The value has to
be a scope URL for Google Apps like gmail, google drive, .... and the default
value is https://mail.google.com
• Type: String
• Predefined Value: https://mail.google.com
Port Google Mailbox Scan (configuration.emailsystem.port)

• Variable name: ECA.ECA.configuration.emailsystem.port
• Description:
This parameter is evaluated only for Mailbox scan (Google or Exchange
mailboxes).
• Type: Integer
Root folder for buffering emails (configuration.emailsystem.rootfolder)

• Variable name: ECA.ECA.configuration.emailsystem.rootfolder
• Description:
File system folder used to buffer emails which were received by the SMTP
server and are waiting to be processed by the archiving services.
• Type: Path
• Predefined Value: C:\ProgramData\OpenText\emailFSroot
45.1.1.5.1 session
Storage location:
Setup
Setup
Debug Output (configuration.emailsystem.session.debug)

• Variable name: ECA.ECA.configuration.emailsystem.session.debug
• Description:
This parameter is evaluated only for mailbox scan. The output is visible in
messages of the jobs in 'Administration Client' or in text files in msub
directory 'messages' of the log directory.
• Type: Flag
• Allowed Value:
• true
• false

AR100500-01-ACN-EN-04
45.1.1.6 IMAP Server

Storage location:
Setup
Setup
IMAP Server Password of private key (configuration.imap.tlskeypassword)

• Variable name: ECA.ECA.configuration.imap.tlskeypassword
• Description:
This variable specifies the password of X.509 private key (default: 'secret'
encrypted).
• Type: String
• Predefined Value: G4A50AE4177DFF2AD
IMAP Server Password of TLS key store (configuration.

imap.tlsstorepassword)
• Variable name: ECA.ECA.configuration.imap.tlsstorepassword

• Description:
This variable specifies the password of TLS key store (default: 'secret'
encrypted).
• Type: String
• Predefined Value: G4A50AE4177DFF2AD
IMAP Server Port Insecure communication (configuration.imap.port)

• Variable name: ECA.ECA.configuration.imap.port
• Description:
This variable specifies the port for outgoing e-mail (default=143). E-mail
messages sent over the network will not be encrypted (insecure
communication). Note: Set port to 0 to switch off insecure communication for
outgoing e-mail.
IMAP Server Port Secure communication (SSL/TLS) (configuration.

imap.tlsport)
• Variable name: ECA.ECA.configuration.imap.tlsport

• Description:
This variable specifies the SSL/TLS port for outgoing e-mail (default=993). E-
mail messages sent over the network will be encrypted (secure
communication). Note: Set port to 0 to switch off secure communication for
outgoing e-mail.

AR100500-01-ACN-EN-04
IMAP Server TLS key store file (JKS) (configuration.imap.tlskeystore)

• Variable name: ECA.ECA.configuration.imap.tlskeystore
• Description:
This variable specifies the path of the key store file. Currently we only
support JKS formatted keystores, which is the Java standard keystore format
created by keytool command-line utility.
• Type: String
• Predefined Value: ${app.home}/conf/ecaImap.jks
Log Level IMAP Server (configuration.imap.LogLevel)

• Variable name: ECA.ECA.configuration.imap.LogLevel
• Protection: customer
• Description:
This setting specifies the log level for IMAP Server. There are 4 distinct
settings which add additional logging from top to bottom.
• Type: Enum
• Allowed Value:
Maximum number of client connections (configuration.

imap.maxworkerthreadcount)
• Variable name: ECA.ECA.configuration.imap.maxworkerthreadcount

• Description:
This variable specifies the maximum number of e-mail client connections of
the IMAP Server. Note: An e-mail client can use more than one connection
(e.g. connection per mailbox).
Number of CMIS documents per page request (configuration.imap.pagesize)

• Variable name: ECA.ECA.configuration.imap.pagesize
• Description:
This variable specifies the maximum number of CMIS documents returned in
a page request (default=1000). Note: Incease in value will improve speed, but
will also increase memory consumption in the IMAP Server!
Timeout of e-mail client (configuration.imap.timeout)

• Variable name: ECA.ECA.configuration.imap.timeout

AR100500-01-ACN-EN-04
• Description:
This variable specifies timeout of e-mail client connection in seconds
(default=1800). Client connection will be closed by IMAP Server if timeout
expires. Note: Timeout value must always be less than "TTL for OTDS
Ticket" of Archive Server configuration.
45.1.1.7 SMTP Server

Storage location:
Setup
Setup
SMTP Server Password of TLS key store and private key (configuration.
smtpserver.keystorepassword)
• Variable name: ECA.ECA.configuration.smtpserver.keystorepassword

• Description:
Password of the keystore containing the TLS certificate (default: 'changeit'
encrypted)
• Type: String
• Predefined Value: GCEF3E85F4B5C2DACFA4939CC17603BEE
SMTP Server Port (configuration.smtpserver.port)

• Variable name: ECA.ECA.configuration.smtpserver.port
• Description:
Port used for incoming SMTP connections. The default value is 25.
SMTP Server TLS key store file (JKS) (configuration.

smtpserver.keystorepath)
• Variable name: ECA.ECA.configuration.smtpserver.keystorepath

• Description:
Specifies the path of the keystore containing the certificate used by the SMTP
server for TLS connections.
• Type: String
• Predefined Value: ${env.ECM_ECA_CONF}/config/fsf/fsf.jks

AR100500-01-ACN-EN-04
45.1.1.7.1 SMTP Server Logging
Storage location:
Setup
Setup
Log File SMTP Server (configuration.smtpserver.logging.file)

• Variable name: ECA.ECA.configuration.smtpserver.logging.file
• Description:
The path and name of the logging file of the SMTP server. The default value
is ${env.ECM_LOG_DIR}/ecaSmtp.log.
• Type: String
• Predefined Value: ${env.ECM_LOG_DIR}/ecaSmtp.log
Log Level SMTP Server (configuration.smtpserver.logging.level)

• Variable name: ECA.ECA.configuration.smtpserver.logging.level
• Description:
This setting specifies the log level for the SMTP server. There are 5 distinct
settings which add additional logging from top to bottom. To disable logging
is possible (Off).
• Type: Enum
• Allowed Value:
• ERROR ("Errors")
• WARN ("Errors and Warnings")
• INFO ("Errors, Warnings and Info")
• DEBUG ("Errors, Warnings, Info and Debug")
• TRACE ("Errors, Warnings, Info, Debug and Trace")
• OFF ("Off")
Max. number of backup files (configuration.smtpserver.logging.

maxbackupindex)
• Variable name: ECA.ECA.configuration.smtpserver.logging.

maxbackupindex
• Description:
Specifies the value for the maximum number of log file backups. Default
value is 9.

AR100500-01-ACN-EN-04
Max. size of logfile (Mega Bytes) (configuration.smtpserver.logging.

maxfilesize)
• Variable name: ECA.ECA.configuration.smtpserver.logging.

maxfilesize
• Description:
Specifies the value for the maximum file size in megabytes. Default value is
50 MB.
• Type: Integer
45.1.1.8 OTDS Proxy

Storage location:
Setup
Setup
45.1.1.8.1 OTDS Proxy Logging
Storage location:
Setup
Setup
Log File Proxy WebApp Directory Service (configuration.otdsproxy.logging.

file)
• Variable name: ECA.ECA.configuration.otdsproxy.logging.file

• Description:
The path and name of the logging file of the OTDS Proxy. The default value
is ${env.ECM_LOG_DIR}/otdsProxy.log.
• Type: String
• Predefined Value: ${env.ECM_LOG_DIR}/ecaProxy.log
Log Level Proxy WebApp Directory Service (configuration.

otdsproxy.logging.level)
• Variable name: ECA.ECA.configuration.otdsproxy.logging.level

• Description:
This setting specifies the log level for the OTDS proxy. There are 5 distinct
settings which add additional logging from top to bottom. To disable logging
is possible (Off).
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04

• OFF ("Off")
Max. number of backup files (configuration.otdsproxy.logging.

maxbackupindex)
• Variable name: ECA.ECA.configuration.otdsproxy.logging.

maxbackupindex
• Description:
value is 9.
Max. size of logfile (Mega Bytes) (configuration.otdsproxy.logging.

maxfilesize)
• Variable name: ECA.ECA.configuration.otdsproxy.logging.

maxfilesize
• Description:
50 MB.
• Type: Integer
45.1.1.9 Marking System

Storage location:
Setup
Setup
Maximum size (configuration.markingsystem.maxsize)

• Variable name: ECA.ECA.configuration.markingsystem.maxsize
• Description:
The maximum number of eMail items, which can be marked in memory (for
example marking for retries). The default value is 100000 eMail items.
• Type: Integer

AR100500-01-ACN-EN-04
45.1.1.10 Query Mailbox Scan

Storage location:
Setup
Setup
Max. Results (configuration.query.maxresults)

• Variable name: ECA.ECA.configuration.query.maxresults
• Description:
This parameter is evaluated only for Mailbox scan (Google mailboxes).
During scan of one or several eMail accounts (mail boxes), this number of
eMails limits the query before switching to the next eMail account or doing
the next query for the same mail account.
• Type: Integer
Min. Age in days (configuration.query.minage)

• Variable name: ECA.ECA.configuration.query.minage
• Description:
This parameter is evaluated only for Mailbox scan (Google mailboxes). The
unit is days and the default value is 30 days. Normally this value is
overridden by the higher prior value in the 'Archive:All-in-One
Administration'. If in the 'Archive:All-in-One Administration' no value is
defined, then only eMails older or equal this number of days are archived.
• Type: Integer
Min. Size in kB (configuration.query.minsize)

• Variable name: ECA.ECA.configuration.query.minsize
• Description:
This parameter is evaluated only for Mailbox scan (Google mailboxes). The
unit is kiloBytes and the default value is 0 kB. Normally this value is
overridden by the higher prior value in the 'Archive:All-in-One
Administration'. If in the 'Archive:All-in-One Administration' no value is
defined, then only eMails of at least this size are archived.
• Type: Integer

AR100500-01-ACN-EN-04
45.1.1.11 Queue Mailbox Scan

Storage location:
Setup
Setup
Backup File (configuration.queue.backupfile)

• Variable name: ECA.ECA.configuration.queue.backupfile
• Description:
• Type: String
• Predefined Value: ${env.ECM_LOG_DIR}/${service.name}-stores.
txt.bak
Wait Time (configuration.queue.waittime)

• Variable name: ECA.ECA.configuration.queue.waittime
• Description:
• Type: Integer
45.1.1.12 Spam Headers

Storage location:
Setup
Setup
X-Gm-Spam header Google Emails (configuration.spamhandling.headers.x-

gm-spam)
• Variable name: ECA.ECA.configuration.spamhandling.headers.x-gm-

spam
• Description:
Google sets email header X-Gm-Spam=1 for spam email.
• Type: Integer
X-Spam-Flag header Google Emails (configuration.spamhandling.headers.x-

spam-flag)
• Variable name: ECA.ECA.configuration.spamhandling.headers.x-spam-

flag
• Description:
Google sets email header X-Spam-Flag=yes for spam email.
• Type: Flag
• Predefined Value: yes

AR100500-01-ACN-EN-04
• Allowed Value:
• yes
• no
45.1.1.13 Notification System

Storage location:
Setup
Setup
Enable notification messages (configuration.notificationsystem.enabled)

• Variable name: ECA.ECA.configuration.notificationsystem.enabled
• Description:
Enables or disables sending of notification messages to the notification
server.
• Type: Flag
• Allowed Value:
• true
• false
Host Notification Server (configuration.notificationsystem.notshost)

• Variable name: ECA.ECA.configuration.notificationsystem.notshost
• Description:
If the value is empty, then the server name of the CMIS connection is taken
as host of the notification server. An non-empty value has higher priority
and is taken as server name of the notification server.
• Type: String
Message user (configuration.notificationsystem.msguser)

• Variable name: ECA.ECA.configuration.notificationsystem.msguser
• Description:
An empty value means default user name as the sender of notification
messages (default 'Administrator' on Windows and 'daemon' on UNIX/
LINUX). Any non-empty value overrides the default value.
• Type: String
Port Notification Server (configuration.notificationsystem.notsport)

• Variable name: ECA.ECA.configuration.notificationsystem.notsport
• Description:

AR100500-01-ACN-EN-04
If the value is empty, then the port number of the CMIS connection is taken
to send messages to the notification server. An non-empty value has higher
priority and is taken as port of the notification server.
• Type: String
Protocol (configuration.notificationsystem.notsprotocol)
• Variable name: ECA.ECA.configuration.
notificationsystem.notsprotocol
• Description:
If the value is empty, then the protocol information of the CMIS connection is
taken to send messages to the notification server. An non-empty value has
higher priority and is taken to send messages to the notification server.
• Type: Enum
• Allowed Value:
• https ("https")
• http ("http")
• <empty> ("Protocol of CMIS connection")
45.1.1.14 Processor
Storage location:
Setup
Setup
Count (configuration.processor.count)
• Variable name: ECA.ECA.configuration.processor.count
• Description:
The number of worker threads (= processors). The default value is 5
processors.
• Type: Integer
From envelope (configuration.processor.fromenvelope)

• Variable name: ECA.ECA.configuration.processor.fromenvelope
• Description:
Archiving Microsoft Exchange email envelope format or other
• Type: Flag
• Allowed Value:
• true

AR100500-01-ACN-EN-04
• false
Max. number of retries (configuration.processor.maxretries)

• Variable name: ECA.ECA.configuration.processor.maxretries
• Description:
The number of retries in case of errors and the default value is 3 retries.
• Type: Integer
Wait time (configuration.processor.waittime)

• Variable name: ECA.ECA.configuration.processor.waittime
• Description:
The polling interval (= wait time), if no work currently to do, i.e. queue is
empty. So the value means the max. wait time until the processing of the
eMail items starts, if new eMails arrive. The default value is 1000
milliseconds.
• Type: Integer
45.1.1.15 Status
Storage location:
Setup
Setup
Update time (configuration.status.updatetime)

• Variable name: ECA.ECA.configuration.status.updatetime
• Description:
The service internal status for monitoring is updated only on request. If
many requests are incoming, then the status is updated in intervals of this
time. The default value is 1000 milliseconds.
• Type: Integer

AR100500-01-ACN-EN-04
45.1.1.16 Worker Mailbox Scan

Storage location:
Setup
Setup
Count (configuration.worker.count)
• Variable name: ECA.ECA.configuration.worker.count

• Description:
The number of worker threads (= processors). The default value is 5
processors.
• Type: Integer
Delete in Deleted Folder (configuration.worker.deleteintrash)
• Variable name: ECA.ECA.configuration.worker.deleteintrash

• Description:
This parameter is evaluated only for Mailbox scan. If an email is archived,
then it could be moved automatically to the 'Deleted' folder. This depends on
the other parameter 'marking=false'. If in the 'Archive:All-in-One
Administration' no other value for 'deleteintrash' is defined and the value is
'true', then the emails which were moved temporarily to the 'Deleted' folder
are really deleted additionally.
• Type: Flag
• Allowed Value:
• true
• false
Fetch Count (configuration.worker.fetchcount)
• Variable name: ECA.ECA.configuration.worker.fetchcount

• Description:
• Type: Integer
Mark Email Items instead of move to Deleted Folder (configuration.

worker.marking)
• Variable name: ECA.ECA.configuration.worker.marking

• Description:
This parameter is evaluated only for Mailbox scan. If an email item is
archived, then it is either marked as 'archived' or moved to the 'Deleted'
folder. If in the 'Archive:All-in-One Administration' no other value is defined

AR100500-01-ACN-EN-04
and the value is 'true', then the emails are marked only. In case of value 'false'
the email items are moved to the 'Deleted' folder.
• Type: Flag
• Allowed Value:
• true
• false
Wait Time (configuration.worker.waittime)
• Variable name: ECA.ECA.configuration.worker.waittime

• Description:
• Type: Integer
45.1.1.17 Working Time

Storage location:
Setup
Setup
From (configuration.workingtime.from)
• Variable name: ECA.ECA.configuration.workingtime.from

• Description:
The feature of the 'working time' is is evaluated only for Mailbox scan
(Google or Exchange mailboxes).
• Type: String
• Predefined Value: 00:00
Schedule (configuration.workingtime.schedule)
• Variable name: ECA.ECA.configuration.workingtime.schedule

• Description:
The 'Schedule' count in minutes is evaluated only for Mailbox scan (Google
or Exchange mailboxes). The value 0 means, that the mailboxes are scanned
and the service stops after the scan. After the service is stopped, the archive
server job scheduler will start the job for the service again in case of default
settings of the job scheduling and not disabled. A value greater than zero
minutes means, that the service to scan mailboxes will run forever unless
stopped by the administrator. The service scans mailboxes and waits the time
in minutes of this 'Schedule' count. After this time in minutes the service
starts a new scan of the mailboxes.
• Type: Integer

AR100500-01-ACN-EN-04
To (configuration.workingtime.to)
• Variable name: ECA.ECA.configuration.workingtime.to
• Description:
The feature of the 'working time' is evaluated only for Mailbox scan (Google
or Exchange mailboxes).
• Type: String
• Predefined Value: 00:00
45.1.2 Logging
Storage location:
Setup
Setup
Log File Email Archiving Services (logging.file)

• Variable name: ECA.ECA.logging.file
• Description:
• Type: String
• Predefined Value: ${env.ECM_LOG_DIR}/${service.name}.log
Log Level Email Archiving Services (logging.level)

• Variable name: ECA.ECA.logging.level
• Description:
This setting specifies the log level for Email Archiving Services. There are 5
distinct settings which add additional logging from top to bottom. To disable
logging is possible (Off).
• Type: Enum
• Allowed Value:
• OFF ("Off")
Max. number of backup files (logging.maxbackupindex)

• Variable name: ECA.ECA.logging.maxbackupindex
• Description:
value is 9.

AR100500-01-ACN-EN-04
Max. size of logfile (Mega Bytes) (logging.maxfilesize)

• Variable name: ECA.ECA.logging.maxfilesize
• Description:
50 MB.
• Type: Integer
45.1.3 Monitoring
Storage location:
Setup
Setup
Command to monitor aborted services (MONITORING_CALL_ABORTED_SERVICES)

• Variable name: ECA.ECA.MONITORING_CALL_ABORTED_SERVICES
• Description:
Command called by monitoring client to summarize information displayed
in Archive Monitoring Server / Health Status. The option '-monitor' is
necessary to get one output line for the Archive Monitoring Server. Default
value: ""$(ECM_EMAIL_CLOUD_ARCHIVE)/bin/ServiceStatus" -monitor -
errorabort"
• Type: String
• Predefined Value: ""$(ECM_EMAIL_CLOUD_ARCHIVE)/bin/ServiceStatus"
-monitor -errorabort"
Command to monitor archived eMails (MONITORING_CALL_EMAILS_ARCHIVED)

• Variable name: ECA.ECA.MONITORING_CALL_EMAILS_ARCHIVED
• Description:
archived"
• Type: String
-monitor -archived"
Command to monitor ProblemsArchive (MONITORING_CALL_PROBLEMS_ARCHIVE)

• Variable name: ECA.ECA.MONITORING_CALL_PROBLEMS_ARCHIVE
• Description:

AR100500-01-ACN-EN-04

emailproblems"
• Type: String
-monitor -emailproblems"
Command to monitor ProblemsRejected (MONITORING_CALL_EMAILS_REJECTED)

• Variable name: ECA.ECA.MONITORING_CALL_EMAILS_REJECTED
• Description:
emailrejected"
• Type: String
-monitor -emailrejected"

AR100500-01-ACN-EN-04
Chapter 46
File Archive
46.1 Specific settings for FSA Document Pipelines

Storage location:
- Windows: Configuration file: <ECM_ARCHIVE_SERVER_CONF>\config\setup\FSA.
Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/FSA.
Setup
Algorithm used to sign (FSA_SIGNATURE_ALGORITHM)

• Variable name: FSA.FSA.FSA_SIGNATURE_ALGORITHM
• Description:
• Type: Enum
• Predefined Value: SHA
• Allowed Value:
• SHA ("SHA1")
• SHA256 ("SHA256")
• SHA512 ("SHA512")
Allow insecure (self-signed) certificates (FSA_ACCEPT_INSECURE_CERTIFICATES)

• Variable name: FSA.FSA.FSA_ACCEPT_INSECURE_CERTIFICATES
• Description:
“Internal” This variable specifies whether self-signed certificates are allowed
to connect to CMIS with SSL or not.
• Type: Flag
• Allowed Value:
• true
• false
Allow Windows system files to be enqueued (FSA_ENQUEUE_SYSFILES)

• Variable name: FSA.FSA.FSA_ENQUEUE_SYSFILES
• Description:
• Type: Flag

AR100500-01-ACN-EN-04
Chapter 46 File Archive

• Allowed Value:
• true
• false
Archive / CMIS Server: communication port (CMIS_PORT)

• Variable name: FSA.FSA.CMIS_PORT
• Description:
This variable specifies the port number on which the Archive / CMIS Server
listens.
Archive / CMIS server: communication protocol (CMIS_PROTOCOL)

• Variable name: FSA.FSA.CMIS_PROTOCOL
• Description:
This setting specifies the communication protocol for the Archive / CMIS
server.
• Type: Enum
• Allowed Value:
• https ("HTTPS")
• http ("HTTP")
Authentication certificate keystore Password (FSA_KEYSTORE_PASSWORD)

• Variable name: FSA.FSA.FSA_KEYSTORE_PASSWORD
• Description:
Will be used to set javax.net.ssl.keyStorePassword.
• Type: String
Authentication Certificate-Keystore (FSA_KEYSTORE)

• Variable name: FSA.FSA.FSA_KEYSTORE
• Description:
Will be used to set javax.net.ssl.keyStore.
• Type: String
Communication port for the Archive Link interface of the Archive Server
(AL_PORT)
• Variable name: FSA.FSA.AL_PORT

AR100500-01-ACN-EN-04
46.1. Specific settings for FSA Document Pipelines
• Description:
This setting specifies the communication port for the Archive Link interface
of the Archive Server. Only used in the Cost-Saving scenario (Create Shortcut
option in Business Administration).
Communication protocol for the Archive Link interface of the Archive Server
(AL_PROTOCOL)
• Variable name: FSA.FSA.AL_PROTOCOL
• Description:
This setting specifies the communication protocol for the Archive Link
interface of the Archive Server. Only used in the Cost-Saving scenario
(Create Shortcut option in Business Administration).
• Type: Enum
• Predefined Value: https
• Allowed Value:
• https ("HTTPS")
• http ("HTTP")
Configure CMIS binding (CMIS_BINDING)

• Variable name: FSA.FSA.CMIS_BINDING
• Description:
• Type: Enum
• Predefined Value: WEBSERVICES
• Allowed Value:
• BROWSER ("BROWSER")
• WEBSERVICES ("WEBSERVICES")
Configure CMIS binding (CONNECT_TIMEOUT)

• Variable name: FSA.FSA.CONNECT_TIMEOUT
• Description:
• Type: String
Configure CMIS binding (READ_TIMEOUT)

• Variable name: FSA.FSA.READ_TIMEOUT
• Description:

AR100500-01-ACN-EN-04

• Type: String
Expiration time of generated signed URLs (in years)

(FSA_SIGNATURE_EXPIRATION)
• Variable name: FSA.FSA.FSA_SIGNATURE_EXPIRATION
• Description:
This setting defines the expiration time [years] of any signature issued by
this pipeline.
Expire time (in minutes) for entries in FSA user cache (LRU) (FSA_USER_LRU_TTL)
• Variable name: FSA.FSA.FSA_USER_LRU_TTL
• Description:
Maximum number of entries in CMIS folders cache (LRU)

(FSA_FOLDER_LRU_SIZE)
• Variable name: FSA.FSA.FSA_FOLDER_LRU_SIZE
• Description:
Maximum number of entries in FSA user cache (LRU) (FSA_USER_LRU_SIZE)

• Variable name: FSA.FSA.FSA_USER_LRU_SIZE
• Description:
Maximum number of threads scanning file shares (FSA_ENQUEUE_THREADS)

• Variable name: FSA.FSA.FSA_ENQUEUE_THREADS
• Description:
This setting defines the maximum number of worker threads that scan
multiple File Share Data Sources in parallel.

AR100500-01-ACN-EN-04
46.1. Specific settings for FSA Document Pipelines

Name of the directory where the shortcut icons are stored (FSA_ICON_DIR)
• Variable name: FSA.FSA.FSA_ICON_DIR
• Description:
• Type: String
• Predefined Value: _otx_fsa_icons_
Number of threads copying documents to CMIS (FSA_DOC2CMIS_THREADS)

• Variable name: FSA.FSA.FSA_DOC2CMIS_THREADS
• Description:
This setting defines the number of instances of the Doc2CMIS doctool.
Number of threads copying documents to pipeline (FSA_DOC2DP_THREADS)

• Variable name: FSA.FSA.FSA_DOC2DP_THREADS
• Description:
This setting defines the number of instances of the Doc2DP doctool.
Number of threads for creating shortcuts (FSA_CREATESC_THREADS)

• Variable name: FSA.FSA.FSA_CREATESC_THREADS
• Description:
This setting defines the number of instances of the CreateSC doctool.
Number of threads for signing urls (FSA_SIGNURL_THREADS)

• Variable name: FSA.FSA.FSA_SIGNURL_THREADS
• Description:
This setting defines the number of instances of the SignUrl doctool.
SSL/TLS trusted certificates store password (FSA_TRUSTSTORE_PASSWORD)

• Variable name: FSA.FSA.FSA_TRUSTSTORE_PASSWORD
• Description:

AR100500-01-ACN-EN-04
Will be used to set javax.net.ssl.trustStorePassword.

• Type: String
SSL/TLS trusted certificates store path (FSA_TRUSTSTORE)

• Variable name: FSA.FSA.FSA_TRUSTSTORE
• Description:
Will be used to set javax.net.ssl.trustStore.
• Type: String
Unique client identifier used in generated signatures (FSA_SIGNATURE_SIGNER)

• Variable name: FSA.FSA.FSA_SIGNATURE_SIGNER
• Description:
This setting defines the URL parameter “authid ("signer name")” which is
used in any signed URL issued by this pipeline.
• Type: String
• Predefined Value: FSA

AR100500-01-ACN-EN-04
Chapter 47
Monitor Server
47.1 Monitor Server (MONS)

Storage location:
- Windows: Configuration file: <ECM_MONITOR_SERVER_CONF>\config\setup
\MONS.Setup
- UNIX: Configuration file: <ECM_MONITOR_SERVER_CONF>/config/setup/MONS.
Setup
47.1.1 Variables for monitor server agent

Storage location:
- Windows: Configuration file: <ECM_MONITOR_SERVER_CONF>\config\setup
\MONS.Setup
- UNIX: Configuration file: <ECM_MONITOR_SERVER_CONF>/config/setup/MONS.
Setup
Wait time before ixmonSvc starts in seconds (AGENT_SLEEP)

• Variable name: MONS.MONS.AGENT_SLEEP
• Description:
Wait time before ixmonSvc starts in seconds (delay start of subagents; all
other processes (DS, ADMS, etc.) must be initialized entirely before the
subagents start.)

AR100500-01-ACN-EN-04
Chapter 48
Cache Server
48.1 Archive Cache Server settings (ACS)

Storage location:
- Windows: Configuration file: <ECM_ARCHIVE_SERVER_CONF>\config\setup\ACS.
Setup
- UNIX: Configuration file: <ECM_ARCHIVE_SERVER_CONF>/config/setup/ACS.
Setup
Administration password (ADA) (PROXY_ADA_ADMIN_PASSWORD)

• Variable name: AS.ACS.PROXY_ADA_ADMIN_PASSWORD
• Description:
Password of 'adaadmin' user for ADMS proxy authentication.
• Type: String
Administration password (FSA) (PROXY_ADMIN_PASSWORD)

• Variable name: AS.ACS.PROXY_ADMIN_PASSWORD
• Description:
Password of 'dpadmin' user for DPInfo authentication.
• Type: String
• Predefined Value: G075B8AA3373A5DA1
Allow only new naming convention (STRICT_COMPONENT_NAME_CHECK)

• Variable name: AS.ACS.STRICT_COMPONENT_NAME_CHECK
• Description:
If true incoming content requests for write-back archives are checked if
related components contain any illegal characters or (= old) component
names. See also key: “ILLEGALCOMPONENTNAMES”.
• Type: Flag
• Allowed Value:
• true
• false
Amount of disk space to to keep free (CS_RESERVDISKSPACE)

• Variable name: AS.ACS.CS_RESERVDISKSPACE
• Description:

AR100500-01-ACN-EN-04
Chapter 48 Cache Server
This setting specifies the amount of disk space [MB] per volume which the
underlying cache administration is trying to to keep free. “Internal” setting
Authentication certificate keystore password (PROXY_KEYSTORE_PASSWORD)
• Variable name: AS.ACS.PROXY_KEYSTORE_PASSWORD

• Description:
Password for the PKCS12 Authentication Certificate. This password must not
be empty.
• Type: String
Authentication certificate keystore path (PROXY_KEYSTORE)
• Variable name: AS.ACS.PROXY_KEYSTORE

• Description:
This is the name of a PKCS12 .p12 keystore-file which must exist in the
config/certs folder. The password of the PKCS12 Authentication Certificate
must be specified and must not be empty.
• Type: String
Authentication password (PROXY_PASSWORD)
• Variable name: AS.ACS.PROXY_PASSWORD

• Description:
This password is only used if no SSL-certificate authentication is configured,
PROXY_USER must be set too.
• Type: String
Authentication user (PROXY_USER)
• Variable name: AS.ACS.PROXY_USER

• Description:
This user is only used if no SSL-certificate authentication is configured,
PROXY_PASSWORD must be set too.
• Type: String
Database (Derby) directory (DERBY)
• Variable name: AS.ACS.DERBY

• Description:
This specifies the absolute path to database partition where the ACS stores its
metadata.
Recommendation: use a separate volume only used by the database!
• Type: Path

AR100500-01-ACN-EN-04
48.1. Archive Cache Server settings (ACS)
External server name (in environments with multiple host names) (MY_HOST_NAME)
• Variable name: AS.ACS.MY_HOST_NAME
• Description:
When working with different networks, domains, or hostnames, the external
server name can be specified by this setting. “Internal” setting only, do not
• Type: String
Holding time in internal document info cache (CS_LATENCY_PERIOD)

• Variable name: AS.ACS.CS_LATENCY_PERIOD
• Description:
This setting specifies the time [sec] period how long document information
resides in the ACS INTERNAL document info cache. See also key:
CS_MAX_DOCS_IN_CACHE. “Internal” setting only, do not modify until
Maximum component size which are cached (CS_MAXCOMPSIZE)

• Variable name: AS.ACS.CS_MAXCOMPSIZE
• Description:
This setting specifies the maximum size [KB] of a single component which is
to be stored in the cache. Components exceeding this size are NOT stored.
There is no limit per default.
• Type: Integer
Maximum number of worker threads to retrieve content (must not be smaller than
Minimum) (CS_MAX_WTHREADS)
• Variable name: AS.ACS.CS_MAX_WTHREADS
• Description:
This setting specifies the maximum number of worker threads the ACS
internally uses to retrieve content from the backend. “Internal” setting only,
Maximum of internal docinfos to cache (CS_MAX_DOCS_IN_CACHE)

• Variable name: AS.ACS.CS_MAX_DOCS_IN_CACHE
• Description:
This setting specifies the maximum size of Archive Cache Servers internal
document info cache. “Internal” setting only, do not modify until otherwise
instructed!
• Type: Integer

AR100500-01-ACN-EN-04
Maximum of Mapped Memory usage (CS_MMUSAGE)

• Variable name: AS.ACS.CS_MMUSAGE
• Description:
This setting specifies the maximum size [KB] of RAM which is used for
Memory Mapped Files. “Internal” setting only, do not modify until
• Type: Integer
Minimum number of worker threads to retrieve content (CS_MIN_WTHREADS)

• Variable name: AS.ACS.CS_MIN_WTHREADS
• Description:
This setting specifies the minimum number of worker threads the ACS
internally uses to retrieve content from the backend. “Internal” setting only,
Name of Derby DB (CS_DBID)

• Variable name: AS.ACS.CS_DBID
• Description:
This setting specifies the name of the internal DERBY database. A
subdirectory with this name is created in the Database directory which
contains all ACS relevant metadata.
• Type: String
• Predefined Value: ACSDB
Name of Derby DB for BA configuration (CS_DBID_BAPM)

• Variable name: AS.ACS.CS_DBID_BAPM
• Description:
contains all ACS relevant metadata.
• Type: String
• Predefined Value: ACSPMDB
Name of Derby DB for Scheduler (CS_DBID_QRTZ)

• Variable name: AS.ACS.CS_DBID_QRTZ
• Description:
contains all scheduler relevant metadata.
• Type: String
• Predefined Value: ACSQRTZDB

AR100500-01-ACN-EN-04
Number of days to keep WB log files around (CS_WBITEM_HISTORY)

• Variable name: AS.ACS.CS_WBITEM_HISTORY
• Description:
This setting specifies the number of days to keep write-back protocol files in
log directory around. Per default this period contains the last 30 days. See
also key: WBVOL.
Pass phrase if encrypted PEM is used (CFG_PEMPASSPHRASE)

• Variable name: AS.ACS.CFG_PEMPASSPHRASE
• Description:
This setting specifies the pass phrase if an encrypted PEM file is to be used.
Filling in is hidden and the pass phrase is stored encrypted.
• Type: String
Path of write-back Volume (WBVOL)

• Variable name: AS.ACS.WBVOL
• Description:
This setting specifies the absolute pathname to be used for write-back
caching. The cache server creates 3 subdirectories:
• dat: contains the raw data of components to be cached.
• idx: contains meta info for recovery in case of database crash.
• log: contains info which documents are transferred to the Archive Server.
Recommendation: use separate disk or partition only be used by the Archive

Cache Server. Attention on Windows OS please only: do NOT use the root
partitions of logical drives, instead create a first level directory to be used as
path. Because of increased security risk of a RAID disk is recommended.
• Type: Path
Path of write-through Volume 1 (VOL1)

• Variable name: AS.ACS.VOL1
• Description:
This setting states the first volume to be used for write-through caching.
Volume is specified by giving an absolute pathname.
Recommendation: use separate path only be used by the Archive Cache
Server. Best be used located on separate disk or partition.
• Type: Path


AR100500-01-ACN-EN-04
• Description:
This setting states the second possible volume to be used for write-through
caching. Volume is specified by giving an absolute pathname.
• Type: Path

• Description:
This setting states the third possible volume to be used for write-through
• Type: Path

• Description:
This setting states the 4th possible volume to be used for write-through
• Type: Path

• Description:
• Type: Path

• Description:

AR100500-01-ACN-EN-04

• Type: Path

• Description:
• Type: Path

• Description:
• Type: Path
Pem File must contain private key and certificate (DS_PEM_FILE_FOR_SIGNING)

• Variable name: AS.ACS.DS_PEM_FILE_FOR_SIGNING
• Description:
This setting specifies the path name of the file containing the private key and
the certificate used to sign AL requests. The certificate is uploaded
implecitely, in the config/setup directory.
• Type: Path
Preferred remote Document Pipeline protocol (PREFERRED_DPH_PROTOCOL)

• Variable name: AS.ACS.PREFERRED_DPH_PROTOCOL
• Description:
This setting specifies the preferred HTTP protocol which should be used to
contact the remote Document Pipeline from outside (for example from
Enterprise Scan). Ensure that this preferred protocol is also configured in the
Application Server.
• https: Ensure that “ArchiveLink HTTP Port” (ICS.AL_PROXYSSLPORT)
is set (> 0), otherwise this setting has no effect.
• http: Ensure that “ArchiveLink HTTPS Port” (ICS.AL_PROXYPORT) is
set (> 0), otherwise this setting has no effect.

AR100500-01-ACN-EN-04
• Type: Enum
• Allowed Value:
• https ("https")
• http ("http")
Proxy ID (BIZ_PROXYID)
• Variable name: AS.ACS.BIZ_PROXYID
• Description:
This ID uniquely identifies the Proxy installation.
• Type: String
Regular Experession to specify illegal component names

(ILLEGALCOMPONENTNAMES)
• Variable name: AS.ACS.ILLEGALCOMPONENTNAMES
• Description:
This setting defines old (= illegal) component names which are not to be used
any longer as regular expression. It is evaluated for write-back documents
only. See also key: “STRICT_COMPONENT_NAME_CHECK”. “Internal”
• Type: String
Size of write-back Volume (WBSIZE)

• Variable name: AS.ACS.WBSIZE
• Description:
This setting specifies the maximum size [MB] used for the write-back
volume.
Recommendation: ensure that there is always sufficient space to be used by
this volume.
Size of write-through Volume 1 (SIZE1)

• Variable name: AS.ACS.SIZE1
• Description:
This setting specifies the maximum size [MB] used for the corresponding
volume.
this volume.


AR100500-01-ACN-EN-04
• Description:
volume.
this volume.

• Description:
volume.
this volume.

• Description:
volume.
this volume.

• Description:
volume.
this volume.

• Description:
volume.

AR100500-01-ACN-EN-04

this volume.

• Description:
volume.
this volume.

• Description:
volume.
this volume.
Sparse file support (CS_ZERO_OUT)
• Variable name: AS.ACS.CS_ZERO_OUT

• Description:
This setting specifies if the Zero Out feature is switched on. Must be set in
case FS supports sparse file. “Internal” setting only, do not modify until
• Type: Flag
• Allowed Value:
• true
• false
SSL/TLS trusted certificates store password (PROXY_TRUSTSTORE_PASSWORD)
• Variable name: AS.ACS.PROXY_TRUSTSTORE_PASSWORD

• Description:
Password for the PKCS12 trusted certificates store. This password must not
be empty.
• Type: String

AR100500-01-ACN-EN-04
SSL/TLS trusted certificates store path (PROXY_TRUSTSTORE)

• Variable name: AS.ACS.PROXY_TRUSTSTORE
• Description:
This is the name of a PKCS12 .p12 keystore-file which must exist in the
config/certs folder.
• Type: String
Systemkey Keystore Password (PROXY_SYSKEYSTORE_PASSWORD)

• Variable name: AS.ACS.PROXY_SYSKEYSTORE_PASSWORD
• Description:
Password for the JCEKS keystore hosting Proxy systemkeys. This password
must not be empty.
• Type: String
• Predefined Value: GCEF3E85F4B5C2DACFA4939CC17603BEE
48.1.1 Scheduler
Storage location:
Setup
Setup
Duration after job protocol entries expire (PROTOCOL_MAX_AGE)

• Variable name: AS.ACS.PROTOCOL_MAX_AGE
• Description:
This variable specifies the period in days after a protocol entry expires.
Expired entries will be deleted by the ProtocolSweeper job.
Max Number of Quartz Worker Threads (MAX_QRTZ_THRD_CNT)

• Variable name: AS.ACS.MAX_QRTZ_THRD_CNT
• Description:
Maximum number of worker threads acquired by quartz scheduler.
• Type: Integer
Maximum cache size per job instance (SF_CACHESIZE_PER_JOBINST)

• Variable name: AS.ACS.SF_CACHESIZE_PER_JOBINST
• Description:
This variable specifies the maximum size of entries which will be cached per
job instance. If more job instance items are queried than the files system is
used to load additional ones if any.

AR100500-01-ACN-EN-04

Min Number of Quartz Worker Threads (MIN_QRTZ_THRD_CNT)

• Variable name: AS.ACS.MIN_QRTZ_THRD_CNT
• Description:
Minimum number of worker threads created by quartz scheduler.
• Type: Integer
48.1.2 Logging
Storage location:
Setup
Setup

Storage location:
Setup
Setup
Administration (LOG_ADMIN)
• Variable name: AS.ACS.LOG_ADMIN
• Description:
This setting specifies the log level for “Administration” category. See also
key: “LOG_ADMIN_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:
CMIS Interface (LOG_CMIS)

• Variable name: AS.ACS.LOG_CMIS
• Description:
This setting specifies the log level for the category “CMIS Interface”. See also
key: “LOG_CMIS_GROUP”. There are 4 distinct settings with increased

AR100500-01-ACN-EN-04
• Type: Enum
• Allowed Value:
Scheduler (LOG_SCHED)
• Variable name: AS.ACS.LOG_SCHED
• Description:
This setting specifies the log level for “Scheduler” category. There are 4
distinct settings which add additional logging from top to bottom.
• Type: Enum
• Allowed Value:
Storage location:
Setup
Setup
Administration (LOG_ADMIN_GROUP)
• Variable name: AS.ACS.LOG_ADMIN_GROUP
• Description:
This setting specifies an own log category for the “Administration” by
• Type: String
• Predefined Value: com.opentext.ecm.asm.bizadmin,com.opentext.
ecm.asm.ca,com.opentext.ecm.as.cmis.client,com.opentext.ecm.
admin,com.opentext.ecm.persistence
CMIS Interface (LOG_CMIS_GROUP)

• Variable name: AS.ACS.LOG_CMIS_GROUP
• Description:

AR100500-01-ACN-EN-04
This setting specifies a separate log category for the “CMIS Interface” by
• Type: String
• Predefined Value: com.opentext.ecm.as.cmis.proxy,com.opentext.ecm.
asm.cmis
Scheduler (LOG_SCHED_GROUP)
• Variable name: AS.ACS.LOG_SCHED_GROUP
• Description:
This setting specifies an own log category for the “Scheduler” by listening all
related java packages. “Internal” setting only, do not modify until otherwise
instructed!
• Type: String
• Predefined Value: com.opentext.ecm.admin.schedule,com.opentext.
ecm.scheduling
48.1.3 Business Administration

Storage location:
Setup
Setup
Directory for the generated EDRM-XML files (BIZ_EXPORT_DIRECTORY)

• Variable name: AS.ACS.BIZ_EXPORT_DIRECTORY
• Description:
This setting specifies the directory where all the generated EDRM-XML files
are stored. If this variable is empty the default directory will
$ECM_VAR_DIR/exports.
• Type: Path
Domain name of the email data sources (BIZ_EMAIL_DOMAIN_NAME)

• Variable name: AS.ACS.BIZ_EMAIL_DOMAIN_NAME
• Description:
This setting specifies the domain name for the email data sources. If this
value is empty, the default will be taken from MY_HOST_NAME.
• Type: String
Maximum number of parallel user exports (BIZ_EXPORT_CONCURRENT_USER)

• Variable name: AS.ACS.BIZ_EXPORT_CONCURRENT_USER
• Description:
This setting specifies the maximum number of parallel user exports.

AR100500-01-ACN-EN-04

Maximum number of waiting user exports (BIZ_EXPORT_WAITING_USER)
• Variable name: AS.ACS.BIZ_EXPORT_WAITING_USER

• Description:
This setting specifies the maximum number of waiting user exports.
Maximum size of export data for user exports (BIZ_EXPORT_MAX_SIZE)
• Variable name: AS.ACS.BIZ_EXPORT_MAX_SIZE

• Description:
This setting specifies the maximum size of export data for user exports.
Scope of supported /archive/admin/exec calls (BIZ_ADMIN_EXEC_LEVEL)
• Variable name: AS.ACS.BIZ_ADMIN_EXEC_LEVEL

• Description:
This setting specifies the scope of the supported /archive/admin/exec calls.
• 0: No /archive/admin/exec calls are supported.

• 1: ADA-related calls are supported.
• 2: Additional read calls are supported (only for trouble shooting).
• 3: Write calls are supported (only for trouble shooting).
Time after which an downloaded export is marked as deletable

(BIZ_EXPORT_EXPIRATION_DOWNLOADED)
• Variable name: AS.ACS.BIZ_EXPORT_EXPIRATION_DOWNLOADED

• Description:
This setting specifies the time after which an downloaded export expires and
can be deleted by cleanup task.
Time after which an export expires and can be deleted by cleanup task
(BIZ_EXPORT_EXPIRATION)
• Variable name: AS.ACS.BIZ_EXPORT_EXPIRATION

• Description:

AR100500-01-ACN-EN-04
This setting specifies the time after which an export expires and can be
deleted by cleanup task.
Time interval between status checks of the export tasks

(BIZ_EXPORT_SUPERVISOR_TIMEINTERVAL)
• Variable name: AS.ACS.BIZ_EXPORT_SUPERVISOR_TIMEINTERVAL
• Description:
This setting specifies the time interval [sec] between the status checks of the
export tasks.
48.2 Integrated Common Service Settings (ICS)

Storage location:
Setup
Setup
Algorithm used to sign (DS_SIGNATURE_ALGORITHM)

• Variable name: AS.ICS.DS_SIGNATURE_ALGORITHM
• Description:
• Type: String
Alias names for backend host (frontend server only) (DS_HOST_ALIASES)

• Variable name: AS.ICS.DS_HOST_ALIASES
• Description:
This setting specifies any alias names of the backend server. See also key:
DSHOST. For “Archive Cache Server” scenario this setting can be used in case
the backend Archive Server has multiple host names. Setting this key in an
• Type: String
Allow illegal content types (DS_ALLOW_ILLEGAL_CONTENTTYPE)

• Variable name: AS.ICS.DS_ALLOW_ILLEGAL_CONTENTTYPE
• Description:
If true the content type by the client will be checked for syntactical errors. In
this case an exception is thrown or in case replacing is allowed the content

AR100500-01-ACN-EN-04
type is replaced by any set default content type. See also key:
“DS_DEFAULT_CONTENTTYPE,
DS_REPLACE_ILLEGAL_CONTENTTYPE” Setting this key in an “Archive
• Type: Flag
• Allowed Value:
• true
• false
AuthId which is used in generated signatures (DS_SIGNATURE_SIGNER)

• Variable name: AS.ICS.DS_SIGNATURE_SIGNER
• Description:
This setting defines the URL parameter “authid” which is used in any signed
URL issued by this server.
• Type: String
Cache Settings are evaluated (Archive Cache Server only)

(DS_INIT_CACHESETTINGS)
• Variable name: AS.ICS.DS_INIT_CACHESETTINGS
• Description:
This setting is for the “Archive Cache Server” exclusively. It is responsible
for reading the Cache Settings for each logical archive. Setting this key in an
• Type: Flag
• Allowed Value:
• true
• false
Certificates are downloaded from BackupServer (frontend server only)

(DS_INIT_CERTIFICATES)
• Variable name: AS.ICS.DS_INIT_CERTIFICATES
• Description:
If true certificates are downloaded from any backend server to allow
verification of signed URLs on the frontend server. Setting this key in an
• Type: Flag
• Allowed Value:
• true

AR100500-01-ACN-EN-04
• false
Charset for outgoing requests (DS_CHARSET)
• Variable name: AS.ICS.DS_CHARSET

• Description:
This setting defines the charset used for URL encoding of any outgoing
request. Setting this key in an “Archive Server” scenario has NO effect.
• Type: String
Context Path of Servlet (DS_KEYWORD)
• Variable name: AS.ICS.DS_KEYWORD

• Description:
This setting specifies the context path of the web application. It is set during
installation. “Internal” setting only, do not modify until otherwise instructed!
• Type: String
Default application (DS_DEFAULTAPPLICATION)
• Variable name: AS.ICS.DS_DEFAULTAPPLICATION

• Description:
This setting specifies the default value of the URL parameter “ixAppl”,
which is used by internal request. Setting this key in an “Archive Server”
• Type: String
Default content type if not set by user (DS_DEFAULT_CONTENTTYPE)
• Variable name: AS.ICS.DS_DEFAULT_CONTENTTYPE

• Description:
If set this setting defines the default content type which is used by any
outgoing request, in case the original request did NOT set or sets an illegal
content type. Setting this key in an “Archive Server” scenario has NO effect.
• Type: String
Default user (DS_DEFAULTUSER)
• Variable name: AS.ICS.DS_DEFAULTUSER

• Description:

AR100500-01-ACN-EN-04
This setting specifies the default value of the URL parameter “ixUser”, which
is used by internal request. Setting this key in an “Archive Server” scenario
has NO effect.
• Type: String
DSBridge contacts configured Cache Server (do not set) (DS_INIT_CACHESERVERS)

• Variable name: AS.ICS.DS_INIT_CACHESERVERS
• Description:
If true this setting states that for any outgoing request a possible “Archive
Cache Server” is to be considered. Setting this key in an “Archive Server”
instructed!
• Type: Flag
• Allowed Value:
• true
• false
Expiration time of generated signed URLs (in minutes)

(DS_SIGNATURE_EXPIRATION)
• Variable name: AS.ICS.DS_SIGNATURE_EXPIRATION
• Description:
This setting defines the expiration time [min] of any signature issued by this
server.
• Type: Integer
Installed Scenario (ICS_SCENARIO)

• Variable name: AS.ICS.ICS_SCENARIO
• Description:
This setting specifies the installed scenario. It is set during installation.
• Type: Enum
• Allowed Value:
• LEA ("Archive Server")
• LEAADA ("Archive Server with ADA integration")
• ACS ("Archive Cache Server")
• EACS ("Extended Archive Cache Server")
• LEARMS ("Archive Server with RMS integration")
Maximum character value accepted to be used for a component name

(DS_MAX_CHAR_VALUE)
• Variable name: AS.ICS.DS_MAX_CHAR_VALUE

AR100500-01-ACN-EN-04
• Description:
• Type: Integer
Number of check phases before a full update is executed. (frontend server only)
(REINIT_AFTER_N_PERIODS)
• Variable name: AS.ICS.REINIT_AFTER_N_PERIODS
• Description:
This setting indicates how much check phases must pass before a full re-
initialization is triggered. See also key: “LAST_REINIT_PERIOD”. Setting
Recognized add-ons (ICS) (ADDONS)

• Variable name: AS.ICS.ADDONS
• Description:
This setting defines the names of all known add-on components as a comma
separated list. If not set a default list is used internally. See also key:
ADDON_NAMES in “Addons.Setup”. “Internal” setting only, do not modify
• Type: String
• Predefined Value: anno.brava,anno.ixos.bak,anno.ixos,anno.ole2,
descr,im,meta.xml,note,note.ixos,note.meta,ATTRIBUTES,ATTRLIST,
DPprotocol,PAGELIST,TATTRLIST
Remote Port (DS_RCPORT)

• Variable name: AS.ICS.DS_RCPORT
• Description:
This setting specifies port number of the backend server in dependence to the
scenario. This port is set by Installation.
By setting this value to 0, even all administrative requests are routed via the
SSL port.
the local port.
• For Archive Cache Server scenario this port should point to the port of
the backend Archive Server.
See also key: ICS_SCENARIO, DSHOST, DS_RCSSLPORT.


AR100500-01-ACN-EN-04
Remote SSL Port (DS_RCSSLPORT)

• Variable name: AS.ICS.DS_RCSSLPORT
• Description:
This setting specifies SSL port number of the backend server in dependence
to the scenario. It is set by Installation.
the local SSL port.
• For Archive Cache Server scenario this port should point to the SSL port
of the backend Archive Server.
See also key: ICS_SCENARIO, DSHOST, DS_RCPORT.

Replace illegal content types with default content type

(DS_REPLACE_ILLEGAL_CONTENTTYPE)
• Variable name: AS.ICS.DS_REPLACE_ILLEGAL_CONTENTTYPE
• Description:
If true any illegal content type is replaced by the default content type. See
also key: “DS_DEFAULT_CONTENTTYPE,
DS_ALLOW_ILLEGAL_CONTENTTYPE” Setting this key in an “Archive
• Type: Flag
• Allowed Value:
• true
• false
Resign in any case, even if even if client signatures are to be reused

(DS_RESIGN_SIGNED_URLS)
• Variable name: AS.ICS.DS_RESIGN_SIGNED_URLS
• Description:
If true this setting is responsible that each outgoing request is signed with the
frontend servers own private key. This also overwrites any URL tunneling
configuration. See also key: “DS_REUSE_SIGNED_URLS”. Setting this key in
an “Archive Server” scenario has NO effect. “Internal” setting only, do not
• Type: Flag
• Allowed Value:
• true

AR100500-01-ACN-EN-04
• false
Reuse client signatures if possible (DS_REUSE_SIGNED_URLS)

• Variable name: AS.ICS.DS_REUSE_SIGNED_URLS
• Description:
If true this setting allows the so called URL tunneling, which means reusing
any client signature if possible. Setting this key in an “Archive Server”
instructed!
• Type: Flag
• Allowed Value:
• true
• false
Run Archive Server in presentation mode. (BIZ_DEMO_MODE)

• Variable name: AS.ICS.BIZ_DEMO_MODE
• Description:
This setting specifies the runtime behaviour and feature availability. This
setting must not be enabled in production. “Internal” setting only, do not
• Type: Flag
• Allowed Value:
• true
• false
Time period after which an offline backend server will be probed again
(ARCHIVEOFFLINETIME)
• Variable name: AS.ICS.ARCHIVEOFFLINETIME
• Description:
If any backend server is no longer available this setting specifies the time
period [ms] before probing it again. Setting this key in an “Archive Server”
instructed!
• Type: Integer
Time to pass when reinitializing thread checks for and administrative changes
(frontend server only) (LAST_REINIT_PERIOD)
• Variable name: AS.ICS.LAST_REINIT_PERIOD

AR100500-01-ACN-EN-04
• Description:
This setting specifies the time period [ms] passed before a background
thread checks for any administrative changes on the backend server. Setting
• Type: Integer
Warning if Archive Server is older than V9.6.1 (frontend server only)

(WARN_IF_OLD_AS)
• Variable name: AS.ICS.WARN_IF_OLD_AS

• Description:
If true a frontend server writes a warning to the log file in case it connects to
an backend server older than V9.6.1. Setting this key in an “Archive Server”
• Type: Flag
• Allowed Value:
• true
• false
48.2.1 Archive Link specific Settings (AL)

Storage location:
Setup
Setup
ADMS Cleanup interval (ADMS_RPC_SESSION_CLEANUP_INTERVAL)
• Variable name: AS.ICS.ADMS_RPC_SESSION_CLEANUP_INTERVAL

• Description:
administrative requests (as is the case by default), this variable can be used to
alter the frequency of checks for inactive RPC connections to Administration
Server. There should normally be no need to set this value.
ADMS host name of legacy interface (ADMS_PROXY_HOST)
• Variable name: AS.ICS.ADMS_PROXY_HOST

• Description:

AR100500-01-ACN-EN-04
If configured, the name of a remote Archive Server expected to handle

incoming requests to administrative URLs. There should normally be no
need to set this value.
• Type: String
ADMS port of legacy interface (ADMS_PROXY_PORT)
• Variable name: AS.ICS.ADMS_PROXY_PORT

• Description:
administrative requests (as is the case by default), this variable must be set to
the RPC port number of Administration Server if that differs from the default
(4034). If a remote server is configured to handle administative requests, this
variable must be set to the port of the remote server. There should normally
be no need to set this value.
ADMS protocol (ADMS_PROXY_PROTOCOL)
• Variable name: AS.ICS.ADMS_PROXY_PROTOCOL

• Description:
If a remote server is expected to receive incoming administrative requests,
this variable must be used to configure the protocol (http or https) used to
forward requests to the target host. There should normally be no need to set
this value.
• Type: String
ADMS RPC session timeout (ADMS_RPC_SESSION_TIMEOUT)
• Variable name: AS.ICS.ADMS_RPC_SESSION_TIMEOUT

• Description:
administrative requests (as is the case by default), this value can be used to
alter the amount of time after which an RPC connection to Administration
Server is deemed inactive. There should normally be no need to set this
value.
ADMS servlet context Path of ADMS legacy interface (ADMS_PROXY_PATH)
• Variable name: AS.ICS.ADMS_PROXY_PATH

• Description:
If a remote server is configured to receive administrative requests, this
variable can be used to configure the request path used when forwarding

AR100500-01-ACN-EN-04
requests to the target host. There should normally be no need to set this
value.
• Type: String
AL charset used for incoming request (AL_URL_CHARSET)
• Variable name: AS.ICS.AL_URL_CHARSET

• Description:
This setting specifies the charset used for URL decoding of incoming
requests. Attention: Do not modify, otherwise you risk accessing data
already archived with an different charset!!
• Type: String
AL charset used for outgoing response (AL_OUT_CHARSET)
• Variable name: AS.ICS.AL_OUT_CHARSET

• Description:
This setting specifies the ArchiveLink charset used for outgoing responses.
• Type: String
AL checks for correct URL parameters (AL_STRICT_PARAMETER_CHECK)
• Variable name: AS.ICS.AL_STRICT_PARAMETER_CHECK

• Description:
If true any incoming request is checked for correctness of its parameters. In
case an URL unknown parameter is detected for a given command an
exception is thrown. If false this check is switched of and only parameters
which are associated to the command are evaluated. Unknown parameters
are ignored.
• Type: Flag
• Allowed Value:
• true
• false
ArchiveLink HTTP Port (AL_PROXYPORT)
• Variable name: AS.ICS.AL_PROXYPORT

• Description:
This setting specifies the HTTP port for ArchiveLink clients and must match

AR100500-01-ACN-EN-04
ArchiveLink HTTPS Port (AL_PROXYSSLPORT)

• Variable name: AS.ICS.AL_PROXYSSLPORT
• Description:
This setting specifies the HTTPS port for ArchiveLink clients and must match
Check for 100 Continue (AL_CHECK_100CONT)

• Variable name: AS.ICS.AL_CHECK_100CONT
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Internal buffer size which used to write the AL response (AL_HTTP_BUFSIZE)

• Variable name: AS.ICS.AL_HTTP_BUFSIZE
• Description:
This setting specifies the buffer size which ArchiveLink uses to write
responses. “Internal” setting only, do not modify until otherwise instructed!
Pattern allowed and expected behind a signed URL (SIGN_URL_ENDING_CHARS)

• Variable name: AS.ICS.SIGN_URL_ENDING_CHARS
• Description:
• Type: String
Preference for collisions between HTTP and AL semantic (AL_PREFERENCE)

• Variable name: AS.ICS.AL_PREFERENCE
• Description:
This setting defines the preference between HTTP and AL semantic in case of
collisions.
• Throw exception
• Prefer AL semantic

AR100500-01-ACN-EN-04
• Prefer HTTP semantic

• Type: Enum
• Predefined Value: HTTP
• Allowed Value:
• NONE ("Throw exception")

• AL ("Prefer AL semantic")
• HTTP ("Prefer HTTP semantic")
Proxy server mode (PROXY_SERVER_MODE)
• Variable name: AS.ICS.PROXY_SERVER_MODE

• Description:
If true then each archive is reported to be hosted on current server instead of
its real location. This has effect for the ArchiveLink command “admInfo”.
• Type: Flag
• Allowed Value:
• true
• false
Switch on ADMS legacy interface (AL_ADMS_PROXY)
• Variable name: AS.ICS.AL_ADMS_PROXY

• Description:
If true incoming requests matching the respective URL pattern are
dispatched to Administration Server for further processing. In particular, this
is required to allow access from remote servers.
• Type: Flag
• Allowed Value:
• true
• false
Target for ADMS legacy interface (ADMS_EXEC_TARGET)
• Variable name: AS.ICS.ADMS_EXEC_TARGET

• Description:
Use localhost for processing on the local machine, or set to a partial URL
such as http://archive1.example.com:8080/archive to process requests on a
single node cluster-wide.
• Type: String

AR100500-01-ACN-EN-04
URL parameters which are to be ignored, Format: param1,paramn

(AL_PARAMETERS_TO_IGNORE)
• Variable name: AS.ICS.AL_PARAMETERS_TO_IGNORE
• Description:
With this setting it is possible to specify URL parameters which are ignored
for further processing. These parameters are evaluated for all ArchiveLink
commands. Single parameters are to be separated by a ,. Per default the
parameter: “compVers” and “compView” are ignored.
• Type: String
48.2.2 HTTP communication parameter

Storage location:
Setup
Setup
Allow secure sockets through proxies (HTTP_ENABLE_SSL_PROXY)

• Variable name: AS.ICS.HTTP_ENABLE_SSL_PROXY
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Buffer size for MP stream filter (HTTP_BUFSIZE)

• Variable name: AS.ICS.HTTP_BUFSIZE
• Description:
Client follows Redirect requests (HTTP_FOLLOW_REDIRECT)

• Variable name: AS.ICS.HTTP_FOLLOW_REDIRECT
• Description:
• Type: Flag
• Allowed Value:
• true

AR100500-01-ACN-EN-04
• false
Default value to control initialize of SSL (HTTP_INIT_SSL)

• Variable name: AS.ICS.HTTP_INIT_SSL
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Encoding of request/response headers (default = USACII)

(HTTP_HEADER_ENCODING)
• Variable name: AS.ICS.HTTP_HEADER_ENCODING
• Description:
• Type: String
HTTP Client checks for stale connections

(HTTP_ENABLE_CONNECTION_STALE_CHECKING)
• Variable name: AS.ICS.HTTP_ENABLE_CONNECTION_STALE_CHECKING
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Maximum number of outgoing HTTP connections

(HTTP_MAX_TOTAL_CONNECTIONS)
• Variable name: AS.ICS.HTTP_MAX_TOTAL_CONNECTIONS
• Description:
• Type: Integer
Maximum number of outgoing HTTP connections per Host

(HTTP_MAX_CONNECTIONS_PER_HOST)
• Variable name: AS.ICS.HTTP_MAX_CONNECTIONS_PER_HOST
• Description:

AR100500-01-ACN-EN-04
This setting defines the maximum number of outgoing HTTP connections

which can be active in parallel. Setting this key in an “Archive Server”
Number of retries, if recoverable Exception occurs (HTTP_NUMBER_OF_RETRIES)

• Variable name: AS.ICS.HTTP_NUMBER_OF_RETRIES
• Description:
• Type: Integer
Path to the IxosCrypto.properties file (DS_CRYPTO_PROPERTIES)

• Variable name: AS.ICS.DS_CRYPTO_PROPERTIES
• Description:
• Type: Path
Read (= socket) timeout (HTTP_TIMEOUT)

• Variable name: AS.ICS.HTTP_TIMEOUT
• Description:
This setting defines the socket (read) timeout [msec]. Setting this key in an
• Type: Integer
Set Cookie Policy (HTTP_PROTOCOL_COOKIE_POLICY)

• Variable name: AS.ICS.HTTP_PROTOCOL_COOKIE_POLICY
• Description:
• Type: String
Trust all certificates (HTTP_BUILTIN_SSL_TRUST_ALL_CERTIFICATES)

• Variable name: AS.ICS.HTTP_BUILTIN_SSL_TRUST_ALL_CERTIFICATES
• Description:
• Type: Flag
• Allowed Value:
• true

AR100500-01-ACN-EN-04
• false
Trust certificates with wrong server names

(HTTP_BUILTIN_SSL_TRUST_WRONG_SERVER)
• Variable name: AS.ICS.HTTP_BUILTIN_SSL_TRUST_WRONG_SERVER
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Use built-in IXOS key store (HTTP_BUILTIN_SSL_USE_IXOS_KEY_STORE)

• Variable name: AS.ICS.HTTP_BUILTIN_SSL_USE_IXOS_KEY_STORE
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Use BuiltIn SSL (HTTP_INIT_BUILTIN_SSL)

• Variable name: AS.ICS.HTTP_INIT_BUILTIN_SSL
• Description:
• Type: Flag
• Allowed Value:
• true
• false
Use Expect-100-continue headers (HTTP_USE_EXPECT100)

• Variable name: AS.ICS.HTTP_USE_EXPECT100
• Description:
• Type: Flag
• Allowed Value:
• true
• false

AR100500-01-ACN-EN-04
48.2.3 Rights Management Services parameters

Storage location:
Setup
Setup
Class-ID of the Gigatrust protector (RMS_PROTECTOR_GIGATRUST_CLASSID)

• Variable name: AS.ICS.RMS_PROTECTOR_GIGATRUST_CLASSID
• Description:
COM Class-ID of the Gigatrust protector. Set to '{740AE583-
ABED-42A1-8510-97FC1E6B1B66}' if it is installed and shall be activated.
• Type: String
Class-ID of the protector for MS Office Open XML formats

(RMS_PROTECTOR_OPCIRM_CLASSID)
• Variable name: AS.ICS.RMS_PROTECTOR_OPCIRM_CLASSID
• Description:
COM Class-ID of the RMS protecor supporting MS Office Open XML
formats.
• Type: String
• Predefined Value: {81273702-956F-4CBD-9B16-43790558EE29}
Class-ID of the protector for older MS Office formats

(RMS_PROTECTOR_MSOIRM_CLASSID)
• Variable name: AS.ICS.RMS_PROTECTOR_MSOIRM_CLASSID
• Description:
COM Class-ID of the RMS protecor supporting older MS Office formats
(Office 2003 and older).
• Type: String
• Predefined Value: {2E4402B2-F2DA-4BC8-BB2C-41BECF0BDDDB}
Directory for temporary files (RMS_TEMPDIR)

• Variable name: AS.ICS.RMS_TEMPDIR
• Description:
Directory for temporary files created during RMS protection.
• Type: Path
• Predefined Value: ./temp
Directory where RMS templates are synchronized to (RMS_TEMPLATEPATH)

• Variable name: AS.ICS.RMS_TEMPLATEPATH
• Description:

AR100500-01-ACN-EN-04
Directory where the RMS templates are sysnchronized to.

• Type: Path
MIME-type patterns for Gigatrust (RMS_PROTECTOR_GIGATRUST_MIMETYPES)
• Variable name: AS.ICS.RMS_PROTECTOR_GIGATRUST_MIMETYPES

• Description:
Semicolon separated list of MIME-type patterns for which the GIGATRUST
• Type: String
• Predefined Value: application/pdf;text/plain
MIME-type patterns of MS Office Open XML formats

(RMS_PROTECTOR_OPCIRM_MIMETYPES)
• Variable name: AS.ICS.RMS_PROTECTOR_OPCIRM_MIMETYPES

• Description:
Semicolon separated list of MIME-type patterns for which the OPCIRM
• Type: String
• Predefined Value: application/vnd\.ms-excel\..*\.macroEnabled\.12;
application/vnd\.ms-powerpoint\..*\.macroEnabled\.12;
application/vnd\.ms-word\..*\.macroEnabled\.12;application/vnd
\.openxmlformats-officedocument\..*
MIME-type patterns of older MS Office formats

(RMS_PROTECTOR_MSOIRM_MIMETYPES)
• Variable name: AS.ICS.RMS_PROTECTOR_MSOIRM_MIMETYPES

• Description:
Semicolon separated list of MIME-type patterns for which the MSOIRM
• Type: String
• Predefined Value: application/msword;application/vnd\.msword;
application/vnd\.ms-word;application/vnd\.ms-excel;application/
msexcel;application/vnd\.ms-powerpoint;application/
mspowerpoint;application/ms-powerpoint
Position of GIGATRUST protector in the order of protectors

(RMS_PROTECTOR_GIGATRUST_ORDER)
• Variable name: AS.ICS.RMS_PROTECTOR_GIGATRUST_ORDER

• Description:
Position of the GIGATRUST protector in the order of protectors. Protectors
with lower order are used first.
• Type: Integer

AR100500-01-ACN-EN-04
Position of MSOIRM protector in the order of protectors

(RMS_PROTECTOR_MSOIRM_ORDER)
• Variable name: AS.ICS.RMS_PROTECTOR_MSOIRM_ORDER
• Description:
Position of the MSOIRM protector in the order of protectors. Protectors with
• Type: Integer
Position of OPCIRM protector in the order of protectors

(RMS_PROTECTOR_OPCIRM_ORDER)
• Variable name: AS.ICS.RMS_PROTECTOR_OPCIRM_ORDER
• Description:
Position of the OPCIRM protector in the order of protectors. Protectors with
• Type: Integer
48.2.4 Logging
Storage location:
Setup
Setup

Storage location:
Setup
Setup
Authentication (LOG_AUTH)
• Variable name: AS.ICS.LOG_AUTH
• Description:
This setting specifies the log level for “Authentication” category. See also
key: “LOG_AUTH_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04

Everything else (LOG_ROOT)
• Variable name: AS.ICS.LOG_ROOT

• Description:
This setting specifies the log level for everything which does not have its
own log category. There are 4 distinct settings which add additional logging
from top to bottom.
• Type: Enum
• Allowed Value:

HTTP Client (LOG_HTTP)
• Variable name: AS.ICS.LOG_HTTP

• Description:
This setting specifies the log level for “HTTP Client” category. See also key:
“LOG_HTTP_GROUP” There are 4 distinct settings which add additional
• Type: Enum
• Allowed Value:

HTTP Client Wire (LOG_HTTPWIRE)
• Variable name: AS.ICS.LOG_HTTPWIRE

• Description:
This setting specifies the log level for “HTTP Client Wire” category. See also
key: “LOG_HTTPWIRE_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04

Integrated Content Service (LOG_ICS)

• Variable name: AS.ICS.LOG_ICS
• Description:
This setting specifies the log level for “Integrated Content Service” category.
See also key: “LOG_ICS_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:
Legacy (LOG_LEGACY)
• Variable name: AS.ICS.LOG_LEGACY
• Description:
This setting specifies the log level for “Legacy Code” category. See also key:
“LOG_LEGACY_GROUP” There are 4 distinct settings which add additional
• Type: Enum
• Allowed Value:
Rights Management (LOG_RMS)

• Variable name: AS.ICS.LOG_RMS
• Description:
This setting specifies the log level for “Rights Management” category. See
also key: “LOG_RMS_GROUP” There are 4 distinct settings which add
• Type: Enum
• Allowed Value:

AR100500-01-ACN-EN-04

Storage location:
Setup
Setup
Authentication (LOG_AUTH_GROUP)
• Variable name: AS.ICS.LOG_AUTH_GROUP

• Description:
This setting specifies an own log category for the “Authentication” by
• Type: String
• Predefined Value: com.opentext.ecm.components.webservices,
com.opentext.ecm.components.http,com.opentext.ecm.
components.security,com.opentext.ecm.api.authws,com.
opentext.ecm.components.otds,com.opentext.otds
HTTP Client (LOG_HTTP_GROUP)
• Variable name: AS.ICS.LOG_HTTP_GROUP

• Description:
This setting specifies an own log category for the “HTTP Client” by listening
all related java packages. Setting this key in an “Archive Server” scenario has
NO effect. “Internal” setting only, do not modify until otherwise instructed!
• Type: String
• Predefined Value: org.apache.http,com.opentext.ecm.httpclient
HTTP Client Wire (LOG_HTTPWIRE_GROUP)
• Variable name: AS.ICS.LOG_HTTPWIRE_GROUP

• Description:
This setting specifies an own log category for the “HTTP Client Wire” by
listening all related java packages. By setting the related log level to trace, all
outgoing (HTTP) payload is logged. Setting this key in an “Archive Server”
instructed!
• Type: String
• Predefined Value: httpclient.wire

AR100500-01-ACN-EN-04
Integrated Content Service (LOG_ICS_GROUP)

• Variable name: AS.ICS.LOG_ICS_GROUP
• Description:
This setting specifies an own log category for the “Integrated Content
Service” by listening all related java packages. “Internal” setting only, do not
• Type: String
• Predefined Value: com.opentext.ecm.services.lea,com.opentext.
ecm.api.lea,com.opentext.ecm.lea,com.opentext.ecm.services.al,
com.opentext.ecm.services.icsrecord,com.opentext.ecm.as.acs.
cryptcompress,com.opentext.ecm.asm.ada
Legacy Code (LOG_LEGACY_GROUP)

• Variable name: AS.ICS.LOG_LEGACY_GROUP
• Description:
This setting specifies an own log category for the “Legacy Code” by listening
all related java packages. “Internal” setting only, do not modify until
• Type: String
• Predefined Value: ixos
Rights Management (LOG_RMS_GROUP)

• Variable name: AS.ICS.LOG_RMS_GROUP
• Description:
This setting specifies an own log category for “Rights Management” by
listening all related java packages.
• Type: String
• Predefined Value: com.opentext.ecm.rms,com.opentext.ecm.
services.rms

AR100500-01-ACN-EN-04
Glossary
Administration Client (former Archiving and Storage Administration)
Administration tool for setup and maintenance of servers, logical archives,

devices, pools, disk buffers, archive modes, and security settings.
Front-end interface for customizing and administering Archive Server.
Annotation
The set of all graphical additions assigned to individual pages of an archived

document (for example, colored marking). These annotations can be removed
again. They simulate handwritten comments on paper documents. There are two
groups of annotations: simple annotations (lines, arrows, highlighting, etc.) and
OLE annotations (documents or parts of documents which can be copied from
other applications via the clipboard).
See Also Notes.
Archive Box
OpenText Archive Center term. If enabled for a File Archiving data source, all
folders and documents below the specified path are archived and replaced by a
single folder shortcut.
This option is intended for documents, and optionally folders, that need to be
archived but are no longer in daily use. Thus, the required disk space on the file
server, including the total number of files, can be reduced. This is in contrast to
the shortcut scenario where every file is replaced by an individual link.
Separate machine, on which documents are stored temporarily. That way the
network traffic in the WAN can be reduced.
Archive Center
See OpenText Archive Center.
Archive ID
Unique name of the logical archive.
Archive mode
Specifies the different scenarios for the scan client (such as late archiving with
barcode, preindexing).
Archive Monitoring Web Client
Web based administration tool for monitoring the state of the processes, storage
areas, OpenText Document Pipeline and database space of the Archive Server.

AR100500-01-ACN-EN-04
Glossary
Archive Spawner
Service program which starts and terminates the processes of the archive system.
Archive Timestamp Server
A timestamp provider signs documents by adding the time and signing the
cryptographic checksum of the document. To ensure evidence of documents, use
an external, qualified timestamp provider like Timeproof or AuthentiDate.
OpenText Archive Timestamp Server is a timestamp provider for demonstration
or testing.
See Also Time Stamping Authority (TSA).
ArchiveLink
See SAP ArchiveLink.
Buffer
Also known as “disk buffer”. It is an area on hard disk where archived

documents are temporarily stored until they are written to the final storage
media.
Burn buffer
A special burn buffer is required for ISO pools in addition to a disk buffer. The
burn buffer is required to physically write an ISO image. When the specified
amount of data has accumulated in the disk buffer, the data is prepared and
transferred to the burn buffer in the special format of an ISO image. From the
burn buffer, the image is transferred to the storage medium in a single,
continuous, uninterruptible process referred to “burning” an ISO image. The
burn buffer is transparent for the administration.
Cache
Memory area which buffers frequently accessed documents.

Archive Server stores frequently accessed documents in a hard-disk volume
called the Document Service cache. The client stores frequently accessed
documents in the local cache on the hard disk of the client.
CMIS
See Content Management Interoperability Services (CMIS).
Collection
OpenText Archive Center term. Controls and defines all archiving activities and is
mapped to a tenant-specific logical archive.
See Also Data source.

AR100500-01-ACN-EN-04
Glossary
Content Management Interoperability Services (CMIS)
An open standard that allows different content management systems to inter-

operate over the Internet. CMIS defines an abstraction layer for controlling
diverse document management systems and repositories using web protocols.
Coordinated Universal Time (UTC)
Primary time standard by which the world regulates clocks and time. It is one of
several closely related successors to Greenwich Mean Time (GMT). For most
purposes, UTC is synonymous with GMT.
Data source
OpenText Archive Center term. Specifies the origin and properties of the
documents that are archived by a collection.
Device
Short term for a storage device in the Archive Server environment. A device is a
physical unit that contains at least storage media, but can also contain additional
software or hardware to manage the storage media. Devices include the
following:
• Local hard disks

• Virtual jukeboxes for storage systems
• Storage systems as a whole
Digital signature
Digital signature means an electronic signature based upon cryptographic

methods of originator authentication, computed by using a set of rules and a set
of parameters such that the identity of the signer and the integrity of the data can
be verified. (21 CFR Part 11)
Disk buffer
See Buffer.
DocID
See Document ID (DocID).
DocTools
Programs that perform single, discrete actions on the documents within a

OpenText Document Pipeline.
Document ID (DocID)
Unique string assigned to each document. It enables the archive system to

identify the document and trace its location.

AR100500-01-ACN-EN-04
Glossary
Document Pipeline (DP)
Mechanism that controls the transfer of documents to the Document Service at a

high security level.
Graphical user interface for monitoring the OpenText Document Pipeline.
Document Service (DS)
The kernel of the archive system. It receives and processes documents to be

archived and provides them at the client's request and controls writing processes
to storage media.
It consists of a read component (RC) and a write component (WC), which archives
documents.
DP
See Document Pipeline (DP).
DPDIR
The directory in which the documents are stored that are being currently
processed by a document pipeline.
DS
See Document Service (DS).
Email root directory
OpenText Archive Center term. Directory in which all incoming emails are
temporarily saved. If archiving of an email fails, it is kept in a subdirectory and is
not automatically deleted. In this case, depending on the number and size of the
failed emails, the directory can grow very quickly.
The location of the directory can be defined during the installation of Archive
Center and in the ECA.ECA.configuration.emailsystem.rootfolder
configuration variable.
Enterprise Scan
With Enterprise Scan, workflows can be implemented from receipt by post

through scanning and linking to the leading application, through to archiving.
After scanning, the pages can be checked carefully, straightened and cleaned up.
Several functions are available to improve contrast and legibility. Enterprise Scan
also provides support for sorting and archiving.
GMT
Greenwich Mean Time; former global time standard. For most purposes, GMT is
synonymous with UTC.
See Also Coordinated Universal Time (UTC).

AR100500-01-ACN-EN-04
Glossary
Hard disk volume
Used as an archive medium, it supports incremental writing as well as deletion of

documents with a strictly limited lifetime, such as paperwork of applicants not
taken on by a company. Hard disk volumes must be created and assigned a
mount path on the operating system level before they can be referred to in the
OpenText Administration Client.
Hold
Logical archives can be put on hold, which means that its documents and
components cannot be changed or deleted. Adding further documents to the
archive is still possible.
In Administration Client, logical archives on hold are indicated by a check mark

in the On Hold column of the Original Archives list and by an entry in the
archive's Properties dialog box.
See Also Retention.
Hot standby
High-availability Archive Server setup, comprising two identical Archive Servers

tightly connected to each other and holding the same data. Whenever the first
server becomes out of order, the second one immediately takes over, thus
enabling (nearly) uninterrupted archive system operation.
ISO image
An ISO image is a container file containing documents and their file system
structure according to ISO 9660. It is written at once and fills one volume.
Job
A job is an scheduled, administrative task to run automatically at regular

intervals. It has a unique name and start command, which runs along with any
argument required by the command.
Known server
A known server is an Archive Server whose archives and disk buffers are known
to another Archive Server. Making servers known to each other provides access
to all documents archived in all known servers. Read-write access is provided to
other known servers. Read-only access is provided to replicate archives. When a
request is made to view a document that is archived on another server and the
server is known, the inquired Archive Server is capable of displaying the
requested document.
Late Archiving
In the Late Archiving with Barcode scenario, paper documents are passed through
the office and are not archived until all document-related work has been
completed. If documents are archived in this way, indexing by barcode, patch

AR100500-01-ACN-EN-04
Glossary
code, or another indexing method is used to join the documents to the

corresponding business entries in SAP. Documents are identified by a barcode or
patch code on their first page.
See Also Enterprise Scan.
Log file
Files generated by the different components of Archive Server to report on their

operations providing diagnostic information.
Log level
Adjustable diagnostic level of detail on which the log files are generated.
Logical archive
Logical area on the Archive Server in which documents are stored. The Archive
Server can contain many logical archives. Each logical archive can be configured
to represent a different archiving strategy appropriate to the types of documents
archived exclusively there. An archive can consist of one or more pools. Each pool
is assigned its own exclusive set of volumes which make up the actual storage
capacity of that archive.
Media
Short term for “long term storage media” in the Archive Server environment. A
medium is a physical object: hard disks and hard disk storage systems with or
without WORM feature.
Monitor Server (MONS)
Obtains status information about archives, pools, hard disk and database space
on the Archive Server. MONS is the configuration parameter name for the
Monitor Server.
MONS
See Monitor Server (MONS).
MTA documents
Meta (MTA) documents, also known as document lists, are one comprehensive
file containing several individual documents of the same file format. If indexing
information is provided for the meta document (META_DOCUMENT_INDEX
component), the individual documents can be searched for and retrieved quickly
and easily.
Notes
The list of all notes (textual additions) assigned to a document. An individual

item of this list should be designated as “note”. A note is a text that is stored
together with the document. This text has the same function as a note clipped to a
paper document.

AR100500-01-ACN-EN-04
Glossary
OpenText Archive Center
OpenText Archive Center offers a common installation for multi-tenant, integrated

archiving. Using the OpenText Archive Center Administration web client, you
can set up archiving scenarios involving email (Archive for Google Apps,
Microsoft Exchange) or file systems (CIFS).
OpenText Archive Monitoring Web Client

See Archive Monitoring Web Client.
Pool
A pool is a logical unit, a set of volumes of the same type that are written in the
same way, using the same storage concept. Pools are assigned to logical archives.
RC
See Read Component (RC).
Read Component (RC)
Part of the Document Service that provides documents by reading them from the
archive.
Remote Standby
Archive server setup scenario including two (ore more) associated Archive
Servers. Archived data is replicated periodically from one server to the other in
order to increase security against data loss. Moreover, network load due to
document display actions can be reduced since replicated data can be accessed
directly on the replication server.
Replication
Refers to the duplication of an archive or buffer resident on an original server on

a remote standby server. Replication is enabled when you add a known server to
the connected server and indicate that replication is to be allowed. That means,
the known server is permitted to pull data from the original server for the
purpose of replication.
Retention
Time frame during which it is impossible to delete or modify a document to

facilitate compliance with regulations and meet the demands of lifecycle
management. Retention is defined per logical archive and can be either fixed
(“hardware retention”; i.e. propagated to the storage system) or variable
(“software retention”; i.e. handled by the leading application).
In OpenText Archive Center, retention periods can also be assigned to documents

using rules.

AR100500-01-ACN-EN-04
Glossary
SAP ArchiveLink
A standardized interface, mainly used to connect an SAP system with the archive
system.
Scan station
Workstation for high volume scanning on which the Enterprise Scan client is
installed and to which a scanner is connected. Incoming documents are scanned
here and then transferred to Archive Server or Archive Center.
SecKey
With SecKeys, you can protect the connections between a client and Archive
Server. A SecKey is an additional parameter in the URL of the archive access. It
contains a digital signature and a signature time and date. The client application
creates a signature for the relevant parameters in the URL and the expiration
time, and signs it with a private key. Archive Server verifies the signature with
the public key, and accepts requests only with a valid signature and if the
SecKey's expiration time has not been reached.
SIA
See Single Instance Archiving (SIA).
Single Instance Archiving (SIA)
Single Instance Archiving means that requests to archive the same component do
not result in an additional copy of the component on Archive Server. Instead, the
component is archived only once and then referenced by subsequent instances.
SIA is mainly used if a large number of emails with identical attachments has to
be archived.
Slot
In virtual jukeboxes of storage systems, a slot is virtually assigned to a volume.
Spawner
See Archive Spawner.
Storage Manager (STORM)
Component that controls jukeboxes and manages storage subsystems.
Tenant
Tenants are a feature of OpenText Archive Center. A tenant is defined by a user

group with an associated, dedicated policy. By default, this policy is
“BusinessAdministration”.

AR100500-01-ACN-EN-04
Glossary
Time Stamping Authority (TSA)
A Time Stamping Authority provides Timestamps in a reliable, secure way, as

defined by the IETF (https://www.ietf.org/rfc/rfc3161.txt). Such qualified
timestamps can be provided over the Internet or by dedicated hardware.
See Also Archive Timestamp Server.
TSA
See Time Stamping Authority (TSA).
UTC
See Coordinated Universal Time (UTC).
Volume
• A volume is a memory area of a storage media that contains documents.
Depending on the device type, a device can contain many volumes (for
example, real and virtual jukeboxes), or is treated as one volume (for example,
storage systems without virtual jukeboxes). Volumes are logically attached
(assigned or linked) to pools.
• Volume is a technical collective term with different meaning in STORM and
Document Service (DS). A DS volume is a virtual container of volumes with
identical documents (after the complete backup is written). A STORM volume
is a virtual container of all identical copies of a volume. For ISO volumes,
there is no difference between DS and STORM volumes.
WC
See Write Component (WC).
Windows Viewer
Component for displaying, occasional scanning, and archiving documents.

Windows Viewer can attach annotations and notes to the documents.
WORM
WORM means Write Once Read Multiple. A WORM disk supports incremental
writing. On storage systems, a WORM flag is set to prevent changes in
documents.
Write Component (WC)
Component of the Document Service that carries out all possible modifications. It is
used to archive incoming documents (store them in the buffer), modify and delete
existing documents, set, modify and delete attributes, and manage pools and
volumes.
Write job
Scheduled administrative task that regularly writes the documents stored in a

disk buffer to appropriate storage media.

AR100500-01-ACN-EN-04

OpenText Archive Server 10.5 SP1 - Administration Guide English (AR100500-01-ACN-En-04)

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

OpenText Archive Server 10.5 SP1 - Administration Guide English (AR100500-01-ACN-En-04)

Hochgeladen von

Copyright:

Verfügbare Formate

OpenText™ Archive Server

The guide describes the administration, monitoring and

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Copyright © 2017 Open Text. All Rights Reserved.

No Warranties and Limitation of Liability

List of tables xix

List of figures xxi

PRE Introduction xxiii

1 Archive Server ......................................................................... 27

2 Basic principles of archives ................................................... 31

3 Administration Client and the main objects of the

OpenText Archive Server – Administration Guide iii

Part 2 Archive Center scenario 47

4 Understanding Archive Center ............................................... 49

5 What happens on Archive Server? ........................................ 51

6 Tasks remaining for the Archive Server administrator ........ 55

7 Configuring accounting and statistics .................................. 57

8 Configuring miscellaneous Archive Center options ............ 61

9 Working with Archive Center Access .................................... 63

10 Troubleshooting Email Cloud Archiving ............................... 65

11 Setting up the infrastructure .................................................. 71

iv OpenText Archive Server – Administration Guide

11.2.1 Creating and modifying disk volumes ............................................... 86

12 Configuring archives and pools ............................................. 99

OpenText Archive Server – Administration Guide v

12.3.4.1 Single file (FS) shadow pool .......................................................... 126

13 Configuring jobs and checking job protocol ...................... 141

14 Configuring security settings ............................................... 151

vi OpenText Archive Server – Administration Guide

14.4.4 Creating a hash tree ...................................................................... 167

15 Configuring Archive Timestamp Server .............................. 181

16 Configuring users, groups, and policies ............................. 187

OpenText Archive Server – Administration Guide vii

17 Connecting to SAP servers .................................................. 201

18 Configuring scan stations .................................................... 207

19 Adding and modifying known servers ................................ 215

20 Configuring remote standby scenarios ............................... 219

21 Configuring Archive Cache Server ...................................... 225

viii OpenText Archive Server – Administration Guide

22 Scenario reports .................................................................... 239

23 Setting configuration variables ............................................ 241

Part 4 Maintenance 245

24 Handling storage volumes .................................................... 247

25 Backups and recovery .......................................................... 261

26 Utilities .................................................................................... 267

Part 5 Migration 271

27 About migration ..................................................................... 273

OpenText Archive Server – Administration Guide ix

28 Setting parameters of volume migration ............................. 277

29 Preparing the migration ........................................................ 281

30 Creating a migration job ....................................................... 287

31 Monitoring the migration progress ...................................... 297

32 Manipulating migration jobs ................................................. 301

33 Volume migration utilities ..................................................... 303

34 Attribute migration ................................................................ 309

Part 6 Monitoring 311

35 Everyday monitoring of the archive system ....................... 313

36 Monitoring with notifications ............................................... 315

x OpenText Archive Server – Administration Guide

36.1.1 Conditions for event filters ............................................................. 316

37 Using OpenText Archive Server Monitoring ....................... 325

38 Auditing, accounting, and statistics .................................... 335

Part 7 Troubleshooting 341