Bookshelf Home | Contents | Index | PDF |
Siebel Developer's Reference > Business Component Classes > CSSBCForecast Class > CSSBCForecast MethodsThis section describes the methods that are implemented in the CSSBCForecast Class. ForecastGenerateThe 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. ForecastGenerate can be used synchronously or asynchronously. In the preconfigured application, this method is invoked when a new forecast is saved.
NOTE: 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 is not invoked 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. To not invoke 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 selectively turn ForecastGenerate on and off, it is likely that you do not need to invoke SetWriteRecordsWithGenerate in script. Typically, just 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. There may be a case for which you do not want ForecastGenerate to be triggered by WriteRecord. However, because typical use of forecasts is to include detail and summary records, it is unlikely that ForecastGenerate is not invoked at all. Thus, you will likely want to toggle the server component to invoke ForecastGenerate synchronously or asynchronously during WriteRecord, instead not invoking ForecastGenerate at all during WriteRecord. RollupForecastThe 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. |
Siebel Developer's Reference |