API Driven Forecasting

The appendix describes the business service methods and arguments that are associated with the Forecast 2000 - Forecast Service business service. The following topics are included in This chapter:

About API Driven Forecasting

You can generate forecasts through batch mode using the Forecast 2000 - Forecast Service business service, which is provided by default with your Siebel business application.

To generate forecasts through batch mode, you must implement the functionality that is available with the Forecast 2000 - Forecast Service and decide, for example, when and how often to run the batch mode forecasting job.

The same forecast-related limitations apply to API driven forecasting as apply to forecast generation and rollup in general.

Note: When generating forecasts through batch mode, if a forecast is being created for a participant who has subordinates and the subordinates have not created their forecasts yet, then the forecasts for subordinates are created automatically.

Forecast 2000 - Forecast Service

This business service allows the generation and, or the roll up of forecasts without the need for any user interface interaction. The following table describes the business service.

Field	Description
Name:	Forecast 2000 - Forecast Service
Project:	Forecast 2000
Class:	CSSSvcForecast
Display Name:	Forecast Service

Forecast 2000 - Forecast Service Business Service Methods

There are two methods associated with the Forecast 2000 - Forecast Service:

GenerateForecast
RollUpForecast

GenerateForecast Method

This business service method generates forecasts. The following table describes the GenerateForecast method.

Field	Description
Name:	GenerateForecast
Display Name:	Generate Forecast

RollUpForecast Method

This business service method rolls up forecasts. The following table describes the RollupForecast method.

Field	Description
Name:	RollUpForecast
Display Name:	Rollup Forecast

Forecast 2000 - Forecast Service Business Service Method Arguments

This topic describes the arguments that are associated with the GenerateForecast and RollUpForecast methods.

GenerateForecast Method Arguments

There following arguments are associated with the GenerateForecast method:

GenerateForecast (Forecast Series Date Id, Forecast Series Id, Position Id)

Forecast Series Date ID

This argument takes the row ID of the date for which the forecast is to be generated.

Field	Description
Name:	Forecast Series Date Id
Data Type:	String
Type:	Input
Storage Type:	Property

Forecast Series ID

This argument takes the row ID of the forecast series for which the forecast is to be generated.

Field	Description
Name:	Forecast Series Id
Data Type:	String
Type:	Input
Storage Type:	Property

Position ID

This argument takes the row ID of the position of the participant for whom the forecast is to be generated.

Field	Description
Name:	Position Id
Data Type:	String
Type:	Input
Storage Type:	Property

RollUpForecast Method Arguments

There following arguments are associated with the RollUpForecast method:

RollUpForecast (Forecast Id, Position Id)

Forecast ID

This argument takes the row ID of the forecast record for which rollup needs to be done.

Field	Description
Name:	Forecast Id
Data Type:	String
Type:	Input
Storage Type:	Property

Position ID

This argument takes the row ID of the position of the participant for whom the forecast is to be rolled up.

Field	Description
Name:	Position Id
Data Type:	String
Type:	Input
Storage Type:	Property