Modifying the online archive configuration file

Archiving files : Using the online archive driver : Modifying the online archive configuration file

Modifying the online archive configuration file

Listing 12‑1 shows the default online archive configuration file. You can modify the parameters described in Table 12‑1.

Listing 12‑1 Default online archive configuration file

<?xml version="1.0" encoding="UTF-8"?>

<archiveconfig>

<

--TargetServer, TargetSOAPPort: [Required] -->

<

-- Name or IP of server and port for connecting to -->

<

-- the SOAP dispatcher service of the target volume -->

<TargetServer>localhost</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] -->

<

-- Level of detail in log file. Valid values are: -->

<

-- Summary, Detail and Trace -->

<LogLevel>Summary</LogLevel>

</archiveconfig>

Table 12‑1 describes the parameters in the online archive configuration file for the Encyclopedia volume that stores the archive.

Table 12‑1 Online archive configuration file parameters
Parameter	Description
TargetServer	Machine name or IP address to use to connect to the Encyclopedia volume that holds the archived files. Required.
TargetSOAPPort	Port number that the iHub SOAP Dispatch service uses to connect to the Encyclopedia volume. Required.
ArchiveVolume	Encyclopedia volume name. The default value is DefaultVolume. Required.
AdminUser	Encyclopedia volume user name. The user must belong to the Administrator role.
AdminPassword	Password of the user specified by the AdminUser parameter. Required.
RetainTimestamp	Flag for archiving the file’s time stamp. The default value is false.
RetainOwner	Flag for archiving the name of the file’s owner. The default value is false.
RetainPermission	Flag for archiving the file’s permissions. The default value is false.
CopyDependOnFile	Flag for archiving the file’s dependency list. The default value is true.
CreateUserRole	Flag for creating missing user or roles in the archive Encyclopedia volume to retain the file’s owner or permission information. The default value is true.
ArchiveRoot	Encyclopedia volume archive session root folder. The default value is /, the Encyclopedia volume root folder.
CreateArchiveSubFolder	Flag for creating a time stamp dependent subfolder under ArchiveRoot for each archive session. The default value is true.
LogLevel	The level of detail for information in the log. Valid values are Summary, Detail, and Trace. The default value is Summary.

The online archive driver applies changes to the configuration file when iHub runs the driver. Changes do not affect any archiving already in process.