Bookshelf Home | Contents | Index | PDF     

Siebel Developer's Reference > Business Component Classes > CSSBCFile Class >

Methods That the CSSBCFileClass Can Reference

This topic describes the methods that the CSSBCFile class can reference. It includes the following topics:

You can specify each method in the Method property of a class method. This class method is a child of the CSSBCFile class.

Unless noted otherwise, each of these methods returns one of the following strings:

  • Success. The operation succeeded.
  • Error. The operation did not succeed.

Create File Method

The CreateFile method places a copy of an external file into the Siebel File System. It updates the relevant fields in the business component so that Siebel CRM can attach it to the current record. You can configure Siebel CRM to call this method from any item described in Calling a Method except from a browser script.

Table 10 describes the arguments that you can use with the CreateFile method.

Table 10. Arguments That You Can Use with the Create File Method
Argument
Description

srcFilePath

Specifies the path to the source file.

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.

keepLink

If Y, then Siebel CRM stores the link to the external file.

altSrcFileName

Optional. If the file name that Siebel CRM creates in the Siebel File System is different from the name of the source file that it uses to copy the file, then it uses the value that the altSrcFileName argument contains as an alternative name for the source file name.

Delete File Method

The DeleteFile method deletes a file that resides in the Siebel File System or an external file. You can configure Siebel CRM to call this method from any item described in Calling a Method except from a browser script or external interface.

Table 11 describes the arguments that you can use with the DeleteFile method.

Table 11. Arguments That You Can Use with the Delete File Method
Argument
Description

fileName

Specifies the name of the file that Siebel CRM deletes, including the path to this file.

internal

Optional. Specifies that the file is an internal file. An internal file is a file that resides in the Siebel File System. You can use one of the following values:

  • True. The file is an internal file.
  • False. The file is not an internal file.

If you do not specify the internal argument, then Siebel CRM assumes that the file is not an internal file.

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.

Table 12 describes arguments that you can use with the GetFile method.

Table 12. Arguments That You Can Use with the Get File 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.

Put File Method

The PutFile method replaces a file in the Siebel File System that is attached to the current record with a copy of a file in a directory. It updates the relevant business component fields. You can configure Siebel CRM to call this method from any item described in Calling a Method except from a browser script.

Table 13 describes the arguments that you can use with the PutFile method.

Table 13. Arguments That You Can Use with the Put File Method
Argument
Description

fileName

Specifies the name of a file and the path to this file that Siebel CRM updates.

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.

Update Src From Link Method

The UpdateSrcFromLink method replaces a file that resides in the Siebel File System that is attached to the current record. Siebel CRM replaces this file with an external file that is linked to the file that it replaces. If something modifies this external file, then it updates the file attachment. It updates the relevant business component fields. You can configure Siebel CRM to call this method from any item described in Calling a Method except from a browser script.

Table 14 describes the arguments that you can use with the UpdateSrcFromLink method.

Table 14. Arguments That You Can Use with the Update Src From Link 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.

    
Siebel Developer's Reference Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.