Configuring the Online Archive Driver
The Online Archive Driver implementation supports retaining file attributes in an archive. In the Java application’s XML configuration file, onlinearchive.cfg, you can specify that an archive retains its file attributes using the following settings:
RetainTimestamp
Specifies whether to retain the time stamp. The default is False.
RetainOwner
Specifies whether to retain the owner. The default is False.
The online archive application attempts to match any user or role in the file’s access control list (ACL) with the same name in the archive Encyclopedia volume.
RetainPermission
Specifies whether to preserve the permissions in the access control list (ACL). The default is False.
If you do not archive the access control list (ACL) of a file, the file owner has full access. If the user or role does not exist in the archive Encyclopedia volume, you can configure the application to create a user or role with the same name.
CopyDependOnFile
Specifies whether to copy the dependent files for the archive file. The default is True.
If the online archive application archives a file that has a dependency on another file, the application archives both files. The application does not delete the file on which the archived file has a dependency unless the application is archiving both files.
In the configuration file, you can also specify the following options:
CreateUserRole
Specifies whether to create missing user or roles in the target volume in order to retain the owner or permissions. The default is True.
The online archive application does not enable a login for a user or role it creates.
ArchiveRoot
Specifies the root encyc folder for all archived files. The default is /.
CreateArchiveSubFolder
Specifies whether to create the archive as a subfolder under the root folder that contains a time stamp. The default is True.
The online archive application creates a folder in the archive Encyclopedia volume and places the files from the archive session into the subfolder. Within the archive, the archive driver creates a folder hierarchy identical to the one in the Encyclopedia volume and places the files in the hierarchy.
The archive root folder name contains the start date and time of the archive session in the following format:
YYYY_mm_dd.hh_mm_ss
For example, if you optionally specify the name of the root archive folder in the configuration files as /MyArchive and the archive sessions starts at 6:00 a.m. May 31, 2008, the application copies the archived files to the following folder:
/MyArchive2008_05_31.06_00_00
If you set CreateArchiveSubFolder to False, the online archive application suppresses the creation of the time stamp folder and does not create the archive as a subfolder. The archive volume mimics the folder structure of the production volume. The CreateArchiveSubFolder option preserves the version numbers of the archived files by placing the archive folder in a separate root folder that has a time stamp.
LogLevel
Specifies the level of detail in log file. Valid values are Summary, Detail, and Trace. The default is Summary.
BIRT iHub installs an onlinearchive.cfg file in the following location:
$AC_SERVER_HOME\etc
Actuate Server Integration Technology also provides a copy of onlinearchive.cfg in the Online Archive Driver folder. The following example shows the onlinearchive.cfg code:
<?xml version="1.0" encoding="UTF-8"?>
<archiveconfig>
<!-- ACTUATE ONLINE ARCHIVE DRIVER CONFIGURATION FILE -->
<!-- See README.html in the onlinearchive directory in -->
<!-- Server Integration Technology installation for usage -->
<!-- and licensing information -->
<!--TargetServer, TargetSOAPPort: [Required] -->
<!-- Name or IP of server and port for connecting to -->
<!-- the SOAP dispatcher service of the target volume -->
<TargetServer>127.0.0.1</TargetServer>
<TargetSOAPPort>8000</TargetSOAPPort>
<!--ArchiveVolume: [Required] -->
<!-- Name of target volume to copy archived files to -->
<ArchiveVolume>DefaultVolume</ArchiveVolume>
<!--AdminUser, AdminPassword: [Required] -->
<!-- Name and password of a user in the target volume -->
<!-- that belongs to the Administrator role -->
<AdminUser>administrator</AdminUser>
<AdminPassword></AdminPassword>
<!--RetainTimestamp: [Optional, default: false] -->
<!-- Whether timestamp of archived file is preserved -->
<RetainTimestamp>false</RetainTimestamp>
<!--RetainOwner: [Optional, default: false] -->
<!-- Whether Owner of archived file is preserved -->
<RetainOwner>false</RetainOwner>
<!--RetainPermission: [Optional, default: false] -->
<!-- Whether Permission (ACL) of archived file is -->
<!-- preserved -->
<RetainPermission>false</RetainPermission>
<!--CopyDependOnFile: [Optional, default: true] -->
<!-- Whether files depended on by archived file are -->
<!-- copied -->
<CopyDependOnFile>true</CopyDependOnFile>
<!--CreateUserRole: [Optional, default: true] -->
<!-- Whether to create missing user or roles in target -->
<!-- volume in order to retain Owner or Permissions -->
<CreateUserRole>true</CreateUserRole>
<!--ArchiveRoot: [Optional, default: /] -->
<!-- Root encyc folder for all archived files -->
<ArchiveRoot>/</ArchiveRoot>
<!--CreateArchiveSubFolder: [Optional, default: true] -->
<!-- Whether to create a timestamp dependent subfolder -->
<!-- under ArchiveRoot for each archive session -->
<CreateArchiveSubFolder>true</CreateArchiveSubFolder>
<!-- LogLevel: [Optional, default: Summary] -->
<!-- Leve of detail in log file. Valid values are: -->
<!-- Summary, Detail and Trace -->
<LogLevel>Summary</LogLevel>
</archiveconfig>