com.ibm.rpm.financial.containers
abstract AbstractFinancial

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.financial.containers.AbstractFinancial

AbstractFinancial
Extends: com.ibm.rpm.framework.RPMObject
Child objects:
   com.ibm.rpm.financial.containers.WbsFinancial
   com.ibm.rpm.financial.containers.WorksheetFinancial

Related scope: com.ibm.rpm.financial.scope.FinancialScope

AbstractFinancial is the set of financial (budget) data for WorkElement items, for a given ChargeCode.

AbstractFinancials cannot be instantiated directly. See its subclasses: WorksheetFinancial and WBSFinancial.

AbstractFinancial is always associated with a WorkElement parent. WorksheetFinancial requires that its parent be an AggregateNode (which is a subclass of WorkElement).

The checkout mode type is: Parent

Supported API Calls:

Field Summary
xsd:double actual
   The actual value for the related chargecode.
TimePhasedFinancial[] actualTimePhased
   The actual value breakdown for each year.
xsd:double baseline
   The baselined number of hours.
xsd:double baselineInitial
   The value of the Estimate at the time of the first baseline.
TimePhasedFinancial[] baselineInitialTimePhased
   Initial Baseline value breakdown for each year.
xsd:double baselinePrevious
   The value of the baseline at the time of the lase baseline.
TimePhasedFinancial[] baselinePreviousTimePhased
   The previous baseline value breakdown for each year.
TimePhasedFinancial[] baselineTimePhased
   The baseline value breakdown for each year.
xsd:double baselineVariance
   The difference between the Estimate and the Baseline.
xsd:double billed
   The charged amount for the related chargecode.
TimePhasedFinancial[] billedTimePhased
   The billed value breakdown for each year.
ChargeCode chargeCode
   The Chargecode related to this financial data.
xsd:double EAC
   The new Estimate At Completion (EAC) for the related WorkElement and ChargeCode. The sum of Actual and ETC.
xsd:double EACVariance
   The value of the Estimate at the time of the last baseline.
xsd:double estimate
   The estimated budget for the related chargecode.
TimePhasedFinancial[] estimateTimePhased
   The estimated budget breakdown for each year.
xsd:double ETC
   The Estimate To Complete (ETC) the related WorkElement for the related ChargeCode.
xsd:double GL
   The General Ledger (GL) amount for the related chargecode.
TimePhasedFinancial[] GLTimePhased
   The general ledger value breakdown for each year.
xsd:double probabilityAmount
   The calculated probable benefit realization (Prob.% x Wbs Benefit Estimates) per selected charge code.
xsd:double probabilityPercent
   The percent probability for obtaining the benefits entered in the worksheets or aggregation from the Wbs.
xsd:double remaining
   The difference between the Estimate and the Actual.
RevenueRecognitionMethodType revRecType
   The way revenues are calculated. Possible values are Manual, Ratio, and FlowThru. When not applicable to the current ChargeCode, this field contains the N/A value and any modification is ignored.
TimePhasedType timePhased
   Represents the way timephased financial breakdown is calculated. Possible values are NotTimephased, AutoTimephased, ManuallyTimephased, and ProjectAssignment.

Time-phased relies on the project estimated start and finish dates as well as the system fiscal calendar to configure the time-phase periods. Planning and tracking of both labor and non-labor budgets are based on the standard project calendar selected. Tracking is based on the system fiscal calendar that is configured by the Application Administrator. Time-phased categorizes Estimates and Actuals by the following budget type:

  • Expense
  • Capital
  • Revenue/Benefits

Inherited Field Summary
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
RPMObject parent
   The parent of the RPMObject.

Field Detail

actual


xsd:double  actual
The actual value for the related chargecode.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


actualTimePhased


TimePhasedFinancial[] actualTimePhased
The actual value breakdown for each year.

Scoping: This field will be used by the API if the scope field actualTimePhased is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


baseline


xsd:double  baseline
The baselined number of hours.

Read-only behavior: The value of this field is read only.


baselineInitial


xsd:double  baselineInitial
The value of the Estimate at the time of the first baseline.

Read-only behavior: The value of this field is read only.


baselineInitialTimePhased


TimePhasedFinancial[] baselineInitialTimePhased
Initial Baseline value breakdown for each year.

