Sie sind auf Seite 1von 582

OpenText™ Archive Center

Administration Guide

The guide describes the administration, monitoring, and


maintenance of OpenText Archive Center and introduces
guidelines for troubleshooting.

AR160200-00-ACN-EN-03
OpenText™ Archive Center
Administration Guide
AR160200-00-ACN-EN-03
Rev.: 2017-May-02
This documentation has been created for software version 16.2.
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 xvii

List of figures xix

Part 1 Overview 21

1 About Archive Center .............................................................. 23


1.1 About this document ........................................................................ 23
1.1.1 What’s new? ................................................................................... 24
1.2 Features of Archive Center .............................................................. 25
1.3 Main components of Archive Center ................................................. 26
1.4 Important directories on Archive Center ............................................ 27
1.5 Running Archive Center as a cluster ................................................. 28

2 Documents, data, logical archives, and jobs ........................ 29


2.1 Content capture and storage ............................................................ 30
2.2 Content retrieval ............................................................................. 31
2.3 Logical archives .............................................................................. 32
2.3.1 Disk buffers .................................................................................... 34
2.3.2 Storage devices .............................................................................. 34
2.3.3 Storage scenarios ........................................................................... 35
2.3.4 Pools and pool types ....................................................................... 36
2.3.5 Caches ........................................................................................... 37
2.4 Jobs ............................................................................................... 38

3 Scenarios leveraging Archive Center Application Layer


and web apps ........................................................................... 39

4 Administration Client and the main objects of the


“Archive Server” node ............................................................ 41
4.1 Administration Client ....................................................................... 41
4.2 Main objects of the “Archive Server” node ......................................... 42
4.2.1 “Infrastructure” node ........................................................................ 42
4.2.2 “Archives” node ............................................................................... 43
4.2.3 “Environment” node ......................................................................... 43
4.2.4 “System” node ................................................................................ 44
4.2.5 “Configuration” node ........................................................................ 45

Part 2 Configuration 47

OpenText Archive Center – Administration Guide iii


AR160200-00-ACN-EN-03
Table of Contents

5 Setting up the infrastructure .................................................. 49


5.1 Installing and configuring storage devices ......................................... 49
5.1.1 Adding a write at-once (STORM) device ........................................... 51
5.1.1.1 Compliant file systems (STORM) ..................................................... 52
5.1.1.2 EMC Centera (STORM) ................................................................... 54
5.1.1.3 IBM TSM SSAM (STORM) ............................................................... 54
5.1.1.4 HDS HCP (STORM) ........................................................................ 55
5.1.2 Configuring STORM storage devices ................................................ 56
5.1.2.1 Attaching and detaching devices ...................................................... 56
5.1.2.2 Initializing storage volumes .............................................................. 56
5.1.3 Adding a single file (VI) device ......................................................... 57
5.1.3.1 Windows Azure ............................................................................... 57
5.1.3.2 EMC Centera (single file) ................................................................. 58
5.1.3.3 HDS HCP (single file) ...................................................................... 59
5.2 Configuring disk volumes ................................................................. 60
5.2.1 Creating and modifying disk volumes ............................................... 61
5.2.2 Configuring a volume for single-file storage ....................................... 63
5.3 Configuring buffers .......................................................................... 63
5.3.1 Creating and modifying a disk buffer ................................................. 63
5.3.2 Attaching a disk volume to a disk buffer ............................................ 65
5.3.3 Detaching a volume from a disk buffer .............................................. 65
5.3.4 Configuring the Purge Buffer job ...................................................... 66
5.3.5 Checking and modifying attached disk volumes ................................ 67
5.3.6 Synchronizing servers ..................................................................... 68
5.3.7 Configuring replicated buffers .......................................................... 68
5.4 Configuring caches ......................................................................... 69
5.4.1 Overview of cache functionality ........................................................ 69
5.4.2 Creating and deleting caches ........................................................... 70
5.4.3 Adding hard disk volumes to caches ................................................. 71
5.4.4 Deleting assigned hard disk volumes ................................................ 71
5.4.5 Defining priorities of cache volumes ................................................. 72
5.5 Checking unavailable volumes ......................................................... 72
5.6 Changing the database user password ............................................. 73
5.7 Setting the reconnection time for the database .................................. 73

6 Configuring archives and pools ............................................. 75


6.1 Logical archives .............................................................................. 75
6.1.1 Data compression ........................................................................... 76
6.1.2 Single instance ............................................................................... 77
6.1.3 Retention ........................................................................................ 79
6.1.3.1 Basics – retention on Archive Center ................................................ 79
6.1.3.2 Retention on storage systems .......................................................... 82

iv OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Table of Contents

6.1.3.3 Document deletion .......................................................................... 83


6.1.3.4 Volume migration and retention ........................................................ 85
6.2 Creating and configuring logical archives .......................................... 86
6.2.1 Creating a logical archive ................................................................. 86
6.2.2 Configuring the archive security settings ........................................... 87
6.2.3 Configuring the archive settings ....................................................... 88
6.2.4 Configuring the archive retention settings ......................................... 89
6.2.5 Activating and configuring timestamp usage ..................................... 90
6.3 Creating and modifying pools ........................................................... 92
6.3.1 Creating and modifying a HDSK (write-through) pool ......................... 92
6.3.2 Creating and modifying pools with a buffer ........................................ 93
6.3.2.1 Write at once (ISO) pool settings ...................................................... 94
6.3.2.2 Single file (VI, FS) pool settings ....................................................... 96
6.3.3 Marking the pool as default .............................................................. 96
6.3.4 Creating and configuring shadow pools ............................................ 97
6.3.4.1 Single file (FS) shadow pool .......................................................... 100
6.3.4.2 Write at-once (ISO) shadow pool .................................................... 101
6.3.4.3 Single file (VI) shadow pool ............................................................ 103
6.3.5 Creating copy orders for shadow pools ........................................... 104
6.3.5.1 Creating copy orders when defining new shadow pools ................... 105
6.3.5.2 Creating copy orders when attaching a volume to an original pool .... 106
6.3.6 Handling shadow copy errors ......................................................... 106
6.3.6.1 Report of shadow copy errors ........................................................ 107
6.3.6.2 Clearing shadow copy errors .......................................................... 107
6.3.7 Recovering original pool data from a shadow pool ........................... 109
6.4 Creating and modifying storage tiers .............................................. 111
6.5 Enabling certificates ...................................................................... 112
6.6 Changing the server priorities ........................................................ 113

7 Configuring jobs and checking job protocol ...................... 115


7.1 Important jobs and commands ....................................................... 115
7.1.1 Configuring security settings for pagelist job ............................... 119
7.2 Starting and stopping the scheduler ................................................ 119
7.3 Starting and stopping jobs ............................................................. 120
7.4 Enabling and disabling jobs ........................................................... 120
7.5 Checking settings of jobs ............................................................... 120
7.6 Creating and modifying jobs ........................................................... 121
7.7 Setting the start mode and scheduling of jobs ................................. 122
7.8 Checking the execution of jobs ....................................................... 123

8 Configuring security settings ............................................... 125


8.1 Overview of security topics ............................................................ 125
8.2 Authentication using signed URLs .................................................. 126

OpenText Archive Center – Administration Guide v


AR160200-00-ACN-EN-03
Table of Contents

8.2.1 Activating SecKey usage for a logical archive ................................. 126


8.2.2 SecKeys from leading applications and components ....................... 127
8.2.3 SecKeys from SAP ........................................................................ 128
8.3 Encrypted document storage ......................................................... 128
8.3.1 Activating encryption usage for a logical archive .............................. 129
8.3.2 Creating a system key for document encryption .............................. 129
8.3.3 Exporting and importing system keys ............................................. 131
8.4 Timestamps .................................................................................. 133
8.4.1 Basic timestamp settings ............................................................... 135
8.4.2 Configuring connection parameters ................................................ 136
8.4.2.1 exceet (AuthentiDate) over the Internet ........................................... 136
8.4.2.2 QuoVadis ..................................................................................... 137
8.4.2.3 Keyon true-Sign ............................................................................ 138
8.4.3 Configuring certificates and signature keys ..................................... 139
8.4.4 Creating a hash tree ...................................................................... 139
8.4.5 Renewing hash trees ..................................................................... 140
8.4.6 Renewing timestamps of hash trees ............................................... 140
8.4.7 Migrating existing document timestamps ........................................ 141
8.5 Certificates ................................................................................... 141
8.5.1 Basic procedures and commands .................................................. 142
8.5.1.1 Checking a certificate .................................................................... 142
8.5.1.2 Enabling a certificate ..................................................................... 143
8.5.1.3 Deleting a certificate ...................................................................... 144
8.5.1.4 Creating a certificate using the Certtool .......................................... 144
8.5.2 Configuring a certificate for authentication ...................................... 146
8.5.2.1 Importing an authentication certificate ............................................. 147
8.5.2.2 Granting privileges for a certificate ................................................. 148
8.5.3 Configuring a certificate for document encryption ............................ 149
8.5.4 Configuring a certificate for timestamp verification ........................... 149
8.6 Governikus adapter ....................................................................... 150
8.6.1 Enabling the adapter framework ..................................................... 152
8.6.2 Configuring the Governikus adapter ............................................... 153
8.6.3 Deploying JCA Resource Adapter and configuring Storage Module .. 155
8.7 Using checksums .......................................................................... 158
8.8 ArchiveLink using Common Names (CN) ........................................ 158

9 Configuring users, groups, and policies ............................. 161


9.1 Password security and settings ...................................................... 161
9.2 About users, groups, and policies ................................................... 163
9.3 Configuring users and their rights ................................................... 164
9.4 Checking, creating, or modifying policies ........................................ 164
9.4.1 Available rights to create policies ................................................... 165

vi OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Table of Contents

9.4.2 Checking policies .......................................................................... 165


9.4.3 Creating and modifying policies ...................................................... 166
9.5 Checking, creating, or modifying users ........................................... 166
9.5.1 Checking users ............................................................................. 167
9.5.2 Creating and modifying users ......................................................... 167
9.6 Checking, creating, or modifying user groups .................................. 168
9.6.1 Checking user groups .................................................................... 168
9.6.2 Creating and modifying user groups ............................................... 168
9.6.3 Adding users and policies to a user group ....................................... 169
9.7 Creating tenants ........................................................................... 169
9.8 Checking a user’s rights ................................................................ 171
9.9 Connecting to Directory Services ................................................... 172

10 Connecting to SAP servers .................................................. 175


10.1 Creating and modifying SAP system connections ............................ 175
10.2 Creating and modifying SAP gateways ........................................... 177
10.3 Assigning an SAP system to a logical archive ................................. 178

11 Configuring scan stations .................................................... 181


11.1 Scenarios and archive modes ........................................................ 181
11.2 Adding and modifying archive modes ............................................. 183
11.3 Adding additional scan hosts .......................................................... 186
11.4 Adding a new scan host and assigning archive modes .................... 186
11.5 Adding additional archive modes .................................................... 187
11.6 Changing the default archive mode ................................................ 188
11.7 Removing assigned archive modes ................................................ 188
11.8 Configuring scan clients for a clustered installation .......................... 188

12 Adding and modifying known servers ................................ 191


12.1 Adding known servers ................................................................... 191
12.2 Enabling replication to known servers ............................................. 192
12.3 Checking and modifying known servers .......................................... 192
12.4 Synchronizing servers ................................................................... 193

13 Configuring remote standby scenarios ............................... 195


13.1 Configuring original Archive Center and Remote Standby Server ..... 196
13.1.1 Configuring the original Archive Center ........................................... 196
13.1.2 Configuring the Remote Standby Server ......................................... 197
13.2 Backups on a Remote Standby Server ........................................... 199
13.2.1 ISO volumes ................................................................................. 199
13.2.2 Generalized Storage (GS) volumes with Vendor Interface (VI) ......... 200

14 Configuring Archive Timestamp Server .............................. 201


14.1 Using the auto initialization mode ................................................... 201

OpenText Archive Center – Administration Guide vii


AR160200-00-ACN-EN-03
Table of Contents

14.2 Configuration variables for Archive Timestamp Server ..................... 202


14.3 Logging information and status ...................................................... 204
14.4 Testing the connection .................................................................. 204

15 Configuring Archive Cache Server ...................................... 205


15.1 Restrictions using Archive Cache Server ........................................ 207
15.2 Configuring an Archive Cache Server in the environment ................. 209
15.2.1 Adding an Archive Cache Server to the environment ....................... 209
15.2.2 Modifying an Archive Cache Server ................................................ 210
15.2.3 Deleting an Archive Cache Server .................................................. 211
15.2.4 Configuring volumes of an Archive Cache Server ............................ 212
15.2.5 Changing database files ................................................................ 214
15.3 Configuring access using Archive Cache Server ............................. 214
15.3.1 Subnet assignment of Archive Cache Server .................................. 214
15.3.2 Configuring archive access using Archive Cache Server .................. 215
15.3.3 Configuring access for write-back scenario ..................................... 217
15.3.4 Adding and modifying subnet definitions of an Archive Cache
Server .......................................................................................... 217
15.3.5 Deleting an assigned Archive Cache Server ................................... 218

16 Scenario reports .................................................................... 219

17 Setting configuration variables ............................................ 221


17.1 Setting and modifying the value of configuration variables ............... 221
17.2 Searching configuration variables ................................................... 222
17.3 Customizing configuration view ...................................................... 223

Part 3 Maintenance 225

18 Handling storage volumes .................................................... 227


18.1 When the retention period has expired ........................................... 227
18.1.1 Checking for Empty Volumes and Deleting Them Manually .............. 229
18.1.2 Deleting Empty Volumes Automatically ........................................... 230
18.2 Exporting volumes ......................................................................... 230
18.3 Importing volumes ......................................................................... 231
18.3.1 Importing ISO volumes .................................................................. 231
18.3.2 Importing hard disk volumes .......................................................... 232
18.3.3 Importing GS volumes for Single File (VI) pool ................................ 233
18.4 Consistency checks for storage volumes and documents ................. 234
18.4.1 Checking database against volume ................................................ 234
18.4.2 Checking volume against database ................................................ 236
18.4.3 Checking a document .................................................................... 236
18.4.4 Counting documents and components in a volume .......................... 237
18.4.5 Checking a volume ........................................................................ 238

viii OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Table of Contents

18.5 Backup for storage systems ........................................................... 238

19 Backups and recovery .......................................................... 241


19.1 Backing up the database ............................................................... 242
19.1.1 Backing up an Oracle Database ..................................................... 243
19.1.2 Backing up a Microsoft SQL Server database ................................. 243
19.2 Backing up and restoring of the Storage Manager configuration ....... 243
19.3 Backup and recovery of an Archive Cache Server ........................... 244
19.3.1 Backup of Archive Cache Server data ............................................ 244
19.3.2 Recovery of Archive Cache Server data ......................................... 245
19.4 Reassigning the jobs of a node in a cluster installation .................... 247

20 Utilities .................................................................................... 249


20.1 Starting utilities ............................................................................. 250
20.2 Checking utilities protocols ............................................................ 250

21 Updating Archive Center and third-party components ...... 253


21.1 Installing patches .......................................................................... 253
21.2 Updating Java ............................................................................... 253
21.3 Updating Apache Tomcat .............................................................. 254

Part 4 Migration 257

22 About migration ..................................................................... 259


22.1 Features of volume migration ......................................................... 260
22.2 Restrictions of volume migration ..................................................... 260

23 Setting parameters of volume migration ............................. 263


23.1 Setting configuration parameters of volume migration ...................... 263
23.2 Setting logging parameters of volume migration .............................. 265

24 Preparing the migration ........................................................ 267


24.1 Preparing for migration .................................................................. 267
24.2 Preparing for fast migration of ISO images ...................................... 267

25 Creating a migration job ....................................................... 269


25.1 Creating a migration job ................................................................. 269
25.2 Creating a fast migration job for ISO volumes ................................. 272

26 Monitoring the migration progress ...................................... 275


26.1 Starting monitoring ........................................................................ 275
26.2 States of migration jobs ................................................................. 276

27 Manipulating migration jobs ................................................. 279


27.1 Pausing a migration job ................................................................. 279
27.2 Continuing a migration job ............................................................. 279

OpenText Archive Center – Administration Guide ix


AR160200-00-ACN-EN-03
Table of Contents

27.3 Canceling a migration job .............................................................. 280


27.4 Renewing a migration job .............................................................. 280

28 Volume migration utilities ..................................................... 281


28.1 Deleting a migration job ................................................................. 281
28.2 Finishing a migration job manually .................................................. 281
28.3 Modifying attributes of a migration job ............................................. 282
28.4 Changing the target pool of write jobs ............................................. 283
28.5 Determining unmigrated components ............................................. 283
28.6 Switching component types of two pools ......................................... 284
28.7 Adjusting the sequence number for new volumes ............................ 284
28.8 Statistic about components on certain volumes ............................... 285
28.9 Collecting diagnostic information .................................................... 285

29 Attribute migration ................................................................ 287

Part 5 Monitoring 289

30 Everyday monitoring of the archive system ....................... 291

31 Monitoring with notifications ............................................... 293


31.1 Creating and modifying event filters ................................................ 293
31.1.1 Conditions for event filters ............................................................. 294
31.1.2 Available event filters .................................................................... 296
31.2 Creating and modifying notifications ............................................... 297
31.2.1 Notification settings ....................................................................... 298
31.2.2 Using variables in notifications ....................................................... 300
31.3 Checking alerts ............................................................................. 301

32 Using OpenText Archive Server Monitoring ....................... 303


32.1 Access permission for the Archive Monitoring Web Client ................ 304
32.1.1 Creating a dedicated group for the Archive Monitoring Web Client
(built-in OpenText User Management) ............................................ 304
32.1.2 Creating a dedicated group for the Archive Monitoring Web Client
(OTDS) ........................................................................................ 305
32.2 Starting the Archive Monitoring Web Client ..................................... 306
32.3 Archive Center Statistics ............................................................ 307
32.4 Archive Center Health Status ...................................................... 308
32.4.1 Database ..................................................................................... 309
32.4.2 Storage Manager ......................................................................... 309
32.4.3 Services ...................................................................................... 309
32.4.4 Pools and Volumes ..................................................................... 310
32.5 Threats ........................................................................................ 310

33 Auditing, accounting, and statistics .................................... 313

x OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Table of Contents

33.1 Auditing ........................................................................................ 313


33.1.1 Configuring auditing ...................................................................... 313
33.1.2 Accessing auditing information ....................................................... 313
33.2 Accounting ................................................................................... 315
33.2.1 Settings for accounting .................................................................. 316
33.2.2 Evaluating accounting data ............................................................ 317
33.3 Storage Manager statistics ............................................................ 318

Part 6 Troubleshooting 319

34 Basics ..................................................................................... 321


