1. Siebel Forecasting Guide
  2. What’s New in This Release

13Forecasting User Properties

Forecasting User Properties

This chapter describes the user properties associated with a number of Forecasting business components. Forecasting user properties are in Siebel Tools. This chapter contains the following topics:

Caution: Some Siebel Forecasting user properties are for internal use only. Adjusting user properties marked for internal use can affect the behavior of adjustments. Do not modify Internal use only user properties. They are included in This chapter for informational purposes only.

About Forecasting User Properties

The following business components are relevant to Siebel Forecasting:

  • Forecast 2000 - Forecast. The business component for forecasts.

  • Forecast 2000 - Forecast Item. Used internally by the forecast engine.

  • Forecast 2000 - Forecast Item Detail. Used internally by the forecast engine.

  • Forecast 2000 - Forecast Item Detail Flat. Joins both the Forecast Item and Forecast Item Detail business components to form a flat view (the Forecast Item business component usually stores the nonnumeric properties that can be shared by child details). In general, this means that new fields, and user properties referencing that field, are added to both business components.

  • Forecast 2000 - Forecast Item DynCol. 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 Modifying Spreadsheet Applets for Forecasting.

  • Forecast 2000 - Forecast Series. The business component for forecast series.

  • Forecast 2000 - Forecast Series Aggregation. The business component for aggregation levels associated with forecast series.

  • Forecast 2000 - Forecast Date. The business component for dates associated with forecast series.

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

Forecast 2000 - Forecast User Properties

The following table describes the user properties associated with the business component: Forecast 2000 - Forecast.

User Property Value Description

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 Refresh

Y or N

If this property is not defined, the Refresh button is not enabled.

Forecast Rollup

[Link Type] = LookupValue ('FCST_FCSTITEM_LINK_TYPE', 'Own Item')

or

[Link Type] = LookupValue ('FCST_FCSTITEM_LINK_TYPE', 'Item')

If active, this search specification is applied on the Forecast Detail business component during rollup.

This search specification defines that only those records that have a Link Type value of Own Item or Item are rolled up.

Forecast UoM Conversion

Y or N

If enabled, the UoM conversion is done when generating a forecast.

Skip Existing Forecast Series Date

Y

If enabled, does not show dates for which forecasts of the currently selected series already exist.

Named Search: Forecast Series Date Range

[Date] >= '&FCST_DATE_LOWER_BOUND' and [Date] <= '&FCST_END_DATE'

If active, this search specification is applied to the Revenue business component during forecast creation. This forecast is typically activated to make sure that the revenues returned by the search are within the Forecast Date range. For more information about this user property, see Using the Named Search: Forecast Series Date Range User Property.

Revenue Aggregation Field n

Field names on the Forecast 2000 - Forecast Item Detail Flat business component

The fields that 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.

The Revenue Aggregation Field 6 user property is deactivated. You must use this user property as the first of any custom user properties.

Skip Existing Forecast Series Date

Y

