Volume
A complex data type that describes an Encyclopedia volume.
Schema
<xsd:complexType name="Volume">
<xsd:all>
<xsd:element name="Name" type="xsd:string"/>
<xsd:element name="ActuateVersion" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ActuateBuildNumber" type="xsd:string"
minOccurs="0"/>
<xsd:element name="SecurityIntegrationOption" type="xsd:long"
minOccurs="0"/>
<xsd:element name="OpenSecuritySelectUsersOfRole"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="OpenSecuritySelectGroupsOfUser"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="DefaultPrinterName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="MaxJobRetryCount" type="xsd:long"
minOccurs="0"/>
<xsd:element name="JobRetryInterval" type="xsd:long"
minOccurs="0"/>
<xsd:element name="DefaultViewingPreference" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="LRX"/>
<xsd:enumeration value="DHTML"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="DHTMLPageCaching" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="DHTMLPageCachingExpirationAge"
type="xsd:long" minOccurs="0"/>
<xsd:element name="IsAutoArchiveRunning" type="xsd:boolean" minOccurs="0"/>
<xsd:element name="AuthorizationIsExternal"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="ConnectionPropertiesAreExternal"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="DefaultSuccessNoticeExpiration"
type="xsd:long" minOccurs="0"/>
<xsd:element name="DefaultFailureNoticeExpiration"
type="xsd:long" minOccurs="0"/>
<xsd:element name="ResourcePath" type="xsd:string"
minOccurs="0"/>
</xsd:all>
</xsd:complexType>
Elements
Name
The name of the volume.
ActuateVersion
The version number.
ActuateBuildNumber
The build number.
SecurityIntegrationOption
The security integration option.
OpenSecuritySelectUsersOfRole
Applies only if using external registration security level. Indicates whether the SelectUsers operation for a role is supported. If the operation is supported, iHub enables appropriate features in iHub Management Console.
OpenSecuritySelectGroupsOfUser
Applies only if using external registration security level. Indicates whether the SelectGroups operation for a user is supported. If the operation is supported, iHub enables appropriate features in iHub Management Console.
DefaultPrinterName
The name of the default printer.
MaxJobRetryCount
The maximum number of retry attempts.
JobRetryInterval
The interval between retry attempts. Measured in seconds.
DefaultViewingPreference
The default viewer.
DHTMLPageCaching
True enables DHTML page caching.
DHTMLPageCachingExpirationAge
If DHTMLPageCaching is True, set DHTMLPageCachingExpirationAge to a valid value. To disable DHTMLPageCaching, set DHTMLPageCachingExpirationAge to ‑1.
IsAutoArchiveRunning
Determines whether an archive pass is currently running. If True, an archive pass is running.
AuthorizationIsExternal
True enables external user registration.
ConnectionPropertiesAreExternal
Specifies whether connection properties are externalized using the Report Server Security Extension (RSSE).
DefaultSuccessNoticeExpiration
Specifies the minimum number of minutes success notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. This time applies to all users whose SuccessNoticeExpiration time is not set or is set to 0. The default value is 0, which means notices never expire.
DefaultFailureNoticeExpiration
Specifies the minimum number of minutes failure notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. This time applies to all users whose SuccessNoticeExpiration time is not set or is set to 0. The default value is 0, which means notices never expire.
ResourcePath
The resource path to the volume.