34.1 Avoiding problems ......................................................................... 321
34.2 Viewing installed patches ............................................................... 322
34.3 Correcting wrong installation settings ............................................. 322
34.4 Monitoring and administration tools ................................................ 323
34.5 Deleting log files ........................................................................... 323

35 Starting and stopping Archive Center ................................. 325


35.1 Starting and stopping under Windows ............................................. 325
35.2 Starting and stopping under UNIX/Linux ......................................... 326
35.3 Starting and stopping single services with spawncmd ...................... 327
35.4 Setting the operation mode of Archive Center ................................. 328

36 Analyzing problems .............................................................. 329


36.1 Spawner log file ............................................................................ 329
36.2 Analyzing processes with spawncmd .............................................. 329
36.3 Working with log files ..................................................................... 331
36.3.1 About log files ............................................................................... 331
36.3.2 Setting log levels ........................................................................... 332
36.3.3 Log settings for Archive Center components (except STORM) ......... 332

Part 7 Configuration parameter reference 335

37 Introduction ............................................................................ 337


37.1 Configuration files ......................................................................... 338
37.2 Priorities ....................................................................................... 338
37.3 General installation variables ......................................................... 339
37.4 Configuration of log files ................................................................ 339

38 Archive Server ....................................................................... 343


38.1 Administration Server (ADMS) ....................................................... 343
38.1.1 Jobs and Commands .................................................................... 344
38.1.1.1 SYS_CLEANUP_PROTOCOL ....................................................... 344
38.1.1.2 Local_backup ............................................................................... 345

OpenText Archive Center – Administration Guide xi


AR160200-00-ACN-EN-03
Table of Contents

38.1.1.3 Delete_Empty_Volumes ................................................................ 345


38.1.1.4 SYS_EXPIRE_ALERTS ................................................................ 346
38.1.1.5 SYS_CLEANUP_ADMAUDIT ........................................................ 346
38.1.2 Buffers ......................................................................................... 346
38.1.3 Archives ....................................................................................... 347
38.1.3.1 Security ........................................................................................ 347
38.1.3.2 Settings ........................................................................................ 348
38.1.3.3 Retention ...................................................................................... 351
38.1.4 Pools ............................................................................................ 353
38.1.4.1 Write through (HDSK) .................................................................... 353
38.1.4.2 Write at-once (ISO) ....................................................................... 354
38.1.4.3 Single file (VI) ............................................................................... 355
38.1.5 Cache servers .............................................................................. 356
38.1.6 Certificates ................................................................................... 357
38.1.7 Notifications .................................................................................. 358
38.1.8 Connection Parameters ................................................................. 358
38.1.9 Directories .................................................................................... 359
38.1.10 System Keys ................................................................................ 360
38.2 Document Service (DS) ................................................................. 361
38.2.1 Document Service related settings ................................................. 361
38.2.2 Accounting and Statistics ............................................................... 361
38.2.2.1 Cookie exclusion list ...................................................................... 364
38.2.3 Backup configuration ..................................................................... 364
38.2.4 Cache configuration ...................................................................... 365
38.2.5 Component settings ...................................................................... 366
38.2.5.1 Compression ................................................................................ 366
38.2.5.2 Blobs ............................................................................................ 367
38.2.5.3 Encryption .................................................................................... 368
38.2.5.4 Timestamps (old) .......................................................................... 368
38.2.5.4.1 Headers for HTTP TS requests ...................................................... 371
38.2.5.5 ArchiSig Timestamps .................................................................... 372
38.2.5.6 Single Instance Archiving ............................................................... 376
38.2.5.6.1 Component or application types that prohibit(!) single instance
archiving ....................................................................................... 376
38.2.5.6.2 Component names that prohibit(!) single instance archiving ............. 377
38.2.5.7 Settings for big components ........................................................... 377
38.2.6 Directories .................................................................................... 378
38.2.7 Document settings ........................................................................ 378
38.2.8 HTTP settings ............................................................................... 379
38.2.9 Media configuration ....................................................................... 379
38.2.9.1 ISO settings .................................................................................. 379
38.2.9.2 HDSK settings .............................................................................. 382

xii OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Table of Contents

38.2.9.3 HSM settings ................................................................................ 382


38.2.9.4 IXW settings ................................................................................. 383
38.2.9.5 Generalized Store ......................................................................... 383
38.2.10 Logging ........................................................................................ 384
38.2.10.1 Administration and Document Service ............................................ 384
38.2.11 Security settings ........................................................................... 384
38.2.11.1 Global security settings for HTTP ................................................... 384
38.2.11.2 Global security settings for RPC ..................................................... 385
38.2.12 STORM communication ................................................................. 386
38.2.12.1 NFS Server ................................................................................... 387
38.2.12.1. NFS Server ................................................................................... 387
1
38.2.12.1. Additional NFS Servers ................................................................. 388
2
38.2.13 System settings ............................................................................ 388
38.2.13.1 Database (fine tuning) ................................................................... 389
38.2.14 Special cs2ds settings ................................................................... 390
38.2.15 Special pagelist settings ................................................................ 391
38.3 Database Server (DBS) ................................................................. 391
38.4 Notification Server (NOTS) ............................................................ 393
38.5 Key Export Tool (RCIO) ................................................................. 395
38.6 Storage Manager (STORM) ........................................................... 396
38.6.1 Configuration STORM (file server.cfg) ............................................ 396
38.6.1.1 Parameters Sizing STORM Server ................................................. 396
38.6.1.2 Parameter SCSI report .................................................................. 396
38.6.1.3 Parameters jbd scheduler .............................................................. 397
38.6.1.4 Parameters ISO9660 Finalization ................................................... 397
38.6.1.5 Parameters Logging Filenames/Dirs/Limits ..................................... 398
38.6.1.6 Logging Trace Levels .................................................................... 400
38.6.1.6.1 Defaults Logging Trace Levels ....................................................... 400
38.6.1.6.2 Logging trace levels STORM internal components .......................... 400
38.6.1.7 Parameters Notification server connection (NOTS) .......................... 404
38.6.1.8 STORM Internals .......................................................................... 405
38.6.1.9 Parameters STORM Statistics ....................................................... 405
38.6.1.10 Parameters ISO9660 Filesystem .................................................... 406
38.6.1.11 Device Configuration ..................................................................... 406
38.6.1.12 NFS VIEWS Definition ................................................................... 410
38.6.1.13 Backup STORM control files .......................................................... 412
38.6.1.14 WORM Filesystem ........................................................................ 413
38.6.1.14. Definition for hashing directories .................................................... 415
1
38.6.1.14. Definition of hashing file names ...................................................... 416
2

OpenText Archive Center – Administration Guide xiii


AR160200-00-ACN-EN-03
Table of Contents

38.6.1.14. Definition of hashing file IDs ........................................................... 417


3
38.6.1.14. Definition of files to store inodes ..................................................... 419
4
38.6.1.15 WORM Filesystem (Small: original hash chunk size 35 MB - inode
chunk size 600 MB) ....................................................................... 420
38.6.1.15. Definition of hashing directories ..................................................... 422
1
38.6.1.15. Definition of hashing file names ...................................................... 423
2
38.6.1.15. Definition of hashing file IDs ........................................................... 425
3
38.6.1.15. Definition of files to store inodes ..................................................... 426
4
38.6.1.16 WORM Filesystem (Medium: original hash chunk size 200 MB -
inode chunk size 600 MB) .............................................................. 428
38.6.1.16. Definition of hashing directories ..................................................... 430
1
38.6.1.16. Definition of hashing file names ...................................................... 431
2
38.6.1.16. Definition of hashing file IDs ........................................................... 433
3
38.6.1.16. Definition of files to store inodes ..................................................... 434
4
38.6.1.17 WORM Filesystem (Large: original hash chunk size 700 MB - inode
chunk size 800 MB) ....................................................................... 436
38.6.1.17. Definition of hashing directories ..................................................... 438
1
38.6.1.17. Definition of hashing file names ...................................................... 439
2
38.6.1.17. Definition of hashing file IDs ........................................................... 441
3
38.6.1.17. Definition of files to store inodes ..................................................... 442
4
38.7 Timestamp Server (TSTP) ............................................................. 445
38.7.1 Configuration for Autostart ............................................................. 447
38.7.2 Script for the Archive Web Monitor ................................................. 449
38.8 Volume Migration (VMIG) .............................................................. 449
38.8.1 Mapping of NFSSERVER names ................................................... 453
38.9 Archive Server settings (JDS) ........................................................ 454
38.9.1 Document Service related settings ................................................. 454
38.9.1.1 Alias name for Retrieval Requests .................................................. 458
38.9.1.2 Alias name for Storage Requests ................................................... 459
38.9.1.3 Tape Pools and Volumes ............................................................... 459
38.9.2 Notification Clients ........................................................................ 460

xiv OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Table of Contents

38.9.3 Filter settings ................................................................................ 460


38.9.4 Administration Service ................................................................... 467
38.9.4.1 Database ...................................................................................... 467
38.9.4.2 Command ..................................................................................... 468
38.9.4.3 Audit ............................................................................................ 468
38.9.4.4 OTDSconnection ........................................................................... 469
38.9.4.5 AllowedUsers ................................................................................ 472
38.9.4.6 Policy ........................................................................................... 476
38.9.4.6.1 Assignments ................................................................................. 476
38.9.4.7 Reports ........................................................................................ 477
38.9.4.7.1 Archive Report .............................................................................. 478
38.9.4.8 SolutionRegistry ............................................................................ 479
38.9.4.8.1 SAP System Landscape Directory .................................................. 479
38.9.5 Search Service ............................................................................. 480
38.9.6 Archive Administration Service ....................................................... 481
38.9.6.1 Contact Information ....................................................................... 481
38.9.7 Logging ........................................................................................ 482
38.9.7.1 Application Server ......................................................................... 482
38.9.7.1.1 Group definitions ........................................................................... 485
38.9.8 Record Integration related settings (Elib) ........................................ 487
38.9.9 Record Access Configuration ......................................................... 487
38.10 CMIS settings ............................................................................... 488
38.10.1 OTDS integration settings for Email Archiving ................................. 488
38.11 Business Administration ................................................................ 491
38.11.1 Default values for the administration web client ............................... 495
38.12 Integrated Common Service Settings (ICS) ..................................... 501
38.12.1 Archive Link specific Settings (AL) .................................................. 508
38.12.2 HTTP communication parameter .................................................... 513
38.12.3 Rights Management Services parameters ....................................... 517
38.12.4 Logging ........................................................................................ 519
38.12.4.1 Application Server ......................................................................... 519
38.12.4.1. Group definitions ........................................................................... 522
1

39 File Share ............................................................................... 525


39.1 Specific settings for FSA Document Pipelines ................................. 525

40 Monitor Server ....................................................................... 531


40.1 Monitor Server (MONS) ................................................................. 531
40.1.1 Variables for monitor server agent .................................................. 531

41 Cache Server .......................................................................... 533


41.1 Archive Cache Server settings (ACS) ............................................. 533

OpenText Archive Center – Administration Guide xv


AR160200-00-ACN-EN-03
Table of Contents

41.1.1 Scheduler ..................................................................................... 543


41.1.2 Logging ........................................................................................ 544
41.1.2.1 Application Server ......................................................................... 544
41.1.2.1.1 Group definitions ........................................................................... 545
41.1.3 Business Administration ................................................................ 546
41.2 Integrated Common Service Settings (ICS) ..................................... 548
41.2.1 Archive Link specific Settings (AL) .................................................. 555
41.2.2 HTTP communication parameter .................................................... 560
41.2.3 Rights Management Services parameters ....................................... 564
41.2.4 Logging ........................................................................................ 566
41.2.4.1 Application Server ......................................................................... 566
41.2.4.1.1 Group definitions ........................................................................... 569

GLS Glossary 571

xvi OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
List of tables
Table 5-1: “Types of storage devices” on page 50

Table 5-2: “Supported storage devices” on page 50

Table 5-3: “Cache configuration” on page 70

Table 6-1: “Retention period types” on page 81

Table 6-2: “Retention behavior settings” on page 81

Table 6-3: “Retention on storage systems” on page 82

Table 6-4: “Purging content” on page 84

Table 6-5: “Deletion on backup media” on page 84

Table 7-1: “Preconfigured jobs” on page 115

Table 7-2: “Pool-related jobs” on page 117

Table 7-3: “Other jobs” on page 118

Table 8-1: “Generate self-signed certificates” on page 144

Table 8-2: “Request a certificate from a trust center ” on page 145

Table 8-3: “Send the certificate to an Archive Center (putCert)” on page 145

Table 9-1: “Administrative WebServices” on page 165

Table 15-1: “Restrictions using Archive Cache Server” on page 207

Table 20-1: “Overview of utilities” on page 249

Table 33-1: “Fields in accounting files” on page 317

Table 33-2: “Job numbers and names of requests” on page 317

OpenText Archive Center – Administration Guide xvii


AR160200-00-ACN-EN-03
List of figures
Figure 1-1: “Main components of Archive Center” on page 26

Figure 2-1: “Content capture and storage” on page 30

Figure 2-2: “Content retrieval” on page 31

Figure 2-3: “Logical archives” on page 33

Figure 2-4: “Pool types and storage systems” on page 37

Figure 4-1: “Main objects of the “Archive Server” node” on page 42

Figure 5-1: “Filling the local cache” on page 69

Figure 6-1: “Shadow pools” on page 97

Figure 6-2: “Pool replication” on page 98

Figure 8-1: “Hash tree for ArchiSig timestamps” on page 134

Figure 8-2: “Verification through hash chain” on page 134

Figure 8-3: “Governikus setup” on page 151

Figure 13-1: “Remote Standby scenario” on page 195

Figure 15-1: “Archive Cache Server scenario” on page 206

Figure 15-2: “Example of subnet assignment of Archive Cache Servers”


on page 215

Figure 19-1: “Backup-relevant areas” on page 241

OpenText Archive Center – Administration Guide xix


AR160200-00-ACN-EN-03
Part 1
Overview
Chapter 1
About Archive Center

OpenText Archive Center (short: Archive Center) provides a full set of services for
content and documents. Archive Center can either be used as an integral part of
OpenText™ Content Suite Platform or as stand-alone server in various scenarios.

Note: Archive Server has been renamed to Archive Center.


The term “Archive Server” is still used to denote the core server component of
Archive Center.

For more information about the differences between the scenarios of the “classic”
Archive Server and those that were introduced by Archive Center, see also
“Scenarios leveraging Archive Center Application Layer and web apps“
on page 39.

1.1 About this document


Structure This manual describes all tasks that are relevant after Archive Center is installed on
a computer:

“Overview” on page 21
Read this part to get an introduction of Archive Center, 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 47
This part describes the preparation of the system and the configuration of
Archive Center: logical archives, pools, jobs, security settings, connections to
SAP and scan stations.

“Maintenance” on page 225


Here you find all tasks to keep the system running: how to prepare and handle
storage media, backups and recovery.

“Migration” on page 257


Here you find all information to migrate content from one storage platform to
another.

“Monitoring” on page 289


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 319


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

OpenText Archive Center – Administration Guide 23


AR160200-00-ACN-EN-03
Chapter 1 About Archive Center

problem. If fatal problems occur, you have to contact OpenText Customer


Support.

Audience and This document is written for administrators of Archive Center, 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 Center. The following knowledge is required to take full
advantage of this document:
• Familiarity with the relevant operation system Windows® or UNIX®/Linux®.
• A general understanding of TCP/IP networks, HTTP protocol, network and data
security, and databases.
• 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.

1.1.1 What’s new?


This version features the following:

“Governikus adapter”, page 150


An adapter for Governikus LZA is available in Archive Center since version 16
EP2 (16.2.0).

24 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
1.2. Features of Archive Center

1.2 Features of Archive Center


Archive Center provides a complete set of services for content storage. Supported
scenarios include simple archiving of documents, where the administration is done
by the leading application, up to metadata handling and search for documents by
users. These services incorporate:
• Storing and retrieving content
• Content lifecycle and retention handling
• Storage virtualization
• Caching and Archive Cache Servers
• Single instance archiving
• Long-term preservation and readability
• SecKeys and timestamps
• Compression and encryption
• Backup and replication
• Disaster recovery and high availability

Note: Archive Center supports being installed as an active-active cluster.

In this scenario, the total archiving load can be distributed among multiple
instances (“nodes”) of Archive Center. For more information, see also “Running
Archive Center as a cluster” on page 28.

Flexibility for different business processes


Depending on the business process, the content type and the storage devices,
Archive Center provides different techniques to store and access documents. This
guarantees optimal data and storage resource management. Large or distributed
Content Suite Platform implementations can consist of several Archive Centers. 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 Center – Administration Guide 25


AR160200-00-ACN-EN-03
Chapter 1 About Archive Center

1.3 Main components of Archive Center


The following figure shows the main components of Archive Center 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 Center

Applications

Application or services deliver documents or content to Archive Center using


Archive Services or SAP ArchiveLink®. The applications or services also sent
retrieval requests to get documents back from Archive Center.

Archive Server

Archive Server, the core server component of Archive Center, 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
Centers, including logical archives, storage devices, pools, etc.

26 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
1.4. Important directories on Archive Center

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 Center” on page 27.
• 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 303.
• 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 Center for longtime archiving. See “Storage devices” on page 34.

1.4 Important directories on Archive Center


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 AC>


Directory used for Archive Center program files.
Windows default: C:\Program Files\OpenText\Archive Server 16.2.0
UNIX/Linux default: /opt/opentext/ArchiveServerSoftware_16_2_0

<OT config AC>


Directory used for Archive Center configuration files.
Windows default: C:\ProgramData\OpenText\Archive Server 16.2.0\
config
UNIX/Linux default: /opt/opentext/ArchiveServerConfig_16_2_0

<OT logging>
Directory used for Archive Center log files.
Windows default: C:\ProgramData\OpenText\log
UNIX/Linux default: /var/adm/opentext/log

<OT var>
Directory used for Archive Center variables.
Windows default: C:\ProgramData\OpenText\var
UNIX/Linux default: /var/adm/opentext

OpenText Archive Center – Administration Guide 27


AR160200-00-ACN-EN-03
Chapter 1 About Archive Center

<OT install SPAWNER>


Directory used for Archive Spawner program files.
Windows default: C:\Program Files\Common Files\Open Text\Spawner\bin
UNIX/Linux default: /opt/opentext/spawner

1.5 Running Archive Center as a cluster


If Archive Center runs as a cluster, see the following list for topics that are
particularly important or different compared to a single node installation.

The following marker is used to indicate deviations of a cluster installation:


Cluster topic