If enabled, does not show dates for which forecasts of the currently selected series already exist.

    Using the Named Search: Forecast Series Date Range User Property

    Use this user property when querying the revenue records to include in the current forecast. The default is to include all records, in the range specified by the forecast.

    The value of the Named Search: Forecast Series Date Range user property must be a valid search specification. The search specification (as well as the Auto and Assoc search specifications) can use special variables as defined in the Forecast Series and Forecast Series Date business components. For example, if the default value of Named Search: Forecast Series Date Range is:

    [Date] >= ‘&FCST_DATE_LOWER_BOUND’ and [Date] <= ‘&FCST_END_DATE’

    then values between the Date - Lower Bound field and the End Date field of the Forecast 2000 -- Forecast Series Date business component are returned. In such a case:

    • The variable &FCST_DATE_LOWER_ BOUND represents the Date - Lower Bound field, which is the History View Date if it has a value.

    • If History View Date does not have a value, the Date - Lower Bound field is the History Edit date if it has a value, or the Start Date if the History Edit date does not have a value.

    You can deactivate and modify the values of the Named Search: Forecast Series Date Range user property; however, you cannot create new instances of it.

    Note: If you deactivate the Named Search: Forecast Series Date Range user property, you can make sure that the revenues that enter the forecast are limited by date, by modifying the Auto and Assoc search specifications of the Forecast Series to include similar criteria.

      Forecast 2000 - Forecast Item User Properties

      The following table describes the user properties associated with the business component: Forecast 2000 - Forecast Item.

      User Property Value Description

      Adjustment: Adjustable

      Y

      Indicates that adjustments are enabled on Forecast Item business component.

      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 positions superior to the manager, and the 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 business component

      Fields that managers can adjust.

      If a field is not configured here, it appears to be uneditable to managers when they view forecast details included from subordinate forecasts.

      Adjustment: Adjustment Allowed Field Name

      Adjustment Allowed

      Used internally.

      Do not disable.

      Adjustment: Adjustment Context BC Name

      Forecast 2000 - Forecast

      Used internally.

      The value is the business component that includes information indicating the ownership or 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 business component that indicates position of owner.

      Adjustment: Adjustment Flag Field Name

      Adjusted Flag

      Used internally.

      Indicates if a record was adjusted and is used in other methods. For example, it is used for determining if the user can invoke the Unadjust Record method.

      Note: The Adjusted Flag is set only when the adjustment is made by a manager. It does not get set when the adjustment is made by the primary sales team member.

      Adjustment: Adjustment For Id Field Name

      Adjustment For Id

      Used internally.

      Field that stores base record identifier (usually, but not necessarily the value of row_id) for which this record is an adjustment.

      Adjustment: Adjustment for Id Matching Field Name

      Forecast Item Number

      Used internally.

      Field which, when matched against [Adjustment For Id], determines if a record was 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 business component that stores the position of the owner. Because Oracle’s 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 is updated during adjustments.

      Adjustment: Owner Position Id Field Name

      Owner Position Id.

      Used internally.

      Field on this business component that stores the owner’s Position Id.

      Revenue Associate List

      Y

      When active, the associate applet shows the revenue, and not a standard child business component. It also applies the Associate search specification and the Forecast Date Range search when querying the Revenue business component.

      When inactive, the behavior defaults to standard association and the business component is defined in the associate applet.

      Revenue Field Map: Forecast Item Field

      Revenue Field

      Maps fields from the Revenue business component to the Forecast Item business component, which are copied when creating the forecast.

      This is most commonly configured by administrators who have added fields to the Revenue business component and want the fields to be carried over in the forecast.

      Forecast 2000 - Forecast Item Detail User Properties

      The following table describes the user properties associated with the business component: Forecast 2000 - Forecast Item Detail.

      User Property Value Description

      Adjustment: Adjustable

      Y

      Used internally.

      Adjustment: Adjustable Field n

      Forecast Item Detail field

      See Forecast Item: Adjustable Field n in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Allowed Field Name

      Adjustment Allowed

      Used internally.

      See Forecast Item: Adjustment Allowed Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Context BC Name

      Forecast 2000 - Forecast

      Used internally.

      See Forecast Item: Adjustment Context BC Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Context Id Field Name

      Owner Forecast Id

      Used internally.

      See Forecast Item: Adjustment Context Id Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Flag Field Name

      Adjusted Flag

      Used internally.

      See Forecast Item: Adjustment Flag Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment For Id Field Name

      Adjustment For Id

      Used internally.

      See Forecast Item: Adjustment For Id Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Context BC Position Id Field Name

      Owner Position Id

      Used internally.

      See Forecast Item: Context BC Position Id Field Name in Forecast 2000 - Forecast Item User Properties.

      On Field Update Set 1

      "Amount Revenue", "Expected Value", "IIF([Win Probability] = 0"

      Or

      [Amount Revenue] = 0, 0.0, [Win Probability]*[Amount Revenue]/100)"

      Used internally.

      Determines how the Expected Revenue is calculated when there are updates to the Revenue or Probability fields.

      On Field Update Set 2

      "Win Probability", "Expected Value", "IIF([Win Probability] = 0"

      Or

      [Amount Revenue] = 0, 0.0, [Win Probability]*[Amount Revenue]/100)"

      Used internally.

      Determines how the Expected Revenue is calculated when there are updates to the Revenue or Probability fields.

      Revenue Field Map: Forecast Item Detail Field

      Revenue Field

      See Forecast Item: Revenue Field Map in Forecast 2000 - Forecast Item User Properties.

      Forecast 2000 - Forecast Item Detail Flat User Properties

      The following table describes the user properties associated with the business component: Forecast 2000 - Forecast Item Detail Flat.

      User Property Value Description

      Adjustment: Adjustable

      Y

      Used internally.

      See Forecast Item: Adjustable in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustable Field n

      Forecast Item Detail Flat field

      See Forecast Item: Adjustable Field n in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Allowed Field Name

      Adjustment Allowed

      Used internally.

      See Forecast Item: Adjustment Allowed Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Context BC Name

      Forecast 2000 - Forecast

      Used internally.

      See Forecast Item: Adjustment Context BC Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Context Id Field Name

      Owner Forecast Id

      Used internally.

      See Forecast Item: Adjustment Context Id Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Flag Field Name

      Adjusted Flag

      Used internally.

      See Forecast Item: Adjustment Flag Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment For Id Field Name

      Adjustment For Id

      Used internally.

      See Forecast Item: Adjustment For Id Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Context BC Position Id Field Name

      Owner Position Id

      Used internally.

      See Forecast Item: Context BC Position Id Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Owner Position Id Field Name

      Owner Position Id

      Used internally.

      See Forecast Item: Owner Position Id in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Force Unadjust Parent BC

      Forecast 2000 - Forecast Item

      Used internally.

      When unadjusting this business component, the parent business component sometimes also needs to be unadjusted, for example, if it drives the visibility of this business component.

      Adjustment: Force Unadjust Parent BC Id Field Name

      Forecast Item Id

      Used internally.

      When unadjusting this business component, the field on this business component that links to the parent business component that it needs to unadjust.

      Aggregation Level Rollup

      Y or N

      Indicates whether or not rollup happens at each aggregation level.

      Aggregation Column Enabled

      Aggregation Column Enabled

      Indicates whether the column must be queried according to the aggregation hierarchy defined in the forecast series.

      On Field Update Invoke 1

      "Amount Revenue", "Forecast 2000 -- Forecast", "ForecastSetUpdateFlag"

      Used internally.

      If a subordinate updates their forecast by changing the Revenue amount, this property invokes a function to set the Refresh Alert field so that the manager will refresh the forecast.

      On Field Update Set 1

      "Amount Revenue", "Expected Value", "IIF([Win Probability] = 0"

      Or

      [Amount Revenue] = 0, 0.0, [Win Probability]*[Amount Revenue]/100)"

      Used internally.

      Determines how the Expected Revenue is calculated when there are updates to the Revenue or Probability fields.

      On Field Update Set 2

      "Win Probability", "Expected Value", "IIF([Win Probability] = 0"

      Or

      [Amount Revenue] = 0, 0.0, [Win Probability]*[Amount Revenue]/100)"

      Used internally.

      Determines how the Expected Revenue is calculated when there are updates to the Revenue or Probability fields.

      Revenue Associate List

      Y

      See Forecast Item: Revenue Associate List in Forecast 2000 - Forecast Item User Properties.

      Revenue Field Map: Forecast Item Detail Field

      Revenue Field

      See Forecast Item: Revenue Field Map in Forecast 2000 - Forecast Item User Properties.

      Forecast 2000 - Forecast Item Dyn Col User Properties

      The following table describes the user properties associated with the business component: Forecast 2000 - Forecast Item DynCol.

      User Property Value Description

      Adjustment: Adjustable

      Y

      Used internally.

      See Forecast Item: Adjustable in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustable Field n

      Field names on the Forecast 2000 - Forecast Item business component

      See Forecast Item: Adjustable Field n in Forecast 2000 - Forecast Item User Properties).

      Adjustment: Adjustment Allowed Field Name

      Adjustment Allowed

      Used internally.

      See Forecast Item: Adjustment Allowed Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Context BC Name

      Forecast 2000 - Forecast

      Used internally.

      See Forecast Item: Adjustment Context BC Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Context Id Field Name

      Owner Forecast Id

      Used internally.

      See Forecast Item: Adjustment Context Id Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment Flag Field Name

      Adjusted Flag

      Used internally.

      See Forecast Item: Adjustment Flag Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment For Id Field Name

      Adjustment For Id

      Used internally.

      See Forecast Item: Adjustment For Id Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Adjustment for Id Matching Field Name

      Forecast Item Number

      Used internally.

      See Forecast Item: Adjustment For Id Matching Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: Context BC Position Id Field Name.

      Owner Position Id

      Used internally.

      See Forecast Item: Context BC Position Id Field Name in Forecast 2000 - Forecast Item User Properties.

      Adjustment: InterTable

      Y

      Used internally.

      See Forecast Item: Adjustment InterTable in Forecast 2000 - Forecast Item User Properties.

      Adjustment: InterTable BC

      Forecast 2000 - Forecast/Forecast Item

      Used internally.

      See Forecast Item: Adjustment InterTable BC in Forecast 2000 - Forecast Item User Properties.

      Adjustment: InterTable Child Field Name

      Forecast Item Id

      Used internally.

      See Forecast Item: Adjustment InterTable Child Field in Forecast 2000 - Forecast Item User Properties.

      Adjustment: InterTable Parent Field Name

      Forecast Id

      Used internally.

      See Forecast Item: Adjustment InterTable Parent Field in Forecast 2000 - Forecast Item User Properties.

      Adjustment: InterTable Update

      Y

      Used internally.

      See Forecast Item: Adjustment InterTable Update in Forecast 2000 - Forecast Item User Properties.

      Revenue Associate List

      Used internally.

      See Forecast Item: Revenue Associate List in Forecast 2000 - Forecast Item User Properties.

      Revenue Field Map: Forecast Item Field

      Revenue Field

      See Forecast Item: Revenue Field Map in Forecast 2000 - Forecast Item User Properties.

      Forecast 2000 - Forecast Series User Property

      The following table describes the user property associated with the business component: Forecast 2000 - Forecast Series.

      User Property Value Description

      Series Subst Var: SERIES_NAME

      Name

      Special variable available for use in Auto, Assoc, and Date Range search specifications. Using this variable, administrators can access the Forecast Series Name.

      Forecast 2000 - Forecast Series Aggregation User Property

      The following table describes the user property associated with the business component: Forecast 2000 - Forecast Series Aggregation.

      User Property Value Description

      On Field Update Set 1

      		 
      "Aggregate Level", "Mapped Field", "Aggregation Field Level + ' ' + ToChar([Aggregate Level])"

      Used Internally.

      Updates the fields called Mapped Field according to the aggregation level selected.

      Forecast 2000 - Forecast Series Date User Properties

      The following table describes the user properties associated with the business component: Forecast 2000 - Forecast Series Date.

      Table Forecast 2000 - Forecast Series Date

      User Property Value Description

      Auto-Set Start/End Dates

      N

      If enabled, when the user creates a new record and sets the Forecast Date field, Start Date automatically defaults to the period that the Forecast Date falls in.

      If the user is copying a record, the End Date defaults so that the difference (number of periods) between the source record's Start Date and End Date is maintained.

      Series Subst Var: FCST_DATE_LOWER_BOUND

      Date - Lower Bound

      Special variable available for use in Auto, Assoc, and Date Range search specifications.

      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 specifications.

      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 specifications.

      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 specifications.

      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 specifications.

      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 specifications.

      Using this variable, administrators can access the Start Date, which cannot be null.