Volume
A complex data type that describes an Encyclopedia volume.
Elements
Name
String. The name of the volume.
ActuateVersion
String. Optional. The version number.
ActuateBuildNumber
String. Optional. The build number.
SecurityIntegrationOption
Long. Optional. The security integration option.
OpenSecuritySelectUsersOfRole
Deprecated since iHub release 3. Replaced by OpenSecuritySelectUsersOfUserGroup.
OpenSecuritySelectUsersOfUserGroup
Boolean. Optional. Applies only if using external registration security level. Indicates whether the SelectUsers operation for a user group is supported. If the operation is supported, iHub enables appropriate features in iHub Management Console.
OpenSecuritySelectGroupsOfUser
Obsolete since iHub release 3.
DefaultPrinterName
String. Optional. The name of the default printer.
MaxJobRetryCount
Long. Optional. The maximum number of retry attempts.
JobRetryInterval
Long. Optional. The interval between retry attempts. Measured in seconds.
DefaultViewingPreference
Obsolete since iHub release 2.
DHTMLPageCaching
Boolean. Optional. True enables DHTML page caching.
DHTMLPageCachingExpirationAge
Long. Optional. If DHTMLPageCaching is True, set DHTMLPageCachingExpirationAge to a valid value. To disable DHTMLPageCaching, set DHTMLPageCachingExpirationAge to ‑1.
IsAutoArchiveRunning
Boolean. Optional. Determines whether an archive pass is currently running. If True, an archive pass is running.
AuthorizationIsExternal
Boolean. Optional. Specifies whether user registration is external.
ConnectionPropertiesAreExternal
Boolean. Optional. Specifies whether connection properties are externalized using the Report Server Security Extension (RSSE).
DefaultSuccessNoticeExpiration
Long. Optional. 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
Long. Optional. 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
String. Optional. The resource path to the volume.