Related Topics
• “Features of Archive Center” on page 25
• “Pools and pool types” on page 36
• “Scenarios leveraging Archive Center Application Layer and web apps“
on page 39
• ““Infrastructure” node” on page 42
• “Installing and configuring storage devices” on page 49
• “Adding a single file (VI) device” on page 57
• “Configuring disk volumes” on page 60
• “Creating and modifying disk volumes” on page 61
• “Configuring caches” on page 69
• “Data compression” on page 76
• “Timestamps” on page 133
• “Configuring scan clients for a clustered installation” on page 188
• “Adding and modifying known servers“ on page 191
• “Configuring Archive Cache Server“ on page 205
• “Adding an Archive Cache Server to the environment” on page 209
• “Reassigning the jobs of a node in a cluster installation” on page 247
• “About migration “ on page 259

28 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Chapter 2
Documents, data, logical archives, and jobs

Documents and data to be archived can consist of a number of components.

Example 2-1: Document components

Documents with several components can be:


• A document (main component) with notes and annotations.
• 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 and notes on different hard disks.
Documents are identified by a unique ID. The leading application uses this ID for
content retrieval. Archive Center delivers all components belonging to this ID to the
leading application.

In the “classic” scenarios, Archive Center only stores the content of documents. The
metadata describing the business context of the documents are stored in the leading
application. The link between the metadata and the content is the unique ID
mentioned above.

Note: For information about “extended” scenarios, see “Scenarios leveraging


Archive Center Application Layer and web apps“ on page 39.

Archive Center 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 Center, a multitude of logical archives can be created. Often,


shortly “archive” is used instead of “logical archive.”

OpenText Archive Center – Administration Guide 29


AR160200-00-ACN-EN-03
Chapter 2 Documents, data, logical archives, and jobs

2.1 Content capture and storage


The following description shows a usual way to capture and store content in
scenarios involving a leading application.

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


Center.

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.

30 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
2.2. Content retrieval

2.2 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 Center.

2. Archive Center 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 Center 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.

OpenText Archive Center – Administration Guide 31


AR160200-00-ACN-EN-03
Chapter 2 Documents, data, logical archives, and jobs

2.3 Logical archives


Archive Center 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.

32 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
2.3. 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 36.
• Buffer(s) and disk volumes to store incoming content temporarily; see also “Disk
buffers” on page 34.
• Storage devices and storage volumes for longtime archiving of content; see also
“Installing and configuring storage devices” on page 49.
• Cache to accelerate content retrieval. Only necessary if slow storage devices are
used; see also “Caches” on page 37.
• Retention period for content; see also “Retention” on page 79.
• Compression and encryption settings; see also “Data compression” on page 76
and “Encrypted document storage” on page 128.
• Security settings and certificates; see also “Configuring the archive security
settings” on page 87.

OpenText Archive Center – Administration Guide 33


AR160200-00-ACN-EN-03
Chapter 2 Documents, data, logical archives, and jobs

• An Archive Cache Server, if used; see also “Configuring Archive Cache Server“
on page 205.

2.3.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 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 63


• “Configuring disk volumes” on page 60

2.3.2 Storage devices


Various types of storage devices offered by leading storage vendors can be used by
Archive Center for longtime archiving:

• CAS: Content Addressed Storage


• NAS: Network Attached Storage
• HSM: Hierarchical Storage Management
• SAN: Storage Area Network

Archive Center 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 49


• “Creating and modifying pools” on page 92
• “Pools and pool types” on page 36

34 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
2.3. Logical archives

2.3.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 (enterprise report management) 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
• “Installing and configuring storage devices” on page 49
• “Creating and modifying pools” on page 92
• “Pools and pool types” on page 36

OpenText Archive Center – Administration Guide 35


AR160200-00-ACN-EN-03
Chapter 2 Documents, data, logical archives, and jobs

2.3.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 111.

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 97

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 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 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 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.
Be aware of the following restrictions when using HDSK pools:

• Storage retention (as is required for compliance scenarios) is not possible.


• As no purge jobs will run, HDSK pools lack an additional check for data
completeness.
• You cannot assign shadow pools to HDSK pools.

Cluster topic: If Archive Center runs as an active-active cluster, HDSK pools
are not supported.

Figure 2-4 illustrates the dependencies between pool types and storage systems.

36 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
2.3. Logical archives

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
• “Creating and modifying pools” on page 92
• “Installing and configuring storage devices” on page 49

2.3.5 Caches
Caches are used to speed up the read access to documents. Archive Center can use
several caches: the disk buffer, the local cache volumes and an Archive Cache Server.
The local cache resides on the Archive Center 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 69
• “Configuring disk volumes” on page 60
• “Configuring Archive Cache Server“ on page 205

OpenText Archive Center – Administration Guide 37


AR160200-00-ACN-EN-03
Chapter 2 Documents, data, logical archives, and jobs

2.4 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 115.

38 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Chapter 3

Scenarios leveraging Archive Center Application


Layer and web apps

Archive Center offers a common installation for multi-tenant, integrated archiving.


Archive Center provides basic metadata handling using a CMIS interface and
supports various data sources, like SAP systems or file systems (CIFS).

Note: Archive Center 16 EP2 can be used with or without the Application
Layer (CMIS).

Cluster topic: If Archive Center runs as an active-active cluster, the Application


Layer is not supported.

Without the Application Layer, Archive Center continues the feature set of previous
versions (Archive Server 10.5.0 and before). This guide describes the basic
functionality of Archive Center, which includes both the core scenarios and
scenarios that use the Application Layer and web applications (here called
“extended functionality”).

Further For more information about the extended functionality in regard to tasks for the
information system administrator, see section 7 “Administering the Archive Center server” in
OpenText Archive Center - Scenario Configuration Guide (AR-CGD).

Operating Archive Center with extended functionality runs in one of the following modes: in
mode multi tenant mode (as a public cloud server or as a private cloud server), or in single
tenant mode (on-premises infrastructure). The mode must be chosen during
installation but can be changed later in the OpenText Administration Client. The
operating mode defines default values for certain properties of logical archives. For
more information, see section 1.2 “Operation mode” in OpenText Archive Center -
Scenario Configuration Guide (AR-CGD) and “Default values for the administration
web client” on page 495.

Web clients The extended functionality introduces the following additional web clients:

OpenText™ Archive Center Administration


Allows the tenant administrator (“business administrator”) to configure Archive
Center

OpenText™ My Archive
Allows the tenant’s users to access their documents

OpenText™ Archive Center Access


Allows access to all the tenant’s documents; used for eDiscovery

OpenText Archive Center – Administration Guide 39


AR160200-00-ACN-EN-03
Chapter 4
Administration Client and the main objects of the
“Archive Server” node

4.1 Administration Client


Administration Client is used to configure Archive Center and to perform most of
your administrative work.

Note: Administration Client is intended for system administrators, who


mainly supervise the Archive Server component. In contrast, the business
administrators use the Archive Center Administration web client for their
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 Centers, 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 online help.

Related Topics
• “Scenarios leveraging Archive Center Application Layer and web apps“
on page 39

OpenText Archive Center – Administration Guide 41


AR160200-00-ACN-EN-03
Chapter 4 Administration Client and the main objects of the “Archive Server” node

4.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.

Figure 4-1: Main objects of the “Archive Server” node

4.2.1 “Infrastructure” node


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 63.
To get more information about buffer types, see “Disk buffers” on page 34.

Caches
Caches are used to accelerate the read access to documents. To create caches, see
“Configuring caches” on page 69.

42 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
4.2. Main objects of the “Archive Server” node

Cluster Nodes
Cluster topic: This object shows information about the cluster nodes (for
example, IP addresses and ports).
For more information about cluster topics, see also “Running Archive Center as a
cluster” on page 28.

Storage Devices
Storage devices are used for longtime archiving. To configure storage devices,
see “Installing and configuring storage devices” on page 49.

Disk Volumes
Disk volumes are used for buffers and pools. To configure disk volumes, see
“Configuring disk volumes” on page 60.

4.2.2 “Archives” node


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 75.

Replicated Archives
Shows replicated archives; see “Logical archives” on page 75.

External Archives
Shows external archives of known servers; see “Logical archives” on page 75.

4.2.3 “Environment” node


Within this object, you configure the environment of an Archive Center. 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 205

Known Servers
Known servers are used for replicating archives in remote standby scenarios.
See “Adding and modifying known servers“ on page 191.

SAP Servers
The configuration of SAP gateways and systems to connect SAP servers to
Archive Center. See “Connecting to SAP servers“ on page 175.

Scan Stations
The configuration of scan stations and archive modes to connect scan stations to
Archive Center. See “Configuring scan stations“ on page 181.

OpenText Archive Center – Administration Guide 43


AR160200-00-ACN-EN-03
Chapter 4 Administration Client and the main objects of the “Archive Server” node

4.2.4 “System” node


Within this object, you configure global settings for the Archive Center. 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 301. To receive alerts in the Administration Client, configure the events
and notifications appropriately. See, “Monitoring with notifications“
on page 293.
Events and Notifications
Events and notifications can be configured to get information on predefined
server events. See “Monitoring with notifications“ on page 293.

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 115.

Key Store
The certification store is used to administer encryption certificates, security keys
and timestamps. See “Configuring a certificate for document encryption”
on page 149.

Policies
Policies are a combination of rights which can be assigned to user groups. See
“Checking, creating, or modifying policies” on page 164.

Reports
Reports contains the tabs "Reports" and "Scenarios" which display the generated
reports and available scenarios respectively. See “Scenario reports“ on page 219.

Storage Tiers
Storage tiers designate different types of storage. See “Creating and modifying
storage tiers” on page 111.

Users and Groups


Administration of users and groups. See “Checking, creating, or modifying
users” on page 166 and “Checking, creating, or modifying user groups”
on page 168.

Utilities
Utilities are tools which are started interactively by the administrator; see
“Utilities“ on page 249.

44 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
4.2. Main objects of the “Archive Server” node

4.2.5 “Configuration” node


Within this object, you can set the configuration variables for:

Archive Server
Shows configuration variables related to the Archive Center. 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 221.

For a complete list including short descriptions of all configuration variables, see
“Configuration parameter reference” on page 335.

OpenText Archive Center – Administration Guide 45


AR160200-00-ACN-EN-03
Part 2
Configuration
Chapter 5
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 Center.

3. In the Administration Client:

• Set up the connection between the storage device and Archive Center.
• 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.

5.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 Center 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 5-1
and 5-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 51.
Cluster topic: Container storage is not supported.

OpenText Archive Center – Administration Guide 49


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

• Single file storage: hard disk-based storage devices (“Generalized Store”, GS)
that are connected with an API.
These kinds of devices are also called “single file (vendor interface)” and are
described in “Adding a single file (VI) device” on page 57.

Disk Volumes NAS and local hard disk devices are administered in the Disk Volumes node; see
“Configuring disk volumes” on page 60.

Important
Released and certified storage platforms can be found in the Storage
Platforms Release Notes on My Support (https://knowledge.opentext.com/
knowledge/llisapi.dll/open/12331031).

Table 5-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 5-2: Supported storage devices

Storage device Supported pool types


Single file (VI)
EMC CAS
Write at-once (ISO)
Single file (FS)
EMC Data Domain
Write at-once (ISO)
Single file (FS)
EMC Isilon
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)

Hard Disk Read Only Write at-once (ISO)

50 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.1. Installing and configuring storage devices

Storage device Supported pool types


Write through (HDSK)
Single file (VI)
HDS HCP
Write at-once (ISO)
IBM TSM SSAM Write at-once (ISO)

iTernity Compliant Archive Single file (FS)


Software Write at-once (ISO)
Single file (FS)
NetApp SnapLock
Write at-once (ISO)
Windows Azure Single file (VI)

Note: Storage devices can only be added in the Administration Client, not
edited or deleted.

5.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 Center is described in the following. We assume that the
storage device is ready and an IP connection between Archive Center 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 50.
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 52 and “Retention”
on page 79, respectively.
Click Next.

OpenText Archive Center – Administration Guide 51


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

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). For more
information, see My Support (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!

5.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
Center.

Supported CFS The following Compliant File Systems are supported:


• EMC VNX FLR
• FAST LTA Silent Cubes
• Hard Disk
• Hard Disk Read Only
• iTernity iCAS

52 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.1. Installing and configuring storage devices

• NetApp SnapLock

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 51.

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).
Click Test Connection to verify your settings.

3. Optional To change the Maximum number of slots or the Default retention


(days), click Advanced.
For details, see “Number of slots” on page 52 and “Retention” on page 79,
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 56).

5. In the action pane, click Refresh to update the view in Administration Client.

OpenText Archive Center – Administration Guide 53


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

5.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
“Adding a write at-once (STORM) device” on page 51.
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
Center 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).
Click Test Connection to verify your settings.
3. Optional To change the Maximum number of slots or the Default retention
(days), click Advanced.
For details, see “Number of slots” on page 52 and “Retention” on page 79,
respectively.
4. Click Next and then click Finish.
The EMC Centera device is added in the result pane.

5.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 51.
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).

54 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.1. Installing and configuring storage devices

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 Center 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).

Click Test Connection to verify your settings.


3. Optional To change the Maximum number of slots, click Advanced.
For details, see “Number of slots” on page 52.
4. Click Next and then click Finish.
The IBM TSM SSAM device is added in the result pane.

You can now attach the device; see “Configuring STORM storage devices”
on page 56.

5.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
“Adding a write at-once (STORM) device” on page 51.
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).
Click Test Connection to verify your settings.
3. Optional To change the Maximum number of slots, click Advanced.
For details, see “Number of slots” on page 52.
4. Click Next and then click Finish.
The HDS HCP device is added in the result pane.

You can now attach the device; see “Configuring STORM storage devices”
on page 56.

OpenText Archive Center – Administration Guide 55


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

5.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 92).

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).

5.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:

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 Detach in the action pane.

This device can no longer be accessed and can be turned off. The status is set to
“Detached”.

5.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.

56 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.1. Installing and configuring storage devices

5.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 Center and the device must be
established.

Cluster topic: You cannot use the Add Storage Device wizard in Administration
Client but must configure the device manually.

For details about a specific device, see the section that corresponds to your device
below.

5.1.3.1 Windows Azure


This section describes the setup of Windows Azure as a storage system for Archive
Center. 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.

To add Windows Azure as storage 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 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 AC>/gs/
azure_cert.pem.

Click Next and then click Finish.


A device of type Windows Azure is added in the result pane.

OpenText Archive Center – Administration Guide 57


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

To add a connection to the new storage device:

1. In the result pane, select the Windows Azure device you created before.

2. In the action pane, click Add Connection and enter the following:

Container name
Basically the top-level directory your data is being stored in. <Container> has
a minimum length of 3 characters.

Note: The “Access type” of the created container is set to “Private”.


Ensure that this setting is kept in case you edit the details of your
account in the Azure Management Portal.

Account name
The name of the Windows Azure storage account. This account must be
created using the Azure Management Portal (https://
manage.windowsazure.com/).

Access Key
The Primary Access Key generated after creating the Storage Account.

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 - Windows Azure Installation and Configuration Guide (AR-
information IAZ) for details about the configuration.

5.1.3.2 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:

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.

58 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.1. Installing and configuring storage devices

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.

5. Click Finish to create the new device.

To add a connection to the new storage device:

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
Center 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. 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.

5.1.3.3 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:

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 HDS HCP 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.

OpenText Archive Center – Administration Guide 59


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

5. Click Finish to create the new device.

To add a connection to the new storage device:

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).

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.

5.2 Configuring disk volumes


Prerequisites for hard disk systems

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 used
hardware must comply with the following:

• Enterprise-ready disk arrays are used.


• High-performance and random access to data and file system metadata (for
example, directory structures) is provided.
• Multi-threaded access is provided.
• Standard file system calls (read, write, stat, delete, etc.) always return results
comparable to locally attached hard disks.
• Disks are protected against data loss by backup or similar technologies.

Sizing hints for disk volumes

Number and size of the volumes depend on many factors and are usually defined
together with OpenText experts or partners when the installation is prepared.
Important factors are:

60 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.2. Configuring disk volumes

• 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:
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 69).
• 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). Ensure that the volume is large enough
to store your documents. See “Configuring a volume for single-file storage”
on page 63.
Cluster topic: If Archive Center runs as an active-active cluster, HDSK pools are
not supported.

5.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 Center. 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.
Cluster topic: This dialog looks different when running a cluster. In case of
volumes for buffers you additionally must select the cluster node on which you
want to create the disk volume.

5. Enter the settings:

Volume name
Unique name of the volume

OpenText Archive Center – Administration Guide 61


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

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).

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 63 and the Storage Platform
Release Notes on My Support (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 63
• “Creating and modifying a HDSK (write-through) pool” on page 92

62 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.3. Configuring buffers

• “Creating and modifying pools with a buffer” on page 93

5.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 61 to create a new disk volume.

3. Create buffers and caches as required (see sections below for details).

4. Create logical archive(s) with pools of type Single File (FS); see “Configuring
archives and pools“ on page 75.

5.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 61.

5.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.

3. Enter the settings:

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.

OpenText Archive Center – Administration Guide 63


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

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 303).

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 69.

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 65.

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 122.

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.

64 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.3. Configuring buffers

5.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:

1. Select Buffers in the Infrastructure object in the console tree.

2. Select the designated disk buffer in the top area of the result pane.

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 61.

5. Click OK to attach the volume.

Related Topics
• “Creating and modifying disk volumes” on page 61
• “Creating and modifying a disk buffer” on page 63

5.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:

1. Select Buffers in the Infrastructure object in the console tree.

2. Select the designated disk buffer in the top area of the result pane.

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.

OpenText Archive Center – Administration Guide 65


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

5.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:

1. Select Buffers in the Infrastructure object in the console tree.


2. Select the designated disk buffer in the top area of the result pane.

3. Click Edit Purge Job in the action pane.

4. Enter the settings:

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 122.

5. Click Next.

6. Enter the settings for the selected start mode.

7. Click Finish.

Related Topics
• “Creating and modifying jobs” on page 121
• “Setting the start mode and scheduling of jobs” on page 122

66 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.3. Configuring buffers

5.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:

1. Select Buffers in the Infrastructure object in the console tree.


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.
3. Select the designated disk buffer in the top area of the result pane.
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
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.

OpenText Archive Center – Administration Guide 67


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

7. Click OK.

5.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.

3. Click OK to confirm. The synchronization is started.

5.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.

2. Select the designated disk buffer in the top area of the result pane.

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.

68 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.4. Configuring caches

5.4 Configuring caches


Cluster topic: Caches are not supported.

5.4.1 Overview of cache functionality


Caches are used to speed up the read access to documents. The local cache resides
on the Archive Center 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 205).

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).

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 5-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 71.

Depending on the time when you want to cache documents, you select the
appropriate configuration setting:

OpenText Archive Center – Administration Guide 69


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

Table 5-3: Cache configuration

Enable caching for the Caching option in the archive configuration; see “Configuring the
logical archive archive settings” on page 88
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 63.

Related Topics

• “Adding hard disk volumes to caches” on page 71


• “Creating and deleting caches” on page 70
• “Defining priorities of cache volumes” on page 72

