4Business Component Classes
Business Component Classes
This chapter describes business component classes. It includes the following topics:
Overview of Business Component Classes
This topic describes an overview of business component classes. It includes the following topics:
Generalized and Specialized Business Component Classes
This topic describes generalized and specialized business component classes.
Generalized Business Component Classes
The following classes are generalized business component classes:
Using Specialized Classes
A specialized business component class is a type of class that Siebel CRM creates from a generalized business component class.
A specialized applet class is a type of class that Siebel CRM creates from a generalized applet class.
It is recommended that you use a specialized class only if necessary. It is recommended that you do not use a specialized business component class with a typical business component or applet. These specialized classes often use functionality that references other objects, such as fields, other business components, applets, or other classes. You must not configure Siebel CRM in such a way that it modifies the values that these objects contain.
Oracle only supports methods that Siebel Object Interfaces Reference describes for use in scripting. Modifying method logic before or after Siebel CRM calls this method can cause unpredictable behavior.
The following classes are specialized business component classes:
Guidelines for Using Methods in Business Component Classes
If you configure a method that Siebel CRM can access in a business component class, then it is recommended that you use the following guidelines:
You can use a method in a script only if the Siebel Object Interfaces Reference describes the method.
If Siebel Object Interfaces Reference does not specifically state that Siebel CRM can call a method directly, then you must not assume that you can use only the method name and arguments to call a method.
You typically configure Siebel CRM to use the InvokeMethod method to call a method.
The format for the InvokeMethod method varies depending on the scripting language that you use. This book does not describe these specific formats.
Siebel Developer's Reference lists method input arguments in the order that Siebel CRM must use them in the call, independent of the scripting language that you use.
If a custom button or command references a method, then you typically use InvokeMethod to call this method. This is true if you use a predefined script or custom script. For more information about the InvokeMethod method, see Siebel Object Interfaces Reference and Configuring Siebel Business Applications.
Intercepting a method or modifying method behavior before or after Siebel CRM calls it can result in unpredictable behavior.
Unless noted otherwise, method arguments use string values.
Calling a Method
You can configure Siebel CRM to use the InvokeMethod method to call most of the methods that this book describes. In many situations you can configure Siebel CRM to call this method from one of the following items:
Server script
Browser script
Custom button
Custom command
External interface
CSSBusComp Class
The CSSBusComp class is a base class. Siebel CRM gets other business component classes from this CSSBusComp class. It provides functionality through business component user properties and an object interface that you can use to meet typical configuration requirements.
The following topics describe business component user properties that can reference business component classes that Siebel CRM creates from the CSSBusComp class:
CSSBCBase Class
This topic describes the CSSBCBase class. It includes the following topics:
The CSSBCBase class is a base class. Siebel CRM creates other business component classes from this CSSBCBase class. It provides functionality through business component user properties and invoke methods, such as the On Field Update Invoke user property or the Sequence method.
The CSSBusComp Class class is the parent of this class.
User Properties that Reference the CSSBCBase Class
The following topics describe user properties that can reference business component classes that Siebel CRM creates from the CSSBCBase class:
Using Aspects to Control Read Only, Insert, and Other Behavior
Using Deep Copy to Copy Records in Child Business Components
Using Deep Delete to Delete Records in Child Business Components
Specifying Sequential Line Numbers for New Records According to Maximum Values
The following topics describe field user properties that can reference business component classes that Siebel CRM creates from the CSSBCBase class:
Aspect Default Value: Aspect (Using Aspects to Control Read Only, Insert, and Other Behavior)
Methods that the CSSBCBase Class can Reference
This topic describes the methods that the CSSBCBase 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 CSSBCBase class.
EvalBoolExpr Method
The EvalBoolExpr method evaluates a conditional Siebel expression against the current row. It returns one of the following values in the result parameter:
Y. The expression is true.
N. The expression is not true.
You can configure Siebel CRM to call the EvalBoolExpr method from each item described in Calling a Method except from a custom button or command.
The following table describes the method argument that you can use with the EvalBoolExpr method.
Table Arguments That You Can Use with the EvalBoolExpr Method
| Argument | Description |
|---|---|
| expr_string |
Specifies the conditional expression that Siebel CRM evaluates. |
EvalExpr Method
The EvalExpr method evaluates a Siebel expression against the current row and returns the value in the result parameter. You can configure Siebel CRM to call the EvalExpr method from each item described in Calling a Method except from a custom button or command.
IsActive Method
The IsActive method reads the Active field value to determine if the row is active. It returns Y or N. You can configure Siebel CRM to call the IsActive method from each item described in Calling a Method except from a custom command.
RefreshBusComp Method
The RefreshBusComp method runs the current query for the business component and places the focus back on the record that Siebel CRM previously highlighted. It refreshes the data but highlights the same record and places the cursor in the same position it occupied in the list applet before Siebel CRM called the RefreshBusComp method. For more information about the IsActive method, see the topic about InvokeMethod methods for business components in Siebel Object Interfaces Reference.
You can configure Siebel CRM to call the IsActive method from each item described in Calling a Method except from a custom command.
RefreshRecord Method
The RefreshRecord method refreshes the currently highlighted record. It updates the business component fields in the client and positions the cursor in the context record. For more information about this method, see the topic about InvokeMethod methods for business components object in Siebel Object Interfaces Reference.
You can configure Siebel CRM to call the RefreshRecord method from each item described in Calling a Method except from a custom command.
Revise Method
The Revise method creates a new revision of the current record. Siebel CRM uses it to revise quotes, orders, and agreement records. This method is similar to BusCompCopyRecord except the Revise method does the following work:
If the Active Field user property is defined, then it sets the current record to inactive.
If the Locked Field and Locked By Field user properties are defined, then it locks the current record.
Increments the revision number of the new record. The Revision Field user property specifies the field that contains the revision number.
Copies values that exist in fields of the current record to the new record. The Revision Copy Field user property specifies the field that contains the new values.
You can configure Siebel CRM to call the Revise method from each item described in Calling a Method except from a custom command.
For information about the BusComp_CopyRecord event, see Siebel Object Interfaces Reference.
For more information, see the following topics:
Creating Numbered Revisions of Quotes, Orders, or Agreements
Creating Numbered Revisions of Quotes, Orders, or Agreements
Viewing an Example That Uses the Revise Method
This topic describes how to view an example that uses the revise method.
To view an example that uses the Revise Method
In the client, navigate to the Agreements screen, and then the Agreements List view.
Examine the My Agreements list that Siebel CRM displays.
This list references the Agreement List Applet No Parent applet. The Revise command in the drop-down menu references the Revise method. If you choose a record, and then click Revise, then Siebel CRM does the following:
Creates a new record that duplicates the chosen record.
Increments the Revision field by 1.
Sequence Method
The Sequence method recreates the sequence numbers for the records in the current business component. It does this only if sequencing is enabled for this business component. Siebel CRM sets the starting value depending on which of the following situations is true:
A field in a business component includes a sequenced field. For example, the FS Agreement Item business component includes the Line Number field. The Sequence Field user property specifies this Line Number field as the sequence field. The following business component is the corresponding business component:
FS Agreement Item.Line Number (Sequence)
The Predefault Value property of the sequence field defines the starting value for the sequence. This value is typically not 1.
A predefault value is not set for the sequence. Siebel CRM defaults the starting value for the sequence to 1.
You can configure Siebel CRM to call the Sequence method from each item described in Calling a Method.
For more information about creating a sequence field, see Configuring Siebel Business Applications.
For more information, see the following topics:
SetAspect Method
The SetAspect method sets and overrides the default aspect of the current business component. The applet code or script method calls the SetAspect method to override the business component aspect with the applet aspect. You can configure Siebel CRM to call the SetAspect method only from a server script or a browser script.
The following table describes the arguments that you can use with the SetAspect method. For more information, see Using Aspects to Control Read Only, Insert, and Other Behavior.
Table Arguments That You Can Use with the SetAspect Method
| Argument | Description |
|---|---|
| aspect |
Specifies the name of the aspect that Siebel CRM sets as the aspect. |
| reset_bool |
Optional. You can use one of the following values:
|
CSSBCAccountSIS Class
This topic describes the CSSBCAccountSIS class. It includes the following topics:
The CSSBCAccountSIS class supports accounts. It does the following:
Resides in the hierarchy of classes that constitute the account module in Siebel Industry Applications.
Manages the account hierarchy through the account life cycle.
Manages the hierarchical relationships that exist between accounts if Siebel CRM modifies an element in the hierarchy. For example, if Siebel CRM deletes a parent account or sets this parent account as the child of another parent, then the CSSBCAccountSIS class maintains the correct relationships between accounts. For example, it makes sure that it relates a child account to the correct parent and grandparent.
Contains functionality that Siebel Life Sciences uses to schedule account calls according to the most desirable call times that Siebel CRM sets for this account.
For more information about the methods that the CSSBCAccountSIS class can reference, see Methods that the CSSBCBase Class can Reference.
The CSSBCBase Class is the parent of this class.
Dependencies and Limitations for the CSSBCAccountSIS Class
The CSSBCAccountSIS class is a specialized class. It is recommended that you do not use it with a typical business component. The Auto Schedule feature uses the names of controls in the Auto Schedule pop-up applet that Siebel CRM predefines in the class. For more information, see Using Specialized Classes.
You can use the CSSBCAccountSIS class only with an Account business component. The class methods perform tasks that are specific to account data. They require a specific set of fields that they use to evaluate the hierarchy.
Business Component User Properties that can Reference the CSSBCAccount SIS Class
The following topics describe business component user properties that can reference the CSSBCAccountSIS class. Siebel CRM requires each of these business component user properties:
CSSBCActivity Class
This topic describes the CSSBCActivity class. It includes the following topics:
The CSSBCActivity class supports actions and business components that handle activities. It also supplies data for Siebel Calendar, Siebel Scheduler, and Siebel Email Response. You can use business component user properties to enable behaviors for CSSBCActivity.
The CSSBCBase Class class is the parent of this class.
Dependencies and Limitations for the CSSBCActivity Class
This topic describes dependencies and limitations for the CSSBCActivity class.
Fields That the CSSBCActivity Class Requires
Activities and the calendar require the following fields:
Display. Indicates where Siebel CRM displays this activity. It can include one of the following values:
Calendar and Activity. Display in Calendar and Activity.
To Do and Activities. Display in To Do and Activity.
Activities Only. Display in Activity only.
Type. Indicates that this record is an activity.
The following table describes the fields that the CSSBCActivity class requires.
Table Fields That the CSSBCActivity Class Requires
| Field Name | Description |
|---|---|
| The following date fields are required:
|
For more information, see Date Fields That the CSSBCActivity Class Requires. |
| Display |
This field indicates where Siebel CRM displays the activity. |
| The following email fields are required:
|
These fields are required for email reply. |
| Orig Appt Id |
This field contains the Original Appointment Id. |
| Owned By |
This field is a multivalue group field that controls visibility. |
| The following primary fields are required:
|
These fields control visibility. |
| The following repeating fields are required:
|
These fields specify a repeating activity for the calendar. |
| The following fields are required:
|
Not applicable. |
Date Fields That the CSSBCActivity Class Requires
Activities and calendar items depend on date fields. An action class uses a predefined validation that you cannot configure. It does this to make sure that the date that the Planned Completion field contains occurs after the dates that the Planned fields contain. The Validation or Validation Message properties of these fields does not specify this validation.
You can write a script that configures a custom message and more restrictive validation on these fields. To capture updates to these fields and to return a custom message, you can use the BusComp_PreSetFieldValue event for the message. Any other validation that you write in the BusComp_PreSetFieldValue event for these fields must be different from or more restrictive than the validation that the classes specify. You cannot use a script to override or make the validation less restrictive. Siebel CRM runs the validation that the classes specify after the BusComp_PreSetFieldValue event finishes running. For more information about these date fields, see the topic about how Siebel CRM validates start and end dates in Configuring Siebel Business Applications.
How an Applet Class Determines if the CSSBCActivity Class is Required
If the Class property of an applet contains one of the following values, then the CSSBCActivity class is required:
CSSFrameAlarmList
CSSFrameAlarmSeeOtherList
CSSFrameCalGrid
CSSFrameCalRerouteBase
CSSFrameCECalAddModify
CSSFrameCEGridDay
CSSFrameCEGridMonth
CSSFrameCEGridWeek
CSSFrameCEMultPart
CSSFrameGanttActivity
CSSFrameGanttActivityBusyFree
CSSFrameListCommSrc
CSSFramePopupCalAppt
CSSFrameSRActivity
CSSSWECalToDoFrameList
CSSSWEFrameActHICalendar
CSSSWEFrameAlarmListSch
CSSSWEFrameGanttActivityFs
CSSSWEFrameGanttHiMode
CSSSWEFrameInMail
CSSSWEFrameInMailBody
Business Component User Properties that can Reference the CSSBCActivity Class
The following topics describe business component user properties that can reference the CSSBCActivity class:
The following topics describe business component user properties that can reference the CSSBCActivity class. Each of these business component user properties is required:
Methods that can Reference the CSSBCActivity Class
This topic describes the methods that can Reference the CSSBCActivity class. 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 CSSBCActivity class. These methods are mostly defined for coding purposes. Calling a method directly requires analysis and testing.
ClearGridBeginEndDate Method
The ClearGridBeginEndDate method returns the business component to regular mode after the SetGridBeginEndDate method sets it to calendar mode. For more information, see SetGridBeginEndDate Method.
You can configure Siebel CRM to call the ClearGridBeginEndDate method from an applet, business component, or business service. You can configure Siebel CRM to call this method from any item described in Calling a Method except from a custom command or external interface.
CompleteActivity Method
The CompleteActivity method saves the activity record and determines the costs associated with an activity. It then updates the parts, time, and expense records of the activity with the costs of each item according to the price list, rate list, and cost list.
Siebel CRM calls the Complete Activity business service when it saves an activity. This business service calls the CompleteActivity method. It typically uses this method with the Action business component. You can use it with other business components that reference the CSSBCActivity class.
If the applet is in query mode, then Siebel CRM cannot call this method.
You can configure Siebel CRM to call the CompleteActivity method from an applet, business component, or business service. You can configure Siebel CRM to call it from any item described in Calling a Method except from an external interface.
IsPrimaryInMvg Method
If the user is the primary in the multivalue group of a specified field, then the IsPrimaryInMvg method returns a value of Y. You can use this method to determine whether or not Siebel CRM allows the user to do operations that only the primary in the multi-value group can do. For example, only the primary can modify the primary.
You can configure Siebel CRM to call this method only from a server script or browser script that resides on an applet, business component, or business service.
The following table describes the arguments that you can use with the IsPrimaryInMvg method.
Table Arguments That You Can Use with the IsPrimaryInMvg Method
| Argument | Description |
|---|---|
| fieldname |
Specifies the name of the field that Siebel CRM examines. |
SetEmployeeId mMethod
The SetEmployeeId method sets the criteria of the next SQL query that resides in the current activity business component to the row ID and login that Siebel CRM provides as input arguments. This configuration allows the user to view employee records in the calendar.
You can configure Siebel CRM to call this method only from a server script or browser script that resides on an applet, business component, or business service.
The following table describes the arguments that you can use with the SetEmployeeId method.
Table Arguments That You Can Use with the SetEmployeeId Method
| Argument | Description |
|---|---|
| emp_login_id |
Specifies the row ID of the employee. Siebel CRM returns the calendar records for this employee. |
| emp_login_name |
Specifies the login of the employee. Siebel CRM returns the calendar records for this employee. |
SetGridBeginEndDate Method
The SetGridBeginEndDate method sets the business component to Calendar mode and sets the beginning and ending dates for the grid.
Siebel CRM requires this method in a script that manipulates the business component in Calendar mode, such as manipulating an instances of a recurring activity.
You can configure Siebel CRM to call this method only from a server script or browser script that resides on an applet, business component, or business service.
The following table describes the arguments that you can use with the SetGridBeginEndDate method. Each argument uses the following format:
mm/dd/yyyy
Table Arguments That You Can Use with the SetGridBeginEndDate Method
| Argument | Description |
|---|---|
| beginDate |
Specifies the beginning date for the grid in the time zone that the object manager uses. Siebel CRM interprets the beginning time for this date as midnight at the beginning of the day. |
| endDate |
Specifies the ending date for the grid. Siebel CRM interprets the ending time for this date as midnight at the end of the day. |
You can use the ClearGridBeginEndDate Method method to modify the mode that the business component uses when it modifies the mode from Calendar mode to regular mode.
CSSBCActivityPlan Class
This topic describes the CSSBCActivityPlan class. It includes the following topics:
The CSSBCActivityPlan class supports activity plans. It filters the template drop-down list in Activity Plans views. If the user creates a new activity in one of these views, then Siebel CRM displays activity templates in the template drop-down list. It only displays activity templates for the current context. For example, the Activity Plans view in the Service screen only displays the activity templates for service requests.
The CSSBCActivityPlan class is a specialized class. It is recommended that you do not use it with a typical business component. For more information, see Using Specialized Classes.
The CSSBusComp Class class is the parent of this class.
Business component user properties that Siebel CRM gets from CSSBusComp Class can reference the CSSBCActivityPlan class.
CSSBCContactSIS Class
This topic describes the CSSBCContactSIS class. It includes the following topics:
The CSSBCContactSIS class supports contact functionality for the following applications:
Siebel Life Sciences. This class supports the following items:
Scheduling
Displaying all and affiliated contacts
Updating position and join fields and making them editable
Setting the Last Call date to the later of the call dates for all positions when Siebel CRM merges contacts
Siebel Automotive. This class supports the following items:
Calling new correspondence from buttons instead of the application menu bar.
Reassigning contacts and any related opportunities and activities.
Creating opportunities and sales steps if Siebel CRM creates a new record. For Siebel Dealer applications only.
This class uses the Pharma Professional Position business component. You must not configure Siebel CRM to deactivate this business component or remove any fields from it.
The CSSBCUser Class class is the parent of this class.
User Properties and Methods that You can Use with the CSSBCContactSIS Class
This topic describes user properties and methods that you can use with the CSSBCContactSIS class
User Properties That Can Reference the CSSBCContactSIS Class
The following topics describe business component user properties that can reference the CSSBCContactSIS class:
The following topics describe field user properties that can reference the CSSBCContactSIS class:
Methods That the CSSBCContact SIS Class Can Reference
The CSSBCContactSIS class can reference the following methods:
AffiliatedContacts. Display affiliated contacts.
AllContacts. Display all contacts.
You can configure Siebel CRM to call these methods from any item described in Calling a Method except from an external interface.
You can specify each method in the Method property of a class method. This class method is a child of the CSSBCContactSIS class.
CSSBCFile Class
This topic describes the CSSBCFile class. It includes the following topics:
The CSSBCFile class supports file attachments and file replication. Siebel CRM uses it to transfer files to and from the Siebel File System.
The CSSBCBase Class class is the parent of this class.
Dependencies and Limitations for the CSSBCFile Class
The following information lists the fields that the CSSBCFile class requires. Prefix represents a unique prefix for the field name. For more information, see Specifying Field Name Prefixes for File Attachment Business Components.
Table Fields That the CSSBCFile Class Requires
| Field Name | Value Type |
|---|---|
| PrefixDockStatus |
BOOL |
| PrefixFileAutoUpdFlg |
BOOL |
| PrefixFileDate |
UTCDATETIME |
| PrefixFileDeferFlg |
TEXT |
| PrefixFileDockReqFlg |
BOOL |
| PrefixFileExt |
TEXT |
| PrefixFileName |
TEXT |
| PrefixFileRev |
ID |
| PrefixFileSize |
NUMBER |
| PrefixFileSrcPath |
TEXT |
| PrefixFileSrcType |
TEXT |
| PrefixFileDockStatFlg |
BOOL |
Methods That the CSSBCFile Class 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.
CreateFile 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.
The following table describes the arguments that you can use with the CreateFile method.
Table Arguments That You Can Use with the CreateFile 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. |
DeleteFile 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.
The following table describes the arguments that you can use with the DeleteFile method.
Table Arguments That You Can Use with the DeleteFile 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:
If you do not specify the internal argument, then Siebel CRM assumes that the file is not an internal file. |
GetFile 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.
Table 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. |
PutFile 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.
The following table describes the arguments that you can use with the PutFile method.
Table Arguments That You Can Use with the PutFile 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. |
UpdateSrcFromLink 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.
The following table describes the arguments that you can use with the UpdateSrcFromLink method.
Table Arguments That You Can Use with the UpdateSrcFromLink 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. |
CSSBCFINOppty Class
This topic describes the CSSBCFINOppty class. It includes the following topics:
The CSSBCFINOppty class supports opportunities. You can use it to implement a specialized Opportunity business component that performs specialized behavior. For example:
Use a search specification in the business component so that the user can view all Opportunities in the secure Admin view.
Use Secured Opportunities so that only an associated Sales Rep can view these opportunities.
The Siebel Automotive application uses the CSSBCFINOppty class to enable Send Letter (CTRL+L) functionality directly from the business component.
The CSSBCFINOppty class requires the Name field that contains the name of the opportunity.
The CSSBCOppty Class class is the parent of this class.
User Properties and Methods that You Can Use with the CSSBCFINOppty Class
This topic describes user properties and methods that you can use with the CSSBCFINOppty class.
Business Component User Properties that Can Reference the CSSBCFINOppty class
The following topics describe business component user properties that can reference the CSSBCFINOppty class:
Methods That the CSSBCFINOppty Class Can Reference
The CSSBCFINOppty class can reference the SetSecureAdminView method. If called on a business component, and if the current business component is in admin mode, then the SetSecureAdminView method configures the business component to use the Secured Admin view mode. This configuration removes the search specification from the business component. You can configure Siebel CRM to call this method from any item described in Calling a Method except from an external interface.
You can specify this method in the Method property of a class method. This class method is a child of the CSSBCFINOppty class.
CSSBCFINSActivity Class
The CSSBCFINSActivity class supports activities that reside in Siebel Financial Services applications. Siebel CRM typically uses the Action business component to support activities. It is not typically necessary to create another Activity business component that requires the CSSBCFINSActivity class. Many dependencies exist on the field names, list of values, and user properties that this class uses.
The CSSBCActivity Class class is the parent of this class.
The following topics describe business component user properties that can reference the CSSBCFINSActivity class:
For more information about the methods that the CSSBCFINSActivity class can reference, see Methods that can Reference the CSSBCActivity Class.
CSSBCForecast Class
This topic describes the CSSBCForecast class. It includes the following topics:
The CSSBCForecast class supports forecasts. It can create, modify, display, or delete a forecast. It can associate a forecast that a subordinate person creates with the forecasts that a manager owns. It can roll up forecast numbers to the summary records and top level (highest level) forecasts. Analysis views, such as the My Forecast Analysis view or the Subordinates View, allow the user to add or delete a subordinate forecast from a manager forecast.
The SBCForecastBase class is the parent of this class.
The CSSBCForecast class is a specialized class. It is recommended that you do not use it with a typical business component. For more information, see Using Specialized Classes.
Dependencies and Limitations for Forecast Classes
The business components whose names begin with Forecast 2000 depend on each other and depend on revenue business components. If you modify one of these business components, then you must also modify any dependent business components. For example:
If you modify the Forecast 2000 -- Forecast Item Detail business component, then you must modify the Forecast 2000 -- Forecast Item Detail Flat business component.
Siebel CRM uses the Forecast 2000 -- Forecast Item DynCol business component to display the Forecast Details spreadsheet. Each record that resides in the Forecast Item DynCol business component corresponds to a row in the spreadsheet, and the child forecast details provide data for the dynamic columns, such as dates. For more information about the dynamic column user properties, see Siebel Forecasting Guide.
Siebel CRM uses the Forecast 2000 -- Forecast Item Detail Flat business component to join the Forecast Item and Forecast Item Detail business components. It uses this join to create a flat view. The Forecast Item business component typically stores the nonnumeric properties that the child details can share. To support this configuration, you must add new fields and user properties that reference this field to these business components.
If you add a field to a revenue business component, and if a forecast must include data from this field, then you must add a corresponding field to a forecast business component and you must add a column to the table that this forecast business component references.
Business Component User Properties that Can Reference the CSSBCForecast Class
The following topics describe business component user properties that can reference the CSSBCForecast class:
The following topic describes a business component user property that can reference the CSSBCForecast class. It is required:
Methods That the CSSBCForecast Class Can Reference
This topic describes the methods that the CSSBCForecast 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 CSSBCForecast class.
ForecastGenerate Method
The ForecastGenerate method does the following:
-
Creates the detail and summary records for a Forecast 2000 – Forecast record.
-
Completes a forecast after Siebel CRM creates the record for the top level (highest level) forecast header.
-
Queries for the correct revenue records, and then creates the detail records and summary records for the forecast.
Siebel CRM calls the ForecastGenerate method when it saves a new forecast.
You can configure Siebel CRM to call this method from any item described in Calling a Method.
Configuring Siebel CRM to Create Forecasts Immediately
Siebel CRM can create detail and summary records in one of the following ways when it initially saves a new forecast:
-
Immediately. The user must wait while Siebel CRM creates the forecast, by default. To enable this behavior, the following system preference must be set to FALSE. This setting configures Siebel CRM to not use the Forecast Service Manager server component:
Forecast: Use Server Task
-
In the background. The user can continue using Siebel CRM while it creates the forecast. To enable this behavior:
-
The following system preference must be set to TRUE. This setting configures Siebel CRM to use the Forecast Service Manager server component.
Forecast: Use Server Task
-
The Forecast Service Manager server component that resides in the Forecast Service Management component group must be enabled. If it is disabled, then Siebel CRM does not create detail or summary records and it only creates the top level (highest level) forecast record.
-
If the WriteRecord method saves a new forecast header record, then Siebel CRM calls the ForecastGenerate method to create the detail and summary records. To configure Siebel CRM to create only the header record, you must write script outside of the WriteRecord method. This script must use an InvokeMethod that calls the SetWriteRecordsWithGenerate method, and it must use an input argument of N. If you use this configuration, then Siebel CRM does the following:
-
Does not call the ForecastGenerate method when it saves a new record for any subsequent new forecast
-
Does not create any detail or summary records unless the script calls the ForecastGenerate method at some later point
If your script uses an input argument of Y when it calls the SetWriteRecordsWithGenerate method, then Siebel CRM calls the ForecastGenerate method when it saves any subsequent new forecast.
Not calling the ForecastGenerate method when Siebel CRM saves a forecast is different from allowing the ForecastGenerate method to run in the background. If you are not required to enable or disable ForecastGenerate for different forecast scenarios, then it is possible that you will not write script that calls the Set Write RecordsWithGenerate method.
Arguments That You Can Use with the ForecastGenerate Method
The table below describes the arguments that you can use with the ForecastGenerate method.
Table Arguments That You Can Use with the ForecastGenerate Method
| Argument | Description |
|---|---|
| copyFcstId |
Specifies the Forecast Row Id of the previous forecast that exists in the same series. If Siebel CRM copies a forecast to create a forecast from a previous forecast, then it includes the modifications that it makes to the detail records of the copied forecast. It includes these modifications in the new forecast. If the New button references this method, then you must set the copyFcstId argument to NULL. |
| bForce |
If Y, and if this forecast already exists, then Siebel CRM recreates the forecast. |
| bAutoForecast |
If Y, and if a subordinate forecast exists, then Siebel CRM associates this subordinate forecast with a manager forecast. You typically set this argument to Y. |
| bNeedRollup |
You can use one of the following values:
|
| bImplicitCreateFcst |
You can use one of the following values:
If a subordinate forecast is missing, then Siebel CRM displays a dialog box when it saves the new forecast. This dialog box asks the user if Siebel CRM must create any subordinate forecasts that are missing. |
RollupForecast Method
The RollupForecast method creates the summary records for a forecast according to the detail records. Siebel CRM uses it to create the initial summary records when it creates a forecast. The Rollup button or a menu item on a forecast applet references the RollupForecast method or the RollupParentForecast method. Siebel CRM does not automatically update summary records. To update summary records after Siebel CRM modifies detail records, it must call the RollupForecast method through a control or programmatically. A current, active row must exist for the RollupForecast method. This row must exist in the forecast business component that resides at the top level (highest level). You can configure Siebel CRM to call this method from any item described in Calling a Method.
CSSBCForecastBase Class
This topic describes the CSSBCForecastBase class. It includes the following topics:
The CSSBCForecastBase is a base class. You can use it only as a parent class. The CSSBCForecast Class is one example of a subclass of the CSSBCForecastBase class. You can use the CSSBCForecastBase class to add or delete detail or summary records in a forecast.
The CSSBCAdjustable class is the parent of this class.
You must not configure Siebel CRM to create a business component that is an instance of the CSSBCForecastBase class.
For more information, see Dependencies and Limitations for Forecast Classes.
Methods That the CSSBCForecastBase Class Can Reference
This CSSBCForecastBase class can reference the RollupParentForecast method. This method determines the summary records that a forecast contains. If Siebel CRM modifies line item detail records, then it does not automatically determine summary records. The RollupParentForecast method does the same work as the RollupForecast Method with the following difference:
Siebel CRM calls the RollupParentForecast method from a child business component that references the CSSBCForecast class.
Siebel CRM calls the RollupForecast method directly from the business component that references the CSSBCForecast class.
You can configure Siebel CRM to call this method from any item described in Calling a Method.
You can specify this method in the Method property of a class method. This class method is a child of the CSSBCForecastBase class.
CSSBCForecastItem Class
The CSSBCForecastItem class stores the detail and summary records for a forecast. It stores data that is relevant to a forecast, such as opportunity, account, and revenue class. Siebel CRM uses records from one of the following classes:
CSSBCForecastItem. Determines each row a spreadsheet contains that resides in a spreadsheet view.
CSSBCForecastItemDetail. Determines the columns that a spreadsheet contains. For more information, see CSSBCForecastItemDetail Class.
You can only use the CSSBCForecastItem class to add or delete the detail and summary records that a forecast contains.
The CSSBCAdjustable class is the parent of this class.
The following topics describe business component user properties that can reference the CSSBCForecastItem class:
For more information, see Dependencies and Limitations for Forecast Classes.
CSSBCForecastItemDetail Class
This topic describes the CSSBCForecastItemDetail class. It includes the following topics:
The CSSBCForecastItemDetail class stores the detail and summary records for forecasts. Siebel CRM uses it with the CSSBCForecastItem Class. The CSSBCForecastItemDetail class stores data that is relevant to some aspects of the records. For example, quantity, price, and revenue. Many CSSBCForecastItemDetail records can exist for each CSSBCForecastItem record. Siebel CRM uses records of the following type:
CSSBCForecastItem. Identifies each row of the spreadsheet that the spreadsheet view displays.
CSSBCForecastItemDetail. Identifies each column of the spreadsheet that the spreadsheet view displays.
You can use the CSSBCForecastItemDetail class to add or delete detail records or summary records to or from a forecast. You must not use it for other reasons.
The CSSBCAdjustable class is the parent of this class.
The Specifying the Field That Siebel CRM Copies for New Revenue Forecasts business component user property can reference the CSSBCForecastItemDetail class.
For more information, see Dependencies and Limitations for Forecast Classes.
Methods That the CSSBCForecastItemDetail Class Can Reference
The CSSBCForecastItemDetail class can reference the following methods:
AutoAdjust. Gets adjustments made to the previous forecast in the series and makes the same adjustment to the current selection of records.
UpdateSelectionFromRevn. Updates a forecast detail record with data from the revenue record that Siebel CRM associates with the forecast detail record.
UpdateSelectionToRevn. Updates the revenue record that Siebel CRM associates with the forecast detail record with data from this forecast detail record.
Siebel CRM calls these methods for an individual forecast detail record. It can use each method in a script that buttons and menu items reference from a forecast detail view. You can specify each method in the Method property of a class method. This class method is a child of the CSSBCForecastItemDetail class.
You can configure Siebel CRM to call this method from any item described in Calling a Method.
CSSBCFundReq Class
The CSSBCFundReq class supports fund requests. The Fund Request business component references the CSSBCFundReq class. It includes code that uses the Outbound Communications Manager business service that sends an email message.
If the following calculated fields in the Fund Request business component evaluate to Y according to a status modification, then Siebel CRM uses code that sends the mail message:
Status Email Apr Rej
Status Email Submit
The Fund Request business component uses specialized code that creates the email message text. An email template does not provide this text. You cannot configure this text.
The CSSBCBase Class class is the parent of this class.
Business component user properties that Siebel CRM gets from CSSBCBase Class can reference the CSSBCFundReq class. This configuration is true except for the following user property because of the specialized business component code that the CSSBCFundReq class uses:
Field Read Only Field: fieldname
For more information, see Making Fields Read-Only.
For more information about the methods that the CSSBCFundReq class can reference, see Methods that the CSSBCBase Class can Reference.
CSSBCOppty Class
The CSSBCOppty class supports opportunities. You can use it to call specialized opportunity behavior, such as estimating compensation.
The CSSBCBase Class class is the parent of this class.
The business component user property described in Allowing Only the Primary to Modify Sales Methods for Opportunities can reference the CSSBCOppty class.
For more information about the methods that the CSSBCOppty class can reference, see Methods that the CSSBCBase Class can Reference.
CSSBCOrderMgmtQuoteItem Class
The CSSBCOrderMgmtQuoteItem class supports quote line items that order management uses. The Quote Item business component references the CSSBCOrderMgmtQuoteItem class. It includes the Product field that includes multiple drop-down lists, including Product. The drop-down list field for Product is Name.
The CSSBCOrderMgmtQuoteItem class is a specialized class. It is recommended that you do not use it with a typical business component. For more information, see Using Specialized Classes.
For more information about quote line items and order management, see Siebel Order Management Guide and Siebel eSales Administration Guide.
The CSSBCOrderMgmtPriceableItem class is the parent of this class.
CSSBCPharmaSpecializedAct Class
The CSSBCPharmaSpecializedAct class supports call reporting in Siebel Life Sciences. This class does following:
Creates records in the S_ACT_EMP table for attendee calls.
Determines time off according to business hours. Siebel CRM uses values that the User Preferences contain to determine the working hours for a user. If these User Preferences do not contain values, then Siebel CRM uses 9 AM to 5 PM.
Makes sure that Siebel CRM synchronizes the Start Date, End Date, Duration, Planned, and Planned Completion fields. If the value in one of these fields is modified, then Siebel CRM determines the value that the calendar displays for activities.
You can use the CSSBCPharmaSpecializedAct class only with the Pharma business components in Siebel Life Sciences. Siebel CRM comes predefined with the business component names and field names hard coded in the class methods.
The CSSBCSubmitBusComp class is a specialized class. It is recommended that you do not use it with a typical business component. For more information, see Using Specialized Classes.
The CSSBCSubmitBusComp class is the parent of the CSSBCSubmitBusComp class.
The Updating the Planned Field if the Start Date Field Is Modified business component user property can reference the CSSBCPharmaSpecializedAct class.
CSSBCPosition Class
This topic describes the CSSBCPosition class. It includes the following topics:
The CSSBCPosition class supports positions in organizations. Siebel CRM uses the specialized business component code for positions in a transaction because it must update the position record in the base table and the denormalized hierarchy table in a transaction. To support this feature, Siebel CRM opens a dedicated database connection. You cannot prevent Siebel CRM from opening this connection. Siebel CRM does not use the default database connection that it typically uses to write records.
The specialized code resides in SqlWriteRecord method of the CSSBCPartyDenorm class. Organizations, groups, and divisions use CSSBCPartyDenorm and use this specialized code.
The CSSBusComp Class class is the parent of the CSSBCPosition class.
The CSSBCPosition class is a specialized class. It is recommended that you do not use it with a typical business component. For more information, see Using Specialized Classes.
Methods That the CSSBCPosition Class Can Reference
The CSSBCPosition class can reference the OnGenReportRelClicked method. This method rebuilds the denormalized relationships that exist in the S_PARTY_RPT_REL table so that the hierarchical view modes display the correct information. The OnGenReportRelClicked method removes all values from the S_PARTY_RPT_REL table. This method then examines each record that resides in the S_PARTY table so that it can recreate the denormalized hierarchical structure in the S_PARTY_RPT_REL table. This work creates a large number of transactions for a Siebel Remote user and regional nodes. For more information, see the topics about creating Siebel reporting relationships in Siebel Database Upgrade Guide and Siebel Enterprise Integration Manager Administration Guide.
You can configure Siebel CRM to call the OnGenReportRelClicked method from any item described in Calling a Method except from an external interface.
You can specify this method in the Method property of a class method. This class method is a child of the CSSBCPosition class.
CSSBCProposal Class
This topic describes the CSSBCPosition class. It includes the following topics:
The CSSBCProposal class supports proposals and presentations. It creates and copies proposals. It can create proposal content. It supports the Proposal Generation business service. The CSSBCProposal class requires the following fields:
Name. Name of the Proposal record.
Template Name. Name of the Proposal template.
The CSSBCFile Class class is the parent of this class.
Methods That the CSSBCProposal Class Can Reference
The CSSBCProposal class can reference the RequestAllFiles method. This method identifies proposals and literature files that Siebel CRM downloads to a Mobile Web Client. It examines the entire content structure of the current proposal, and then sets the File Dock Request Flag that resides in the template file and in the literature files that the section components specify. Siebel CRM downloads the proposal and literature files to the Mobile Web Client the next time the user synchronizes.
You can configure Siebel CRM to call this method from any item described in Calling a Method except from an external interface.
You can specify this method in the Method property of a class method. This class method is a child of the CSSBCProposal class.
CSSBCServiceRequest Class
This topic describes the CSSBCServiceRequest class. It includes the following topics:
The CSSBCServiceRequest class supports service requests. It supports special functionality that resides in the Service Request module that tracks service data, such as determining warranty coverage and calculating commit time. A service request uses a lifecycle that begins with an Open status and ends with a Closed status. The user updates this status. The state model can guide the user in setting this status.
The CSSBCBase Class class is the parent of this class.
The following topics describe business component user properties that can reference the CSSBCServiceRequest class:
For more information about the methods that the CSSBCServiceRequest class can reference, see Methods that the CSSBCBase Class can Reference.
Dependencies and Limitations
The Entitlement Verification and Commit Time business services depend on the fields and functionality that the Service Request module provides. The CSSBCEntitlement class and the CSSCommitTimeService class interact frequently with the CSSBCServiceRequest class.
Siebel CRM sets the contact as the recipient when it creates correspondence for a service request. To support this configuration, the Primary Contact Address Id field must be active in the Service Request business component.
The CSSBCServiceRequest class requires the Status field and Sub-Status field.
CSSBCTaskTransient Class
The CSSBCTaskTransient class supports transient data that Siebel CRM requires while a task UI instance runs. It filters a single record for the current context in a task UI and current business component. It runs a default query on the first Get or Set function, and then creates a new record if the Execute method returns no rows.
The CSSBCTaskTransientBase Class class is the parent of this class.
Siebel CRM uses the CSSBCTaskTransient class only to support a transient business component in a task UI. You must not use it for any other purpose. To access this class, you must use only the Transient BusComp new object wizard in Siebel Tools. For more information about transient business components, see Siebel Business Process Framework: Task UI Guide.
CSSBCTaskTransientBase Class
The CSSBCTaskTransientBase class supports a transient business component. It is similar to the CSSBCTaskTransient class except that it requires you to configure Siebel CRM to manage records. Siebel CRM does not use the CSSBCTaskTransientBase directly in Siebel Tools. It uses the CSSBCTaskTransient class. You must not use the CSSBCTaskTransientBase class for typical configuration purposes. You can use it only to support a transient business component. For more information, see CSSBCTaskTransient Class.
The CSSBCBase Class class is the parent of this class.
CSSBCUser Class
This topic describes the CSSBCUser class. It includes the following topics:
The CSSBCUser class supports users, employees, contacts, and personal contacts. It does the following:
Creates and manages user records
Integrates external security adapters
Manages the Sync List for personal information manager (PIM) devices
Manages personal contact information
Manages other typical contact and employee tasks
The CSSBCBase Class class is the parent of this class.
The following topics describe business component user properties that can reference the CSSBCUser class:
For more information about the methods that the CSSBCUser class can reference, see Methods that the CSSBCBase Class can Reference.
Guidelines for Using the CSSBCUser Class
Siebel CRM uses the CSSBCUser class for business components that contain information about people. These business components use the S_PARTY table as the base table and the S_CONTACT table as the primary extension table. To enable this configuration, Siebel CRM sets the value of the Inner Join Extension Table 1 business component user property to S_CONTACT.
The records in these business components are contacts that Siebel CRM displays in contact views, including employees where sensitive data might exist. This situation is true except for personal contacts.
The CSSBCUser class includes integrated support for external authentication systems, such as LDAP (Lightweight Directory Access Protocol). You must do some customization to enable this configuration. After you enable external authentication, Siebel CRM propagates the users and passwords that it creates to the external authentication systems when it calls the WriteRecord method.
The CSSBCUser class requires the configurable constraint that the Making Sure the Current Employee Holds a Position topic describes. The business component configuration or the database layer contains other required fields. The following required business component fields store information about people:
First Name
Last Name
Person UId
If Siebel CRM enters a value in the Login field, then the CSSBCUser class allows it to modify this value but not to leave the field empty.