Getting Encyclopedia volume properties
To display information about the current Encyclopedia volume, specify the Encyclopedia volume in the header. Then use GetVolumeProperties and ResultDef to request details about one or more of the following properties:
VolumeProperties requests metadata about the Encyclopedia volume, including the Encyclopedia volume name, the default viewing preference for the Encyclopedia volume, the default printer name, and information about how often to retry jobs.
OnlineBackupSchedule requests the schedule for backing up the Encyclopedia volume.
TranslatedRoleNames requests the security roles in the Encyclopedia volume.
ExternalUserPropertyNames requests user names from an external source.
PrinterOptions requests printer settings for printers that the Encyclopedia volume accesses.
AutoArchiveSchedule requests the default schedule for aging and archiving files on the Encyclopedia volume.
ArchiveLibrary requests the name of any archive libraries set for the volume.
Requesting general Encyclopedia volume properties
The following example requests metadata about an Encyclopedia volume named voltaire:
<SOAP-ENV:Header>
<TargetVolume>voltaire</TargetVolume>
<AuthId>Q4yxAKHFJg9FY0JssYijJI5XvkJqDO</AuthId>
<Locale>en_US</Locale>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<GetVolumeProperties>
<ResultDef>
<String>VolumeProperties</String>
</ResultDef>
</GetVolumeProperties>
</SOAP-ENV:Body>
The preceding request returns known properties of an Encyclopedia volume.
<SOAP-ENV:Body>
<GetVolumePropertiesResponse>
<VolumeProperties>
<Name>voltaire</Name>
<ActuateVersion>7 Development</ActuateVersion>
<ActuateBuildNumber>DEV021230</ActuateBuildNumber>
<SecurityIntegrationOption>0</SecurityIntegrationOption>
<MaxJobRetryCount>0</MaxJobRetryCount>
<JobRetryInterval>0</JobRetryInterval>
<DefaultViewingPreference>DHTML
</DefaultViewingPreference>
<DHTMLPageCaching>false</DHTMLPageCaching>
<OnlineBackupMode>false</OnlineBackupMode>
</VolumeProperties>
</GetVolumePropertiesResponse>
</SOAP-ENV:Body>