5.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 72.

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 71


• “Defining priorities of cache volumes” on page 72

70 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.4. Configuring caches

5.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:

1. Select Caches in the Infrastructure object in the console tree.


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.
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 72.

Related Topics
• “Configuring caches” on page 69
• “Defining priorities of cache volumes” on page 72

5.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:

1. Select Caches in the Infrastructure object in the console tree.


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. 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 72.

OpenText Archive Center – Administration Guide 71


AR160200-00-ACN-EN-03
Chapter 5 Setting up the infrastructure

Related Topics
• “Configuring caches” on page 69
• “Defining priorities of cache volumes” on page 72

5.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:

1. Select Caches in the Infrastructure object in the console tree.

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 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.

5.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:

1. Select Storage Devices in the Infrastructure object in the console tree.

2. Select the Unavailable Volumes tab in the result pane to list all unavailable
devices.

72 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
5.6. Changing the database user password

5.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 Center > Configuration and search for the
User password of database variable (internal name: AS.DBS.DBPASSWORD;
see “Searching configuration variables” on page 222).

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.

5.7 Setting the reconnection time for the database


By default, Archive Center 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:

1. In the console tree, expand Archive Center > Configuration and search for the
Number of minutes to wait for reconnect variable (internal name:
AS.DBS.MAXWAITTIMETORECONNECTMINUTES; see “Searching
configuration variables” on page 222).

2. Open the Number of minutes to wait for reconnect variable and enter the time
in minutes during which Archive Center tries to reconnect to the database.

Note: The recommended value depends on the scenario.

Click OK.

OpenText Archive Center – Administration Guide 73


AR160200-00-ACN-EN-03
Chapter 6
Configuring archives and pools

Before you can work effectively with Archive Center, 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.

6.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 195).
• 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 191).

OpenText Archive Center – Administration Guide 75


AR160200-00-ACN-EN-03
Chapter 6 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 Archive Cache Server” on page 215).
• 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 227).

6.1.1 Data compression


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 88.

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; see “Searching configuration variables” on page 222).

Pools with For pools using a disk buffer, the Write job compresses the data in the disk buffer
buffer (unless Archive Center Proxy was used). The job then copies the compressed data to
the medium. After compressing a file, the job deletes the corresponding
uncompressed file.

Note: From version 16 on, Write jobs do not compress or encrypt data
anymore if the new compression/encryption format is present, that is if
Archive Center Proxy was used to encrypt or to compress the documents
before.
This means that documents that were only compressed on Archive Center
Proxy will not be encrypted on Archive Center.

With the introduction of OpenText™ Archive Center Proxy and the option to install
Archive Center as a cluster, only the new, streaming-enabled format is supported.

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

76 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.1. Logical archives

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.

Important
Compress jobs are only allowed for HDSK write-through pools. Do not create
Compress jobs for any other kind of volume!

Cluster topic: You must not enable compression for HDSK pools.

6.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 Center 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 88.

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 79.

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:

1. Start Administration Client.

2. In the console tree, expand Archive Center > Configuration and search for the
List of component/application types that are NOT using SIA variable (internal
name: AS.DS.SIA_TYPES; see “Searching configuration variables”
on page 222.

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.

OpenText Archive Center – Administration Guide 77


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

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 Center. As soon as an email is retrieved from Content
Server, it is checked whether the email needs to be recomposed. If so, the
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:

1. Start Administration Client.

2. Change the following variables if required.


For a description of how to set, modify, delete, and search configuration
variables, see “Setting configuration variables“ on page 221.

• 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)

78 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.1. Logical archives

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.

6.1.3 Retention
Introduction This part explains the basic retention handling mechanism of Archive Center.
OpenText strongly recommends reading this part if you use retention periods for
documents. For more information about administering retention, see “Configuring
the archive retention settings” on page 89.

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
Center 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 Center 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.

6.1.3.1 Basics – retention on Archive Center


Introduction Retention handling enables a leading application to implement retention
management and pass retention periods to Archive Center. Archive Center 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 Center 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

OpenText Archive Center – Administration Guide 79


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

behavior) during the creation of a document. Archive Center 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 Center. 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 89).
• When the retention period has expired, the leading application has to trigger the
deletion of the document. Archive Center 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 Center only reacts to requests sent by the leading application. That is why
we talk about retention handling in Archive Center. Thereby, we avoid the situation
that a leading application still might have index information for documents already
deleted in Archive Center.

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 257.

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 222; internal variable name: ADDON_NAMES (row1 to.rowN).

Compliance Archive Center 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 Center 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 Center (i.e. no retention is set at
the archive).

80 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.1. Logical archives

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 Center (see
“Configuring the archive retention settings” on page 89).

Table 6-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 Center 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 89):

Table 6-2: Retention behavior settings

Setting Description
Deferred Deferred archiving prevents Archive Center 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 Center, 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.

OpenText Archive Center – Administration Guide 81


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

Related Topics

• “Configuring the archive retention settings” on page 89


• “When the retention period has expired” on page 227

6.1.3.2 Retention on storage systems


Introduction The retention period is set for each document within the Archive Center 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 Center 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 77.
• You cannot export volumes containing at least one document with
nonexpired 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 6-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.

82 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.1. Logical archives

6.1.3.3 Document deletion


Document When the retention period has expired, Archive Center allows the client to delete the
deletion document. The leading application must send the deletion request.

Note: You can also use the AutoDelete job to find and remove documents
with expired retention. For more information, see “Other jobs” on page 118.

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 88) and
• The maintenance level of Archive Center (see “Setting the operation mode of
Archive Center” on page 328).

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 Center. 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.

OpenText Archive Center – Administration Guide 83


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

• For documents: The document information in Archive Center is deleted (as all
component information is already deleted).
• For components: The component information in Archive Center 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 Center.

The purging capabilities depend on storage system and pool type. The following
table lists the purge behavior depending on the pool type.

Table 6-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 6-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).

84 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.1. Logical archives

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 Center 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.

6.1.3.4 Volume migration and retention


Volume migration 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 volume migration.

Note: Fast volume migration 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.

OpenText Archive Center – Administration Guide 85


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

• 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.

6.2 Creating and configuring logical archives


On each Archive Center, one or more logical archives can be created. To do so,
follow these main steps:

1. “Creating a logical archive” on page 86


2. “Configuring the archive security settings” on page 87
3. “Configuring the archive settings” on page 88
4. “Configuring the archive retention settings” on page 89
5. “Activating and configuring timestamp usage” on page 90
6. “Creating and modifying storage tiers” on page 111
7. “Creating and modifying pools” on page 92

6.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 75.
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.

86 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.2. Creating and configuring logical archives

General The description of the new archive can be viewed and modified (open Properties in
information the action pane and select the General tab).

6.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 126.
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
Centers, 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

OpenText Archive Center – Administration Guide 87


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

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 Center. This central setting has priority over the archive setting.
See also “Setting the operation mode of Archive Center” on page 328.
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.

6.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:

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 Settings tab. Check the settings and modify them, if needed.

Compression
Activates data compression for the selected archive.
See also “Data compression” on page 76.
Encryption
Activates the data encryption to prevent that unauthorized persons can
access archived documents.
See also “Encrypted document storage” on page 128.
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.
Single instance
Enables single instance archiving.
See also “Single instance” on page 77.

88 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.2. Creating and configuring logical archives

Deferred archiving
Select this option, if the documents should remain in the disk buffer until
the leading application allows Archive Center 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 313).

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 70
and “Configuring caches” on page 69).

Important
After assigning a cache to an archive you must restart Archive
Center.

4. Click OK to resume.

6.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 Center accepts and executes deletion requests
from the leading application.

To configure the retention of a logical 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 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.

No retention – read only


Like No retention, but documents cannot be changed.

OpenText Archive Center – Administration Guide 89


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

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 that do not use
the metadata services, the leading application must trigger the deletion.
See also OpenText Archive Center - Scenario Configuration Guide (AR-CGD).

4. Click OK to resume.

Important
Documents with expired retention period are only deleted
• if document deletion is allowed; see “Configuring the archive security
settings” on page 87, and
• if no maintenance mode is set; see “Setting the operation mode of Archive
Center” on page 328.

Related Topics
• “Retention” on page 79
• “When the retention period has expired” on page 227

6.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.

90 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.2. Creating and configuring logical archives

To configure timestamps of a logical 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 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 Center 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 133.

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.
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.

5. Click OK to resume.

OpenText Archive Center – Administration Guide 91


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

6.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 on My Support (https://
knowledge.opentext.com/knowledge/llisapi.dll/open/12331031)).

Background
• “Pools and pool types” on page 36

6.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 86.

To create a HDSK pool:

1. Select Original Archives in the Archives object in the console tree.


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 75.
5. Select Write through (HSDK) and click Next.

92 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.3. Creating and modifying pools

6. Select a Storage tier (see “Creating and modifying storage tiers” on page 111).
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 61).

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 115.

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.

6.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:

1. Select Original Archives in the Archives object in the console tree.

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 (per archive), descriptive Pool name. Consider the naming
conventions; see Naming rule for archive components on page 75

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 94


• “Single file (VI, FS) pool settings” on page 96

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 61).
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 115.

OpenText Archive Center – Administration Guide 93


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

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.

6.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 111).

Buffering

Used disk buffer


Select the designated buffer (see “Configuring buffers” on page 63).

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 115.
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, $

94 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.3. Creating and modifying pools

(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 222). 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 on My Support (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/12331031).

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 Center 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 Center. 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
• “Creating and modifying pools with a buffer” on page 93

OpenText Archive Center – Administration Guide 95


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

• “Pools and pool types” on page 36

6.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 111).

Buffering

Used disk buffer


Select the designated buffer (see “Configuring buffers” on page 63).

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 115.

Documents written in parallel


Number of documents that can be written at once.

Related Topics

• “Creating and modifying pools with a buffer” on page 93


• “Pools and pool types” on page 36

6.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:

1. Select Original Archives in the Archives object in the console tree.

2. Select the designated archive in the console tree.

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.

96 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.3. Creating and modifying pools

6.3.4 Creating and configuring shadow pools


You can create 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, and VI.

Pool cluster 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 6-1: Shadow pools

Requirements for 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.

OpenText Archive Center – Administration Guide 97


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

Note: When logical archives are replicated, only the original pools are
replicated. Shadow pools assigned to the original pools are not replicated.

Original Archive Server Replicate Archive Server

A1 A1 ~

P1 P2 P3 P1~ P2~ P3~

P1' P2' P2' '

Figure 6-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.

98 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.3. Creating and modifying pools

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
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 104).

Creating shadow pools


To create a shadow pool:

1. Select Original Archives in the Archives object in the console tree.

2. Select the designated archive in the console tree.

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 75.

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 100


• “Write at-once (ISO) shadow pool” on page 101
• “Single file (VI) shadow pool” on page 103

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 61).

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 115.

OpenText Archive Center – Administration Guide 99


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

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.

6.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 115.

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 104). 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


Select the designated buffer (see “Configuring buffers” on page 63).

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 63).
• 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.

100 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.3. Creating and modifying pools

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 115.

Documents written in parallel


Number of simultaneously written documents.

Related Topics

• “Creating and modifying pools with a buffer” on page 93


• “Pools and pool types” on page 36

6.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
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 115.

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 104). 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


Select the designated buffer (see “Configuring buffers” on page 63).

OpenText Archive Center – Administration Guide 101


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

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 63).
• 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
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 115.

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 222). 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 on My Support (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/12331031).

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.

102 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.3. Creating and modifying pools

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 Center 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.

Related Topics
• “Creating and modifying pools with a buffer” on page 93
• “Pools and pool types” on page 36

6.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
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 115.

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 104). 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


Select the designated buffer (see “Configuring buffers” on page 63).

OpenText Archive Center – Administration Guide 103


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

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 63).
• 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
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 115.
Documents written in parallel
Number of simultaneously written documents.

Related Topics
• “Creating and modifying pools with a buffer” on page 93
• “Pools and pool types” on page 36

6.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 106.
• 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 105.

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.

104 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.3. Creating and modifying pools

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.
• 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.
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.

6.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.

OpenText Archive Center – Administration Guide 105


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

6.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.

1. Select Original Archives in the Archives object in the console tree.


2. Select the designated archive in the console tree.
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.

6.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 107).
2. Use the Clear Shadow Copy Errors utility to clear shadow copy errors from the
Copy job (see “Clearing shadow copy errors” on page 107).

106 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.3. Creating and modifying pools

3. Run the Copy job again.

6.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 106).

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.

6.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 106).

• 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 108.

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:

OpenText Archive Center – Administration Guide 107


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

• 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 107).

2. Check if the respective components do no longer exist on the Archive Center.

3. Use the Clear Shadow Copy Errors utility (see “Clearing shadow copy errors”
on page 107).

• 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.

108 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.3. Creating and modifying pools

• Click Run.

6.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 60).

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 67).
3. Restart the dsaux spawner service.
> spawncmd restart dsaux

OpenText Archive Center – Administration Guide 109


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

4. Create an additional disk buffer (see “Configuring buffers” on page 63).


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 97).

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 105).
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 105).

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 65).

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 230).

11. Attach the spare hard disk volumes (see step 1) to the new original pool’s disk
buffer.

110 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.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.

6.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 6-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

• “Creating and modifying pools” on page 92

OpenText Archive Center – Administration Guide 111


AR160200-00-ACN-EN-03
Chapter 6 Configuring archives and pools

6.5 Enabling certificates


For each archive, one or several authentication certificates can be enabled (or
disabled, if required).

For more information, see “Configuring a certificate for authentication”


on page 146.

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.

112 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
6.6. Changing the server priorities

6.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 197.

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.

OpenText Archive Center – Administration Guide 113


AR160200-00-ACN-EN-03
Chapter 7
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 Center are set up during installation of an Archive
Center.
• 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.

7.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 119 below for further
details on the pagelist job.

Table 7-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 315.

OpenText Archive Center – Administration Guide 115


AR160200-00-ACN-EN-03
Chapter 7 Configuring jobs and checking job protocol

Name Command Description


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 243.
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 313. 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 123.
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
Center Statistics” on page 307.
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 222).

116 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
7.1. Important jobs and commands

Name Command Description


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 287
SYS_REFRESH_ARCHIVE Refresh_Archive_In Synchronizes the configuration
fo information of the known
Archive Centers
SYS_RETRY_ATTRIBUTE_MI AttribAtrMigration Retries the attribute migration
GRATION for failed migrations

Table 7-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 63.

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.

Note: Customizing parameters must be added to the command


as last argument. Example: Compress_HDSK -c

OpenText Archive Center – Administration Guide 117


AR160200-00-ACN-EN-03
Chapter 7 Configuring jobs and checking job protocol

Command Description
ShadowCopy Copies the documents of an original pool to the specified shadow
pool.

Table 7-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 Center. The Copy_Back job is disabled by default and must
only be enabled for Archive Centers with enabling “write back” mode.
See “Configuring Archive Cache Server“ on page 205.

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.

Note: Customizing parameters must be added to the command


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 257.
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 133.
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 119 below.

118 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
7.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 more information, see OpenText Document Pipelines - Overview and
Import Interfaces (AR-CDP).

7.1.1 Configuring security settings for pagelist job


For secure pagelist job handling, a certificate is required.

The certificate is sent to the Archive Center with the putCert command or imported
with the Import Certificate for Authentication utility (see “Configuring a certificate
for authentication” on page 146). You can use the certtool utility (command line)
to create a certificate, or to generate a request to get a trusted certificate. For more
information, see “Creating a certificate using the Certtool” on page 144.

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 AC>\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.

Background
• “Certificates” on page 141

7.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 122). 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.

OpenText Archive Center – Administration Guide 119


AR160200-00-ACN-EN-03
Chapter 7 Configuring jobs and checking job protocol

To start and stop certain jobs, see “Starting and stopping jobs” on page 120.

7.3 Starting and stopping jobs


Jobs can also be started and stopped manually if necessary.

To start or stop jobs:

1. Select Jobs in the System object in the console tree.

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.

7.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:

1. Select Jobs in the System object in the console tree.

2. Select the Jobs tab in the top area of the result pane. The jobs are listed.

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.

7.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.

2. Select the Jobs tab in the top area of the result pane. The jobs are listed.

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 121.

120 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
7.6. Creating and modifying jobs

7.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 97. The name of a Copy
job is specified during the creation of the shadow pool and can be modified later.

To create a job:

1. Select Jobs in the System object in the console tree.

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 115.

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 115.

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 122.

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.

OpenText Archive Center – Administration Guide 121


AR160200-00-ACN-EN-03
Chapter 7 Configuring jobs and checking job protocol

7.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 121.

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.

122 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
7.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.

7.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 Center 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
configuration variables” on page 222).

To check the last message of a job:

1. Select Jobs in the System object in the console tree.

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:

1. Select Jobs in the System object in the console tree.

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.

OpenText Archive Center – Administration Guide 123


AR160200-00-ACN-EN-03
Chapter 7 Configuring jobs and checking job protocol

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 Center. It provides more detailed information
about how the job was terminated in case of an error.

To clear the protocol list:

1. Select Jobs in the System object in the console tree.

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.

124 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Chapter 8
Configuring security settings

8.1 Overview of security topics


Introduction Archive Center 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 126)
• Protection of files and documents (see “Encrypted document storage”
on page 128)
• Timestamps to ensure that documents were not modified unnoticed in the
archive (see “Timestamps” on page 133 and “Configuring Archive Timestamp
Server“ on page 201)

These methods make use of


• Certificates, for authentication, encryption, and timestamps (see “Certificates”
on page 141)
• Checksums to recognize and reveal unwanted modifications to the documents on
their way through the archive (see “Using checksums” on page 158)

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 on My
information Support (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 335, in particular:
• “Archive Server“ on page 343
• “Security settings” on page 384
• “Key Export Tool (RCIO)” on page 395
• “Timestamp Server (TSTP)” on page 445

Protecting from computer viruses

To archive “clean” documents, you must protect the documents from viruses
before archiving. Archive Center does not perform any checks for viruses. To

OpenText Archive Center – Administration Guide 125


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

ensure error-free work of Archive Center, 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 Center is using them.

8.2 Authentication using signed URLs


Signed URL Archive Center 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 Center 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 141.

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 Center. In
addition, the administrator must configure the usage of SecKeys on the Archive
Center.

SecKey usage A SecKey requests the right of access. When a document is accessed, Archive Center
checks whether the SecKey should be checked.

Procedure

• “Activating SecKey usage for a logical archive” on page 126


• “SecKeys from leading applications and components” on page 127
• “SecKeys from SAP” on page 128
• “Configuring a certificate for authentication” on page 146

8.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.

126 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.2. Authentication using signed URLs

To activate SecKeys:

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 them, if needed.

Authentication (SecKey) Required To


Set the archive-specific access permissions:

• Read documents
• Update documents
• Create documents
• Delete documents

4. Click OK to resume.

8.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 Center. Client
programs of Archive Center, 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 144 and “Request a certificate from a trust center ” on page 145).
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 Center uses to verify the signatures.

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 Center use one of the following
options:

