OpenText Archive Server
Administration Guide
The guide describes the administration, monitoring and maintenance of OpenText Archive Server and introduces guidelines for troubleshooting.
Rev.: 2011-May-16
This documentation has been created for software version 10.1.1.
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
Email: [email protected]
FTP: ftp://ftp.opentext.com
For more information, visit http://www.opentext.com
Copyright © by Open Text Corporation, Open Text Inc.
Open Text Corporation is the owner of the trademarks Open Text, OpenText, The Content Experts, OpenText ECM Suite, OpenText eDOCS, eDOCS, OpenText FirstClass, FirstClass, OpenText Exceed, OpenText HostExplorer, OpenText Exceed OnDemand, OpenText Exceed 3D, OpenText Exceed Freedom, OpenText Exceed PowerSuite, OpenText Exceed XDK, OpenText NFS Solo, OpenText NFS Client, OpenText NFS Server, OpenText NFS Gateway, OpenText Everywhere, OpenText Real Time, OpenText Eloquent Media Server, OpenText Integrated Document Management, OpenText IDM, OpenText DocuLink, Livelink, Livelink ECM, Artesia, RedDot, RightFax, RKYV, DOMEA, Alchemy, Vignette, Vizible, Nstein, LegalKEY, Picdar, Hummingbird, IXOS, Alis Gist-in-Time, Eurocortex, Gauss, Captaris, Spicer, Genio, Vista Plus, Burntsand, New Generation Consulting, Momentum Systems, DOKuStar, and RecoStar among others. This list is not exhaustive. All other products or company names are used for identification purposes only, and are trademarks of their respective own-ers. All rights reserved.
Table of Contents
List of Tables ... 13
List of Figures... 15
PRE
Introduction
17
i About This Document... 17ii Further Information... 18
iii Conventions ... 19
Part 1
Overview
21
1
Archive Server ... 23
1.1 Basic Features of Archive Server ... 23
1.2 Flexibility for Different Business Processes ... 23
1.3 The Main Components of Archive Server ... 23
1.4 Important Directories on Archive Server ... 25
2
Basic Principles of Archives ... 27
2.1 Documents, Data and Logical Archives ... 27
2.2 Content Capture and Storage ... 27
2.3 Content Retrieval ... 28
2.4 Logical Archives ... 29
2.4.1 Disk Buffers... 31
2.4.2 Storage Devices... 31
2.4.3 Storage Scenarios... 32
2.4.4 Pools and Pool Types ... 33
2.4.5 Caches ... 35
2.5 Jobs... 35
3
Administration Client and the Main Objects of the Archive
Server Node ... 37
3.1 Administration Client ... 37
3.2 Main Objects of the Archive Server Node... 37
3.2.1 Infrastructure ... 38
3.2.2 Archives ... 39
3.2.4 System ... 39
3.2.5 Configuration... 40
Part 2
Configuration
43
4
Setting Up the Infrastructure ...45
4.1 Configuring Disk Volumes... 45
4.1.1 Overview ... 45
4.1.2 Creating and Modifying Disk Volumes... 46
4.2 Configuring Buffers ... 47
4.2.1 Creating and Modifying a Disk Buffer ... 48
4.2.2 Attaching a Disk Volume to a Disk Buffer ... 49
4.2.3 Detaching a Volume From a Disk Buffer ... 49
4.2.4 Configuring the Purge Buffer Job... 50
4.2.5 Checking and Modifying Attached Disk Volumes ... 51
4.2.6 Synchronizing Servers ... 52
4.2.7 Configuring Replicated Buffers ... 52
4.3 Configuring Caches ... 53
4.3.1 Overview ... 53
4.3.2 Creating and Deleting Caches ... 54
4.3.3 Adding Hard-Disk Volumes to Caches... 54
4.3.4 Deleting Assigned Hard-Disk Volumes... 55
4.3.5 Defining Priorities of Cache Volumes ... 56
4.4 Installing and Configuring Storage Devices... 56
4.5 Configuring Hard Disk-Based Storage Devices (Single File VI) ... 57
4.6 Configuring Storage Devices with Optical Media (STORM) ... 58
4.6.1 Attaching and Detaching Devices ... 58
4.6.2 Inserting a Single Volume ... 58
4.6.3 Inserting Several Media at Once... 59
4.6.3.1 Offline Import... 59
4.6.3.2 Testing Jukebox Slots... 60
4.6.4 Initializing Storage Volumes... 60
4.6.4.1 Automatic Initialization and Assignment ... 61
4.6.4.2 Manual Initialization of Original Volumes... 61
4.6.4.3 Manual Initialization of Backup Volumes ... 61
4.6.4.4 Adding Volumes to Document Service ... 62
4.7 Checking Unavailable Volumes ... 62
4.8 Changing the Database User Password... 63
4.9 Setting the Reconnection Time for the Database ... 63
5
Configuring Archives and Pools...65
5.1 Logical Archives ... 65
5.1.1 Data Compression ... 66
5.1.2 Single Instance... 67
5.1.3 Retention... 69
5.1.3.1 Basics – Retention on Archive Server ... 70
5.1.3.2 Retention on Storage Systems ... 72
Table of Contents
5.1.3.4 VolumeMigration and Retention... 77
5.2 Creating and Configuring Logical Archives... 78
5.2.1 Creating a Logical Archive ... 78
5.2.2 Configuring the Archive Security Settings... 79
5.2.3 Configuring the Archive Settings... 80
5.2.4 Configuring the Archive Retention Settings ... 81
5.2.5 Activating and Configuring Timestamp Usage... 83
5.3 Creating and Modifying Pools ... 84
5.3.1 Creating and Modifying a HDSK (Write-Through) Pool ... 85
5.3.2 Creating and Modifying Pools with a Buffer... 85
5.3.2.1 Write At-Once Pool (ISO) Settings... 86
5.3.2.2 Write Incremental (IXW) Pool Settings ... 88
5.3.2.3 Single File (VI, FS) Pool Settings... 90
5.3.3 Marking the Pool as Default... 90
5.4 Creating and Modifying Storage Tiers ... 91
5.5 Enabling Certificates ... 91
5.6 Changing the Server Priorities ... 92
6
Configuring Jobs and Checking Job Protocol ... 95
6.1 Important Jobs and Commands... 95
6.2 Starting and Stopping the Scheduler ... 98
6.3 Starting and Stopping Jobs... 98
6.4 Enabling and Disabling Jobs... 98
6.5 Checking Settings of Jobs ... 99
6.6 Creating and Modifying Jobs ... 99
6.7 Setting the Start Mode and Scheduling of Jobs... 100
6.8 Checking the Execution of Jobs... 101
7
Configuring Security Settings ... 103
7.1 Overview ... 103
7.2 Authentication Using Signed URLs... 104
7.2.1 Activating SecKey Usage for a Logical Archive... 105
7.2.2 SecKeys from Leading Applications and Components... 105
7.2.3 SecKeys from SAP... 106
7.3 Encrypted Document Storage... 106
7.3.1 Activating Encryption Usage for a Logical Archive ... 107
7.3.2 Creating a System Key for Document Encryption ... 107
7.3.3 Exporting and Importing System Keys... 108
7.4 Timestamp Usage ... 111
7.4.1 Basic Settings ... 113
7.4.2 Configuring Certificates and Signature Keys ... 114
7.4.3 Creating a Hash Tree... 115
7.4.4 Renewing Hash Trees ... 115
7.4.5 Renewing Timestamps of Hash Trees... 116
7.4.6 Migrating Existing Document Timestamps... 116
7.5 Certificates ... 117
7.5.1.1 Checking a Certificate... 118
7.5.1.2 Enabling a Certificate... 119
7.5.1.3 Deleting a Certificate... 119
7.5.1.4 Creating a Certificate Using the Certtool ... 119
7.5.2 Configuring a Certificate for Authentication ... 122
7.5.2.1 Importing an Authentication Certificate... 123
7.5.2.2 Granting Privileges for a Certificate ... 124
7.5.3 Configuring a Certificate for Document Encryption... 125
7.5.3.1 Importing an Encryption Certificate... 125
7.5.4 Configuring a Certificate for Timestamp Verification ... 126
7.5.4.1 Importing a Certificate for Timestamp Verification... 126
7.6 Using Checksums ... 126
7.7 ArchiveLink Using Common Names (CN) ... 127
8
Configuring OpenText Archive Timestamp Server...129
8.1 Using the Auto Initialization Mode... 130
8.2 Configuration Using Archive Timestamp Client ... 131
8.2.1 Starting Archive Timestamp Client... 131
8.2.2 Configuring Basic Settings... 131
8.2.3 Configuring Certificates and Signature Keys ... 134
8.2.3.1 Generating a New Signature Key ... 135
8.2.3.2 Requesting a Certificate from a Trust Center ... 137
8.2.3.3 Adding New Certificates... 138
8.2.4 Checking the Status and Restarting Archive Timestamp Server... 139
8.2.5 Transmitting Configuration Parameters ... 140
8.2.6 Checking the Logfile ... 141
8.2.7 Checking and Adjusting the Time ... 141
8.2.8 Checking the Current Signature Key and Certificates Configuration... 143
8.3 Configuration Using Administration Client ... 144
8.3.1 Configuring Connection Parameters... 147
8.3.1.1 Timeproof TSS80 ... 147
8.3.1.2 AuthentiDate Via the Internet... 148
8.3.1.3 Quovadis ... 148
8.3.1.4 Archive Timestamp Server... 149
8.3.1.5 Testing the Connection ... 150
9
Configuring Users, Groups, and Policies ...153
9.1 Password Security and Settings ... 153
9.2 Concept... 155
9.3 Configuring Users and Their Rights... 155
9.4 Checking, Creating and Modifying Policies ... 156
9.4.1 Available Rights to Create Policies ... 156
9.4.2 Checking Policies... 157
9.4.3 Creating and Modifying Policies... 157
9.5 Checking, Creating and Modifying Users ... 158
9.5.1 Checking Users... 158
9.5.2 Creating and Modifying Users... 158
9.6 Checking, Creating and Modifying User Groups ... 159
Table of Contents
9.6.2 Creating and Modifying User Groups... 159
9.6.3 Adding Users and Policies to a User Group ... 160
9.7 Checking a User's Rights... 161
10
Connecting to SAP Servers ... 163
10.1 Creating and Modifying SAP System Connections... 163
10.2 Creating and Modifying SAP Gateways... 165
10.3 Assigning an SAP System to a Logical Archive... 166
11
Configuring Scan Stations... 169
11.1 Scenarios and Archive Modes ... 169
11.2 Adding and Modifying Archive Modes... 171
11.3 Adding Additional Scan Hosts... 174
11.4 Adding a New Scan Host and Assigning Archive Modes ... 174
11.5 Adding Additional Archive Modes ... 175
11.6 Changing the Default Archive Mode ... 176
11.7 Removing Assigned Archive Modes ... 176
12
Adding and Modifying Known Servers ... 177
12.1 Adding Known Servers ... 177
12.2 Checking and Modifying Known Servers ... 178
12.3 Synchronizing Servers ... 178
13
Configuring Remote Standby Scenarios ... 181
13.1 Configuring Original Archive Server and Remote Standby Server... 182
13.1.1 Configuring the Original Archive Server... 182
13.1.2 Configuring the Remote Standby Server ... 182
13.2 Backups on a Remote Standby Server... 185
13.2.1 ISO Volumes ... 185
13.2.2 IXW Volumes ... 186
13.3 Restoring of IXW or ISO Volumes ... 186
13.3.1 Restoring an Original IXW or ISO Volume... 186
13.3.2 Restoring a Replicate of an IXW or ISO Volume ... 189
14
Configuring Archive Cache Server ... 193
14.1 Restrictions Using Archive Cache Server ... 194
14.2 Configuring an Archive Cache Server in the Environment ... 197
14.2.1 Adding an Archive Cache Server to the Environment ... 197
14.2.2 Modifying an Archive Cache Server... 198
14.2.3 Deleting an Archive Cache Server... 199
14.2.4 Configuring Volumes of an Archive Cache Server ... 200
14.2.5 Changing Database Files... 202
14.3 Configuring Access Via an Archive Cache Server... 203
14.3.1 Subnet Assignment of an Archive Cache Server... 203
14.3.2 Configuring Archive Access Via an Archive Cache Server... 204
14.3.3 Configuring Access for Write-Back Scenario... 206 14.3.4 Adding and Modifying Subnet Definitions of an Archive Cache Server206
14.3.5 Deleting an Assigned Archive Cache Server... 207
14.3.6 Configuring Archive Cache Server for Multiple Archive Servers ... 207
15
Scenario Reports ...209
15.1 Generating Scenario Reports ... 209
16
Setting Configuration Variables...211
16.1 Setting and Modifying Configuration Variable Values... 211
16.2 Searching Configuration Variables ... 212
16.3 Customizing Configuration View ... 213
Part 3
Maintenance
215
17
Handling Storage Volumes ...217
17.1 When the Retention Period Has Expired ... 217
17.1.1 Checking for Empty Volumes and Deleting Them Manually ... 219
17.1.2 Deleting Empty Volumes Automatically ... 220
17.2 Exporting Volumes... 220
17.3 Importing Volumes ... 222
17.3.1 Importing ISO Volumes... 222
17.3.2 Importing Finalized and Non-Finalized IXW Volumes ... 223
17.3.3 Lost&Found for IXW Volumes... 224
17.3.4 Importing Hard-Disk Volumes ... 224
17.3.5 Importing GS Volumes for Single File (VI) Pool... 225
17.4 Consistency Checks for Storage Volumes and Documents ... 226
17.4.1 Checking Database Against Volume ... 227
17.4.2 Checking Volume Against Database ... 228
17.4.3 Checking a Document... 228
17.4.4 Counting Documents and Components in a Volume... 229
17.4.5 Checking a Volume... 230
17.4.6 Comparing Backup and Original IXW Volume... 231
17.5 Backup for Storage Systems ... 231
18
Finalizing and Backing Up of Optical Media ...233
18.1 Finalizing Storage Volumes ... 233
18.1.1 Automatic Finalization of IXW Volumes... 233
18.1.2 Manually Finalizing IXW Volumes... 234
18.1.3 Manually Finalizing IXW Pools... 234
18.1.4 Checking the Finalization Status... 235
18.1.5 Setting the Finalization Status Manually... 235
18.2 Managing Written Optical Media... 236
18.2.1 Newly Written ISO Media... 236
18.2.2 Removing Optical Media from Jukebox ... 237
18.3 Backup and Recovery of Optical Media... 237
18.3.1 Optical ISO Media ... 238
18.3.1.1 Backup of ISO Volumes... 239
Table of Contents
18.3.2 IXW Volumes ... 240
18.3.2.1 Backup of IXW Volumes ... 240
18.3.2.2 Restoring of IXW Volumes... 242
19
Backups and Recovery ... 245
19.1 Backup of the Database... 246
19.1.1 Backing Up an Oracle Database... 247
19.1.2 Backing Up an Microsoft SQL Server Database... 247
19.2 Backing Up and Restoring of the Storage Manager Configuration... 247
19.3 Backup and Recovery of an Archive Cache Server... 248
19.3.1 Backup of Archive Cache Server Data ... 248
19.3.2 Recovery of Archive Cache Server Data ... 249
20
Utilities ... 251
20.1 Starting Utilities ... 252
20.2 Checking Utilities Protocols ... 252
Part 4
Migration
255
21
About Migration... 257
21.1 Features of Volume Migration... 257
21.2 Restrictions ... 258
22
Setting Parameters of Volume Migration... 259
22.1 Setting Configuration Parameters of Volume Migration... 259
22.2 Setting Logging Parameters of Volume Migration ... 261
23
Preparing the Migration ... 263
23.1 Preparing for Local Migration... 263
23.2 Preparing for Remote Migration... 263
23.3 Preparing for Local Fast Migration of ISO Images... 265
23.4 Preparing for Remote Fast Migration of ISO Images... 265
24
Creating a Migration Job ... 267
24.1 Creating a Local Migration Job ... 267
24.2 Creating a Remote Migration Job ... 270
24.3 Creating a Local Fast Migration Job for ISO Volumes... 272
24.4 Creating a Remote Fast Migration Job for ISO Volumes... 273
25
Monitoring the Migration Progress ... 277
25.1 Starting Monitoring ... 277
25.2 States of Migration Jobs ... 278
26
Manipulating Migration Jobs ... 281
26.1 Pausing a Migration Job ... 281
26.3 Canceling a Migration Job ... 282
26.4 Renewing a Migration Job ... 282
27
Volume Migration Utilities ...285
27.1 Deleting a Migration Job ... 285
27.2 Finishing a Migration Job Manually... 285
27.3 Modifying Attributes of a Migration Job... 285
27.4 Changing the Target Pool of Write Jobs... 286
27.5 Determining Unmigrated Components ... 287
27.6 Switching Component Types of Two Pools ... 287
27.7 Adjusting the Sequence Number for New Volumes... 288
27.8 Statistic About Components on Certain Volumes... 288
27.9 Collecting Diagnostic Information ... 288
Part 5
Monitoring
289
28
Everyday Monitoring of the Archive System ...291
29
Monitoring with Notifications...293
29.1 Creating and Modifying Event Filters ... 293
29.1.1 Conditions for Event Filters... 294
29.1.2 Available Event Filters ... 296
29.2 Creating and Modifying Notifications ... 297
29.2.1 Notification Settings ... 298
29.2.2 Using Variables in Notifications ... 300
29.3 Checking Alerts ... 301
30
Using Archive Monitoring Web Client ...303
30.1 First Steps and Overview... 303
30.1.1 Starting Archive Monitoring Web Client ... 303
30.1.2 Archive Monitoring Web Client Window... 304
30.1.3 Setting the Refresh Interval ... 306
30.1.4 Adding and Removing Hosts ... 306
30.1.5 Configuring the Icon Type... 307
30.1.6 Customizing Archive Monitoring Web Client... 307
30.2 Component Status Display ... 308
30.2.1 DP Space ... 308
30.2.2 Storage Manager ... 308
30.2.3 DocService (Document Service)... 309
30.2.4 DS Pools ... 310
30.2.5 DS DP Tools, DS DP Queues, DS DP Error Queues... 310
30.2.6 Log Diskspace... 310
30.2.7 DP Tools, DP Queues, DP Error Queues... 311
30.2.8 Timestamp Service ... 313
31
Auditing, Accounting and Statistics...315
Table of Contents
31.1.1 Configuring Auditing... 315
31.1.2 Accessing Auditing Information... 315
31.2 Accounting ... 318
31.2.1 Settings for Accounting ... 318
31.2.2 Evaluating Accounting Data... 319
31.3 Storage Manager Statistics... 321
Part 6
Troubleshooting
323
32
Basics ... 325
32.1 Avoiding Problems ... 325
32.2 Viewing Installed Archive Server Patches ... 325
32.3 Correcting Wrong Installation Settings... 326
32.4 Monitoring and Administration Tools... 327
32.5 Deleting Log Files ... 327
33
Starting and Stopping of Archive Server... 329
33.1 Starting and Stopping Under Windows ... 329
33.2 Starting and Stopping Under UNIX ... 330
33.3 Starting and Stopping Single Services with spawncmd... 331
33.4 Setting the Operation Mode of Archive Server ... 332
34
Analyzing Problems ... 333
34.1 Spawner Log File ... 333
34.2 Analyzing Processes with spawncmd... 333
34.3 Working with Log Files ... 335
34.3.1 About Log Files ... 335
34.3.2 Setting Log Levels... 336
34.3.3 Log Settings for Archive Server Components (Except STORM) ... 336
34.3.4 Log Levels and Log Files for STORM... 337
GLS
Glossary
339
List of Tables
• “Cache configuration” (page 53) • “Types of storage devices” (page 57) • “Retention period types” (page 71) • “Retention behavior settings” (page 72) • “Retention on storage systems” (page 73) • “Purging content” (page 76)
• “Deletion on backup media” (page 76) • “Preconfigured jobs” (page 95) • “Pool-related jobs” (page 96) • “Other jobs” (page 97)
• “Generate self-signed certificates” (page 120) • “Request a certificate from a trust center” (page 121)
• “Send the certificate to an Archive Server (putCert)” (page 121) • “Administrative WebServices” (page 156)
• “Restrictions using Archive Cache Server” (page 195) • “Overview of utilities” (page 251)
• “Fields in accounting files” (page 319)
List of Figures
Figure 1-1: “Main components of Archive Server” on page 24 Figure 2-1: “Content capture and storage” on page 28
Figure 2-2: “Content retrieval” on page 29 Figure 2-3: “Logical archives” on page 30
Figure 2-4: “Pool types and storage systems” on page 34 Figure 3-1: “Main objects of Archive Server” on page 38 Figure 4-1: “Filling the local cache” on page 53
Figure 13-1: “Remote Standby scenario” on page 181 Figure 14-1: “ Archive Cache Server scenario” on page 194
Figure 14-2: “Example of subnet assignment of Archive Cache Servers” on page 204
Preface
Introduction
OpenText Archive Server (short Archive Server) provides a full set of services for content and documents. Archive Server can either be used as an integral part of the Enterprise Library or as stand-alone server in various scenarios.
i About This Document
Structure This manual describes all jobs that are relevant after Archive Server is installed on a
machine:
“Overview” on page 21
Read this part to get an introduction of Archive Server, the architecture, the storage systems and basic concepts like logical archives and pools. You find also a short introduction to the Administration Client and its main objects.
“Configuration” on page 43
This part describes also the preparation of the system and the configuration of Archive Server: logical archives, pools, jobs, security settings, connections to SAP and scan stations.
“Maintenance” on page 215
Here you find all tasks to keep the system running: how to prepare and handle storage media, backups and recovery.
“Migration” on page 255
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 323
This part provides support if problems occur and hints how you can avoid lems. It explains where to find the log files and how to find the cause of the prob-lem. If fatal problems occur, you have to contact OpenText Customer Support.
Audience and
knowledge This document is written for administrators of Archive Server, and for the project managers responsible for the introduction of archiving. All readers share an interest
in administration tasks and have to ensure the trouble-free operation of Archive Server. These are the issues dealt with in this manual. The following knowledge is required to take full advantage of this document.
• A general understanding of TCP/IP networks, HTTP protocol, network and data security, and the databases (ORACLE or MS SQL Server).
• Additional knowledge of NFS file systems would be helpful.
Besides these technical backgrounds, a general understanding of the following business issues is important:
• the number and type of documents to be electronically archived each day or each
month
• how often archived documents will be retrieved
• are retrieval requests predictable or independent
• for what period of time documents will be frequently accessed • the length of time for which documents must be archived
• which archived documents are highly sensitive and might have to be updated
(personal files, for example).
On the basis of this information you can decide which scenario you are going to use for archiving and how many logical archives you need to configure. You can determine the size of disk buffers and caches in order to guarantee fast access to archived data.
ii Further Information
This manual This manual is available in PDF and HTML format and can be downloaded from the
OpenText Knowledge Center
(https://knowledge.opentext.com/knowledge/llisapi.dll/open/12331031). You can print the PDF file if you prefer to read longer text on paper.
Online help For all administration clients (Administration Client, Archive Monitoring Web
Client, Document Pipeline Info and configuration properties), online help files are available. You can open the online help via help menu, help button, or F1.
Other manuals In addition to this Administration Guide, use part 7 "Configuration Parameter
Reference" in OpenText Archive Server - Administration Help (AR-H-ACN) for a reference of all configuration properties.
To learn about Document Pipelines and their usage in document import scenarios, refer to the guide OpenText Document Pipelines - Overview and Import Interfaces (AR-CDP).
OpenText Online (http://online.opentext.com/) is a single point of access for the product information provided by OpenText. You can access the following support sources through OpenText Online:
• Communities • Knowledge Center
Introduction
OpenText Online Communities
(http://communities.opentext.com/communities/livelink.exe/open/OpenTextOnli neCommunity) provide the following resources:
• Usage tips, help files, and best practices for customers and partners. • Information on product releases.
• User groups and forums where you can ask questions of OpenText experts.
The OpenText Knowledge Center (https://knowledge.opentext.com) is OpenText's corporate extranet and primary site for technical support. The Knowledge Center is the official source for the following:
• Product downloads, patches, and documentation including Release Notes.
• Discussion forums, Online Communities, and the Knowledge Base. • OpenText Developer Network (OTDN), which includes developer
documentation and programming samples for OpenText products. If you need additional assistance, you can find OpenText Corporate Support Contacts at http://support.opentext.com/.
iii Conventions
User interfaceThis format is used for elements in the graphical user interface (GUI), such as buttons, names of icons, menu items, and fields.
Filenames,commands, and sample data
This format is used for file names, paths, URLs, and commands at the command prompt. It is also used for example data, text to be entered in text boxes, and other literals.
Note: If you copy command line examples from a PDF, be aware that PDFs can contain hidden characters. OpenText recommends copying from the HTML version of the document, if it is available.
KEY NAMES
Key names appear in ALL CAPS, for example: Press CTRL+V.
<Variable name>
Angled brackets < > are used to denote a variable or placeholder. The user replaces the brackets and the descriptive content with the appropriate value. For example, <server_name> becomes serv01.
Internal cross-references
Click the cross-reference to go directly to the reference target in the current document.
External cross-references
External cross-references are usually text references to other documents. However, if a document is available in HTML format, for example, in the
Knowledge Center, external references may be active links to a specific section in the referenced document.
Warnings, notes, and tips
Caution
Cautions help you avoid irreversible problems. Read this information carefully and follow all instructions.
Important
Important notes help you avoid major problems. Note: Notes provide additional information about a task. Tip: Tips offer you quicker or easier ways of performing a task.
Part 1
Overview
Chapter 1
Archive Server
1.1 Basic Features of Archive Server
Archive Server provides a complete set of services for content and documents. These services incorporate:
• Store and retrieve content • Content lifecycle
• Storage virtualization
• Caching and Archive Cache Servers
• Single instance archiving
• Long-term preservation and readability • secKeys and timestamps
• Compression and encryption • Retention handling
• Backup and replication
• Disaster recovery • High availability
1.2 Flexibility for Different Business Processes
Depending on the business process, the content type and the storage devices, Archive Server provides different techniques to store and access documents. This guarantees optimal data and storage resource management. Large or distributed Enterprise Library implementations can consist of several Archive Servers. To support disaster recovery, servers can be replicated. Additional Archive Cache Servers can speed up the access to the archived documents. Archive Cache Server is used in distributed environments with low network bandwidth (optional).1.3 The Main Components of Archive Server
The following figure shows the main components of Archive Server and its environment.Figure 1-1: Main components of Archive Server Applications
Application or services deliver documents or content to Archive Server using Archive Services or Archive Link. Retrieval requests are also sent by applications to get documents back from the Archive Server.
Archive Server
Archive Server incorporates the following components for storing, managing and retrieving documents and data:
• Document Service (DS), handles the storage and retrieval of documents and
components.
• Storage Manager (STORM), manages and controls the storage devices. • Administration Server, provides the interface to the Administration Client
which helps the administrator to create and maintain the environment of Archive Servers, including logical archives, storage devices, pools, etc. Administration Tools
To administer, configure and monitor the components mentioned above, you can use the following tools:
• Administration Client is the tool to create logical archives and to perform most of
the administrative work like user management and monitoring. See also “Important Directories on Archive Server” on page 25.
• 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
1.4 Important Directories on Archive Server
resources. This information is gathered by the Archive Monitoring Server from Archive Server. See also “Using Archive Monitoring Web Client” on page 303.
• Archive Timestamp Client is used to configure Archive Timestamp Server. See
“Starting Archive Timestamp Client” on page 131.
• Document Pipeline Info is used to monitor the processes in the OpenText
Document Pipeline. Storage Devices
Various types of storage devices offered by leading storage vendors can be used by Archive Server for long-time archiving. See “Storage Devices” on page 31.
1.4 Important Directories on Archive Server
During the installation, several directories are created and the default settings can be modified. Within this manual, the following variables are used for these directories. You should replace these variables with the values that are specified on your system.
<OT install AS>
Directory used for Archive Server program files.
Windows default: C:\Program Files\Open Text\Archive Server x.x.x\
UNIX default: /opt/opentext/ArchiveServerSoftware_x_x_x/
<OT config AS>
Directory used for Archive Server configuration files.
Windows default: C:\Documents and Settings\All Users\Application Data\Open Text\Archive Server x.x.x\config\
UNIX default: /opt/opentext/ArchiveServerConfig_x_x_x/
<OT logging>
Directory used for Archive Server log files.
Windows default: C:\Documents and Settings\All Users\Application Data\Open Text\var\LogDir\
UNIX default: /var/adm/opentext/log/
<OT var>
Directory used for Archive Server variables.
Windows default: C:\Documents and Settings\All Users\Application Data\Open Text\var\
UNIX default: /var/adm/opentext/
<OT install SPAWNER>
Directory used for SPAWNER program files.
Windows default: %COMMON FILES%\Opent Text\Spawner\bin
Chapter 2
Basic Principles of Archives
2.1 Documents, Data and Logical Archives
Documents and data to be archived can consist of a number of components.
Examples are documents (main component) with notes and annotations or an email document, which consists of an information header, the message body and possible attachments. Within this guide, “content” is used to label all components belonging together. Normally, all content components are stored together on the same type of medium. However, it is also possible to separate the components and store them on different media. For example, you can store documents on an optical, and the notes on a hard disk. Documents are identified by a unique ID. The leading application uses this ID for content retrieval. Archive Server delivers all components belonging to this ID to the leading application.
Archive Server only stores the content of documents. The metadata describing the business context of the documents are stored in Enterprise Library’s metadata repository or leading application. The link between the metadata and the content is the unique ID mentioned above.
Archive Server represents a large virtual storage system, which can be used by various applications. All documents that belong to a business process can be
grouped together by the concept of a logical archive. In general, a logical archive is a collection of documents that have similar properties.
On a single Archive Server, a multitude of logical archives can be created. Often, shortly “archive” is used instead of “logical archive”.
2.2 Content Capture and Storage
The following description shows a usual way to capture and store content. Depending on your requirements, variations of this description are possible.
Figure 2-1: Content capture and storage
1. The application sends the content to a logical archive created on an Archive Server.
2. Content is stored temporarily in the disk buffer.
3. Content is copied to the associated storage platform for long-time archiving. The time scheduling is configured in the Writejob. If a cache is used, the content is copied simultaneously to the cache. This can also be done by the scheduled
purge bufferjob.
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.
2.3 Content Retrieval
The following description shows a usual way to retrieve content. Depending on your requirements, variations of this description are possible.
2.4 Logical Archives
Figure 2-2: Content retrieval
1. Content is requested by a client. For this, the client sends the unique document ID and archive ID to Archive Server.
2. Archive Server checks whether the content consists of more components and where the components are stored.
3. If the content is still stored in the buffer or in the cache, it is delivered directly to the client.
4. If the content is already archived on the storage device, Archive Server sends a request to the storage device, gets the content and leads it forward to the application. Content is returned in chunks, so the client does not have to wait until the complete file is read. That is important for large files or if the client only reads parts of a file.
2.4 Logical Archives
Archive Server is storing the data in a well-organized way. The logical organization unit is the logical archive. You can organize documents in different logical archives according to the following criteria:
• Metadata belonging to the content • Leading application
• Document lifecycle or the retention period
• Archiving and cache strategy • Storage system and media types
• Security requirements for documents
• Customer relations (for ASPs)
The logical archive does not determine where and the way the content is archived. The archive settings define the general aspects of data handling during archiving, retrieval, and at the end of the document lifecycle.
Important settings are:
• compression
• single instance archiving
• caching
• restrictions to ensure document security (signatures, certificates, SSL, encryption,
timestamps)
• auditing mode • retention settings
Below you find an overview of the main components of logical archives.
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
2.4 Logical Archives
• Buffer(s) and disk volumes to store incoming content temporarily; see also “Disk Buffers” on page 31.
• Storage devices and storage volumes for long-time archiving of content; see also
“Installing and Configuring Storage Devices” on page 56.
• Cache to accelerate content retrieval. Only necessary if slow storage devices are
used; see also “Caches” on page 35.
• Retention period for content; see also “Retention” on page 69.
• Compression and encryption settings; see also “Data Compression” on page 66 and “Encrypted Document Storage” on page 106.
• Security settings and certificates; see also “Configuring the Archive Security Settings” on page 79.
• An Archive Cache Server, if used; see also “Configuring Archive Cache Server”
on page 193.
2.4.1 Disk Buffers
The buffer (or disk buffer) is a hard-disk volume where the content is physically collected until the Writejob 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 Writejob regularly checks the amount of data and writes the image, if there is
sufficient data in the buffer. In other pools, the Writejob writes all data that has
been arrived in the buffer since the last run of the job. Sufficient free disk space must be available in the buffer in order to accommodate new incoming documents. The documents that have already been written to the storage media must therefore be deleted from the disk buffer at regular intervals. This can only be done if a copy of the document has successfully been stored on the long-term storage. This is usually done by the Purge Bufferjob.
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.
See also:
• “Configuring Buffers” on page 47
• “Configuring Disk Volumes” on page 45
2.4.2 Storage Devices
Various types of storage devices offered by leading storage vendors can be used by Archive Server for long-time archiving:
• CAS: Content Addressed Storage
• NAS: Network Attached Storage
• SAN: Storage Area Network
• Opticals:
• DVD: Digital Versatile Disk • UDO: Ultra Density Optical • WORM: Write Once Read Many
Archive Server primarily supports storage devices that offer WORM functionality, retention handling, or HSM functionality. Depending on their type, the storage devices are connected via STORM, VI (vendor interface) or API (application programming interface).
See also:
• “Installing and Configuring Storage Devices” on page 56 • “Pools and Pool Types” on page 33
• “Creating and Modifying Pools” on page 84
2.4.3 Storage Scenarios
Regarding the archiving of and access to individual documents over its lifecycle, we differentiate between single file storage and container file storage. “Single file storage” means that documents are archived individually on the storage platform. “Container file storage” indicates that the documents are bundled in containers like ISO images or blobs.
Below you find criteria for single file storage and ISO images. Single file storage
• Large files in COLD scenarios
• Document requires individual treatment
• Lifecycle of document not known or depends on metadata
• Individual deletion of documents on the end of the lifecycle required
• More administration effort • Time-consuming migration
ISO images
• Very small files • Same document type
• Same lifecycle
2.4 Logical Archives
• Less administration effort
• Simple backup or migration • Partial read access to documents
See also:
• “Installing and Configuring Storage Devices” on page 56 • “Pools and Pool Types” on page 33
• “Creating and Modifying Pools” on page 84
2.4.4 Pools and Pool Types
At least one pool belongs to each logical archive. A pool points to a certain type of physical storage devices that are written in the same way. Components are assigned to the pool using storage tiers; see “Creating and Modifying Storage Tiers” on page 91. A special type is “Migration” that is used for document migration within the archive.
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. An optical storage media can contain one or two ISO volumes, depending on the type of media (single or double side). The storage volumes are either hard disks providing the WORM feature (HD-WO) or optical volumes (DVD and UDO or WORM in jukeboxes). These systems are managed as virtual or physical jukeboxes in the Administration Client. ISO pools require a disk buffer.
IXW pool, Write incremental
In an IXW pool, documents are written incrementally to storage media. Supported storage media are optical media, UDOs and WORMs placed in jukeboxes. Each side of a medium represents a volume. The IXW file system information manages the physical location of the documents on the volume. When an IXW volume has been filled with documents, it can be finalized. Then the archived documents are managed by the ISO file system of STORM, and the index information is deleted from the IXW file system information. Finalized IXW volumes behave like ISO volumes, but distinguish from ISO images in that only an ISO header exists on the volume, e.g. Bulk Migration is not supported for finalized IXW volumes.
Documents are written as single files to the volume. They cannot be deleted from finalized volumes which are read-only volumes. Only logical deletion from non-finalized volumes is possible, as physical deletion of data is not possible from optical WORMs. IXW volumes require a disk buffer.
FS pool, Single file
The FS pool (FS = File System interface) points to mounted hard-disk volumes of an HSM, NAS or SAN system over the network. FS pools support single file storage. They require a disk buffer.
VI pool, Single file
The VI pool (VI = Vendor interface) is connected to the storage system via the API of the storage vendor. VI pools support single file storage. They require a disk buffer. This storage scenario is sometimes also referred to as GS
(Generalized Store) scenario. HDSK pool, Write through
In an HDSK (HDSK = hard disk) pool, documents are stored directly to the storage, which can be a local file system directory or a local SAN system. HDSK pools support single file storage. It is the only pool type that works without a buffer. No WORM functionality is available.
Note: As HDSK pools do not use a buffer, they are not intended for use in productive archive systems. Use them only for test purposes.
The following figure illustrates the dependencies between pool types and storage systems.
Figure 2-4: Pool types and storage systems
See also:
• “Creating and Modifying Pools” on page 84
2.5 Jobs
2.4.5 Caches
Caches are used to speed up the read access to documents. Archive Server can use several caches: the disk buffer, the local cache volumes and an Archive Cache Server. The local cache resides on the Archive Server and can be configured. The local cache is recommended to accelerate retrieval actions especially with optical storage devices. 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. See also:
• “Configuring Caches” on page 53 • “Configuring Disk Volumes” on page 45
• “Configuring Archive Cache Server” on page 193
2.5 Jobs
Jobs are recurrent tasks, which are automatically started according to a time schedule or when certain conditions are met. This allows, for example, that temporarily stored content is transferred automatically from the disk buffer to the storage device. See also “Configuring Jobs and Checking Job Protocol” on page 95.
Chapter 3
Administration Client and the Main Objects of the
Archive Server Node
3.1 Administration Client
Administration Client is used to configure Archive Server and to perform most of your administrative work:
• Administering users and rights • Creating logical archives and pools • Administering devices and volumes • Defining disk buffers
• Planning and monitoring jobs
• Configuring server connections (to other Archive Servers, to Archive Cache
Servers, to SAP servers, etc.)
• Inserting volumes
• Defining the settings for archive modes • Configuring events and notifications
• Setting configuration parameters
The structure of this documentation corresponds to the structure of the program. If you need to find information quickly concerning a particular window, press F1to
open the associated context online help.
3.2 Main Objects of the Archive Server Node
In this section you find an overview and a short description of the main objects of the Archive Server node in the console tree. Cross-references are leading to detailed descriptions of the different objects.
Figure 3-1: Main objects of Archive Server
3.2.1 Infrastructure
Within this object, you configure the required infrastructure objects to enable the usage with logical archives.
Buffers
Documents are collected in disk buffers before they are finally written to the storage medium. To create disk buffers, see “Configuring Buffers” on page 47. To get more information about buffer types, see “Disk Buffers” on page 31. Caches
Caches are used to accelerate the read access to documents. To create caches, see “Configuring Caches” on page 53.
Devices
Storage devices are used for long-time archiving. To configure storage devices, see “Installing and Configuring Storage Devices” on page 56.
Disk Volumes
Disk volumes are used for buffers and pools. To configure disk volumes, see “Configuring Disk Volumes” on page 45.
3.2 Main Objects of the Archive Server Node
3.2.2 Archives
Within this object, you create logical archives and pools, you can define replicated archives for remote standby scenarios and you can see external archives of known servers.
Original Archives
Logical archives of the selected server. To create and modify archives, see “Configuring Archives and Pools” on page 65.
Replicated Archives
Shows replicated archives; see “Logical Archives” on page 65. External Archives
Shows external archives of known servers; see “Logical Archives” on page 65.
3.2.3 Environment
Within this object, you configure the environment of an Archive Server. For example, Archive Cache Servers must first be configured in the environment if it should be assigned to a logical archive.
Cache Servers
Cache servers can be used to accelerate content retrieval in a slow WAN. See “Configuring Archive Cache Server” on page 193
Known Servers
Known servers are used for replicating archives in remote standby scenarios. See “Adding and Modifying Known Servers” on page 177.
SAP Servers
The configuration of SAP gateways and systems to connect SAP servers to Archive Server. See “Connecting to SAP Servers” on page 163.
Scan Stations
The configuration of scan stations and archive modes to connect scan stations to Archive Server. See “Configuring Scan Stations” on page 169.
3.2.4 System
Within this object, you configure global settings for the Archive Server. You also find all jobs and a collection of useful utilities.
Alerts
Displays alerts of the “Admin Client Alert” type. See “Checking Alerts” on page 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, e.g. 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 95.
Key Store
The certification store is used to administer encryption certificates, security keys and timestamps. See “Configuring a Certificate for Document Encryption” on page 125.
Policies
Policies are a combination of rights which can be assigned to user groups. See “Checking, Creating and Modifying Policies” on page 156.
Reports
Reports contains the tabs "Reports" and "Scenarios" which display the generated reports and available scenarios respectively. See “Generating Scenario Reports” on page 209.
Storage Tiers
Storage tiers designate different types of storage. See “Creating and Modifying Storage Tiers” on page 91.
Users and Groups
Administration of users and groups. See “Checking, Creating and Modifying Users” on page 158 and “Checking, Creating and Modifying User Groups” on page 159.
Utilities
Utilities are tools which are started interactively by the administrator; see “Utilities” on page 251.
3.2.5 Configuration
Within this object, you can set the configuration variables for: Archive Server
Shows configuration variables related to the Archive Server. This includes Administration Server, database server, Document Service logging, Notification Server, Archive Timestamp Server.
Monitor Server
Shows configuration variables related to the Archive Monitoring Server and Web Client.
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 211.
Part 2
Configuration
Chapter 4
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 long-time archiving and set up the connection to the Archive Server.
3. In the Administration Client:
• 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.
4.1 Configuring Disk Volumes
4.1.1 Overview
Hard disk volumes are used for disk buffers, for local caches and as local storage devices. At first, you create these volumes at operating system level. The number and size depends on many factors and is usually defined together with OpenText experts or partners when the installation is prepared. Important factors are:
• Leading application and scenario
• Number and size of documents to be archived and accessed, per time unit • Frequency of read access
• If the volume is used as disk buffer:
Pool and media type, in particular if ISO images are written.
The buffer must be large enough to accommodate the entire storage capacity of the ISO image, and in addition, the amount of data that has to be stored in the buffer between two Writejobs.
• If the volume is used as cache:
If documents are retrieved after archiving, e.g. 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_Bufferjob to copy documents automatically to the cache (see “Configuring Caches” on page 53).
• If the volume is used as storage device:
Hard disk volumes can be used for NAS (Network Attached Storage) systems and as local storage device (HDSK pool). Using HDSK pools is only
recommended for test purposes. Ensure that the volume is large enough to store your test documents.
4.1.2 Creating and Modifying Disk Volumes
The hard disks must be partitioned at the operating system level first. These disk volumes can be added in Administration Client to be used by Archive Server. This process is called creating. After creating, the disk volumes can be used as buffer, pool, or local storage device of a logical archive.
To create disk volumes:
1. Create the volumes at the operating system level. 2. Start Administration Client.
3. Select Disk Volumes in the Infrastructure object of the console tree.
4. Click New Disk Volume in the action pane. The New Disk Volume window opens.
5. Enter the settings: Volume name
Unique name of the volume Mount path
Mount path of the volume in the file system. The mount path is a drive under Windows and a volume directory under UNIX.
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 it is recommended to use 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 (e.g., e:\vol2).
4.2 Configuring Buffers
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 the Storage Platform Release Notes in the Knowledge Center
(https://knowledge.opentext.com/knowledge/llisapi.dll/Open/123310 31).
6. Click Finish.
Create as many hard-disk volumes as you need.
Renaming disk
volumes To rename a disk volume, select it in the result pane and click Rename in the action 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. Further steps:
• “Creating and Modifying a Disk Buffer” on page 48
• “Creating and Modifying a HDSK (Write-Through) Pool” on page 85
• “Creating and Modifying Pools with a Buffer” on page 85
• “Write Incremental (IXW) Pool Settings” on page 88
4.2 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 Writejob. 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
4.2.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_Bufferjob. Min. free space
Minimum available storage space (%). The Purge_Buffer job deletes data from the buffer until the required percentage of storage space is available. This applies to every hard-disk volume that is assigned to the buffer. If it is not possible to delete sufficient documents from the disk buffer because these have not yet been written to storage media, the Purge_Buffer
job is terminated without a message and the required minimum amount of storage space is not available. You can check the free space in the disk buffers using Archive Monitoring Web Client (see “Using Archive Monitoring Web Client” 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 53.
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 ndays are also deleted even if the required storage space is available. Conversely, documents that are more recent than ndays 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.
4.2 Configuring Buffers
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 100.
Modifying a disk
buffer To modify a disk buffer, select it and click Properties in the action pane. Proceed in the same way as when creating a disk buffer. The name of the disk buffer and the
Purge_Bufferjob cannot be changed.
Deleting a disk
buffer To delete a disk buffer, select it and click Delete in the action pane. A disk buffer can only be deleted if it is not assigned to a pool.
4.2.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 46.
5. Click OK to attach the volume. See also:
• “Creating and Modifying Disk Volumes” on page 46 • “Creating and Modifying a Disk Buffer” on page 48
4.2.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-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.
4.2.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 IXW pools, the documents always remain in the buffer for security reasons, or the disk buffer is used as a type of cache. Documents are removed from the disk buffer using the Purge_Bufferjob. 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_Bufferduring 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 100. 5. Click Next.
6. Enter the settings for the selected start mode. 7. Click Finish.
See also:
• “Creating and Modifying Jobs” on page 99.
4.2 Configuring Buffers
4.2.5 Checking and Modifying Attached Disk Volumes
This function can be used to check the status of a volume, e.g. 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.
7. Click OK.
4.2.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 (e.g. replicated archives, pools, or buffers).
Thus you can update:
• 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.
4.2.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.