Administering an Encyclopedia volume : About Encyclopedia-level management operations : Uploading a file
 
Uploading a file
To upload a file to an Encyclopedia volume, use UploadFile. You must identify the Encyclopedia volume in the SOAP header using TargetVolume. Then, specify the file to upload. You also can set certain properties of the file. For example, you can use the AccessType element to indicate whether the file is private or shared and you can use MaxVersions to set the maximum number of versions of the file to retain in the Encyclopedia volume.
You can upload an Actuate native file type or an external file type. To work with an external file you upload, BIRT iHub must recognize the file type.
Table 5‑1 lists the principal elements of an UploadFile request.
Table 5‑1 UploadFile request elements
Element
Description
NewFile
Identifies the file to upload. Specify an optional version number by adding it to the file name using a semicolon. In addition to the file name and version, NewFile can contain the following information:
*AccessType indicates whether the file is shared or private in the Encyclopedia volume.
*ReplaceExisting indicates whether to replace an existing file that has the same name. If the file you replace has dependencies, BIRT iHub creates a new version and does not overwrite the existing version.
*MaxVersions indicates the maximum number of versions of the file to retain in the Encyclopedia volume.
CopyFromLatestVersion
When the Encyclopedia volume contains older versions of the file you are uploading, you can indicate whether to copy certain properties from the latest version of the older file to the newer version. The properties you can copy are:
*Description, text that describes the file
*Permissions, the access control list (ACL) specifying the users and roles that can access the file
*ArchiveRules, rules that control how to age and expire the file
If the file to upload already has these properties set, the settings for CopyFromLatestVersion take precedence.
Content
*ContentType defines the type of file to upload, such as application/octet-stream or binary. ContentType is required.
*ContentLength specifies the size of the attachment. ContentLength is optional.
*ContentEncoding indicates the object encoding used, such as binary or application/octet-stream. ContentEncoding is optional.
*Locale specifies the object locale. Locale is optional.
*ContentData is the content of the attachment in the format HTTP requires for transmission across the internet.