• Import the certificate; see “Importing an authentication certificate”


on page 147.

OpenText Archive Center – Administration Guide 127


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

Or:
• Send the certificate with the putcert command; see “Send the certificate to
an Archive Center (putCert)” on page 145.

Repeat this step if you want to use the certificate for several archives.

4. Enable the certificate; see “Enabling a certificate” on page 143.

Procedure

• “Activating SecKey usage for a logical archive” on page 126


• “Creating a certificate using the Certtool” on page 144
• “Configuring a certificate for authentication” on page 146

8.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 Center.

To configure SecKey usage for SAP systems:

1. Create private key and certificate on the application side.

2. Send the certificate to Archive Center using the OAHT transaction. There, you
enter the target Archive Center and the archives for which the certificate is
valid.

3. Follow the instructions in “Configuring a certificate for authentication”


on page 146.

8.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. For more information, see “Activating encryption usage for a
logical archive” on page 129.

For document encryption, a symmetric key (system key) is used. The administrator
creates this system key and stores it in the Archive Center's keystore. The system key
itself is encrypted on the Archive Center with the Archive Center’s public key and
can then only be read with the help of the Archive Center's private key. RSA
(asymmetric encryption) is used to exchange the system key between the Archive
Center and the remote standby server.

128 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.3. Encrypted document storage

Keys per One system key can be active for all archives of Archive Center or each archive can
archive use its own key. 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. For more information, see “Data compression” on page 76.
HDSK pools
(write through)
Procedure
• “Activating encryption usage for a logical archive” on page 129
• “Creating a system key for document encryption” on page 129
• “Exporting and importing system keys” on page 131
• “Configuring a certificate for document encryption” on page 149

8.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 129.

To activate encryption usage:

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. Activate Encryption (mark the check box).

4. Click OK to resume.

8.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 149).

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.

OpenText Archive Center – Administration Guide 129


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

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. Application Layer 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
reimported at least to restore the complete key store (Number of required
token files).

Notes
• Specifying the system key folder is required for scenarios using the
Application Layer. 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 the Application Layer: 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 131).

6. Make a backup of the key/certificate pair used by recIO to encrypt the System
Keys:
Copy the <OT config AC>/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 Centers 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 131.

130 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.3. Encrypted document storage

8.3.3 Exporting and importing system keys


The contents of the System key node (all keys) of an Archive Center can be exported
and imported with the recIO command line tool. The program must be executed
directly on the Archive Center.

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: recIO (release) 10.5.0.332
IMPORTANT: -----------------------------------------------------
recIO 10.5.0.332 Copyright ¬ 2013 Open Text Corporation
Please authenticate!
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
Token[2/5] (default = A:\ixoskey.pem )
File (CR to accept above) : Z:\share\otaskey2.pem
Token[3/5] (default = A:\ixoskey.pem )
File (CR to accept above) : Z:\share\otaskey3.pem
Token[4/5] (default = A:\ixoskey.pem )
File (CR to accept above) : Z:\share\otaskey4.pem
Token[5/5] (default = A:\ixoskey.pem )
File (CR to accept above) : Z:\share\otaskey5.pem

V
Verifies the contents of the System key node against the exported files.

OpenText Archive Center – Administration Guide 131


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

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 Center.

Example:
C:\Program Files\OpenText\Archive Server 10.5.0\bin>recIO V
IMPORTANT: -----------------------------------------------------
IMPORTANT: recIO (release) 10.5.0.332
IMPORTANT: -----------------------------------------------------
recIO 10.5.0.332 Copyright ¬ 2013 Open Text Corporation
Please authenticate!
User :dsadmin
Password :
Token[1/?] (default = A:\ixoskey.pem)
File (CR to accept above) : Z:\share\otaskey2.pem
Token[2/3] (default = A:\ixoskey.pem)
File (CR to accept above) : Z:\share\otaskey3.pem
Token[3/3] (default = A:\ixoskey.pem)
File (CR to accept above) : Z:\share\otaskey4.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: recIO (release) 10.5.0.332
IMPORTANT: -----------------------------------------------------
recIO 10.5.0.332 Copyright ¬ 2013 Open Text Corporation
Token[1/?] (default = A:\ixoskey.pem)
File (CR to accept above) : Z:\share\otaskey2.pem
Token[2/3] (default = A:\ixoskey.pem)
File (CR to accept above) : Z:\share\otaskey3.pem
Token[3/3] (default = A:\ixoskey.pem)
File (CR to accept above) : Z:\share\otaskey5.pem
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 Center's public key
and sent to the administration server. The results are displayed. Keys already
contained in the Archive Center's store are not overwritten.

Example:
C:\Program Files\OpenText\Archive Server 10.5.0\bin>recIO I
IMPORTANT: -----------------------------------------------------
IMPORTANT: recIO (release) 10.5.0.332
IMPORTANT: -----------------------------------------------------
recIO 10.5.0.332 Copyright ¬ 2013 Open Text Corporation
Please authenticate!
User :dsadmin
Password :
Token[1/?] (default = A:\ixoskey.pem)
File (CR to accept above) : Z:\share\otaskey5.pem
Token[2/3] (default = A:\ixoskey.pem)
File (CR to accept above) : Z:\share\otaskey4.pem
Token[3/3] (default = A:\ixoskey.pem)
File (CR to accept above) : Z:\share\otaskey2.pem

132 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.4. Timestamps

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

8.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 Center can verify whether the component was modified after
storing it by looking at the signature. Archive Center 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 Center supports the following types of timestamps:


• ArchiSig timestamps
• Document timestamps (old)

Cluster topic: Timestamps are not supported.

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

OpenText Archive Center – Administration Guide 133


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

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 8-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 8-2).

Hash Hash Hash Timestamp


h1=H(d1) h2=H(d2) h6=H(h3|h4) t=TSP(h7)

Document d1

Figure 8-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 Center versions. You can migrate these timestamps to ArchiSig timestamps;
see “Migrating existing document timestamps” on page 141.

134 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.4. Timestamps

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 88. 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 140 and “Renewing
hash trees” on page 140.

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 201

Procedure
• “Basic timestamp settings” on page 135
• “Activating and configuring timestamp usage” on page 90
• “Creating a hash tree” on page 139
• “Configuring a certificate for timestamp verification” on page 149

8.4.1 Basic timestamp settings


TSAs Archive Center supports the following Time Stamping Authorities (TSA):
• exceet (former AuthentiDate)
• QuoVadis
• Keyon true-Sign

Configuration The following description includes the most relevant parameters for ArchiSig
timestamps. In general, you do not need to modify the further parameters described
in “Configuring connection parameters” on page 136.

To check and modify configuration variables:

1. Select Configuration, and one by one, search for the following variables (see
“Searching configuration variables” on page 222).

OpenText Archive Center – Administration Guide 135


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

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 136.

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 201.

8.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 202.

8.4.2.1 exceet (AuthentiDate) over the Internet


Introduction exceet offers qualified timestamps over the Internet. This kind of service provides
the highest level of trustworthiness.

exceet uses an authentication system with user name/password. The connection


must therefore be made using SSL/TLS.

ArchiSig Configuration recommendation:


timestamps
Connection method (internal name: TS_CONNECTION)
Use HTTPS (HTTP over SSL).
Timestamp server port (internal name: TS_PORT)
By default, exceet uses port 443. See the exceet service description for details.

136 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.4. Timestamps

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).

Path for HTTP Timestamp request URLs (internal name: TS_HTTP_PATH)


Path for HTTP timestamp request URLs; see the exceet 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
exceet service description for details.

Password for HTTP Timestamp request (internal name: TS_AUTH_PASSWORD)


Password provided by exceet.

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.

8.4.2.2 QuoVadis
Introduction QuoVadis offers qualified timestamps over the Internet. This kind of service
provides the highest level of trustworthiness.

ArchiSig Configuration recommendation:


timestamps
Connection method (internal name: TS_CONNECTION)
Use HTTP.

Timestamp server port (internal name: TS_PORT)


Use 80.

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 Classic timestamps are neither supported nor recommendable with a timestamping
(old) service over the Internet.

OpenText Archive Center – Administration Guide 137


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

8.4.2.3 Keyon true-Sign


Introduction Keyon offers qualified timestamps as part of their central signature service “true-
Sign”.

ArchiSig Configuration recommendation:


timestamps
Connection method (internal name: TS_CONNECTION)
Use HTTP.

Timestamp server port (internal name: TS_PORT)


Use the port configured in the true-Sign server configuration.

Hostname of the timestamp server (internal name: TS_HOST)


Hostname or IP address of the true-Sign server.

Format of used timestamps (internal name: TS_FORMAT)


Use RFC 3161 (IETF).

Path for HTTP Timestamp request URLs (internal name: TS_HTTP_PATH)


Use /rfc3161/.

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)


Use the port configured in the true-Sign server configuration.

Mode of the Timestamp Server (internal name: TIME_STAMP_MODE)


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:
Connection: close

138 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.4. Timestamps

8.4.3 Configuring certificates and signature keys


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

Timeproof timestamp server


The certificate is automatically stored on the Archive Center 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 150.
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 150.

3. Enable the new certificate. See “Enabling a certificate” on page 143.

8.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 115.

OpenText Archive Center – Administration Guide 139


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

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.

8.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.

8.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 Center, and enable it in the Timestamp Certificates
tab in System > Key Store > Certificates.
For more information, see “Timestamps” on page 133.

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).

140 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.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.

8.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 135.

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.

8.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 Center uses certificates for various use cases:
cases
• Authentication certificates, used for signed URLs; see “Configuring a certificate
for authentication” on page 146.

OpenText Archive Center – Administration Guide 141


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

• Encryption certificates, used for document encryption; see “Configuring a


certificate for document encryption” on page 149.
• Timestamp certificates, used for document verification; see “Importing a
certificate for timestamp verification” on page 150.

PEM files Privacy Enhanced Mail Security Certificate (PEM) files are encoded certificate files
used to store the public key and the certificate. Archive Center 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 143.

8.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

8.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 Center 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 143).

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.

The following procedure describes the manual verification by checking the


fingerprint.

142 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.5. Certificates

To check a certificate:

1. Select Key Store in the System object of the console tree.

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.

8.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 142). If required, you can disable a certificate.

To enable a certificate:

1. Select Key Store in the System object of the console tree.

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 certificate by its name and click Enable in the action pane.

OpenText Archive Center – Administration Guide 143


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

8.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:

1. Select Key Store in the System object of the console tree.

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 Delete
Certificate in the action pane.

4. Confirm the upcoming message with OK.

8.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 144 Generate self-signed certificates.


• “Request a certificate from a trust center ” on page 145 Request a certificate from
a trust center (optional).
• “Send the certificate to an Archive Center (putCert)” on page 145 Send the
certificate to an Archive Center (optional, putcert).

Provisioning The platform-specific Certtool is included in the delivery of Archive Center.

If you have to manage a large number of certificates, make sure that the AuthIDs and
the names of the certificates are unique.

Table 8-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

144 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.5. Certificates

CN optional Common name, resp. hostname of your Archive


Center. 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 Center

Table 8-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
Center. 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 Center

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 8-3: Send the certificate to an Archive Center (putCert)

certtool putCert <certInFile> <server> <port> <archive> <id>


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

OpenText Archive Center – Administration Guide 145


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

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
Administration Client

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
Center.

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 Center.
The following prompt is displayed: command: _

2. Enter the following command:


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

3. Enter the following command:


putCert -a <archive> -f <file>
For the <archive> variable, enter the logical archive on the Archive Center 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.

8.5.2 Configuring a certificate for authentication


Authentication certificates are used for signed URLs. A certificate can be used by
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 Center.

146 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.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 Center.

Procedure
• “Importing an authentication certificate” on page 147
• “Granting privileges for a certificate” on page 148
• “Checking a certificate” on page 142
• “Enabling a certificate” on page 143
• “Generate self-signed certificates” on page 144
• “Send the certificate to an Archive Center (putCert)” on page 145

8.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 Center.

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. In the action pane, click Import Authentication Certificate.


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 Center 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 250.

OpenText Archive Center – Administration Guide 147


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

8.5.2.2 Granting privileges for a certificate


Certificates comprise a set of privileges related to the access mode of documents.
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 87)

To grant privileges:

1. Select Key Store in the System object of the console tree.

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
• Create documents
• Update documents
• Delete documents
• Pass by
This privilege is evaluated in Enterprise Library scenarios, for example. Pass
by must be set for the certificate of the

• Archive Storage Provider


• Enterprise Library Proxy Services (if used)
• Rendition Services (if used)
• Governikus (TR-Esor) scenario

Pass by must not be set for all other kinds of client certificates, for example,
SAP.

5. Click OK to confirm changes.

148 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.5. Certificates

8.5.3 Configuring a certificate for document encryption


Encryption certificates are used to encrypt the System Key node of the Key Store
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


With the Set Encryption Certificates utility, you replace the server key and the
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 250.

Procedure
• “Generate self-signed certificates” on page 144
• “Send the certificate to an Archive Center (putCert)” on page 145
• “Importing an encryption certificate” on page 149
• “Checking a certificate” on page 142
• “Enabling a certificate” on page 143

8.5.4 Configuring a certificate for timestamp verification


Timestamp certificates are used for timestamp verification.

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 139.

OpenText Archive Center – Administration Guide 149


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

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 250.

Procedure
• “Importing a certificate for timestamp verification” on page 150
• “Checking a certificate” on page 142
• “Enabling a certificate” on page 143

8.6 Governikus adapter


Archive Center supports Governikus. It allows customers to set up a TR-Esor
compliant solution for long-term storage of data, which is able to preserve its
evidentiary value.

New: An adapter for Governikus LZA is available in Archive Center since


version 16 EP2 (16.2.0).

When Archive Center sends a document to Governikus LZA for archiving,


Governikus will in turn use Archive Center as a permanent storage for the TR-Esor
XAIP (XML-formatted Archival Information Packages), and resulting data and
metadata files. These files will be put into the same logical archive previously used
as target for archiving by the leading application.

150 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.6. Governikus adapter

+
Write Read Read
Content
Archive Center Governikus LZA

Governikus Write API


ICS
Service Storage API

+
Content + XAIP
Storage System

Figure 8-3: Governikus setup

Prerequisites The Governikus infrastructure consists of Governikus Service Components (SC) and
Governikus LZA. Governikus SC provides core functionality (like cryptography as a
service, Certificate Authority verification). Governikus LZA provides the ArchiSig/
ArchiSafe modules, with which Archive Center communicates. For more
information, see the Governikus website (https://www.governikus.de/produkte-
loesungen/).

Any certificates used for signature validation must be imported globally and have
the “Pass By” flag set.

Setup Setting up Governikus support for Archive Center comprises the following steps:

1. Enable the adapter framework on Archive Center.

2. Configure the Governikus adapter on Archive Center.

3. Deploy the JCA Resource Adapter and configure the Storage Module in
Governikus LZA.

Error log Error messages will be written to the as.log file.

Related Topics

• “Granting privileges for a certificate” on page 148

OpenText Archive Center – Administration Guide 151


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

8.6.1 Enabling the adapter framework


The adapter framework is disabled by default.

To enable the adapter framework:

1. In Administration Client, set the following configuration variables.


For a description of how to set, modify, delete, and search configuration
variables, see “Setting configuration variables“ on page 221.