Scoping: This field will be used by the API if the scope field baselineInitialTimePhased is enabled.

Read-only behavior: The value of this field is read only.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


baselinePrevious


xsd:double  baselinePrevious
The value of the baseline at the time of the lase baseline.

Read-only behavior: The value of this field is read only.


baselinePreviousTimePhased


TimePhasedFinancial[] baselinePreviousTimePhased
The previous baseline value breakdown for each year.

Scoping: This field will be used by the API if the scope field baselinePreviousTimePhased is enabled.

Read-only behavior: The value of this field is read only.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


baselineTimePhased


TimePhasedFinancial[] baselineTimePhased
The baseline value breakdown for each year.

Scoping: This field will be used by the API if the scope field baselineTimePhased is enabled.

Read-only behavior: The value of this field is read only.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


baselineVariance


xsd:double  baselineVariance
The difference between the Estimate and the Baseline.

Read-only behavior: The value of this field is read only.


billed


xsd:double  billed
The charged amount for the related chargecode.

Read-only behavior: The value of this field is read only.


billedTimePhased


TimePhasedFinancial[] billedTimePhased
The billed value breakdown for each year.

Scoping: This field will be used by the API if the scope field billedTimePhased is enabled.

Read-only behavior: The value of this field is read only.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


chargeCode


ChargeCode chargeCode
The Chargecode related to this financial data.

Null value: This field may never be null during updates.

Scoping: This field will be used by the API if the scope field chargeCode is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.


EAC


xsd:double  EAC
The new Estimate At Completion (EAC) for the related WorkElement and ChargeCode. The sum of Actual and ETC.

Read-only behavior: The value of this field is read only.


EACVariance


xsd:double  EACVariance
The value of the Estimate at the time of the last baseline.

Read-only behavior: The value of this field is read only.


estimate


xsd:double  estimate
The estimated budget for the related chargecode.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


estimateTimePhased


TimePhasedFinancial[] estimateTimePhased
The estimated budget breakdown for each year.

Scoping: This field will be used by the API if the scope field estimateTimePhased is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


ETC


xsd:double  ETC
The Estimate To Complete (ETC) the related WorkElement for the related ChargeCode.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 1e+13.


GL


xsd:double  GL
The General Ledger (GL) amount for the related chargecode.

Read-only behavior: The value of this field is read only.


GLTimePhased


TimePhasedFinancial[] GLTimePhased
The general ledger value breakdown for each year.

Scoping: This field will be used by the API if the scope field GLTimePhased is enabled.

Read-only behavior: The value of this field is read only.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


probabilityAmount


xsd:double  probabilityAmount
The calculated probable benefit realization (Prob.% x Wbs Benefit Estimates) per selected charge code.

Read-only behavior: The value of this field is read only.


probabilityPercent


xsd:double  probabilityPercent
The percent probability for obtaining the benefits entered in the worksheets or aggregation from the Wbs.

Minimum: The minimum value for this field is 0D.

Maximum: The maximum value for this field is 100D.


remaining


xsd:double  remaining
The difference between the Estimate and the Actual.

Read-only behavior: The value of this field is read only.


revRecType


RevenueRecognitionMethodType revRecType
The way revenues are calculated. Possible values are Manual, Ratio, and FlowThru. When not applicable to the current ChargeCode, this field contains the N/A value and any modification is ignored.

Relationship: This field is a reference relationship.


timePhased


TimePhasedType timePhased
Represents the way timephased financial breakdown is calculated. Possible values are NotTimephased, AutoTimephased, ManuallyTimephased, and ProjectAssignment.

Time-phased relies on the project estimated start and finish dates as well as the system fiscal calendar to configure the time-phase periods. Planning and tracking of both labor and non-labor budgets are based on the standard project calendar selected. Tracking is based on the system fiscal calendar that is configured by the Application Administrator. Time-phased categorizes Estimates and Actuals by the following budget type:

Relationship: This field is a reference relationship.


Inherited Field Detail

contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


parent


RPMObject parent
The parent of the RPMObject.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.

Valid types:
com.ibm.rpm.scopemanagement.containers.ScopeElement
com.ibm.rpm.wbs.containers.WorkElement