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

CSSBCForecast Methods

This topic describes the methods that are implemented in the CSSBCForecast Class.

ForecastGenerate Method

The ForecastGenerate method generates the detail and summary records for a Forecast 2000 - Forecast record.

The ForecastGenerate method fills out the creation of a forecast after the forecast header (top-level) record is created. ForecastGenerate queries for the correct revenue records, and then creates the detail records and summary records for the forecast. In the preconfigured application, this method is invoked when a new forecast is saved.

ForecastGenerate can be used synchronously or asynchronously:

• Creating a forecast synchronously. When a new forecast record is initially saved, ForecastGenerate is invoked to create detail and summary records immediately. This behavior is the default behavior in the preconfigured application. To use ForecastGenerate synchronously, you must have the following setting:
  • The Forecast: Use Server Task system preference must be set to FALSE, so that the application does not check the Forecast Service Manager server component.
• Creating a forecast asynchronously. When a new forecast record is initially saved, ForecastGenerate is invoked to create detail and summary records in the background, thereby allowing the user to use other parts of the application concurrently.

  To use ForecastGenerate asynchronously, you must have the following settings:

  • The Forecast: Use Server Task system preference must be set to TRUE, so that the application looks at the Forecast Service Manager server component.
  • The Forecast Service Manager server component (in the Forecast Service Management component group) must be enabled. If it is disabled, no detail or summary records are created; only the top-level forecast record is created.

Table 16 describes the method arguments for ForecastGenerate.

When the WriteRecord method saves a new forecast header record, the default behavior of the preconfigured application is to call ForecastGenerate to create the detail and summary records. You can opt instead to create header records only, with no detail or summary records. To do so, you must provide script outside of WriteRecord that uses InvokeMethod to call the SetWriteRecordsWithGenerate method with an input parameter of N. For subsequent new forecasts, ForecastGenerate does not invoke when new records are saved. No detail or summary records are created unless ForecastGenerate is called elsewhere in script.

By calling SetWriteRecordsWithGenerate with an input parameter of Y, you can reset the application to call ForecastGenerate automatically when subsequent new forecast records are saved.

NOTE:  Not invoking ForecastGenerate during the save record process is different from asynchronously creating a forecast, in which ForecastGenerate is invoked automatically but runs in the background to allow the user to do other tasks in the user interface. Unless you plan to turn ForecastGenerate on and off selectively, it is likely that you do not need to invoke SetWriteRecordsWithGenerate in script. Typically, you would set the Forecast: Use Server Task system preference and Forecast Service Manager server component to generate detail and summary records either synchronously or asynchronously whenever a new forecast record is created.

RollupForecast Method

The RollupForecast method calculates the summary records for a forecast based on the detail records. Summary records are not updated dynamically; the RollupForecast method must be invoked, either by a control or programmatically, after detail records are modified. This method must have a current active row on the top-level forecast business component.

The RollupForecast method is typically used when a forecast is created to generate the initial summary records. This method underlies the Rollup button or menu choice on Forecast applets.

See also RollupParentForecast Method.