a. As the value of the TR-ESOR Provider configuration variable (internal


name: AS.ICS.TRESOR_PROVIDER, enter GOVERNIKUS (case-sensitive).
Allowed values are NONE or GOVERNIKUS.
b. As the value of the TR-ESOR Archives configuration variable (internal
name: AS.ICS.TRESOR_ARCHIVES, enter a comma-separated list of the
logical archives to be enabled for TR-Esor archiving.

2. Open the <OT config AC>/tr-esor/tresor_factory.properties file in an


editor.

3. Add or adapt the following properties:

Important
Each property name must start with the same case-sensitive string used
to set up the TRESOR_PROVIDER as described in Step 1.a.

GOVERNIKUS_API_DIR
Directory containing the Governikus client libraries and APIs. The path can
be a relative path in <Catalina home>. Use Java path notation with slashes (/).

Important
Do not put adapter client classes in any of classpath directories
configured in Tomcat.

GOVERNIKUS_ADAPTER_CONFIG
Name of the configuration file for the Governikus adapter. The name must
match the file configured in “Configuring the Governikus adapter”
on page 153. Default value: GOVERNIKUS.Setup

Example:

# Preconfigured GOVERNIKUS Adapter Factory


GOVERNIKUS=com.opentext.ecm.asm.ics.service.tresor.governikus.v1.
GovernikusAdapterFactory

# Preconfigured GOVERNIKUS adapter jar file containins factory


and adapter
GOVERNIKUS_ADAPTER_JAR=lib/governikus_adapter.jar

# Set this to a directory containing the GOVERNIKUS client


libraries and APIs

152 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.6. Governikus adapter

# This may be a relative path in catalina.home - use java path


with "/"
# CAUTION: DO NOT PUT ADAPTER CLIENT CLASSES IN ANY OF THE
TOMCAT PRECONFIGURED CLASSPATH DIRECTORIES
GOVERNIKUS_API_DIR=C:/tomcat9/tr-esor/governikus

# Preconfigured GOVERNIKUS adapter configurations (Keystores,


URIs, etc...)
GOVERNIKUS_ADAPTER_CONFIG=GOVERNIKUS.Setup

8.6.2 Configuring the Governikus adapter


The Governikus client adapter requires a set of adapter-specific configuration
properties. The following properties need to be configured:

To configure the adapter framework:

1. Open the <OT config AC>/tr-esor/GOVERNIKUS.Setup file in an editor.


2. Edit the following properties:

GOV_ARCHISAFE_URL
TR-Esor ArchiSafe URL:
GOV_ARCHISAFE_URL=https://
<governikus_lza_host>:<governikus_lza_port>/archisafe/esor/
exec?wsdl

Example: GOV_ARCHISAFE_URL=https://governikus:8444/archisafe/
esor/exec?wsdl

GOV_ARCHISAFE_SEARCH_URL
TR-Esor Archisafe Search URL:
GOV_ARCHISAFE_SEARCH_URL=https://
<governikus_lza_host>:<governikus_lza_port>/archisafe/search?
wsdl

Example: GOV_ARCHISAFE_SEARCH_URL=https://governikus:8444/
archisafe/search?wsdl

The following three properties must be set up in the Governikus LZA


configuration as LZA Authority, which is allowed to read, write, and delete
documents. They define a “technical” user for the communication between
Archive Center and Governikus LZA (TR-Esor Submission Information).

GOV_AUTHOR
TR-Esor author name:
GOV_AUTHOR=<name>

Example: GOV_AUTHOR=govauthor

GOV_CLIENT
TR-Esor client name:
GOV_CLIENT=<ClientID>

OpenText Archive Center – Administration Guide 153


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

Example: GOV_CLIENT=govclient

GOV_UNIT
TR-Esor unit name:
GOV_UNIT=<Unit>

Example: GOV_UNIT=govunit

All communication with Governikus LZA is using TLS/SSL. The following


properties specify which keystores and trusted root certificates to use for
establishing and securing the communication channel.

GOV_CLIENTKEYALIAS
TR-Esor client key alias if store has more than one certificate:
GOV_CLIENTKEYALIAS=<keystore alias for client key>

Example: GOV_CLIENTKEYALIAS=myclient

GOV_CLIENTKEYPASS
TR-Esor client keystore password:
GOV_CLIENTKEYPASS=<client key password>

Example: GOV_CLIENTKEYPASS=passwd

GOV_CLIENTKEYSTORE
TR-Esor client keystore path:
GOV_CLIENTKEYSTORE=<full path to client keystore>

Example: GOV_CLIENTKEYSTORE=C:/software/OpenText/Archive Server


16.2.0/config/tr-esor/keyStore.jks

GOV_CLIENTKEYSTORE_TYPE
TR-Esor client keystore type:
GOV_CLIENTKEYSTORE_TYPE=<client keystore type>

Example: GOV_CLIENTKEYSTORE_TYPE=JKS

GOV_TRUSTKEYALIAS
TR-Esor trusted root CA of TR-Esor server certificate if truststore has more
than one certificate:
GOV_TRUSTKEYALIAS=<trusted root alias in keystore>

Example: GOV_TRUSTKEYALIAS=otcarsa

GOV_TRUSTPASS
TR-Esor truststore password:
GOV_TRUSTPASS=<truststore password>

Example: GOV_TRUSTPASS=passwd

GOV_TRUSTSTORE
TR-Esor truststore path:
GOV_TRUSTSTORE=<full path to truststore>

154 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.6. Governikus adapter

Example: GOV_TRUSTSTORE=C:/software/OpenText/Archive Server 16.


2.0/config/tr-esor/trustStore.jks

GOV_TRUSTSTORE_TYPE
TR-Esor truststore type:
GOV_TRUSTSTORE_TYPE=<truststore type>

Example: GOV_TRUSTSTORE_TYPE=JKS

8.6.3 Deploying JCA Resource Adapter and configuring


Storage Module
On Governikus LZA, you need to deploy a Java Connectivity Architecture (JCA)
resource adapter file in Red Hat® JBoss® Application Server. You then configure a
Storage Module in the Governikus LZA administration.

To deploy the resource adapter:

1. Ensure that Archive Center is running.


2. From the computer hosting Archive Center, copy the
<OT config AC>/external/governikus_lza/ot_acstorage.rar file to the
<JBoss_installdir>/standalone/deployments directory on the Governikus
LZA computer.

To configure the Storage Module:

1. Specify the following:

Dateninhalte separieren
Governikus LZA is able to store XAIP and data objects separately.
OpenText strongly recommends enabling this option. Data separation helps
to reduce network message sizes significantly and reduces storage space
usage noticeably. Furthermore, XAIP-only archiving is very different from
typical Archive Center document formats. However, it is possible to use the
adapter in single XAIP mode.
Archivierungsart
SelectOpenText Archive Center (16 EP2), OpenText Software GmbH to
activate the storage adapter.
Archive Server Host
Hostname of Archive Center
Archive Server Port
HTTP or HTTPS port of Archive Center
Use SSL
Select if SSL/TLS is required
Archive Server SecKey PrivateKey for ArchiveLink Signature
Path to PEM file containing a valid private and public key pair to use for
signing ArchiveLink URLs

OpenText Archive Center – Administration Guide 155


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

Archive Server Certificate Password


Key to access a password protected key pair as configured above

Archive Server SecKey Certificate for ArchiveLink Signature Verification


Path to PEM file containing the public key that will be sent to Archive
Center. This public key is used to verify the ArchiveLink URL signature.
The certificate needs to be enabled in Administration Client.

AuthID of Governikus System for SecKey


This value will internally be appended by the String _GovStorage. The
certificate that is put to Archive Center will hence result in an AuthID
named <AuthID>_GovStorage. This is also the name of a technical user
who calls back into Archive Center.

Governikus Retentions Only


Governikus only supports a Preservation Date to ensure a document is
retained for a certain period of time. This setting determines whether these
dates or any typical Archive Center-specific retentions will be sent forward
to Archive Center as well.
Setting retentions on Archive Center is much more restrictive than the
Governikus Preservation Date and can keep Governikus features from
working as expected. For example, updating an existing XAIP with
EvidenceRecords will be impossible for “ReadOnly” retentions or dates, etc.
Unlike standard Archive Center behavior, a document under retention will
still be enriched with a new Governikus component version for each update
or append request. However, existing versions are write protected.
Carefully consider which requirements have to be met.
If the check box is cleared, retentions are propagated to Archive Center
(default).

156 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.6. Governikus adapter

2. Save the configuration by clicking Übernehmen.

3. Switch to the Storage Module main configuration page, enter a description for
your changes and click Save to activate the configuration.

4. In Administration Client, verify whether the certificate for ArchiveLink is


added as a Global certificate in System > Key Store > Certificates.
If it is not present, restart Governikus LZA to put the certificate to Archive
Center automatically.

5. Enable the certificate before starting to archive.

Related Topics
• “Configuring a certificate for authentication” on page 146

OpenText Archive Center – Administration Guide 157


AR160200-00-ACN-EN-03
Chapter 8 Configuring security settings

8.7 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 293). 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 133.
Verification can check timestamps as well as checksums.

The certificates for those timestamps must be known to the Archive Center and
enabled, before the timestamp checksums can be verified (see “Importing a
certificate for timestamp verification” on page 150).

To activate the usage of checksums for Document Pipeline:

1. Open the Configuration object.

2. Search for the Use checksum in Archive Server communication variable


(internal name: DP.COMMON.DSH_CHECKSUM; see “Searching
configuration variables” on page 222).

3. Set the Use checksum in Archive Server communication variable to on.

8.8 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 144).
• You can retrieve the Subject from the certificate and use it as application ID
(name of the application); see the procedure below.

158 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
8.8. ArchiveLink using Common Names (CN)

To retrieve the application name from a certificate:

1. Start Administration Client.

2. In the console tree, expand Archiving and Storage and log on to the Archive
Center.

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).

OpenText Archive Center – Administration Guide 159


AR160200-00-ACN-EN-03
Chapter 9

Configuring users, groups, and policies

Archive Center needs a few specific administrative users for proper work. They are
managed in the System object of the Archive Center. 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
Center.

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 172.

Important
Do not add users to the system partition of OTDS (“OTInternal”). Instead,
create a partition for your users and add the corresponding users and user
groups as members to tenant groups within the system partition.

For more information, see Section 4 “User partitions” in OpenText Directory Services -
Installation and Administration Guide (OTDS-IWC).

9.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.

OpenText Archive Center – Administration Guide 161


AR160200-00-ACN-EN-03
Chapter 9 Configuring users, groups, and policies

Changing password for dsadmin


A standard change password dialog for dsadmin users is provided in the
Administration Client to change their password, for example, after first login.
Depending on the kind of user management (OTDS or Archive Center’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)

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 Center.

2. In the console tree, select Archive Center 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 settings
You can specify a minimum length for passwords, if a user is locked out after
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:

1. In the console tree, expand Archive Center> Configuration and search for the
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.

3. Click OK and restart the Archive Spawner service.

Lock out after failed logons


You can define that a user is locked out after a specified number of failed attempts to
log on; default is 0 (no lockout).

Note: The dsadmin user will never be locked out.

162 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
9.2. About users, groups, and policies

To configure user lockout:

1. In the console tree, expand Archive Center> Configuration and search for the
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.
3. Click OK and restart the Archive Spawner service.
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.

Note: The dsadmin user will never be locked out.

To configure user lockout time:

1. In the console tree, expand Archive Center> Configuration and search for the
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.
3. Click OK and restart the Archive Spawner service.

9.2 About users, groups, and policies


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.

OpenText Archive Center – Administration Guide 163


AR160200-00-ACN-EN-03
Chapter 9 Configuring users, groups, and policies

Standard users During the installation of Archive Center, 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 167.
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 167.

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 167.

Tenants Tenants are special user groups intended for the Application Layer (“extended
functionality”). For more information, see “Creating tenants” on page 169.

9.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.


2. Create the user.
3. Create and configure the user group and add the users and the policies.

9.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.

164 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
9.4. Checking, creating, or modifying policies

9.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 9-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.
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 Center.
• Accounting
• Administration Server
• DPinfo
• Scanning Client
• Spawner

9.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 166.

OpenText Archive Center – Administration Guide 165


AR160200-00-ACN-EN-03
Chapter 9 Configuring users, groups, and policies

9.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 >>.

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 166
• “Checking, creating, or modifying user groups” on page 168
• “About users, groups, and policies ” on page 163

9.5 Checking, creating, or modifying users

166 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
9.5. Checking, creating, or modifying users

9.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 167.

9.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
area of the result pane.

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 Center. The name can be a
maximum of 14 characters in length. Spaces are not permitted. This name
cannot be changed subsequently.

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.

OpenText Archive Center – Administration Guide 167


AR160200-00-ACN-EN-03
Chapter 9 Configuring users, groups, and policies

Deleting users To delete a user, select the user and click Delete in the action pane.

Related Topics
• “Creating and modifying policies” on page 166
• “Checking, creating, or modifying user groups” on page 168
• “About users, groups, and policies ” on page 163

9.6 Checking, creating, or modifying user groups


9.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 168.

9.6.2 Creating and modifying user groups


To create a user group:

1. Select Users and Groups in the System object in the console tree.

2. Select the Groups tab in the top area of the result pane. All available groups are
listed in the top area of the result pane.

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

168 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
9.7. Creating tenants

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 166


• “Checking, creating, or modifying users” on page 166
• “About users, groups, and policies ” on page 163
• “Adding users and policies to a user group” on page 169

9.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.

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

9.7 Creating tenants


A tenant is defined by a user group with an associated, dedicated policy. Tenants are
required by the Application Layer (“extended functionality”). 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 171 below.

OpenText Archive Center – Administration Guide 169


AR160200-00-ACN-EN-03
Chapter 9 Configuring users, groups, and policies

Important
• Ensure that every user of Archive Center is member of at least one tenant
group. Otherwise, certain scenarios do not work correctly because
Archive Center protects user information based on the tenant groups.
• 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:

1. Select Users and Groups in the System object in the console tree.
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.

170 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
9.8. Checking a user’s rights

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 164.

2. Depending on your needs, change the value of the following configuration


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

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

For a description of how to set, modify, delete, and search configuration


variables, see “Setting configuration variables“ on page 221.

9.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.

OpenText Archive Center – Administration Guide 171


AR160200-00-ACN-EN-03
Chapter 9 Configuring users, groups, and policies

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.

9.9 Connecting to Directory Services


OpenText Directory Services (OTDS) is the user management system for Archive
Center and other OpenText products. To connect Archive Center to OTDS, an OTDS
resource is required. You can easily set up and configure a new resource for OTDS
in Administration Client.

Note: If Archive Center was installed using the Archive Center Installer, the
connection to OTDS has been configured automatically.

To connect Archive Center 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://otdsserver:8090

OTDS administrator
Enter the name of the OTDS administrator; default: otadmin@otds.admin

OTDS administrator password


Enter the password of the OTDS administrator.

4. On the Resource page, enter a resource name for Archive Center.


Resource names must be unique.

5. On the Summary page, verify your entries and click Finish. The resource is
created.
Restart Archive Center to activate the new resource.

Note: To modify the resource, you must sign in to Directory Services


using the admin web client.

Securing If you configure Archive Center 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 Center 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 Center and OTDS application servers.

172 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
9.9. Connecting to Directory Services

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.

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.
For a description of how to set, modify, delete, and search configuration
variables, see “Setting configuration variables“ on page 221.

3. Restart Archive Center to activate strict verification.

Linking You can easily transfer the permissions and policies in Archive Center’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 Center’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 Center:

1. Create groups with the same group names in the Archive Center’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 more information about OTDS, see OpenText Directory Services - Installation and
information Administration Guide (OTDS-IWC).

OpenText Archive Center – Administration Guide 173


AR160200-00-ACN-EN-03
Chapter 10
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 177
• “Creating and modifying SAP system connections” on page 175
• “Assigning an SAP system to a logical archive” on page 178

10.1 Creating and modifying SAP system connections


Document Pipelines connects to 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.

OpenText Archive Center – Administration Guide 175


AR160200-00-ACN-EN-03
Chapter 10 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. Usually, the value 00 is
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 being used (<xx> =
instance number).

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).
If you run Document Pipeline version 16 or later only, this setting is
ignored. You can keep the default value in the Codepage field.

Note: Document Pipeline 16 and later expect the character set UTF-8
within the IXATTR file in any case. If you need to convert to UTF-8, see
the parameters in the enqueue jobs, like startEXR3.

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

176 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
10.2. Creating and modifying SAP gateways

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.

10.2 Creating and modifying SAP gateways


SAP gateways link the SAP system connection to the outside world. Define at least
one gateway 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:

1. Select SAP Servers in the Environment object in the console tree.


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 Center 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.

OpenText Archive Center – Administration Guide 177


AR160200-00-ACN-EN-03
Chapter 10 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.

10.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 177.
• The SAP system is created and configured; see “Creating and modifying SAP
system connections” on page 175.

To assign an SAP system to an archive:

1. Select SAP Servers in the Environment object in the console tree.

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 systems 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


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

178 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
10.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 later is currently
used.

Protocol
Communication protocol between the SAP application and Archive Center.
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

OpenText Archive Center – Administration Guide 179


AR160200-00-ACN-EN-03
Chapter 11
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 Center. 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 183.
• Scan station to which an archive mode applies. See “Adding a new scan host and
assigning archive modes” on page 186.
• 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 178.

If Archive Center runs as an active-active cluster, the configuration variable
ADMS_EXEC_TARGET must be set. See “Configuring scan clients for a clustered
installation” on page 188.

11.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 Section 4.2.4 “Archiving with bar code technology” in OpenText Archiving and
Document Access for SAP Solutions - Scenario Guide (ER-CCS).

OpenText Archive Center – Administration Guide 181


AR160200-00-ACN-EN-03
Chapter 11 Configuring scan stations

Scenario (Opcode) Conditions Workflow Extended Conditions


Late_Archiving BARCODE n/a n/a
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
Documents are indexed in Enterprise Scan first. The archiving process archives the
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
Documents are indexed in Enterprise Scan first. The archiving process 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.
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
value = <domain>\<name>
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

182 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
11.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

BIZ_APPLICATION<name>
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.
DMS_Indexing PILE_INDEX 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
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.
DMS_Indexing PILE_INDEX n/a BIZ_ENCODING_BASE64_UTF8N

BIZ_APPLICATION<name>

BIZ_PLG_EVENT=<plugin>:
<event>

11.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 181.

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.

OpenText Archive Center – Administration Guide 183


AR160200-00-ACN-EN-03
Chapter 11 Configuring scan stations

4. Enter the settings for the archive mode.


For more information, see “Archive Modes properties” on page 184.

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 more information, see “Archive Modes
properties” on page 184.

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 188.

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


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.

184 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
11.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 more information about creating 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 186

OpenText Archive Center – Administration Guide 185


AR160200-00-ACN-EN-03
Chapter 11 Configuring scan stations

• “Scenarios and archive modes” on page 181

11.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:

1. Select Scan Stations in the Environment object in the console tree.

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 183
• “Adding a new scan host and assigning archive modes” on page 186

11.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:

1. Select Scan Stations in the Environment object in the console tree.

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.

186 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
11.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 187).

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 186.

Related Topics
• “Adding and modifying archive modes” on page 183
• “Adding additional archive modes” on page 187
• “Archive Modes properties” on page 184

11.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:

1. Select Scan Stations in the Environment object in the console tree.

2. Select the Scan Hosts tab in the result pane.

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
• “Adding and modifying archive modes” on page 183
• “Archive Modes properties” on page 184

OpenText Archive Center – Administration Guide 187


AR160200-00-ACN-EN-03
Chapter 11 Configuring scan stations

11.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 all scan clients using this scan host. The first
assigned archive mode is the default mode. This order can be changed if necessary.

To change the default archive mode:

1. Select Scan Stations in the Environment object in the console tree.

2. Select the Scan Hosts tab in the result pane.

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.

11.7 Removing assigned archive modes


To remove assigned archive modes:

1. Select Scan Stations in the Environment object in the console tree.

2. Select the Scan Hosts tab in the result pane.

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.

11.8 Configuring scan clients for a clustered


installation
If Archive Center runs as an active-active cluster, setting a configuration variable is
required for changes of the archive mode to work properly. Thereby, requests issued
by clients are redirected to a dedicated node instead of being bound to the first
reached host from which the session token originates.

To configure a configuration variable for an active-active cluster:

1. Start Administration Client and connect to one of the nodes.

2. If not done already, enable the display of hidden variables as described in


“Customizing configuration view” on page 223.

3. Locate the ADMS_EXEC_TARGET variable, and change its value from localhost to
a URL like this:

188 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
11.8. Configuring scan clients for a clustered installation

<protocol>://<dedicated node>:<port>/archive
where <dedicated node> is the fully-qualified name of the node that will handle
the administration of the archive modes.

Example: https://archive.example.com:8090/archive

4. For the changes to take effect, restart the Apache Tomcat and Archive Spawner
services on all nodes.

OpenText Archive Center – Administration Guide 189


AR160200-00-ACN-EN-03
Chapter 12
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 195.

Cluster topic: Known servers and remote standby scenarios are not supported.

12.1 Adding known servers


To add a known server:

1. Select Known Servers in the Environment object in the console tree.

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
Center 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.

OpenText Archive Center – Administration Guide 191


AR160200-00-ACN-EN-03
Chapter 12 Adding and modifying known servers

• 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.

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.

12.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:

1. Select Known Servers in the Environment object in the console tree.

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.

12.3 Checking and modifying known servers


To check a known server:

1. Select Known Servers in the Environment object in the console tree.

2. Select the server you want to check.

3. Click Properties in the action pane.

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.

192 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
12.4. Synchronizing servers

Build Information
Detailed information of the software build and revision of the known
server.

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.

12.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
• Timestamp certificates
• System keys

To synchronize known servers:

1. Select Known Servers in the Environment object in the console tree.

2. Click Synchronize Servers in the action pane.

3. Click OK to confirm. The synchronization is started.

OpenText Archive Center – Administration Guide 193


AR160200-00-ACN-EN-03
Chapter 13

Configuring remote standby scenarios

