Understanding Actuate Information Delivery API operations : About Actuate Information Delivery API operations : Working with Encyclopedia volumes
 
Working with Encyclopedia volumes
The Encyclopedia volume is the main repository for applications and data. Operations exist to control data on the volume as well as the volume itself.
Encyclopedia volume administrators use Administrate to create, delete, update, copy, and move items within an Encyclopedia volume. An administrator manages the following items:
*Channels
*Files
*File types
*Folders
*Jobs, job notices, and job schedules
*Notification groups
*Security roles
*Users
*Volumes
The Administrate operation supports the ability to create composite operations that combine several transactions into one SOAP message. Grouping transactions reduces network traffic by streamlining the request and response process. This technique results in lower bandwidth use and increased throughput.
Update Administrate operations are also capable of acting as a composite. This feature supports the ability to implement multiple updates of Encyclopedia content in one SOAP message. A single SOAP message can contain multiple update operations, with each update operation having multiple updates within it. The following Administrate operations support multiple operations:
*UpdateChannel
*UpdateFile
*UpdateFileType
*UpdateGroup
*UpdateJobSchedule
*UpdateRole
*UpdateUser
*UpdateVolumeProperties
Typically, only an Encyclopedia volume administrator or a user in the Administrator role uses Administrate operations. The exception is that all users can change some of their own properties and all users can modify items they create.
Table 3‑3 lists the operations that work with Encyclopedia volumes.
Table 3‑3 Operations for working with Encyclopedia volumes 
Operation
Description
Administrate
Packages operations that create, delete, copy, update, and move Encyclopedia volume items. Typically, only the Encyclopedia volume administrator or a user in the Administrator role uses Administrate operations.
ExecuteVolumeCommand
For a specified volume, begins a predefined command. The available commands are:
*StartPartitionPhaseOut
*StartArchive
*SwitchToOnlineBackupMode
*SwitchToNormalModes
GetVolumeProperties
Retrieves the properties of an Encyclopedia volume. GetVolumeProperties can also return schedule, printer options, autoarchive settings, archive library, and other properties.
Transaction
A packaging mechanism for Administrate operations. If a failure occurs anywhere in a transaction, all operations in the transaction fail.
UpdateVolumeProperties,
UpdateVolumeProperties
Operation, UpdateVolumeProperties
OperationGroup
Updates the properties of a specific Encyclopedia volume. The request must specify the update activity to apply, such as updating general properties or printer settings.
UpdateVolumeProperties is accessed through the Administrate operation.