GCFInitiateTransfer function

Initiates a Global Collaboration Framework transfer for the selected document with the specified options.

Syntax

Function GCFInitiateTransfer(DestinationShare, TransferOwnership, _ OnSchedule, Enlistment, EmailAddress, _ EmailText, FileName, [Options])

Parameters
Name	Description
DestinationShare	The share name of the vault to which the document should be sent.
TransferOwnership	When True, ownership of locally owned documents will be transferred to the destination share.
OnSchedule	When True, the transfer will be executed as part of the regular update schedule.
Enlistment	When True, the destination share will be enlisted for the document.
EMailAddress	The address to which to send an email when the document has been imported to the destination share.
EMailText	The message body to send when the document has been imported to the destination share. This text is not appended to text that is automatically calculated at the remote site by the GCFNotificationMessage function.
FileName	The name of the selected document. This name will be used to update the Transfers table.
Options	Optional transfer parameter that will be used by the Meridian Enterprise export processor to control how the document will be added to the transfer briefcase: The default is an empty string. The parameter can have the following possible values: NOREFS: Do not include any referenced documents in the transfer operation. NOCADREFS: Do not include documents with CAD-related references in the transfer operation. NOCUSTOMREFS: Do not include documents with custom-defined references in the transfer operation. NOCADPRESENTATION: Do not include Autodesk Inventor drawing and presentation files (.idw and .ipn) in the transfer operation.

Parameters

Name

Description

DestinationShare

The share name of the vault to which the document should be sent.

TransferOwnership

When True, ownership of locally owned documents will be transferred to the destination share.

OnSchedule

When True, the transfer will be executed as part of the regular update schedule.

Enlistment

When True, the destination share will be enlisted for the document.

EMailAddress

The address to which to send an email when the document has been imported to the destination share.

EMailText

The message body to send when the document has been imported to the destination share. This text is not appended to text that is automatically calculated at the remote site by the GCFNotificationMessage function.

FileName

The name of the selected document. This name will be used to update the Transfers table.

Options

Optional transfer parameter that will be used by the Meridian Enterprise export processor to control how the document will be added to the transfer briefcase:

The default is an empty string. The parameter can have the following possible values:

NOREFS: Do not include any referenced documents in the transfer operation.
NOCADREFS: Do not include documents with CAD-related references in the transfer operation.
NOCUSTOMREFS: Do not include documents with custom-defined references in the transfer operation.
NOCADPRESENTATION: Do not include Autodesk Inventor drawing and presentation files (*.idw and *.ipn) in the transfer operation.

Return value

When successful, returns True.

Remarks

To initiate transfer upon a workflow transition, consider using InitiateTransferOwnershipOnWorkFlow function instead. To initiate transfer to a Meridian Project Portal workspace, use the NEW InitiateTransferToPortal function function instead.

Related concepts

Understanding email notification

Understanding document ownership

Understanding ownership transfers

Cross-site workflow implementation

Understanding claim ownership transfers

Understanding enlistment transfers

Related tasks

Configuring the general settings

Calculating import notification messages

Transferring ownership upon release

Related information

GCFEmails table

GCFNotificationMessage function

GCF privileges

InitiateTransfer function

RequestOwner function

EnlistTheSite function


	BlueCielo Meridian Global Collaboration Framework 2012 Administrator's Guide \| BlueCielo ECM Solutions