In a remote standby scenario, a Remote Standby Server is configured as duplicate of


the original Archive Center. The Remote Standby Server and the Archive Center 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 Center first
(see “Adding and modifying known servers“ on page 191). Thus, the Remote
Standby Server can transmit data from the original Archive Center.

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 13-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.

OpenText Archive Center – Administration Guide 195


AR160200-00-ACN-EN-03
Chapter 13 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
Center 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 Center,
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.

13.1 Configuring original Archive Center and Remote


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

13.1.1 Configuring the original Archive Center


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 Center.

2. Add the Remote Standby Server as known server (see “Adding known servers”
on page 191). 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.

196 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
13.1. Configuring original Archive Center and Remote Standby Server

13.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 191).
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 199).

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 113).

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 Center:

1. Sign in to the original Archive Center.

2. In the action pane, click Synchronize Servers.

OpenText Archive Center – Administration Guide 197


AR160200-00-ACN-EN-03
Chapter 13 Configuring remote standby scenarios

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 199).

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 122).

4. Schedule the replication job Synchronize_Replicates (see “Setting the start


mode and scheduling of jobs” on page 122).

Note: On the original Archive Center, the backup jobs can be disabled if
no additional backups should be written.

To configure replicated disk buffers:

1. Select Known Servers in the Environment object in the console tree.

198 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
13.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.

5. Select Buffers in the Infrastructure object in the console tree.

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
• “Configuring disk volumes” on page 60
• “Installing and configuring storage devices” on page 49

13.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.

13.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:

1. Sign in to the Remote Standby Server.

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 94).

OpenText Archive Center – Administration Guide 199


AR160200-00-ACN-EN-03
Chapter 13 Configuring remote standby scenarios

5. Configure the Synchronize_Replicates job according to your needs (see


“Setting the start mode and scheduling of jobs” on page 122).
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 123).

13.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:

1. Sign in to the Remote Standby Server.

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 more information, see the storage installation guides on


OpenText My Support.
EMC Centera GS devices:

• See “EMC Centera (single file)” on page 58.


• See the Archive Center Knowledge Base on My Support 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


“Setting the start mode and scheduling of jobs” on page 122).
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 123).

200 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Chapter 14
Configuring Archive Timestamp Server

To put a timestamp on every document, Archive Center 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 Center.
It handles the incoming requests, creates the timestamps, and sends the reply. It
runs as an Archive Center component.

After the installation of Archive Center 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 135.

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 202.

Background
• “Timestamps” on page 133

14.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.

OpenText Archive Center – Administration Guide 201


AR160200-00-ACN-EN-03
Chapter 14 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 447. The file is typically located in the <OT config AC>/
timestamp/ directory.
• Timestamp certificates
After the installation of Archive Center, 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 222):
• File with certificate (internal name: TS_REQ_CERTFILE)
• Passphrase for the private key (internal name: TSTP_KEY_PASSPHRASE)
• File with private key (internal name: TS_REQ_PRIVKEYFILE)

14.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 222.

“Configuration recommendation” on page 202 shows the recommended default


settings for ArchiSig timestamps and for document timestamps.
For a reference of all available variables related to the configuration of Archive
Timestamp Server, see “Timestamp Server (TSTP)” on page 445.

Configuration recommendation
ArchiSig timestamps

Timestamps are not added per document, but for containers of hash trees calculated
from the documents (new method).

202 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
14.2. Configuration variables for Archive Timestamp Server

Connection method (internal name: TS_CONNECTION)


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.

Timestamp server port (internal name: TS_PORT)


By default, Archive Timestamp Server uses port 32001.

Hostname of the timestamp server (internal name: TS_HOST)


The hostname or the IP address of Archive Timestamp Server. This can be
localhost if Archive Timestamp Server runs on the same host.

Format of used timestamps (internal name: TS_FORMAT)


Use RFC 3161 (IETF).

Document timestamps

Each document component gets a timestamp (old method).

Timestamp server port (internal name: TIME_STAMP_SERVER_PORT)


By default, Archive Timestamp Server uses port 32001.

Host of the Timestamp Server (internal name: TIME_STAMP_SERVER_HOST)


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.

Example: tshost1:32001;tshost2:10318

Mode of the Timestamp Server (internal name: TIME_STAMP_MODE)


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.

Background
• “Timestamps” on page 133

OpenText Archive Center – Administration Guide 203


AR160200-00-ACN-EN-03
Chapter 14 Configuring Archive Timestamp Server

14.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.

14.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

204 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Chapter 15
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 Center. 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 Center, 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 Center 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 Center.
Cluster topic: The write-back mode is not supported.

Typical scenario for using the “Write back” mode


You have a quite slow network connection between an Archive Cache Server and an
Archive Center. 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 Center is just informed about new documents. During the night, the WAN
is much faster, because of reduced network traffic. The documents just stored on the
Archive Cache Server can now be safely transferred to the Archive Center 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 207).

The following figure shows a simple outlay of a scenario with only one Archive
Center and one Archive Cache Server. In real environments, one Archive Cache
Server can support more than one Archive Center and one Archive Center can have
more than one Archive Cache Server attached. Clients can also access the Archive
Center directly without using Archive Cache Server. This depends on the
configuration; see “Configuring access using Archive Cache Server” on page 214.

OpenText Archive Center – Administration Guide 205


AR160200-00-ACN-EN-03
Chapter 15 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 15-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 Center.

206 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
15.1. Restrictions using Archive Cache Server

15.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 Center. Especially for “write back” documents, this
paradigm cannot be followed completely. The following table shows all known
restrictions.

Table 15-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 Center.
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 Center).
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 87)
• Archive Server > Modify Operation Mode > Documents
cannot be deleted, no errors are returned (see also “Setting
the operation mode of Archive Center” on page 328
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
Center, 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 Center.
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.

OpenText Archive Center – Administration Guide 207


AR160200-00-ACN-EN-03
Chapter 15 Configuring Archive Cache Server

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 Center.
Transfer and commit Write-back documents are transferred to the related Archive
Center 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.
Cluster If Archive Center runs as an active-active cluster, the write-
back mode is not supported.
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.

208 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
15.2. Configuring an Archive Cache Server in the environment

15.2 Configuring an Archive Cache Server in the


environment
15.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
Center 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
Center 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:

OpenText Archive Center – Administration Guide 209


AR160200-00-ACN-EN-03
Chapter 15 Configuring Archive Cache Server

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 115 and “Other jobs” on page 118.

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.

7. Cluster only: Disable the global certificate of Archive Cache Server on one node,
and then enable it again. Do the same on all other cluster nodes.

8. Continue with “Configuring archive access using Archive Cache Server”


on page 215.

15.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 Center. 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 Center. A window to watch the transfer status opens.

210 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
15.2. Configuring an Archive Cache Server in the environment

To modify an Archive Cache Server:

1. Select Cache Servers in the Environment object in the console tree.

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 209.

4. Click Finish.

15.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 218.

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 218.

2. Select Jobs in the System object in the console tree.

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 Center. A window to watch the transfer status opens.

Caution
This step ensures that pending write-back documents are transferred
to the related Archive Center. If this step fails, the Archive Cache
Server must not be deleted before the problem is solved.

4. Select Cache Servers in the Environment object in the console tree.

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.

OpenText Archive Center – Administration Guide 211


AR160200-00-ACN-EN-03
Chapter 15 Configuring Archive Cache Server

15.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 more information about write-back volumes and write-through volumes, see
“Configuring Archive Cache Server“ on page 205.

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 213.

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.

212 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
15.2. Configuring an Archive Cache Server in the environment

To resize volumes:

1. In the <OT config>\Archive Cache Server\config\setup directory, open the


ACS.Setup file with an editor.

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 213.

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.

3. Enter the following command:


cscommand -c listVolumes -u <user name> -p <user password>
Enter the user and user password of the corresponding Archive Center.
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.

OpenText Archive Center – Administration Guide 213


AR160200-00-ACN-EN-03
Chapter 15 Configuring Archive Cache Server

15.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
ACS.Setup file with an editor.
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.

15.3 Configuring access using Archive Cache Server


15.3.1 Subnet assignment of 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
Centers. 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 Center directly.

214 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
15.3. Configuring access using 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 15-2: Example of subnet assignment of Archive Cache Servers

Important
The subnet configuration will only be evaluated by clients using the
OpenText Archive Center API.

Note: Archive Cache Server keeps track of any relevant changes to the archive
settings and is synchronized automatically.

15.3.2 Configuring archive access using Archive Cache Server


Prerequisite 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 209.

To configure archive access:

1. Select Original Archives in the Archives object in the console tree.


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.
4. Enter settings:

OpenText Archive Center – Administration Guide 215


AR160200-00-ACN-EN-03
Chapter 15 Configuring Archive Cache Server

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 Center. 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 Archive Cache Server” on page 214.

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 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.

6. Click Finish to complete.

216 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
15.3. Configuring access using Archive Cache Server

Modifying To modify the settings of an Archive Cache Server, select it in the top area of the
settings result pane and click Properties in the action pane. Proceed in the same way as
when configuring an Archive Cache Server.

15.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 Center certificate.

To configure the certificates for write-back:

1. On Archive Center, enable the Archive Cache Server certificate named


CS_ACS_<Cache Server hostname>.

Important
The certificate must be enabled regardless of the security settings of the
archive.

2. On Archive Center, import and enable the Archive Center certificate as global
authentication certificate unless this has already been done during the Archive
Center configuration.

Important
The certificate must be imported and enabled regardless of the security
settings of the archive.

You can find the Archive Center certificate here:


<OT config AC>/config/setup/as.pem

Background
• “Certificates” on page 141

15.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:

1. Select Original Archives in the Archives object in the console tree.

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 Archive
Cache Server” on page 215

OpenText Archive Center – Administration Guide 217


AR160200-00-ACN-EN-03
Chapter 15 Configuring Archive Cache Server

5. Click Finish.

To modify the subnet definitions of an Archive Cache Server:

1. Select Original Archives in the Archives object in the console tree.

2. Select the logical archive which the Archive Cache Server 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. 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 Archive Cache Server” on page 215

5. Click Finish.

15.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:

1. Select Original Archives in the Archives object in the console tree.

2. Select the logical archive to which the Archive Cache Server is assigned.

3. Select the Cache Servers tab in the top area of the result pane and select the
Archive Cache Server you want to delete.

4. Click Properties in the action pane.

5. Deselect enabled to stop caching. See also “Configuring archive access using
Archive Cache Server” on page 215.

6. Select Jobs in the System object in the console tree.

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 Center. 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.

218 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Chapter 16
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 Center. 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. Click Run Scenario.


The resulting report is stored as HTML file and can be displayed in a standard
browser; see the “To display a report:“ on page 219 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. Click Refresh.

4. Select a report in the Reports tab.

OpenText Archive Center – Administration Guide 219


AR160200-00-ACN-EN-03
Chapter 16 Scenario reports

5. Click Open Report.


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 Center.

These details include:


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

220 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Chapter 17
Setting configuration variables

Within this object, you can set the configuration variables for:

• Archive Server
• Document Pipeline
• Monitoring Server

For a complete list including short descriptions of all configuration variables, see
“Configuration parameter reference” on page 335.

17.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.

OpenText Archive Center – Administration Guide 221


AR160200-00-ACN-EN-03
Chapter 17 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:

17.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 Center, 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:

222 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
17.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.

17.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.

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.

OpenText Archive Center – Administration Guide 223


AR160200-00-ACN-EN-03
Part 3
Maintenance
Chapter 18
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.

18.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 79. 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 Center 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 Center 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 Center 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.

OpenText Archive Center – Administration Guide 227


AR160200-00-ACN-EN-03
Chapter 18 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 222):
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 229).

Important
To ensure correct deletion, you must synchronize the clocks of the Archive
Center 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.

228 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
18.1. When the retention period has expired

18.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 222):
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.

OpenText Archive Center – Administration Guide 229


AR160200-00-ACN-EN-03
Chapter 18 Handling storage volumes

18.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 121 and “Enabling and disabling jobs” on page 120.

18.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,
and the reference may be stored on a newer medium than the document.
SIA documents can be exported only when all references are outdated.
Further, if the Export from database option is enabled, the Export utility
does not analyze references to the documents.
• Volumes containing at least one document with nonexpired retention are
not exported. In this case, no document of the volume will be exported.

To export volumes:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.
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.

230 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
18.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 249
• “Checking utilities protocols” on page 250

18.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 Center.

Note: To import ArchiSig documents with timestamps, the ArchiSig archive


must be imported first to avoid problems.

18.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:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

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.

OpenText Archive Center – Administration Guide 231


AR160200-00-ACN-EN-03
Chapter 18 Handling storage volumes

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.

5. Select Original Archives in the Archives object in the console tree.

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

• “Utilities“ on page 249


• “Checking utilities protocols” on page 250

18.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:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

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.

232 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
18.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
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.
5. Select Original Archives in the Archives object in the console tree.
6. Select the designated archive and the FS or HDSK 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
• “Utilities“ on page 249
• “Checking utilities protocols” on page 250

18.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):

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.
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.

OpenText Archive Center – Administration Guide 233


AR160200-00-ACN-EN-03
Chapter 18 Handling storage 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.

5. Select Original Archives in the Archives object in the console tree.

6. Select the designated archive and the VI 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 VI pool.

Related Topics
• “Utilities“ on page 249
• “Checking utilities protocols” on page 250

18.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.

18.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.

234 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
18.4. Consistency checks for storage volumes and documents

To check the database against a volume:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Select the Check Database Against Volume utility.

3. Click Run in the action pane.

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
• “Utilities“ on page 249
• “Checking utilities protocols” on page 250

OpenText Archive Center – Administration Guide 235


AR160200-00-ACN-EN-03
Chapter 18 Handling storage volumes

18.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:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Select the Check Volume Against Database utility.

3. Click Run in the action pane.

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.
A protocol window shows the progress and the result of the check.

Related Topics
• “Utilities“ on page 249
• “Checking utilities protocols” on page 250

18.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:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Select the Check Document utility.

236 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
18.4. Consistency checks for storage volumes and documents

3. Click Run in the action pane.


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.
A protocol window shows the progress and the result of the check.

Related Topics
• “Utilities“ on page 249
• “Checking utilities protocols” on page 250

18.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:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.
2. Select the Count Documents/Components utility.
3. Click Run in the action pane.
4. Enter the name of the volume.
5. Click Run.

OpenText Archive Center – Administration Guide 237


AR160200-00-ACN-EN-03
Chapter 18 Handling storage volumes

A protocol window shows the progress and the result of the counting.

Related Topics
• “Utilities“ on page 249
• “Checking utilities protocols” on page 250

18.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:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Select the Check Volume utility.

3. Click Run in the action pane.

4. Enter the name of the volume.

5. Click Run.
A protocol window shows the progress and the result of the check.

Related Topics
• “Utilities“ on page 249
• “Checking utilities protocols” on page 250

