Archive Center Installation
Archive Center Installation
Use this guide for fast and easy installation of Archive Center.
AR160200-00-IGW-EN-10
OpenText™ Archive Center
Installation Guide for Windows (Integrated Archive Installer)
AR160200-00-IGW-EN-10
Rev.: 2021-Jan-28
This documentation has been created for OpenText™ Archive Center 16.2.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.
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
One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.
Disclaimer
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
GLS Glossary 69
Note: Archive Center can be used with or without the Application Layer. In
the latter case, Archive Center continues the feature set of previous Archive
Server versions (10.5.0 and before).
This documentation describes scenarios that use the Application Layer and
web clients explicitly.
For more information about the basic functionality of Archive Center, see also
OpenText Archive Center - Administration Guide (AR-ACN).
Archive Center OpenText™ Archive Center Administration is a web-based, easy-to-use client for the
Administration business administrators, which is included in Archive Center.
Archive Center is a multi-tenant solution: Several customers can use one Archive
Center without any risk of interference with each other. Business administrators
define and control the archiving activities by setting up and administrating
collections, which can only be accessed by members of their tenant group.
In each collection, a list of data sources defines the properties and sources of the
documents to be archived.
DPs Archive Center uses Document Pipelines (and their “DocTools”) to import
documents in various scenarios. The Archive Center Installer provides the base
package “OpenText Document Pipeline Base” and a pipeline for document import
using CMIS (“OpenText Document Pipeline for Archive Center CMIS”) by default.
For more information, see also OpenText Archive Center - Scenario Configuration Guide
(AR-CGD).
My Archive OpenText™ My Archive, similar to Access, is an easy-to-use web client that allows
access to the archive. In contrast, it allows individual users to access their archived
documents. Users can view, search, and download the documents only if they have
appropriate rights.
Archive Box The Archive Box option is intended for folders and documents that need to be
archived but are no longer in daily use. Thus, the required disk space on the file
server, including the total number of files, can be reduced. This is in contrast to the
shortcut scenario where every file is replaced by an individual link. If enabled for a
File Archiving data source, all folders and documents below the specified path are
archived and replaced by a single shortcut.
Related documentation
Product docu- The following documentation is available for Archive Center on OpenText My
mentation Support (https://knowledge.opentext.com/docs):
Note: Update 16.2.3 (20.2) delivers new features and fixes for Archive
Center. In this documentation we assume that Update 16.2.3 (20.2) is
installed.
• OpenText Document Pipelines - Overview and Import Interfaces (AR-CDP)
This guide describes concepts, tools, and scenarios of OpenText™ Document
Pipeline and gives detailed information on the standard DocTools.
Release Notes The Release Notes describe the following aspects in detail:
• Requirements
• Restrictions
• Important dependencies
• Last-minute changes regarding the documentation
• Identification codes of the current documentation
The Release Notes are continually updated. The latest version of the Archive Center
Release Notes is available on My Support (https://knowledge.opentext.com/
knowledge/llisapi.dll/Open/52712069).
3rd-party The following software has to be installed on the computer before you install the
software Archive Center components.
Operating system
For information about the supported systems and versions, see the Release
Notes in My Support (https://knowledge.opentext.com/knowledge/llisapi.dll/
Open/52712069). Only English language settings with default decimal separators
are supported.
Only English language settings with default decimal separators are supported.
Microsoft® Visual C++®
Archive Center requires a Microsoft Visual C++ package. For supported
versions, see the Release Notes in My Support (https://knowledge.opentext.com/
knowledge/llisapi.dll/Open/52712069).
.NET Framework
OpenText™ Administration Client requires .NET Framework. For supported
versions, see the Release Notes in My Support (https://knowledge.opentext.com/
knowledge/llisapi.dll/Open/52712069).
Verify that the “.NET Framework” feature is enabled in the Windows Server
Manager.
Note: The Archive Center Installer does not check for this requirement.
Database
Archive Center requires Microsoft® SQL Server®, Microsoft® Azure® SQL
Database, or Oracle® Database. For supported versions, see the Release Notes in
My Support (https://knowledge.opentext.com/knowledge/llisapi.dll/Open/
52712069).
The database can be installed locally or on a remote system.
Java
Archive Center requires Java™ Development Kit, or Java™ Runtime
Environment. For supported versions, see the Release Notes in My Support
(https://knowledge.opentext.com/knowledge/llisapi.dll/Open/52712069).
Application server
Archive Center requires Apache® Tomcat™. For supported versions, see the
Release Notes in My Support (https://knowledge.opentext.com/knowledge/
llisapi.dll/Open/52712069).
Basic settings
See “Configuring basic settings” on page 10 for recommended settings.
OpenText Directory Services
Directory Services (OTDS) can either be installed locally or remotely, and you
can either use an existing instance or install a new one. Depending on which
landscape you want to use, the installation paths differ. For more information,
see “Setting up Directory Services” on page 20.
Archive Center requires OTDS. OpenText recommends to use the latest OTDS
version. For supported versions, see the Release Notes in My Support (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/52712069).
• The installation directory for Archive Center is called <OT install AC>.
The default value is C:\Program Files\OpenText.
• The directory for configuration data is called <OT config AC>.
The default value is C:\ProgramData\OpenText\Archive Server 16.2.0\
config.
Procedure
• You do not install Directory Services locally but use an existing instance.
• You install Archive Center into another folder than %programfiles% for which
the user has write access.
Tip: You can grant full access to a user by running the following command:
icacls <folder> /grant <domain\user>:(OI)(CI)F
Tomcat user Tomcat must be run by a dedicated user (not LocalSystem). If this user is not a
member of the local Administrators group, some restrictions apply. For more
information, see “Running Tomcat without local administrative rights” on page 15.
Hard disk layout Most disks for Archive Center must be mirrored with RAID 1, and there must be at
least three independent disks. The secure operation of the database requires one disk
for the database and two separate disks for the log files. Archive Center stores all
documents temporarily on hard disk. This disk must be protected by RAID 5 or
RAID 1.
For the disk layout of an Oracle Database, see the Oracle documentation (http://
www.oracle.com/pls/db112/homepage).
For the disk layout of a Microsoft SQL Server database, see the following MSDN
entries:
Unwanted frag- Be aware that the file system may fragment disk partitions in an undesirable
mentation manner, depending on the used type of file system. This can lead to incorrect free
space detection, causing attempts to write data to the file system to fail, resulting in
a “no space left on device” message.
Ports to open Archive Center requires the following ports, which must be configured in the
firewall:
RPC
Tools and administration interface: 4020, 4027, 4030, 4032, 4033, 4034
TCP
HTTP/HTTPS ports for Tomcat as defined in the server.xml file (default: 8080,
8090)
Enforcing In mixed IPv4/IPv6 environments, you may need to enforce preferred usage of one
protocol of the protocols.
Tip: In the Start menu, search for edit the system environment
variables.
Related Topics
Do the same for the connection to the Enterprise Scan, if you use the mass scanning
scenario. Make sure that lookup and reverse lookup are working. If you are using a
remote database, do the same for the database server.
Note: These commands set the minimum port number to 8091 (by default,
Archive Server uses port 8090 for HTTPS). If your system requires a
different setting, for example, because an application needs a certain port
above 8091, change the commands correspondingly, where num = 65535 −
start.
For IPv4
netsh int ipv4 set dynamicport tcp start=8091 num=57444
netsh int ipv4 set dynamicport udp start=8091 num=57444
For IPv6
netsh int ipv6 set dynamicport tcp start=8091 num=57444
netsh int ipv6 set dynamicport udp start=8091 num=57444
2. Use following commands to verify the result of the previous step (for IPv6,
replace IPv4 accordingly):
>netsh int ipv4 show dynamicportrange tcp
Protocol tcp Dynamic Port Range
---------------------------------
Start Port : 8091
Number of Ports : 57444
and
>netsh int ipv4 show dynamicportrange udp
Protocol udp Dynamic Port Range
---------------------------------
3. Click OK.
You will be asked for credentials and you must restart the computer.
1. Open Device Manager > Disk Drives > Properties of the drive > Policies.
Notes
• OpenText recommends running Archive Center with the current JDK update
version to avoid security and stability issues.
• If Open JDK 11 is used you must set the JAVA_HOME path in the system
environment variable. This is not required using Oracle Java 11.
• For known issues concerning the installation of Java 8 and troubleshooting
information, see also this article in the OpenText Knowledge Base (https://
knowledge.opentext.com/knowledge/cs.dll/kcs/kbarticle/view/KB2851395).
To install Java:
1. Download the Java Development Kit (JDK) from the Oracle website (http://
www.oracle.com/technetwork/java/javase/downloads/index.html).
OpenText recommends running Archive Center with the current JDK update
version to avoid security and stability issues.
1. Install Tomcat.
2. Configure Java options to optimize performance.
3. Configure the Tomcat user and the Tomcat connectors.
1. Download the Windows Service Installer for the Tomcat software from https://
tomcat.apache.org/download-80.cgi.
OpenText recommends running Archive Center with the current Tomcat update
version to avoid security and stability issues.
Notes
Note: You can select Use default to avoid having to correct the path later,
for example, after a Java update.
Note: For optimal performance, always set Initial memory pool and
Maximum memory pool to the same value.
6. The following setting avoids problems with CMIS names or property values
that contain backslashes (\).
In the Java Options field, add the following line:
-Dorg.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH=true
7. Click OK.
9. In the line starting with .handlers = ..., remove the entry java.util.
logging.ConsoleHandler, and then save the file.
The user running Tomcat can either be a member of the local Administrators group
or a user with less permissions. In the latter case, see “Running Tomcat without local
administrative rights” on page 15.
2. In the console tree, select Groups, and then open the Properties of the
Administrators group.
3. Click Add, browse for the Tomcat user, and then click OK twice.
Tomcat user Run Tomcat with a user. Do not use the local system account.
3. Enter the name and password of the user to run the Tomcat service.
Use the <domain>\<user> notation. The <user>@<domain> notation can lead to
connection errors when running the installer.
Important
When enabling SSL/TLS, OpenText recommends using a server certificate from
a Certificate Authority. The root certificate must be trusted by the JRE or JDK
and correctly imported into the truststore (for example, <JRE_HOME>\lib\
security\cacerts or <JDK_HOME>\jdk8\jre\lib\security\cacerts).
For information about enabling SSL/TLS, see the Tomcat SSL Configuration
HOW-TO (https://tomcat.apache.org/tomcat-8.0-doc/ssl-howto.html).
Example:
<!-- Define a HTTP/1.1 Connector on port 8080 -->
<Connector port="8080"
protocol="HTTP/1.1"
redirectPort="8090"
connectionTimeout="20000"
disableUploadTimeout="true"
enableLookups="false"
/>
Notes
Example:
<!-- Define a SSL HTTP/1.1 Connector on port 8090 -->
<Connector port="8090"
SSLEnabled="true"
scheme="https"
secure="true"
sslProtocol="TLS"
sslEnabledProtocols="TLSv1.2,TLSv1.1,TLSv1"
protocol="HTTP/1.1"
acceptCount="100"
maxHttpHeaderSize="8192"
maxThreads="150"
minSpareThreads="25"
algorithm="SunX509"
clientAuth="false"
disableUploadTimeout="true"
enableLookups="false"
Notes
Further For more information, see the Tomcat SSL Configuration HOW-TO (https://
information tomcat.apache.org/tomcat-8.5-doc/ssl-howto.html).
• The access role of Archive Center requires the Include Groups from OUs
setting.
For more information, see Section 6.7 “Including/excluding groups from
organizational units” in OpenText Directory Services - Installation and
Administration Guide (OTDS-IWC).
• A user named system.cmis within the OTInternal partition. The password
should never expire. You do not need to remember the password as system.
cmis is only used as a technical user for the Application Layer (Archive
Center CMIS).
• A group called $PushConnector with an assigned user called, for example,
pushconnector.
Resource
Archive Center is represented in OTDS by a resource (a unique name and an
identifier). The Archive Center Installer takes care of creating the resource
automatically.
For more information, see Section 5.2.2 “Creating a synchronized resource” in
OpenText Directory Services - Installation and Administration Guide (OTDS-IWC).
Impersonation right
Directory Services requires the “impersonate user” right. The Archive Center
Installer sets this right automatically.
For more information, see Section 5.3 “Configuring access to your resources” in
OpenText Directory Services - Installation and Administration Guide (OTDS-IWC).
Attribute mapping configuration
The OTDS user attribute mapping and group attribute mapping depend on the
scenario. See “Scenario-specific settings” on page 22.
For more information, see also Section 5.2.1.3 “Using resource attribute
mappings” in OpenText Directory Services - Installation and Administration Guide
(OTDS-IWC).
ACLs
The CMIS ACLs must be based on OTDS user IDs (not on the user name).
Names of users and groups are treated case-insensitive in OTDS, while CMIS
allows for case-sensitive names. If the ACLs are based on the user name it can
happen that permissions are not mapped correctly, because CMIS distinguishes
between, for example, access.default@OTInternal and access.
default@otinternal.
File Archiving
Use Directory Services to let file share users be able to access their files using a
CMIS interface. File share users are mapped to Directory Services users.
Attribute mapping configuration
The oTExternalSID field must include objectSID, in the %s format.
My Archive
Use Directory Services to let users have web access to their archived documents
through My Archive. Allow the corresponding Directory Services users to access
Archive Center by adding them to the access role of Archive Center.
My Archive users must be members of the OTDS group OTInternal
\<tenant>_UG, either directly or through another group membership.
Archive Center supports Microsoft SQL Server, Azure SQL Database, and Oracle
Database. The database can be installed locally or remotely.
• You can either use an existing database or create a new database. The database
can reside on the computer on which Archive Center is installed or on a
dedicated database server.
• The Microsoft SQL Server or Client software has to be installed beforehand. For
remote database servers, the database and database user must have been created.
• If you use a local installation of SQL Server, the Archive Center Installer will
create the database and the user.
• For mandatory characteristics of the database for Archive Center, see “Database
characteristics” on page 23.
• SQL Server must use static ports. Dynamic ports will not work. For more
information, see “Configuring network connectivity” on page 47.
For a detailed instruction how to install an example SQL Server database for Archive
Center, see “Appendix: Setting up the database in Microsoft SQL
Server“ on page 47.
SQL Server
Note: CHECKSUM protection can catch more errors but is also more
resource intensive than TORN_PAGE_DETECTION. For details, see
the Microsoft website (http://msdn.microsoft.com/en-us/library/
aa337525.aspx).
Permissions for During the installation of Archive Center with a local instance of SQL Server, the
creating and database user is created as database owner with the full scope of assigned
running the
Archive Center
administration permissions. However, technical users who run an Archive Center
database database on a regular basis do not need the full scope of administration permissions
that are required for creating a database. Following security considerations, the
permissions of the database account used by Archive Center can be reduced after
successful installation.
For more information, see “Required rights for the SQL Server database user”
on page 50 or “Required rights for the Azure SQL Database user” on page 52.
a. Install Microsoft Command Line Utilities for SQL Server, available from the
Microsoft website (https://www.microsoft.com/en-us/download/
details.aspx?id=53591), which require the Microsoft ODBC Driver for SQL
Server (https://www.microsoft.com/en-us/download/details.aspx?
id=53339).
b. Ensure that the options described in “Database characteristics” on page 23
are configured. For example, run the following commands:
ALTER DATABASE <database> SET ANSI_NULLS on, ANSI_NULL_DEFAULT on,
ANSI_WARNINGS on, QUOTED_IDENTIFIER on, ANSI_PADDING on, ARITHABORT on
GO
3. The script shows the affected rows per tested feature (lines starting with
“(0 rows affected)”, for example).
The script must not yield any messages beginning with FATAL:.
If you do not get any FATAL: messages, the configuration of connection and
user is correct.
The Oracle server or client software has to be installed beforehand. A database and a
database user must have been created. For mandatory settings of the database for
Archive Center, see “Database characteristics” on page 26.
For a detailed instruction how to install an example database for Archive Center, see
“Appendix: Setting up the database in Oracle Database“ on page 55.
Important
To be able to connect to Oracle Database, additional client software is required:
On the remote host, either install the Oracle Instant Client for Windows or the
Oracle Full Client for Windows.
The bin folder of the client software must occur in the PATH variable before the
bin folder of the server software.
If the Oracle Database resides on the same host, the Client is already installed by the
Oracle Database installer.
This value depends on the web server configuration value for the maximum
number of supported threads. For Tomcat, this is the maxThreads connector
parameter. Set the database processes parameter to maxThreads + 50.
• There must be at least two non-default tablespaces with a block size of 8 KB for
the Archive Center data and index, respectively. These tablespaces must not be
named data and index. To verify, execute
select tablespace_name, block_size from dba_tablespaces;
• The database user provided for Archive Center must have the system and object
privileges listed in “Creating the database user” on page 60.
2. Extend tnsnames.ora to include a TNS service name that points to the cluster
host and the SID of the cluster.
Example:
RACLINUX =
(DESCRIPTION =
(ADDRESS = (PROTOCOL = TCP)(HOST = rac-cluster01.example.com)(PORT = 1521))
(CONNECT_DATA =
(SERVER = DEDICATED)
(SERVICE_NAME = ORCL)
)
)
3. Before starting the Archive Server setup, ensure that at least one dedicated node
is running.
4. During the Archive Server setup, enter the following database parameters:
• As database server, use the cluster host name, not the name of a dedicated
node.
• As Oracle SID, use the SID of the cluster, not the SID of the instance running
on a dedicated node.
Important
Ensure that the owner of the Tomcat process has at least read access on the
$ORACLE_HOME\network\admin\tnsnames.ora file.
Example:
sqlplus ecr/ecr@ecr_<db_host>
You are prompted for the data and index tablespace names.
3. The script must not yield any messages beginning with FATAL:.
If you do not get any FATAL: messages, the configuration of connection and
user is correct.
Example:
[oracle@racnode1 ~]$ sqlplus ecr/ecr@ORCL
SQL*Plus: Release 12.1.0.2.0 Production on Fri Aug 18 13:27:40 2017
Copyright (c) 1982, 2014, Oracle. All rights reserved.
Last Successful login time: Fri Aug 18 2017 13:26:39 -04:00
Connected to:
Oracle Database 12c Enterprise Edition Release 12.1.0.2.0 - 64bit Production
With the Partitioning, Real Application Clusters, Automatic Storage Management, OLAP,
Advanced Analytics and Real Application Testing options
SQL> @/tmp/StPreSchemaCreateOracle.sql
Please enter data tablespace: USERS
Please enter index tablespace: USERS
WARNING: Cannot determine archive log mode of database - please ensure it is set to
ARCHIVELOG
WARNING: Cannot determine number of processes - please ensure it is 200 at the least.
INFO: user=ECR
INFO: database server=racnode2
INFO: service=ORCL
INFO: oracle sid=ORCL2
Disconnected from Oracle Database 12c Enterprise Edition Release 12.1.0.2.0 - 64bit
Production
With the Partitioning, Real Application Clusters, Automatic Storage Management, OLAP,
Advanced Analytics and Real Application Testing options
Related Topics
Oracle RAC Ensure to avoid switches to another database node while running the setup. During
installation, switches do not happen transparently for Archive Center. The
installation can fail in this case.
Remote setup
If you want to run the installer using Microsoft Remote Desktop (Terminal
Service Client), use the /admin option when establishing the remote
session.
5. The Archive Center Installer checks the prerequisites. When all checks have
finished successfully, click Next.
Note: This feature is only required for the OpenText public cloud.
For installations of Archive Center on customers’ sites, do not
select this option.
Single tenant
Archive Center is installed on a dedicated server within the company’s
network. Only one tenant is used, meaning that write and read requests
are not separated. Archive Center Proxy is not required.
Select this option.
Select Tomcat
Select the instance of Tomcat to be used (if applicable).
Tomcat HTTP port
Select the HTTP port configured for Tomcat; default: 8080 (if applicable).
Allowed values are 1 to 65534.
Tomcat HTTPS port
Select the HTTPS (SSL/TLS) port configured for Tomcat; default: 8090 (if
applicable). Allowed values are 1 to 65534.
Windows Service user
Enter the name of the Tomcat service user (if applicable).
Ensure that the <domain>\<user> notation is used. The <user>@<domain>
notation can cause connection errors.
Windows Service user password
Enter the password of the Tomcat service user.
SQL Server
• Local database
• Remote database
Important
The database must exist.
Database user Enter the name of the database user.
Database password Enter the password of the database user.
Data filegroup Enter the name of the data filegroup.
Index filegroup Enter the name of the index filegroup.
Important
The database must exist.
Database user Enter the name of the database user.
Database password Enter the password of the database user.
Data filegroup Leave empty.
Index filegroup Leave empty.
Oracle Database
Server name Enter the name of the computer hosting the database.
If the database is an Oracle RAC, enter the name of the
RAC cluster.
Important
Do not enter localhost, even if the database
resides on the same computer. Instead, enter the
actual hostname.
Port Enter the port configured for the database; default:
1521.
Database name Enter the name of the database.
Important
The database must exist.
Database user Enter the name of the database user.
Password Enter the password of the database user.
Service name Enter the TNS service as configured by the Oracle Net
Configuration Assistant (NetCA); default: ecr_<db
server>.
If the database is a remote Oracle RAC, enter the TNS
service name configured in “Remote DB on Oracle
RAC” on page 27.
Oracle SID Enter the system identifier for the database; default:
ECR.
If the database is an Oracle RAC, enter the ORACLE_
SID of the node specified as the Server name (not the
abstract SID of the RAC).
Data file group Enter the name of the data file group.
Index file group Enter the name of the index file group.
Local TNS admin Enter the folder where the Oracle net configuration files
are located; default: $ORACLE_HOME/network/
admin.
Important
Only local paths are supported.
UNC paths or mapped network drives will not
work.
Local Oracle home Enter the folder of the Oracle installation.
If you use Oracle client, enter the folder of the Oracle
client installation.
If you use Oracle instant client, enter the location to
which the Oracle instant client package was extracted.
Note: Archive Center Installer tries to connect to the remote database for
30 seconds. In case of incorrect entries for server name, instance, or port,
the title bar shows “(Not Responding)” and you have to wait for the result
of the connection test.
• To install a new, local instance of OTDS, select the corresponding option and
choose a password for the OTDS administrator ([email protected]).
• To use an existing installation of OTDS, select the corresponding option and
specify the connection credentials. Enter the OTDS server URL in the form
<protocol>://<hostname>.<domain>:<port>, for example: https://
otdsserver.example.com:8090
Do not add any characters after <port>. For example, https://
otdsserver.example.com:8090/ will fail.
11. On the Folders page, you can change default parameters if required, for
example, installation folders. For details, see “Specifying folder settings”
on page 38.
Important
Do not use the default folders for production systems. Plan carefully
where to locate the files for the database and for temporary storage as
these may become very big.
If an installation fails
In case of an error during installation, click Close. To find out which setup
caused the error, see the %temp%\OpenText\
Installer_<date>_<time>_.log file.
See also “Troubleshooting” on page 39.
Important
Immediately set the password of the dsadmin user (using
Administration Client). For more information, see “Changing the
dsadmin password” on page 43.
Changing the password of dsadmin is also required when using OTDS.
• Local SQL Server only: A database named AC<n> was created in SQL Server
with a user named acadmin.
• Archive Center was started automatically (that is the Tomcat and Archive
Spawner processes).
• If you want to store the summary information for future reference, click
Save Summary.
Creating tenant Before users can sign in to Archive Center Administration, their tenant group must
exist. In the multi tenant operation mode, Archive Center Installer can create a
tenant for demonstration purposes. In the single tenant operation mode, no tenant
should have been created. Create the tenants in Administration Client: Users and
Groups > System > New Tenant. For more information, see Section 9.7 “Creating
tenants” in OpenText Archive Center - Administration Guide (AR-ACN).
Related Topics
No overlapping folders
All installation and configuration folders must be distinct. For example, you
cannot use one folder for the exports and for the search index.
Installation folder
Folder in which Archive Center is installed
Configuration folder
Folder in which configuration data is stored
The user running Archive Center (that is Tomcat and Spawner) must be allowed
to write to this folder. See also “Running Tomcat without local administrative
rights” on page 15.
DB data files
Folder for the database’s data (MDF) files (local database only)
DB index files
Folder for the database’s index (NDF) files (local database only)
DB log files
Folder for the database’s log (LDF) files (local database only)
DB primary file group
Folder for the database’s primary filegroup (local database only)
Document Pipeline folder
Folder in which documents are saved temporarily
Export folder
Folder in which the My Archive and Archive Center Access web clients save
files when their export function is used
Important
Depending on the scenario and usage, the exported files or their number
can become very big. Ensure that you provide enough disk space for the
export directory.
You can also change the folder location later using the Directory for the
generated EDRM-XML files configuration variable (internal name:
AS.AS.BIZ_EXPORT_DIRECTORY).
Search index folder
Folder in which the search index for the My Archive and Archive Center Access
web apps is stored
Important
Depending on the scenario and usage, the index can become very big.
Ensure that you provide enough disk space.
You can also change the folder location later using the ES_DATA_DIRECTORY
configuration variable in the <OT config AC>\AS.Setup file.
Buffer volumes
Folder in which the default disk volumes for buffers are created
Important
Do not use the default folder (%ProgramData%\OpenText\buffervols) for
production systems.
For more information about prerequisites for hard disk systems, see Section 5.2
“Configuring disk volumes” in OpenText Archive Center - Administration Guide
(AR-ACN).
3.3 Troubleshooting
• Retrying installation
If for some reason the Archive Center installation failed, you usually cannot
rerun the installation because changes made to the file system and the database,
for example, cannot be revoked automatically. Before trying to run the installer
again, do the following.
5. To clean up the Tomcat installation, delete all files and folders that were not
present in the original Tomcat instance. In particular, the Archive Center
Installer placed files in the following folders: <Tomcat_home>\conf\
Catalina\localhost, <Tomcat_home>\webapps, and <Tomcat_home>\work
\Catalina\localhost.
6. Open the window to edit the system environment variables and delete all
System variables that start with ECM_.
Further, remove the entry for the Archive Spawner in the Path variable
(default: C:\Program Files\Common Files\Open Text\Spawner\bin;).
• Open a command window and run the following command to check the
drive <drive>:
FSUTIL.EXE 8dot3name query <drive>
For example, FSUTIL.EXE 8dot3name query C: always yields
The volume state for Disable8dot3 is 0 (8dot3 name creation is
enabled).
The registry state of NtfsDisable8dot3NameCreation is 2, the
default (Volume level setting).
Based on the above two settings, 8dot3 name creation is enabled on
C:.
Related Topics
Note: You only need to change a property’s value if it is different from the
default value mentioned below.
Although Archive Center is ready to be used after a successful installation, you must
perform some additional configurations. In particular, you can change passwords
for security reasons.
Note: To administer users and groups, you use the Directory Services web
client, which is accessible under <protocol>://<host>:<port>/otds-admin.
For more information about working with OTDS, see OpenText Directory
Services - Installation and Administration Guide (OTDS-IWC).
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.
4. Restart the Tomcat and Archive Spawner services for the changes to take effect.
4. Select the Configuration object in the console tree and search for the User
password of database configuration variable (internal name:
AS.DBS.DBPASSWORD).
6. Click OK.
The password is automatically stored and encrypted.
8. Restart the Tomcat and Archive Spawner services for the changes to take effect.
Note: With Oracle 11, the default password policy changed. Now, by default a
user password expires after 180 days.
If you do not want your password to expire, consult your local database
administrator to modify your profile accordingly.
2. Select the Configuration object in the console tree and search for my_host.
3. Open the Properties of the External Archive Server Host Name configuration
variable (internal name: AS.DS.MY_HOST_NAME).
As Value, specify the fully qualified external hostname,, for example
externalhost.domain1.example.com.
4. Open the Properties of the Alias Archive Server Host Name(s) configuration
variable (internal name: AS.DS.MY_HOST_ALIASES).
As Value, specify a comma-separated list containing the internal hostname,
external hostname, and the fully qualified external hostname, for example
internalhost,externalhost,externalhost.domain1.example.com.
Note: Changes to these settings do not take effect until the application
server is restarted.
a. In the console tree, click Directory Services > User Partitions > <your user
partition>.
Note: To verify that the user partition is a member of the access role
for the Archive Center resource, click Directory Services > Access
Roles > <your user 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 group name as <tenant>_ILM.
a. In the console tree, click Directory Services > User Partitions > <your user
partition>, and then in the action pane, click New User.
b. In the New User wizard, specify all required information (the name should
be ilm.<tenant>), and then click Finish.
5. In the result pane, on the Groups tab, select the group you have just created
(<tenant>_ILM), and then in the action pane, click Edit Members.
6. Search for the user, click Add to Group, and then click OK.
This chapter provides an example for the setup of Microsoft SQL Server. It does not
cover Azure SQL Database except for Section 5.5 on page 52.
Collation tab
Using a case-sensitive (CS) and accent-sensitive (AS) database is recommended
unless other products require a case-insensitive database. The collation of this
database should be the same as the collation of SQL Server’s tempdb for
technical reasons. Therefore, OpenText recommends selecting a case-sensitive
and accent-sensitive server collation for maximum performance and
compatibility. For example, select SQL_Latin1_General_CP1_CS_AS.
Authentication Mode
On the Database Engine Configuration page, select the Account Provisioning
tab, and then enable SQL Server Authentication as Authentication Mode (for
example, as mixed mode). Enter and confirm the password for the sa logon.
5. Analogously, enable TCP/IP and disable Shared Memory for the client protocols
of SQL Native Client [11.0] Configuration and SQL Native Client 11.0
Configuration (32 bit).
3. Under General, enter a database name (for example, ECR) and the owner of the
database (for example, ecr).
4. Under Filegroups, create one filegroup for data and one for index (for example,
ECR_DATA and ECR_INDEX).
5. Create the database files for the data and the index filegroups:
a. Add two files for the data and index filegroups created before: Choose a
logical name for the files (for example, ECR_DATA_1 and ECR_INDEX_1,
respectively).
Choose the respective filegroup (in the example, select the ECR_DATA
filegroup for the ECR_DATA_1 file and the ECR_INDEX filegroup for the ECR_
INDEX_1 file).
Choose a path where the files are to be located. The files will be created in
the folder you enter. The folder must exist.
b. Choose a path for the primary filegroup and the transaction log (named
<database name> and <database name>_log, respectively.
Important
Do not use the default locations in the SQL Server installation folder.
The transaction log should be located on an empty disk without any
other files.
Specify a suitable initial size and enable unrestricted autogrowth for each of
the files:
Example:
6. Under Security > Login, select the Properties of the user created before (for
example, ecr). Select the database created before (for example, ECR) as the
default database, and then click OK.
• db_datareader
• db_datawriter
• public
• Permission to execute stored procedures
Recommendation: execute permission on the schema
Example:
USE [ECR]
CREATE LOGIN ecrowner WITH PASSWORD='ecrowner',
DEFAULT_DATABASE=ECR, CHECK_EXPIRATION=OFF, CHECK_POLICY=OFF;
ALTER AUTHORIZATION ON DATABASE::ECR TO ecrowner;
GO
2. Map the existing login to the new database user with restricted permissions.
Example:
USE [ECR];
CREATE USER [ecr] FOR LOGIN [ecr];
EXEC sp_addrolemember 'db_datawriter', 'ecr';
EXEC sp_addrolemember 'db_datareader', 'ecr';
GRANT EXECUTE ON SCHEMA::[dbo] TO [ecr];
GO
Restricted Instead of downgrading the database permission, you can create a new login for a
permissions new database user with restricted permissions. After that, change the Archive
Center database access configuration to the new database account.
Example:
USE [ECR];
CREATE LOGIN ecrdb WITH PASSWORD='ecrdb',
DEFAULT_DATABASE=ECR, CHECK_EXPIRATION=OFF,CHECK_POLICY=OFF;
• db_datareader
• db_datawriter
• public
• Permission to execute stored procedures
Recommendation: execute permission on the schema
Example:
CREATE LOGIN ecrowner WITH PASSWORD='<password of ecrowner>',
DEFAULT_DATABASE=ECR;
ALTER AUTHORIZATION ON DATABASE::ECR TO ecrowner;
GO
2. Map the existing login to the new database user with restricted permissions.
Example:
CREATE USER [ecrowner] FOR LOGIN [ecrowner];
EXEC sp_addrolemember 'db_datawriter', 'ecrowner';
EXEC sp_addrolemember 'db_datareader', 'ecrowner';
GRANT EXECUTE ON SCHEMA::[dbo] TO [ecrowner];
GO
Restricted Instead of downgrading the database permission, you can create a new login for a
permissions new database user with restricted permissions. After that, change the Archive
Center database access configuration to the new database account.
Example:
CREATE LOGIN ecrdb WITH PASSWORD='<password of ecrdb>',
DEFAULT_DATABASE=ECR;
Local database To set up a test database, you have to perform the following procedures on the
database server:
Remote In addition, if the database is located on a different server than Archive Center, you
database have to perform the following procedures on the Archive Server computer:
2. Configure the network service names or copy the tnsnames.ora and sqlnet.
ora files from the database server to the Archive Server computer.
4. Listener Configuration, Listener Name: Type a name for the Oracle listener, for
example, LISTENER, and then click Next.
6. Listener Configuration, TCP/IP Protocol: Use the standard TCP port number
1521, and then click Next.
Note: If you enter a different port here, you will need the port number
during the installation of Archive Center.
7. Listener Configuration, More Listeners: Select No, and then click Next.
Prerequisites The disks used for the database must fulfil the following prerequisites:
Important
The database must not be installed on a computer that works as primary or
backup domain controller.
The following shows how to create a TEST database with the Oracle 11.2 Database
Configuration Assistant. This very simple test database will have the following
characteristics:
• All database files are located in one directory. Thus, as a prerequisite, create a
directory in which you want all database files to be created (for example,
d:\dbdata).
1. To start the Database Configuration Assistant, from the Start menu, click
Oracle–OraDb11g_home1 > Configuration and Migration Tools > Database
Configuration Assistant.
The path depends on the Oracle installation name you specified during
installation.
3. Step 1 of 11: Operations: Select Create a Database, and then click Next.
4. Step 2 of 11: Database Templates: Select Custom Database, and then click
Next.
Click Next.
7. Step 5 of 11: Database Credentials: Feel free to set the passwords according to
your company standards.
Click Next.
Click Next.
Note: This is the minimum for a test system; a reasonable value for a
productive database will be substantially larger.
i. Click Tablespaces.
ii. Click Create.
iii. On the General tab, set the following:
Note: This is the size for a test system; a reasonable value for
a productive database will be several GB.
• As status, select Online.
• As type, select Permanent.
iv. On the Storage tab, set the following:
• Extent Management:
Select locally managed.
Select Automatic Allocation.
• Segment Space Management:
Select Automatic.
• Enable logging:
Select yes.
• Block size:
Select default.
v. Click Create.
d. Create the tablespace ECR_INDEX. Proceed as for the tablespace ECR_DATA in
Step 12.c, but enter a different name (for example, ECR_INDEX), and file
name (for example, ECR_INDEX_1.dbf).
e. Configure the data files of the table spaces:
13. Step 11 of 11: Creation Options: Select Create Database, click Finish, and then
confirm with OK.
The database creation may take some time.
14. Database Configurations Assistant: Note the database control URL displayed,
and then click Exit.
The database is now created and started.
exit
Using a role to grant the rights indirectly is not sufficient as stored procedures
will not have the rights.
For more information, see also “Required rights for the Oracle Database user”
on page 62.
2. If the location of the net configuration files is the default location, the existing
configuration has been loaded.
If you use a nonstandard location, click File > Open Network Configuration to
edit the listener configuration. Enter the according name of the directory
containing the listener.ora file, and then click OK.
3. Expand Oracle Net Configuration > Local > Listeners and click the name of the
existing listener, for example, LISTENER.
Select Listening Locations. There should be at least the following two
addresses:
5. Enter the global database name (for example, ECR), the Oracle home directory
(for example, E:\software\ora102), and the SID (for example, ECR).
6. Click File > Save Network Configuration to save the listener configuration to
the listener.ora file.
7. To make your changes effective, you have to restart the listener. Open a
command prompt and enter
lsnrctl stop
lsnrctl start
1. To start the Net Manager, from the Start menu, click Oracle – <Oracle
installation name> > Configuration and Migration Tools > Net Manager.
The path depends on the Oracle installation name you specified during
installation.
2. If the location of the net configuration files is the default location, the existing
configuration has been loaded.
If you use a nonstandard location, click File > Open Network Configuration to
edit the Net Service Name configuration. Enter the according name of the
directory containing the tnsnames.ora file, and then click OK.
3. Expand Oracle Net Configuration > Local, and then click Service Naming.
6. Page 2 of 5, Protocol: Select TCP/IP (Internet Protocol), and then click Next.
7. Page 3 of 5, Protocol Settings: Enter the database host name and the configured
port of the Oracle listener and click Next.
8. Page 4 of 5, Service: Enter the configured service name of the database (for
example, ECR). Choose Dedicated server as the Connection Type, and then
click Next.
10. Expand Oracle Net Configuration > Local, and then click Service Naming.
12. Select IPC as protocol and the ORACLE_SID of the database just created as Key
Name.
13. Click File > Save Network Configuration to save the Net Service Name
configuration to the tnsnames.ora file.
exit
Note: Using a role to grant the rights indirectly is not sufficient as stored
procedures will not have the rights.
Administration privileges required for running a database schema
We assume that the same database user is used to create and to run the database
schema.
grant create session to ecr;
grant create sequence to ecr;
alter user ecr quota unlimited on ecr_data;
Notes
In the following, you can find information about the starting and stopping of
Archive Center, including the database.
1. Use the Microsoft SQL Server Management Studio to start the SQL Server
service.
2. From the Control Panel, open Administrative Tools > Services.
3. Select Apache Tomcat, and then click Start.
4. Select Archive Spawner, and then click Start.
• Use the Microsoft SQL Server Management Studio to stop the SQL Server
service.
1. Use Microsoft SQL Server Configuration Manager to change the startup type of
the SQL Server service.
2. Open the Services window as described above.
3. Double-click Archive Spawner, set the startup type to Manual, and then click
OK.
4. Double-click Apache Tomcat, set the startup type to Manual, and then click
OK.
1. Use Microsoft SQL Server Configuration Manager to change the startup type of
the SQL Server service.
3. Select Archive Spawner, click Startup, set the startup type to Disabled, and
then click OK.
4. Select Apache Tomcat, click Startup, set the startup type to Disabled, and then
click OK.
2. Double-click Archive Spawner, set Startup type to Manual, and then click OK.
2. Double-click Archive Spawner, set Startup type to Disabled, and then click
OK.
CMIS
Collection
Controls and defines all archiving activities and is mapped to a tenant-specific
logical archive(extended Archive Center feature)
See also: Data source
Data source
Specifies the origin and properties of the documents that are archived by a
collection(extended Archive Center feature)
Tenant
A tenant consists of a defined user group for a customer. Tenants are entirely
delimited from one another.
In Archive Center, a tenant is defined by a user group with an associated,
dedicated policy(extended Archive Center feature).