Configuring Siebel eBusiness Applications > Configuring Special Purpose Applets >

Configuring Attachment Business Components


The Business Component property of the attachment list applet identifies the business component that the Siebel file system uses to store the attachment list data. For the Account Attachment Applet, this business component is called Account Attachment. The attachment business component must adhere to the following requirements:

  • The Class property of the Business Component object must be set to CSSBCFile.
  • The Table property must refer to an attachment table, as described in the section Configuring Attachment Tables. In the Account Attachment Applet, this table is S_ACCNT_ATT.
  • Two Business Component User Prop object definitions must be created as children of the attachment business component, as follows:
    • DefaultPrefix user. This is the text of the prefix used in the names of the Siebel File Engine-based field object definitions. These are fields which are based on the base table for the business component. (There may be fields which are based on a joined table, and these will have a different prefix.) For the Account Attachment business component in the example, the prefix is "Accnt," which appears in field names such as AccntFileName and AccntAutoUpdFlag.
    • FileMustExist user. This is a TRUE/FALSE value indicating whether or not the user can enter the name of a file to be provided later. Typically this is set to TRUE, indicating that the file must already exist in order to add it as an attachment.
  • The FileDockReqFlg field must have the value for the predefault property set to "N". The FielDockReqFlg maps to the required column FILE_DOCK_REQ_FLG in the attachment table.

The field names of file engine-supplied fields have to adhere to a special format, and map to specific column names in the attachment table. These names consist of the prefix, as specified in the DefaultPrefix user property, followed by a required set of suffixes. These field names, corresponding columns, and data types are listed in the Table 63.

Table 63.  Fields in an Attachment Business Component
Name
Column
Type
Text Length

xxxFileAutoUpdFlg

FILE_AUTO_UPD_FLG

DTYPE_BOOL

1

xxxFileDate

FILE_DATE

DTYPE_DATETIME

 

xxxFileDeferFlg

FILE_DEFER_FLG

DTYPE_TEXT

1

xxxFileDockReqFlg

FILE_DOCK_REQ_FLG

DTYPE_TEXT

1

xxxFileDockStatFlg

FILE_DOCK_STAT_FLG

DTYPE_TEXT

1

xxxFileExt

FILE_EXT

DTYPE_TEXT

10

xxxFileName

FILE_NAME

DTYPE_TEXT

220

xxxFileRev

FILE_REV_NUM

DTYPE_ID

15

xxxFileSize

FILE_SIZE

DTYPE_NUMBER

 

xxxFileSrcPath

FILE_SRC_PATH

DTYPE_TEXT

220

xxxFileSrcType

FILE_SRC_TYPE

DTYPE_TEXT

30

Table 64 lists a non-file engine field that will usually be present, although it is not required.

Table 64.  Non-File Engine Field in an Attachment Business Component
Name
Column
Type
Calculation

Dock Status

(calculated)

DTYPE_BOOL

IIf ([AccntFileDockStatFlg] = "N" OR [AccntFileDockStatFlg] IS NULL,"N","Y")

Additional fields can be included as needed. For specialized uses of attachments, such as an image control, the file engine fields may be present in addition to the fields from a standard business component (often through a join). For example, a Product or Literature business component can contain file engine fields to support display of product picture or brochure picture bitmap images.

Multiple sets of file engine fields from different tables can be incorporated in the same business component. For example, literature attachments can have subattachments, with the subattachments derived from an intersection table or extension table. The field name prefix must be different for each table.

Configuring Siebel eBusiness Applications