18.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 My
Support (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 Center (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 more information, see the Storage Platform Release Notes on
My Support (https://knowledge.opentext.com/knowledge/llisapi.dll/open/12331031).

238 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
18.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

OpenText Archive Center – Administration Guide 239


AR160200-00-ACN-EN-03
Chapter 19

Backups and recovery

The backup concept used by Archive Center ensures that documents are protected
against data loss throughout their entire path to, through, and in the Archive Center.

Batch Input Scan COLD

ArchiveLink Server API Document Pipeline

Archive Cache Server

Write Through ACS Data Write Back

Archive Server

Storage Manager Document Service


Disk Buffer Cache Area
Configuration Database

Storage
Systems

Figure 19-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. For more information about the volumes to
be protected, see the “Configuring basic settings” chapter in the Archive Center
installation guides.

OpenText Archive Center – Administration Guide 241


AR160200-00-ACN-EN-03
Chapter 19 Backups and recovery

Document Pipelines
The Document Pipeline of OpenText Imaging Enterprise Scan must be protected
against data loss. For more information, 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 Centers, 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 242.
Storage Manager configuration
The configuration of the Storage Manager must be saved. For more information,
see “Backing up and restoring of the Storage Manager configuration”
on page 243.
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 Center tools. For
more information, see “Backup for storage systems” on page 238.
Archive Cache Server
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. For
more information, see “Backup and recovery of an Archive Cache Server”
on page 244.
Directory Services
OpenText recommends backing up the server hosting OpenText Directory
Services (OTDS) on a regular basis (for example, weekly).

Note: OTDS is required, for example, by the Application Layer.


For general information about OTDS, see OpenText Directory Services -
Installation and Administration Guide (OTDS-IWC).

19.1 Backing up the database


All archived documents are administered in the Archive Center 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.

242 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
19.2. Backing up and restoring of the Storage Manager configuration

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.

19.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)

19.1.2 Backing up a Microsoft SQL Server database


See “Back Up and Restore of SQL Server Databases” on the Microsoft website
(https://technet.microsoft.com/en-us/library/ms187048(v=sql.110).aspx).

For more information about password change, see “Changing the database user
password” on page 73.

19.2 Backing up and restoring of the Storage Manager


configuration
For more information about 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).

OpenText Archive Center – Administration Guide 243


AR160200-00-ACN-EN-03
Chapter 19 Backups and recovery

19.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 Center. 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.

19.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 Center. 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.

Note: Running cscommand requires that a JDK or JRE is included in the PATH
environment variable.

To backup Archive Cache Server data:

1. Run Copy_Back jobs (recommended).

2. Activate maintenance mode:


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>

244 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
19.3. Backup and recovery of an Archive Cache Server

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.

19.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 244, you need the
cscommand in the <OT config>\Archive Cache Server\bin directory.

Note: Running cscommand requires that a JDK or JRE is included in the PATH
environment variable.

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 Center are not affected.

To recover data (complete loss of all volumes):

1. Activate maintenance mode. Use


cscommand -c setOffline -u <username> -p <password>

OpenText Archive Center – Administration Guide 245


AR160200-00-ACN-EN-03
Chapter 19 Backups and recovery

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


cscommand -c setOnline -u <username> -p <password>

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


cscommand -c setOffline -u <username> -p <password>

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


cscommand -c setOnline -u <username> -p <password>

246 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
19.4. Reassigning the jobs of a node in a cluster installation

19.4 Reassigning the jobs of a node in a cluster


installation
In case of a failing node, which cannot run its scheduled jobs anymore and cannot be
repaired, the system administrator can start a utility that assigns these jobs to the
other node(s).

To reassign the jobs of a node:

1. In Administration Client, start the Reassign Work of Node utility. For more
information, see “Starting utilities” on page 250.

2. Enter the fully-qualified name of the failed node, for example: node2.
example.com
For a full recovery, add a node to replace the lost one.

OpenText Archive Center – Administration Guide 247


AR160200-00-ACN-EN-03
Chapter 20

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 20-1: Overview of utilities

Utility Related information


Check Database Against Volume “Checking database against volume” on page 234
Check Document “Checking a document” on page 236
Check Volume “Checking a volume” on page 238
Check Volume Against Database “Checking volume against database” on page 236
Count Documents/Components “Counting documents and components in a
volume” on page 237
Export Volumes “Exporting volumes” on page 230
Import GS Volume “Importing GS volumes for Single File (VI) pool”
on page 233
Import HD Volume “Importing hard disk volumes” on page 232
Import ISO Volume “Importing ISO volumes” on page 231
Reassign Work of Node “Reassigning the jobs of a node in a cluster
installation” on page 247
Report Shadow Copy Errors “Handling shadow copy errors” on page 106
Review Attribute Migration Errors “Attribute migration“ on page 287
View Installed Archive Server Patches “Viewing installed patches” on page 322
VolMig Cancel Migration Job “Canceling a migration job” on page 280

OpenText Archive Center – Administration Guide 249


AR160200-00-ACN-EN-03
Chapter 20 Utilities

Utility Related information


VolMig Continue Migration Job “Continuing a migration job” on page 279
VolMig Fast Migration of ISO “Creating a fast migration job for ISO volumes”
Volume on page 272
VolMig Migrate Components on “Creating a migration job” on page 269
Volume
VolMig Pause Migration Job “Pausing a migration job” on page 279
VolMig Renew Migration Job “Renewing a migration job” on page 280
VolMig Status “Monitoring the migration progress“ on page 275

20.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.

4. Click Run in the action pane.

5. Enter dedicated values.

6. Click Run to start the utility.

A window to monitor the results of the utility execution opens.

20.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:

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 check.


The latest message of the utility is listed in the bottom area of the result pane.

4. Select the Results tab in the bottom area of the result pane to check whether the
execution of the utility was successful

250 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
20.2. Checking utilities protocols

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:

1. Select Utilities in the System object in the console tree.

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
area of the result pane.

To clear protocols:

1. Select Utilities in the System object in the console tree.

2. Select the Protocol tab in the top area of the result pane.

3. Click Clear Protocol in the action pane.


All protocol entries are deleted.

Re-reading Utilities and jobs are read by Archive Center 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 Center.

To re-read scripts:

1. Select Utilities in the System object in the console tree.

2. Select the Protocol tab in the top area of the result pane.

3. Click Reread Scripts in the action pane.

OpenText Archive Center – Administration Guide 251


AR160200-00-ACN-EN-03
Chapter 21
Updating Archive Center and third-party
components

OpenText recommends keeping your system up to date to avoid security and other
issues. You should install all mandatory patches for Archive Center, and you should
use the latest updates of Java and Tomcat.

21.1 Installing patches


OpenText provides regular, mandatory patch collections, called “Update
16.<m>.<n>”, where <m> represents the Enhancement Pack and <n> is a consecutive
number to identify the Update.

You can find the current Update on OpenText My Support (https://


knowledge.opentext.com/knowledge/llisapi.dll/Open/62404702). For more
information, see the corresponding Update Installation Guide for your system.

21.2 Updating Java


When you install a new Java update (for example, from version 1.8.0_111 to
1.8.0_121), you must adapt the following settings.

To adapt Archive Center to an updated Java version:

1. Configure Tomcat to use the new Java version.

Example: On Windows, open the Configure Tomcat application (tomcat8w.exe),


select the Java tab, and change the path in the Java Virtual Machine field to the new
version.
For example, change
C:\Program Files\Java\jre1.8.0_111\bin\server\jvm.dll to
C:\Program Files\Java\jre1.8.0_121\bin\server\jvm.dll

2. Change the value of the following system environment variables to the path to
the new Java version (for example, C:\Program Files\Java\jre1.8.0_121):

• ECM_DP_ACCMIS_JAVA_HOME
• ECM_DP_BASE_JAVA_HOME
• ECM_DP_FSA_JAVA_HOME
• ECM_DP_INFO_JAVA_HOME
• ECM_JAVA_HOME

If OTDS is installed, also change the value of the OPENDJ_JAVA_HOME


environment variable (for example, to C:\Program Files\Java\jre1.8.
0_121\).

OpenText Archive Center – Administration Guide 253


AR160200-00-ACN-EN-03
Chapter 21 Updating Archive Center and third-party components

Tip: On Windows, run set ecm at a command prompt. Verify that all
shown variables ending with _JAVA_HOME are set to the correct Java path.
3. If you imported certificates into the cacerts file of the JRE, you may have to
import them again into the corresponding cacerts file of the updated JRE.
4. Restart the Apache Tomcat and Archive Spawner services.

21.3 Updating Apache Tomcat


You can update to a newer minor version of Apache Tomcat. For example, you can
upgrade from Tomcat 8.5.8 to version 8.5.11.

To update Tomcat:

1. Download the latest 64-bit container file from the Tomcat website (https://
tomcat.apache.org/download-80.cgi).

Note: Windows only: Do not use the Windows Service Installer.

Extract the file to a temporary folder.


2. Stop the Apache Tomcat and Archive Spawner services.
Windows only: Exit the Tomcat tray control (tomcat8w.exe).
3. Back up the following files and folders in the <Tomcat_home> folder:

• conf folder
• In the lib folder:

• archive-help-config.jar
• as_bizprovAPI.jar
• as_intf.jar
• as_metadataAPI.jar
• commons-logging-1.1.1.jar
• ixosBaseIntf.jar
• jicsdb_intf.jar
• jicsx_intf.jar
• log4j.jar

4. Delete the bin and lib folders.


5. In the webapps folder, delete the following folders:

• docs
• manager
• ROOT
• examples (if installed)
• host-manager (if installed)

6. Delete all files and folders within the work folder.

254 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
21.3. Updating Apache Tomcat

7. Copy the following folders from the temporary folder of the new Tomcat to the
<Tomcat_home> folder:

• bin
• lib
• webapps (accept to merge the folders)

8. Copy the saved files from the lib folder (Step 3) into the <Tomcat_home>\lib
folder.

9. Start the Apache Tomcat and Archive Spawner services.

OpenText Archive Center – Administration Guide 255


AR160200-00-ACN-EN-03
Part 4
Migration
Chapter 22

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.

Cluster topic: Volume migration is not supported.

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 281.

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 267.

b. See “Creating a migration job“ on page 269.

3. Check the migration status using the VolMig Status utility. For more
information, see “Monitoring the migration progress“ on page 275.

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 287. 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.

OpenText Archive Center – Administration Guide 259


AR160200-00-ACN-EN-03
Chapter 22 About migration

22.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
• Fast migration of ISO images
Migration of entire ISO images. 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.

22.2 Restrictions of volume migration


The following restrictions are valid for the volume migration features:

• 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.
• Compression/encryption

Note: From version 16 on, migrating volumes that contain compressed


documents into a logical archive with enabled encryption is not possible
anymore due to the new compression/encryption format.

As a remedy, use copy orders for shadow pools. For more information, see
“Creating and configuring shadow pools” on page 97 and “Creating copy orders
for shadow pools” on page 104.

260 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
22.2. Restrictions of volume migration

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 195 and “Creating
and modifying pools” on page 92.

OpenText Archive Center – Administration Guide 261


AR160200-00-ACN-EN-03
Chapter 23
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.

23.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 222).

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

OpenText Archive Center – Administration Guide 263


AR160200-00-ACN-EN-03
Chapter 23 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


(Internal name: VMIG_VERIFY_DIG4)
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


(Internal name: VMIG_VERIFY_DIG5)
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


(Internal name: VMIG_VERIFY_DIG6)

264 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
23.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

23.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 222).
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)

OpenText Archive Center – Administration Guide 265


AR160200-00-ACN-EN-03
Chapter 24
Preparing the migration

24.1 Preparing for migration


To prepare for local migration:

1. If migrating documents archived with Archive Server versions before 10.5.0: Ensure
that the attribute migration is done for all documents to be migrated by running
the SYS_MIGRATE_ATTRIBUTES job. For more information, see “Attribute
migration“ on page 287.

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 92.

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 115.

24.2 Preparing for 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 115.

2. Disable backup for the original pool to avoid that the server creates additional
(unwanted) backups in the original pool.

OpenText Archive Center – Administration Guide 267


AR160200-00-ACN-EN-03
Chapter 25

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:

1. Select Original Archives in the Archives object in the console tree.

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.

25.1 Creating a migration job


To create a local migration job:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Select the VolMig Migrate Components On Volume utility.

3. Click Run in the action pane.

4. Enter appropriate settings to all fields (see Settings for local migration
on page 269).
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:

OpenText Archive Center – Administration Guide 269


AR160200-00-ACN-EN-03
Chapter 25 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)

270 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
25.1. Creating a 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 282 (-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.

OpenText Archive Center – Administration Guide 271


AR160200-00-ACN-EN-03
Chapter 25 Creating a migration job

-A <archive>
Migrate components only from a certain archive.

25.2 Creating a fast migration job for ISO volumes


To create a local fast migration job:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Select the VolMig Fast Migration of ISO Volume utility.

3. Click Run in the action pane.

4. Enter appropriate settings to all fields. Click Run.


Settings for local fast migration

Source Volume
Specify the source volume(s) name. The following characters are provided
therefore:

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]

Use target jukebox from archive


Enter the target archive name.

Use target jukebox from pool


Enter the target pool name.

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 Migrate_Volumes job and
• all previous jobs have been processed.

272 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
25.2. Creating a fast migration job for ISO volumes

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
documents is not changed. Verification of the entire ISO image is performed
automatically against the built-in ISO checksum.

OpenText Archive Center – Administration Guide 273


AR160200-00-ACN-EN-03
Chapter 26
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 279

26.1 Starting monitoring


To start monitoring:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Select the VolMig Status utility.

3. Click Run in the action pane.

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.

OpenText Archive Center – Administration Guide 275


AR160200-00-ACN-EN-03
Chapter 26 Monitoring the migration progress

26.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.
• 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 volume or is writing
that image file to the target storage.
• 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.

276 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
26.2. States of migration jobs

• 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 280).
• 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 279).
• 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 279).

OpenText Archive Center – Administration Guide 277


AR160200-00-ACN-EN-03
Chapter 27

Manipulating migration jobs

The volume migration provides utilities to manipulate running migration jobs, by


using Administration Client.

27.1 Pausing a migration job


You can pause a migration job and continue it later. See “Continuing a migration
job” on page 279. This can be useful to prefer other jobs.

To pause a migration job:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Determine the ID of the migration job you want to pause via the VolMig Status
utility; see “Monitoring the migration progress“ on page 275.

3. Select the VolMig Pause Migration Job utility.

4. Click Run in the action pane.

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.

27.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:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Determine the ID of the migration job you want to continue via the VolMig
Status utility; see “Monitoring the migration progress“ on page 275.

3. Select the VolMig Continue Migration Job utility.

4. Click Run in the action pane.

5. Enter the ID of the migration job that you want to continue in the Migration Job
ID(s) field.

OpenText Archive Center – Administration Guide 279


AR160200-00-ACN-EN-03
Chapter 27 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.

27.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 280.

To cancel a migration job:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Determine the ID of the migration job you want to cancel via the VolMig Status
utility. See “Monitoring the migration progress“ on page 275.

3. Select the VolMig Cancel Migration job utility.

4. Click Run in the action pane.

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.

27.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:

1. Select Utilities in the System object in the console tree. All available utilities are
listed in the top area of the result pane.

2. Determine the ID of the migration job you want to renew via the VolMig Status
utility. See “Monitoring the migration progress“ on page 275.

3. Select the VolMig Renew Migration job utility.

4. Click Run in the action pane.

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.

280 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Chapter 28
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.

28.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.

28.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.

OpenText Archive Center – Administration Guide 281


AR160200-00-ACN-EN-03
Chapter 28 Volume migration utilities

28.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 28-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

282 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
28.4. Changing the target pool of write jobs

28.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.

28.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.

OpenText Archive Center – Administration Guide 283


AR160200-00-ACN-EN-03
Chapter 28 Volume migration utilities

28.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 Center
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.

28.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).

284 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
28.8. Statistic about components on certain volumes

28.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.

28.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.

OpenText Archive Center – Administration Guide 285


AR160200-00-ACN-EN-03
Chapter 29

Attribute migration

Archive Center 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 120 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

OpenText Archive Center – Administration Guide 287


AR160200-00-ACN-EN-03
Chapter 29 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 120 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 250.

2. When requested, enter the number of errors to review or keep the field empty to
use the default value (1000).

288 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
Part 5
Monitoring
Chapter 30
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 Centers and Document Pipeline hosts via network. Archive
Monitoring Web Client is installed on the Archive Center and is performed in a
browser, accessible with an URL.

The utilities provides the following functions:

Administration Client
• 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 293)
• Checking free disk space

Archive Server Monitoring


• Checking statistics about archiving and retrieving activities and the Archive
Center‘s read/write performance.
• Checking the error queues of the Archive Center components.
• Checking reported quota limit violations.

For more information about Archive Server Monitoring, see “Using OpenText
Archive Server Monitoring“ on page 303.

Document Pipeline Info


• Checking the correct document flow in Archive Center
• Checking the correct document flow in Document Pipelines
• Locating problems
For more information about Document Pipeline Info, see OpenText Document
Pipelines - Overview and Import Interfaces (AR-CDP).

OpenText Archive Center – Administration Guide 291


AR160200-00-ACN-EN-03
Chapter 31
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 293.
2. Create the type and settings of the notifications and assign them specific event
filters; see “Creating and modifying notifications” on page 297.

31.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 294.
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.

OpenText Archive Center – Administration Guide 293


AR160200-00-ACN-EN-03
Chapter 31 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 294
• “Available event filters” on page 296
• “Creating and modifying notifications” on page 297
• “Checking alerts” on page 301

31.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

294 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
31.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 293


• “Available event filters” on page 296
• “Creating and modifying notifications” on page 297
• “Checking alerts” on page 301

OpenText Archive Center – Administration Guide 295


AR160200-00-ACN-EN-03
Chapter 31 Monitoring with notifications

31.1.2 Available event filters


Preconfigured A number of preconfigured events are delivered with the installation of Archive
events Center. 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
Message class: Server or <any>
Component: Monitor Server
Message code: -

296 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
31.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
Message class: Server or <any>
Component: Monitor Server
Message code: -

Related Topics
• “Conditions for event filters” on page 294
• “Checking alerts” on page 301
• “Creating and modifying notifications” on page 297

31.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 301
• 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 298.

5. Click OK. The new notification is created.

6. Select the new notification in the top area of the result pane.

OpenText Archive Center – Administration Guide 297


AR160200-00-ACN-EN-03
Chapter 31 Monitoring with notifications

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 298
• “Checking alerts” on page 301
• “Using variables in notifications” on page 300

31.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 301).

298 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
31.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 300). 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 300).
Active Period
Weekdays and time of the day at which the notification is to be sent.

Related Topics
• “Creating and modifying notifications” on page 297

OpenText Archive Center – Administration Guide 299


AR160200-00-ACN-EN-03
Chapter 31 Monitoring with notifications

• “Checking alerts” on page 301


• “Using variables in notifications” on page 300

31.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 298
• “Checking alerts” on page 301

300 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
31.3. Checking alerts

31.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

OpenText Archive Center – Administration Guide 301


AR160200-00-ACN-EN-03
Chapter 32
Using OpenText Archive Server Monitoring

Tasks The OpenText Archive Server Monitoring Web Client provides the following
monitoring functions:
• Archive Center Statistics - Checking the archiving and retrieving activities and
the Archive Center’s read/write performance.
• Archive Center Health Status - Checking the status of the Archive Center
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 Center Threat Detection - Checking quota limit violations reported for
Archive Center 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 Center 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
Center host, for example,
https://alpha.opentext.com:8090/archive/monitoring (see “Starting the
Archive Monitoring Web Client” on page 306).

Warning and With Administration Client, you can configure warning and error messages that are
error messages sent when the status of Archive Center components changes (see “Monitoring with
notifications“ on page 293). You can also use external system management tools
within the scope of special project solutions.

Security
• The Archive Monitoring Web Client requires authentication.
• As the Archive Monitoring Web Client uses basic authentication, it is strongly
recommended to use the HTTPS protocol.

OpenText Archive Center – Administration Guide 303


AR160200-00-ACN-EN-03
Chapter 32 Using OpenText Archive Server Monitoring

32.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 304
• OpenText Directory Services (OTDS): see “Creating a dedicated group for the
Archive Monitoring Web Client (OTDS)” on page 305

32.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 Center.

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 Center > 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:
i. In the console tree, select Archive Center > 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.

304 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
32.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.

32.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 Center.

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 Center > 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:
i. In the console tree, select Archive Center > System > Users and Groups
ii. In the action pane, click New Group.

OpenText Archive Center – Administration Guide 305


AR160200-00-ACN-EN-03
Chapter 32 Using OpenText Archive Server Monitoring

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 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 Center 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 Center 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.

32.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

306 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
32.3. Archive Center Statistics

Variable Description Example


<prot> Protocol https orhttp
(not recommend
<server> Name of the administered Archive Center 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 Center Statistics
see “Archive Center Statistics” on page 307
• Archive Center Health Status
see “Archive Center Health Status” on page 308
• Archive Center Threat Detection
see “Threats” on page 310

32.3 Archive Center Statistics


The monitor reports the Archive Center activities for Archiving and Retrieving
documents.

Diagrams show the number of Components and the Data volume handled by the
Archive Center 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 Center activities.
• Supported diagrams:
• Number of components handled by the Archive Center (read/write)
• Data volume (MB) handled by the Archive Center (read/write)
• Read/write performance (MB/s) of the Archive Center
• Supported time periods:
• Last 24 hours (hourly)
• Last 7 days (daily)
• Last 30 days (daily)

OpenText Archive Center – Administration Guide 307


AR160200-00-ACN-EN-03
Chapter 32 Using OpenText Archive Server Monitoring

• Last 26 weeks (weekly)


• Last 12 months (monthly)
• Last 36 months (monthly)
• Enabling/disabling the Archive Center statistics
• To enable the Archive Center statistics, the <AS.DS.STATISTIC> and
<AS.DS.USE_ACCOUNTING> variables must be set to on.
• The Archive Center statistics is enabled by default.
• To disable the Archive Center 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 115).

32.4 Archive Center Health Status


The monitor checks the status and error queues of the Archive Center 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 309
• “Storage Manager” on page 309
• “Services” on page 309
• “Pools and Volumes” on page 310

Note: Depending on the installed Document Pipelines and the current Archive
Center configuration, the Health Status can report more status change groups.

308 OpenText Archive Center – Administration Guide


AR160200-00-ACN-EN-03
32.4. Archive Center Health Status

32.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.

32.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

32.4.3 Services
The monitor checks the Document Service, the Archive Center 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>)

OpenText Archive Center – Administration Guide 309


AR160200-00-ACN-EN-03
Chapter 32 Using OpenText Archive Server Monitoring

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 c