Bookshelf v7.5: Forecasting User Properties

Siebel Forecasting Guide > Forecasting User Properties >

Forecasting User Properties

Forecasting user properties are found in Siebel Tools. For more information about user properties, see Siebel Tools Reference.

CAUTION: Some Siebel Forecasting user properties are for internal use only. Adjusting user properties marked for internal use can affect the behavior of adjustments. Internal use only user properties should not be modified. They are included in this appendix for informational purposes only.

Table 7 describes the user properties associated with the business component: Forecast 2000 - Forecast.

Table 7. Forecast 2000 - Forecast
User Property	Value	Comments
Associate: Completion Timeout (Client)	120 (default)	Maximum amount of time (in seconds) to wait on the client for a subordinate's forecast to finish before skipping the association and returning an error.
Associate: Completion Timeout (Server)	1200 (default)	Maximum amount of time to wait (in seconds) on the server for a subordinate's forecast to finish before skipping the association and returning an error.
Associate: Sleep Time Between Attempts	5 (default)	Amount of time to wait (in seconds) between checks for completion of subordinate's forecast.
Forecast Analysis BC	Forecast 2000 - Forecast Item Detail Flat	The business component whose records are displayed in the child applet in the Analysis view, when parent records are selected for comparison.
Forecast Rollup	[Link Type] = LookupValue ('FCST_FCSTITEM_LINK_TYPE', 'Own Item') or [Link Type] = LookupValue ('FCST_FCSTITEM_LINK_TYPE', 'Item')	If active, this search spec is applied on the Forecast Detail BusComp during rollup.
Named Search: Forecast Series Date Range	[Date] >= '&FCST_DATE_LOWER_BOUND' and [Date] <= '&FCST_END_DATE'	If active, this search spec is applied to the Revenue BusComp during forecast creation. This is usually active to make sure that the revenues are within the Forecast Date range. If not active, administrators need to modify the Auto and Assoc search specs of the Forecast Series to include similar criteria if they want the revenues that enter the forecast to be limited by date. This search spec (as well as the Auto and Assoc search specs) can use special variables as defined in the Forecast Series and Forecast Series Date BusComps.
Revenue Aggregation Field (N)	Field names on the Forecast 2000 - Forecast Item Detail Flat BusComp	The fields which are aggregated during forecast rollup. Rollup aggregates the forecast details by forecast period, and sums up the fields configured here when creating each summary record.
Skip Existing Forecast Series Date	Y	If enabled, will not show dates for which forecasts of the currently selected series already exist.

Table 8 describes the user properties associated with the business component: Forecast 2000 - Forecast Item.

