Bookshelf Home | Contents | Index | PDF     

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

Methods That the CSSBCForecastClass 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.

Forecast Generate 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 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 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 SetWriteRecordsWithGenerate method.

Arguments That You Can Use with the Forecast Generate Method

Table 15 describes the arguments that you can use with the ForecastGenerate method.

Table 15. Arguments That You Can Use with the Forecast Generate 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:

  • Y. Create summary records for the forecast. You typically set this argument to Y.
  • N. D not create summary records for the forecast until the user manually chooses Rollup.

bImplicitCreateFcst

You can use one of the following values:

  • Y. Create any subordinate forecasts that are missing.
  • N. Disregard any subordinate forecasts that are missing.

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.

Rollup Forecast 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. You can configure Siebel CRM to call this method from any item described in Calling a Method.

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