Get File Method

The GetFile method copies a file that resides in the Siebel File System that is attached to the current record into a temporary directory. It allows a user to view or edit a file attachment. It returns one of the following strings:

• Success, outFilePath. The operation succeeded. OutFilePath contains the path to the file that Siebel CRM copied to the temporary directory.

• Error. Siebel CRM did not copy the file to the temporary directory.

• OutOfDate. Siebel CRM did not copy the file to the temporary directory but this file is not the most recent version of the file. The most recent version of the file is not available in the File System.

The TmpDir parameter in the Siebel section of the .cfg file for the Siebel Business Application specifies the temporary directory.

You can configure Siebel CRM to call this method from any item described in Calling a Method except from a browser script.

The following table describes arguments that you can use with the GetFile method.

Argument	Description
keyFieldName	Specifies the name of the PrefixFileName field that contains the name of the file in the Siebel File System. For example, the AcctsFileName field contains the name of the file for the Account Attachment business component.