Table 8. Forecast 2000 - Forecast Item
User Property	Value	Comments
Adjustment: Adjustable	Y	Indicates that adjustments are enabled on Forecast Item BusComp. An adjustable business component supports the concept of hierarchical information sharing. When a manager modifies a subordinate's record, the changes are made to a copy of the record, not the actual subordinate record. Therefore, changes are not visible to the subordinate. Also, the manager's record is visible to the positions above him, for example his change shadows the original record. The record created by the manager is called an adjustment of the original. If adjustments are disabled, changes are made on the same record and are visible throughout the hierarchy.
Adjustment: Adjustable Field (N)	Field names on the Forecast 2000 - Forecast Item BusComp	Fields which managers can adjust. If a field is not configured here, it will appear to be uneditable to managers when they view forecast details included from subordinate forecasts.
Adjustment: Adjustment Allowed Field Name	Adjustment Allowed	Used internally. Should not be disabled.
Adjustment: Adjustment Context BC Name	Forecast 2000 - Forecast	Used internally. Value is the business component which includes information indicating the ownership/level of an adjustment record. This is used to support copy-on-write implementation of adjustments. In Forecasting, the same record is visible in both manager and subordinate forecasts before adjustments and its context is the forecast it is being viewed under. When an adjustment is made, the adjusted record then takes its ownership from its context (the manager's forecast).
Adjustment: Adjustment Context Id Field Name	Owner Forecast Id	Used internally. Field on Context BusComp which indicates position of owner.
Adjustment: Adjustment Flag Field Name	Adjusted Flag	Used internally. Indicates if a record has been adjusted and is used in other methods. For example, it is used for determining if the user can invoke the Unadjust Record method.
Adjustment: Adjustment For Id Field Name	Adjustment For Id	Used internally. Field which stores base record identifier (usually, but not necessarily the value of row_id) that this record is an adjustment for.
Adjustment: Adjustment for Id Matching Field Name	Forecast Item Number	Used internally. Field which, when matched against [Adjustment For Id], determines if a record has been adjusted. This is part of the criteria used in calculating the value of the Adjustment Flag.
Adjustment: Context BC Position Id Field Name	Owner Position Id	Used internally. Field on the Context BusComp which stores the position of the owner. Because Siebel Forecasting is position-based, this links the user to the forecast record created. The position is used when calculating whether a record is visible.
Adjustment: InterTable	Y	Used internally (default N). Indicates whether this adjustable business component's visibility is determined by an intertable. The code would potentially need to modify the intertable when creating adjustments.
Adjustment: InterTable BC	Forecast 2000 - Forecast/Forecast Item	Used internally. Indicates the business component that sits on the intertable.
Adjustment: InterTable Child Field Name	Forecast Item Id	Used internally. Indicates the field on the intertable that stores the pointer id to this business component.
Adjustment: InterTable Parent Field Name	Forecast Id	Used internally. Indicates the field on the intertable that stores the pointer to the parent (context) business component.
Adjustment: InterTable Update	Y	Used internally. Indicates whether or not the intertable should be updated during adjustments.
Adjustment: Owner Position Id Field Name	Owner Position Id.	Used internally. Field on this business component which stores the owner's Position Id.
Revenue Associate List	Y	When active, the associate applet will show the revenue, and not a standard child business component. It also applies the Associate Search Spec and the Forecast Date Range search when querying the Revenue BusComp. When inactive, the behavior defaults to standard association and the business component will be as defined in the associate applet.
Revenue Field Map: <Forecast Item Field>	<Revenue Field>	Maps fields from the Revenue BusComp to the Forecast Item BusComp, which are copied when creating the forecast. This is most commonly configured by administrators who have added fields to the Revenue BusComp and want the fields to be carried over in the forecast.

Table 9 describes the user properties associated with the business component: Forecast 2000 - Forecast Item Detail.

Table 9. Forecast 2000 - Forecast Item Detail
User Property	Value	Comments
Adjustment: Adjustable	Y	Used internally.
Adjustment: Adjustable Field (N)	<Forecast Item Detail field>	See Forecast Item: Adjustable Field (N) in Table 8.
Adjustment: Adjustment Allowed Field Name	Adjustment Allowed	Used internally. See Forecast Item: Adjustment Allowed Field Name in Table 8.
Adjustment: Adjustment Context BC Name	Forecast 2000 - Forecast	Used internally. See Forecast Item: Adjustment Context BC Name in Table 8.
Adjustment: Adjustment Context Id Field Name	Owner Forecast Id	Used internally. See Forecast Item: Adjustment Context Id Field Name in Table 8.
Adjustment: Adjustment Flag Field Name	Adjusted Flag	Used internally. See Forecast Item:Adjustment Flag Field Name in Table 8.
Adjustment: Adjustment For Id Field Name	Adjustment For Id	Used internally. See Forecast Item: Adjustment For Id Field Name in Table 8.
Adjustment: Context BC Position Id Field Name	Owner Position Id	Used internally. See Forecast Item: Context BC Position Id Field Name in Table 8.
Revenue Field Map: <Forecast Item Detail Field>	<Revenue Field>	See Forecast Item: Revenue Field Map in Table 8.

Table 10 describes the user properties associated with the business component: Forecast 2000 - Forecast Item Detail Flat.

Table 10. Forecast 2000 - Forecast Item Detail Flat
User Property	Value	Comments
Adjustment: Adjustable	Y	Used internally. See Forecast Item: Adjustable in Table 8.
Adjustment: Adjustable Field (N)	<Forecast Item Detail Flat field>	See Forecast Item: Adjustable Field (N) in Table 8.
Adjustment: Adjustment Allowed Field Name	Adjustment Allowed	Used internally. See Forecast Item: Adjustment Allowed Field Name in Table 8.
Adjustment: Adjustment Context BC Name	Forecast 2000 - Forecast	Used internally. See Forecast Item: Adjustment Context BC Name in Table 8.
Adjustment: Adjustment Context Id Field Name	Owner Forecast Id	Used internally. See Forecast Item: Adjustment Context Id Field Name in Table 8.
Adjustment: Adjustment Flag Field Name	Adjusted Flag	Used internally. See Forecast Item: Adjustment Flag Field Name in Table 8.
Adjustment: Adjustment For Id Field Name	Adjustment For Id	Used internally. See Forecast Item: Adjustment For Id Field Name in Table 8.
Adjustment: Context BC Position Id Field Name	Owner Position Id	Used internally. See Forecast Item: Context BC Position Id Field Name in Table 8.
Adjustment: Owner Position Id Field Name	Owner Position Id	Used internally. See Forecast Item: Owner Position Id in Table 8.
Adjustment: Force Unadjust Parent BC	Forecast 2000 - Forecast Item	Used internally. When unadjusting this buscomp, the parent buscomp may also need to be unadjusted, e.g. if it drives the visibility of this buscomp.
Adjustment: Force Unadjust Parent BC Id Field Name	Forecast Item Id	Used internally. When unadjusting this buscomp, the field on this buscomp which links to the parent buscomp that it should unadjust.
Revenue Associate List	Y	See Forecast Item: Revenue Associate List in Table 8.
Revenue Field Map: <Forecast Item Detail Field>	<Revenue Field>	See Forecast Item: Revenue Field Map in Table 8.

Table 11 describes the user properties associated with the business component: Forecast 2000 - Forecast Item DynCol.

Table 11. Forecast 2000 - Forecast Item DynCol
User Property	Value	Comments
Adjustment: Adjustable	Y	Used internally. See Forecast Item: Adjustable in Table 8.
Adjustment: Adjustable Field (N)	Field names on the Forecast 2000 - Forecast Item buscomp	See Forecast Item: Adjustable Field (N in Table 8).
Adjustment: Adjustment Allowed Field Name	Adjustment Allowed	Used internally. See Forecast Item: Adjustment Allowed Field Name in Table 8.
Adjustment: Adjustment Context BC Name	Forecast 2000 - Forecast	Used internally. See Forecast Item: Adjustment Context BC Name in Table 8.
Adjustment: Adjustment Context Id Field Name	Owner Forecast Id	Used internally. See Forecast Item: Adjustment Context Id Field Name in Table 8.
Adjustment: Adjustment Flag Field Name	Adjusted Flag	Used internally. See Forecast Item: Adjustment Flag Field Name in Table 8.
Adjustment: Adjustment For Id Field Name	Adjustment For Id	Used internally. See Forecast Item: Adjustment For Id Field Name in Table 8.
Adjustment: Adjustment for Id Matching Field Name	Forecast Item Number	Used internally. See Forecast Item: Adjustment For Id Matching Field Name in Table 8.
Adjustment: Context BC Position Id Field Name.	Owner Position Id	Used internally. See Forecast Item: Context BC Position Id Field Name in Table 8.
Adjustment: InterTable	Y	Used internally. See Forecast Item: Adjustment InterTable in Table 8.
Adjustment: InterTable BC	Forecast 2000 - Forecast/Forecast Item	Used internally. See Forecast Item: Adjustment InterTable BC in Table 8.
Adjustment: InterTable Child Field Name	Forecast Item Id	Used internally. See Forecast Item:Adjustment InterTable Child Field in Table 8.
Adjustment: InterTable Parent Field Name	Forecast Id	Used internally. See Forecast Item: Adjustment InterTable Parent Field in Table 8.
Adjustment: InterTable Update	Y	Used internally. See Forecast Item: Adjustment InterTable Update in Table 8.
Revenue Associate List		Used internally. See Forecast Item: Revenue Associate List in Table 8.
Revenue Field Map: <Forecast Item Field>	<Revenue Field>	See Forecast Item: Revenue Field Map in Table 8.

Table 12 describes the user properties associated with the business component: Forecast 2000 - Forecast Series.

Table 12. Forecast 2000 - Forecast Series
User Property	Value	Comments
Series Subst Var: SERIES_NAME	Name	Special variable available for use in Auto, Assoc, and Date Range search specs. Using this variable, administrators can access the Forecast Series Name.

Table 13 describes the user properties associated with the business component: Forecast 2000 - Forecast Series Date.

Table 13. Forecast 2000 - Forecast Series Date
User Property	Value	Comments
Auto-Set Start/End Dates	N	If enabled, when the user creates a new record and sets the Forecast Date field, Start Date will automatically default to the period that the Forecast Date falls in. Also, if the user is copying a record, the End date will default so that the difference (number of periods) between the source record's start date and end date will be maintained.
Series Subst Var: FCST_DATE_LOWER_BOUND	Date - Lower Bound	Special variable available for use in Auto, Assoc, and Date Range search specs. Using this variable, administrators can access the lower bound of the Forecast Series Date record, for example the earliest of {History View Date, History Edit Date, Start Date}, some of which can be null.
Series Subst Var: FCST_EFFECTIVE_DATE	Forecast Date	Special variable available for use in Auto, Assoc, and Date Range search specs. Using this variable, administrators can access the Forecast Date.
Series Subst Var: FCST_END_DATE	End Date	Special variable available for use in Auto, Assoc, Date Range search specs. Through this variable, administrators can access the End Date.
Series Subst Var: FCST_HISTE_START_DATE	History Edit Date	Special variable available for use in Auto, Assoc, and Date Range search specs. Using this variable, administrators can access the History Edit Date, which can be null. The History Edit Date defaults to History View if defined, otherwise it defaults to Start Date.
Series Subst Var: FCST_HISTV_START_DATE	History View Date	Special variable available for use in Auto, Assoc, and Date Range search specs. Using this variable, administrators can access the History View Date, which can be null. The History View Date defaults to the earlier of {History Edit, Start}.
Series Subst Var: FCST_START_DATE	Start Date	Special variable available for use in Auto, Assoc, and Date Range search specs. Using this variable, administrators can access the Start Date, which cannot be null.

When entering user properties or search specs for forecast administration, make sure that the quote symbols (') are not formatted to be directional. The beginning and ending quotations should appear identical. Formatting is automatically done by some editors, for example Microsoft Word, but such formatted quotes are not recognized by the Siebel parser.

The "Forecast 2000 - Forecast Item Detail" business component is used internally by the forecast engine, while the "Forecast 2000 - Forecast Item Detail Flat" business component joins both the Forecast Item and Forecast Item Detail business components to form a flat view (the Forecast Item BusComp usually stores the non-numeric properties which can be shared by child details). In general, this means that new fields, and user properties referencing that field, should be added to both business components.

The "Forecast 2000 - Forecast Item" business component is used internally by the forecast engine, while the "Forecast 2000 - Forecast Item DynCol" business component is used to display the Forecast Details spreadsheet. Each record in the Forecast Item DynCol business component corresponds to a row in the spreadsheet, with the child forecast details forming the dynamic columns (dates). For information on the dynamic columns user properties, see Changing the Configuration of Spreadsheet Applets for New Views (Administrator).