migrateFolderFileStaged

Locates a locally stored file, and attaches it to an entry while preserving Forum data. (V1.0.3)

Syntax

public void migrateFolderFileStaged ( long binderId, long entryId, String fileUploadDataItemName, String filename, String stagedFileRelativePath, String modifier, Calendar modificationDate );

Description

The migrateFolderFileStaged accesses a Forum file that has been copied locally on the Teaming server as a way to streamline the transfer of files, avoiding transferring them over the Internet. The operation then attaches the file to a folder entry in Teaming that preserves values from a SiteScape Forum installation (for example, the person who last modified the item in Forum, and the date of the last modification in Forum).

Parameters and Return Value

binderId

The binder identifier of the folder that contains the entry to which you want to attach a file.

entryId

The entry identifier of the entry to which you want to attach the file.

fileUploadDataItemName

The internal-use name used by the database to identify the file as an element of an entry.

For example, a Forum custom command allowed for uploading different files into a single entry that served different functions, such as an expense report, a meeting presentation, and so on. These custom file uploads have associated internal-use names that are different than the reserved internal-use name applied to standard file entries or standard attachments.

If you are migrating to a folder file, specify upload as an argument to this parameter to make this attachment the primary file for the entry.

filename

The name of the file to be attached to the entry.

stagedFileRelativePath

The relative path specification, beginning with the staging area designated in the ssf.properties and ssf-ext.properties files on the Teaming server. (See the installation guide for more information about these files.)

Although the files can be present in any folder structure within the staging area, one streamlined way to approach this task is to unzip the Forum hidden directory into the staging area. Then, use this parameter to specify the relative path through the hidden folder structure to the location of the file to be attached to the entry in Teaming.

modifier

A string containing the full name of the person who last modified the corresponding file in Forum.

modificationDate

Calendar data specifying the date when the corresponding file was modified in Forum.

Example

call.setOperationName(new QName("migrateFolderFileStaged")); Object result = call.invoke(new Object[] {new Long(21), new Long(45), String("_budgetReport"), String("budget-report.xls"), String("hidden/ssf/myworkspace/myforum/4567849"), new String("JGarces"), modcal});

To locate the file, Teaming begins with the defined staging folder and then applies the relative path hidden/ssf/myworkspace/myforum/456789.This code attaches the budget-report.xls file to the entry whose identifier is 45 and is located in a folder whose binder identifier is 21. The internal-use name that maps to the file as an element in the entry is _budgetReport. The operation also provides the name of the person who modified the file in Forum and the date when that modification occurred.

See Also