PUBLIC
SAP BusinessObjects Profitability and Cost ManagementDocument Version: 10.0 – 2018-04-26
SAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
1 History of changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
2 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
3 Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223.1 Access Rights. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233.2 Activity Related Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
ActivityFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
ActivityLineItemFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
ActivityLineItemValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
ActivityLineItemVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
ActivityUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
ActivityValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
ActivityVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
ExternalActivityFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
ExternalActivityValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
ExternalActivityVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
PostReassignLineItemFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
PostReassignLineItemValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
PostReassignLineItemVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
ReassignActivityLineItemValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
ReassignActivityServiceValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
ReassignedFinalValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
ReassignedInValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
ReassignedMoveValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ReassignedOutValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ReassignSplitInValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
ReassignSplitOutValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
ReassignSplitPostValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
ReassignSplitValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
ServiceActivityUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
ServiceActivityValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
SourceActivityLineItemFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
SourceActivityLineItemValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
SourceActivityLineItemVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
SummaryActivityFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
SummaryActivityValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
SummaryActivityVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
SummaryMovementValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
SummaryServiceActivityValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.3 Boundary Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41EmployeePercentBoundaryValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
MetricActualBoundaryValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
MetricPercentBoundaryValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
ObjectiveActualBoundaryValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
ObjectivePercentBoundaryValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
3.4 Cost Object Related Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44ActivityCostObjectFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
ActivityCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
ActivityCostObjectVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Contribution Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
CostObjectActivityFixedUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
CostObjectActivityLineItemFixedUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
CostObjectActivityLineItemUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
CostObjectActivityUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
CostObjectFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
CostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
CostObjectVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
DirectCostObjectFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
DirectCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
DirectCostObjectVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
DirectPrimaryDriverUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
DirectPrimaryDriverVolume Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
DirectServiceCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
DirectServicePrimaryDriverUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
DirectServicePrimaryDriverVolume Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
ExtActivityCostObjectFixedUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
ExtActivityCostObjectUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
ExtActivityCostObjectVariableUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
ExternalCostObjectFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
ExternalCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
ExternalCostObjectVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
GrossContribution Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
JointCostObjectFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
JointCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
JointCostObjectVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideContent P U B L I C 3
LineItemCostObjectFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
LineItemCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
LineItemCostObjectVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
PrimaryDriverUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
PrimaryDriverVolume Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Revenue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
ServiceCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
ServicePrimaryDriverUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
ServicePrimaryDriverVolume Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
SourceCostObjectFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
SourceCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
SourceCostObjectVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
SummaryCostObjectFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
SummaryCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
SummaryCostObjectVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
SummaryPostCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
SummaryPreCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
TargetCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
TotalCostObjectFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
TotalCostObjectValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
TotalCostObjectVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
TracebackFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
TracebackValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
TracebackVariableValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
UnitPrice Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
UnitsSold Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Bill of Materials Cost Object Related Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783.5 Data Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
ActivityDriverDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
DataRevenue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
DataUnitPrice Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
DataUnitsSold Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
EmployeePercentBoundaryDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ExtActivityCostObjectDataUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87
ExternalActivityDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
ExternalCostObjectDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
LineItemDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
LineItemDetailDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
MetricActualBoundaryDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
MetricActualDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
4 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
MetricBasePointDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
MetricPercentBoundaryDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
MetricTargetDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
ObjectiveActualBoundaryDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
ObjectiveActualDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
ObjectiveBasePointDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
ObjectiveMetricWeightingDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
ObjectivePercentBoundaryDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
ObjectiveTargetDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
ObjectiveWeightingDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
ResourceDriverDataSplit Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
ResourceDriverDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
ServiceDriverDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
SpreadDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
WorkSheetDataValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Bill of Materials Data Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033.6 Delta Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
ActivityDriverDeltaValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
ActivityDriverOriginalValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
ActivityDriverTargetValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
LineItemDeltaValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
LineItemOriginalValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
ResourceDriverDeltaSplit Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
ResourceDriverDeltaValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
ResourceDriverOriginalSplit Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
ResourceDriverOriginalValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
ResourceDriverTargetSplit Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
ResourceDriverTargetValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110
ServiceDriverOriginalValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110
ServiceDriverDeltaValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
ServiceDriverTargetValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
3.7 Driver Value Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111ActivityDriverValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
EmployeeResourceDriverDataSplit Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
EmployeeResourceDriverSplit Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
ResourceDriverPctSplit Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
ResourceDriverSplit Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
ResourceDriverValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
ServiceDriverValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Bill of Materials Driver Value Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideContent P U B L I C 5
3.8 General Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117CurrencyRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
EmployeeResultValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
LineItemCalculatedFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
LineItemDetailValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
LineItemDetailValueNC Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
LineItemFixedValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
LineItemValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
LineItemVariability Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
SpreadValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
UOMFactor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
WorkSheetValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
3.9 Icon and Color Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124EmployeeResultDataColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
EmployeeResultIcon Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
EmployeeResultRangeColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
MetricAchievementIcon Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
MetricAchievementDataColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
MetricAchievementRangeColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
MetricTotalActualDataColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
MetricTotalActualIcon Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
MetricTotalActualRangeColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
ObjectiveAchievementDataColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
ObjectiveAchievementIcon Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
ObjectiveAchievementRangeColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ObjectiveLinkedResultDataColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ObjectiveLinkedResultIcon Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
ObjectiveLinkedResultRangeColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ObjectiveMetricAchievementDataColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
ObjectiveMetricAchievementIcon Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128
ObjectiveMetricAchievementRangeColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
ObjectiveResultDataColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
ObjectiveResultIcon Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ObjectiveResultRangeColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ObjectiveTotalActualDataColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
ObjectiveTotalActualIcon Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ObjectiveTotalActualRangeColor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
3.10 Metric Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130MetricAchievementValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
MetricActualAdjustmentValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
6 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
MetricActualValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
MetricBasePointValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
MetricTargetAdjustmentValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132
MetricTargetValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
MetricTotalActualValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
MetricTotalTargetValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
MetricVarianceValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
3.11 Objective Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134ObjectiveAchievementValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
ObjectiveActualAdjustmentValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134
ObjectiveActualValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
ObjectiveBasePointValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
ObjectiveLinkedResultValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
ObjectiveMetricResultValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
ObjectiveResultValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
ObjectiveTargetAdjustmentValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
ObjectiveTargetValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
ObjectiveTotalActualValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
ObjectiveTotalTargetValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
3.12 Service Related Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138ServiceCost Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
ServiceFixedUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
ServiceIncome Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
ServiceUnitRate Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
ServiceVariableFactor Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
3.13 Weighting Grid Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141ObjectiveMetricWeightingPctValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
ObjectiveMetricWeightingValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142
ObjectiveWeightingValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
3.14 Grid Value Dependencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
4 Predefined Model Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1464.1 Return Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1464.2 General Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
AverageConsolidate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
CalculateSlice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
CellMemo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Consolidate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
CurrencyRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
LineItemCalculatedFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideContent P U B L I C 7
LineItemDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
LineItemDetailDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
LineItemDetailValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
LineItemDetailValueNC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
LineItemFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
LineItemOriginalValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
LineItemValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
LineItemVariability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
ModelValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
PeriodPct. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
PeriodValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
PeriodPctVariance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
PeriodVariance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
RunDefaultRule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
SafeDivide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157
SpreadDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
SpreadValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
StoredModelValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
VersionPct. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
VersionPctVariance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
VersionPeriodValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
VersionValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
VersionVariance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
WorkSheetDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
WorkSheetValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
4.3 Activity Value Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163ActivityFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
ActivityLineItemFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
ActivityLineItemValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
ActivityLineItemVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
ActivityUnitRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
ActivityValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165
ActivityVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
ExternalActivityDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
ExternalActivityFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
ExternalActivityValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
ExternalActivityVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
ReassignActivityLineItemValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
ReassignActivityServiceValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
8 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
ReassignedFinalValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
ReassignedInValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
ReassignedMoveValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
ReassignedOutValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
ReassignSplitInValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
ReassignSplitOutValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
ReassignSplitPostValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
ReassignSplitValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
ServiceActivityUnitRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172ServiceActivityValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
SourceActivityLineItemFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
SourceActivityLineItemValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
SourceActivityLineItemVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
SummaryActivityFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
SummaryActivityValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
SummaryActivityVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174
SummaryMovementValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
SummaryServiceActivityValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
4.4 Boundary Value Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176EmployeePercentBoundaryValue Grid Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
MetricActualBoundaryDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
MetricActualBoundaryValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
MetricPercentBoundaryDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177
MetricPercentBoundaryValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
ObjectiveActualBoundaryDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178
ObjectiveActualBoundaryValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
ObjectivePercentBoundaryDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
ObjectivePercentBoundaryValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
4.5 Cost Object Value Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179ActivityCostObjectFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
ActivityCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
ActivityCostObjectVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
ConsolidatedPrice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Contribution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .183
CostObjectFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
DataUnitPrice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184
CostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
CostObjectVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
DataRevenue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
DataUnitsSold. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideContent P U B L I C 9
DirectCostObjectFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
DirectCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
DirectCostObjectVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
DirectPrimaryDriverVolume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
DirectPrimaryDriverUnitRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
DirectServiceCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191
DirectServicePrimaryDriverUnitRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192
DirectServicePrimaryDriverVolume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192
ExternalCostObjectDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
ExternalCostObjectFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
ExternalCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
ExternalCostObjectVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
GrossContribution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
JointCostObjectFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
JointCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
JointCostObjectVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
LineItemCostObjectFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
LineItemCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
LineItemCostObjectVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
PrimaryDriverUnitRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
PrimaryDriverVolume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Revenue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
ServiceCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
ServicePrimaryDriverUnitRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
ServicePrimaryDriverVolume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
SourceCostObjectFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
SourceCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
SourceCostObjectVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
SummaryCostObjectFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
SummaryCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
SummaryCostObjectVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
SummaryPostCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
SummaryPreCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
TargetCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208
TotalCostObjectFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
TotalCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
TotalCostObjectVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
TracebackValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
TracebackFixedValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
10 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
TracebackVariableValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
UnitPrice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
UnitsSold. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
4.6 Delta Value Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215ActivityDriverDeltaValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
AddActivityDriverDelta. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
AddLineItemDelta. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
AddResourceDriverDelta. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
AddResourceDriverSplitDelta. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
AddServiceDriverDelta. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
CurrentDeltaValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
LineItemDeltaValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
ResourceDriverDeltaSplit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
ResourceDriverDeltaValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
ServiceDriverDeltaValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
4.7 Driver Value Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219ActivityDriverDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
ActivityDriverOriginalValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
ActivityDriverTargetValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
ActivityDriverValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
ResourceDriverDataSplit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
ResourceDriverDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
ResourceDriverNonSpare. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
ResourceDriverOriginalSplit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
ResourceDriverOriginalValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
ResourceDriverPctSplit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
ResourceDriverSplit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
ResourceDriverTargetSplit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
ResourceDriverTargetValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
ResourceDriverValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
4.8 Icon and Color Value Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225EmployeeResultDataColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
EmployeeResultIcon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225
EmployeeResultRangeColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226
MetricAchievementDataColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
MetricAchievementIcon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
MetricAchievementRangeColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
MetricTotalActualDataColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
MetricTotalActualIcon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
MetricTotalActualRangeColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideContent P U B L I C 11
ObjectiveAchievementDataColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
ObjectiveAchievementIcon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
ObjectiveAchievementRangeColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
ObjectiveLinkedResultDataColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
ObjectiveLinkedResultIcon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
ObjectiveLinkedResultRangeColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
ObjectiveMetricAchievementIcon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
ObjectiveMetricAchievementDataColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
ObjectiveMetricAchievementRangeColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
ObjectiveResultDataColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
ObjectiveResultIcon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .230
ObjectiveResultRangeColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
ObjectiveTotalActualDataColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
ObjectiveTotalActualIcon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
ObjectiveTotalActualRangeColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
4.9 Metric Value Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231DefaultMetricAchievementValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
DefaultMetricCenterAchievementValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
MetricAchievementValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
MetricActualAdjustmentValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
MetricActualDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
MetricActualValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233
MetricBasePointDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
MetricBasePointValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
MetricTargetAdjustmentValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
MetricTargetDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
MetricTargetValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234
MetricTotalActualValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
MetricTotalTargetValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
MetricVarianceValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
4.10 Objective Value Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235DefaultObjectiveAchievementValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
DefaultObjectiveCenterAchievementValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .236
DefaultObjectiveResultValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
ObjectiveAchievementValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
ObjectiveActualAdjustmentValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
ObjectiveActualDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
ObjectiveActualValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
ObjectiveBasePointDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
ObjectiveBasePointValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
12 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
ObjectiveLinkedResultValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
ObjectiveMetricResultValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
ObjectiveMetricWeightingDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
ObjectiveMetricWeightingPctValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
ObjectiveMetricWeightingValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
ObjectiveResultValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
ObjectiveTargetAdjustmentValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
ObjectiveTargetDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
ObjectiveTargetValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
ObjectiveTotalActualValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
ObjectiveTotalTargetValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
ObjectiveWeightingDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
ObjectiveWeightingPctValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
ObjectiveWeightingValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
4.11 Service Value Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244ServiceCost. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
ServiceDriverDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
ServiceDriverOriginalValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
ServiceDriverTargetValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
ServiceDriverValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245
ServiceFixedUnitRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
ServiceIncome. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
ServiceUnitRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
ServiceVariableFactor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
TotalServiceDriverValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
4.12 Structure Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247EPO CODE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Current Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .248Using Restrict Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
ActiveCalculateSlices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
ActivityCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
ActivityDriverCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .250
BoundaryCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .251
ChildList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
CodeByLeafPosition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
CostObject1Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
CostObject2Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
CostObject3Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
CostObject4Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
CostObject5Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideContent P U B L I C 13
CostObjectTargets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .253
CurrencyCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
CurrentActivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
CurrentActivityDriver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
CurrentConsolidatingDimension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
CurrentCostObject1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .254
CurrentCostObject2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255
CurrentCostObject3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255
CurrentCostObject4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255
CurrentCostObject5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .256
CurrentCurrency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
CurrentIcon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
CurrentLineItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257
CurrentLineItemDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
CurrentMetric. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257
CurrentModelName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .258
CurrentModelType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .258
CurrentObjective. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .258
CurrentPeriod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
CurrentResourceDriver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
CurrentRespCenter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .259
CurrentRevenueType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
CurrentRule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
CurrentRuleNumber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
CurrentService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .261
CurrentSpread. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .261
CurrentTable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .261
CurrentTableField. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .262
CurrentVersion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
CurrentWorkSheet1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .262
CurrentWorksheet2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263
DirectCostObjectTargets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
DirectPrimaryActivityDriver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
EPOCodeFromName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
ExportComplete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
ExportDimensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
ExportResults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
IconCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
IncludeCombinationParent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
14 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
IsChild. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
IsCostObjectCalculated. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
IsParent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
ItemDimension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
ItemName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
ItemPropertyValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .268
LeafChildList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
LeafPosition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
LineItemCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
LineItemDetailCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .269
MetricCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
ObjectiveCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Parent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
ParentBelowGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .270
PeriodCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .271
PrimaryActivityDriver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
RaiseAlert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .271
RaiseCapacityAlert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
ResourceDriverCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
RespCenterCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .272
RestrictCombinationActivityDriverDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
RestrictCombinationCostObjectValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .273
RestrictCombinationDataRevenue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
RestrictCombinationLineItemDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .274
RestrictCombinationLineItemDetailDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
RestrictCombinationResourceDriverDataSplit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
RestrictCombinationResourceDriverDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
RestrictCombinationServiceDriverDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
RestrictCombinationSpreadDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
RestrictCombinationWorksheetDataValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279
RestrictDimension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
RestrictDimensionParent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
RestrictReturnZero. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .282
RevenueTypeCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
ServiceCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
ServiceCostObjectTargets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
ServicePrimaryActivityDriver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
SpreadCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
VersionCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideContent P U B L I C 15
WorkSheet1Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Worksheet2Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
5 Book Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2855.1 Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2855.2 Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2855.3 Control Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2865.4 Book Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2895.5 Button object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .290
Button Object General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Button Object Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
5.6 Chart object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .293
Chart Object General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Chart Object Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
5.7 DataManager object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
DataManager General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
DataManager Cell Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305
DataManager Web Only. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
5.8 DimensionTree object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
DimensionTree General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .310
DimensionTree Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .314
DimensionTree Web Only. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .317
5.9 DimensionList object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
DimensionList General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .318
DimensionList Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
5.10 Drill object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .326
Drill Object General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
5.11 Edit Box object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Edit Box Object General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Edit Box Object Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Edit Box Object Web Only. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
5.12 Grid object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .333
Grid General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Grid Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
5.13 Keys object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .344
Keys General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Keys Web Only. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
5.14 Memo object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .353
Memo General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Memo Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
16 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
5.15 Model object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .356
Model Object General Properties and Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
5.16 Tree Filter object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Tree Filter Object General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Tree Filter Object Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
5.17 Workflow object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Workflow General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
6 Work Manager Process Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3646.1 EmailAddressForProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
6.2 ObjectProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
6.3 AddInstanceToGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
6.4 BuildBookURL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
6.5 BuildBookViewerString. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
6.6 ClearStateTimeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
6.7 ConvertToURLCompliantString. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
6.8 CreateNewGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
6.9 CreateWorkFlowObject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
6.10 DebugLogEvent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
6.11 DebugLogEventEx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
6.12 GetEmailAddressForUserID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
6.13 GetFullNameForUserID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
6.14 GetFullNameForProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
6.15 GetIDForUserName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
6.16 GetUserIDListForGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
6.17 RaiseAlert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
6.18 SendEmail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
6.19 SetTimeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
6.20 SetTimeoutDelta. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
6.21 SetNewTimeoutDelta. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
6.22 SetNextEvent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
6.23 StartConsoleJob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
6.24 WorkflowComplete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
7 Function Data Type Variants. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
8 Constant Names and Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3748.1 Dimension Constants. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
8.2 Grid Value Constants. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
8.3 TableID Constants. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideContent P U B L I C 17
9 Reserved Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
18 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Content
1 History of changes
The current version of this document is version 1.5. The following table provides an overview of the most important changes to prior and current versions of this document.
Version Date Important Changes
Version 1.0 May-10-2011 Initial version of the SAP BusinessObjects Profitability and Cost Management Modeling Reference Guide document for SAP BusinessObjects Profitability and Cost Management 10.0.
Version 1.1 August-2011 As part of the updated Profitability and Cost Management version released in August 2011, the document contains the following amendments or additions: :
● The code example for Grid.GetCellValue is corrected.
● The “DimensionList General”, “Keys General”, and “DimensionTree General” topics are all updated with additional information on how to reference items in a BOM Makeup in book script.
● The RaiseAlert and RaiseCapacityAlert structure functions contain additional information about how the functions are used in rules.
● The “Edit Box Object” and “Memo Object” topics have a note that explains that when the Text property for these objects is set at design time it cannot be altered at run time in a way that saves the change to the database, although it can be edited.
● Grid Values are ordered alphabetically within the groups in which they display in the Grid Values panel in View Builder. The groups are also presented alphabetically.
● The description for CodeByLeafPosition is amended.
Version 1.2 September-2011 A new topic, “Grid Value Dependencies”, is added that describes how costs are
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideHistory of changes P U B L I C 19
Version Date Important Changes
traced in the activity-based costing calculation and the grid value dependencies that are involved.
Version 1.3 November - 2011 As part of the release of Support Package 02, the document includes the following changes:
● The sections on the grid values CostObjectActivityUnitRate, CostObjectActivityFixedUnitRate, CostObjectActivityLineItemUnitRate, and CostObjectActivityLineItemFixedUnitRate are updated to reflect that these values are now available to Profitabiliity and Costing and Bill of Materials models if the correct model options are set.
● The section on the TargetCostObjectValue grid value is amended by removing a note that incorrectly stated that TargetCostObjectValue values are not cached.
Version 1.4 May 2012 As part of the release of Support Package 03, the document includes the following change:
● The “Reserved Names” topic is revised and updated.
Version 1.5 February 2013 As part of the release of Support Package 06, the document includes the following change:
● The “Data Manager General” topic is updated with the GridStyleName property.
You can ensure that you have the latest version of this document by downloading it from the SAP Help Portal at http://help.sap.com.
20 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
History of changes
2 Introduction
The Profitability and Cost Management Modeling Reference Guide describes in detail the definition, purpose, function and usage of the Grid Values, Rule Functions, Book Scripting and Workflow Properties and Methods within Profitability and Cost Management model types, which include the following:
Profitabiliy and CostingTransactional CostingObjectives and MetricsBill of Materials
It is intended as a reference document, and so contains an index to enable the quick location of specific topics.
The document is divided into four major sections:
● Grid Values● Predefined Functions● Book Objects● Work Manager Process Functions
Several Appendices list additional reference material:
● Function Data Types● Constant Names and Values● Reserved Names
Related Information
Constant Names and Values [page 374]Function Data Type Variants [page 373]Reserved Names [page 385]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideIntroduction P U B L I C 21
3 Grid Values
Grid Values define the values you can display in a grid. In View Builder, these values can be moved onto a grid from the Grid Values panel to be displayed as headers or as key values. In the panel, Grid Values are grouped into categories and we present them here using the same groupings, presented in alphabetical order. Within the groupings presented here, the grid values themselves are also listed in alphabetical order. For more information on building Grids see the Profitability and Cost Management Modeling User Guide.
Grid Values are either input values or calculated values. In the descriptions that follow, their default access settings refer to their availability at leaf level. Several factors can affect access rights and these are described in the “Access Rights” topic.
Grid Values for the Profitability and Costing and Transactional Costing model types are found under the following categories:
● Activity Related Grid Values● Cost Object Related Grid Values● Data Grid Values● Delta Grid Values● Driver Value Grid Values● General Grid Values● Service Related Grid Values
Grid Values for Bill of Materials model types are found under the following categories:
● Activity Related Grid Values● Cost Object Related Grid Values● Data Values● Delta Values● Driver Values● General Grid Values
Grid Values related specifically to the Bill of Materials modeling calculation are listed in a separate section in the relevant categories listed above.
Grid Values for the Objectives and Metrics model type are found under the following categories:
Boundary Grid ValuesData Grid ValuesGeneral Grid ValuesIcon and Color Grid ValuesMetric Grid ValuesObjective Grid ValuesWeighting Grid Values
22 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Related Information
Access Rights [page 23]
3.1 Access Rights
Grid Values are either input values or calculated values. Two main factors can influence the default access rights associated with these values; the use of rules and the security privilege you have been provided by your administrator.
Calculated values are derived automatically through the assignments and rules you have defined in your model. By default these will have Read Only access, but your administrator can further restrict your access to some of these through security limitations on the groups you belong to.
Input values - for example <Line Items>, drivers, and <Metrics> - have Read/Write access by default, and are displayed in your grids in bolded form. If they are not bolded, they have either been calculated by a rule or had restricted security access imposed by your administrator. The effects of a rule are not always obvious, as conditional statements and Restrict functions can be used to limit the range of the key dimensions associated with your Grid Value. In this case some ranges of a Grid Value will be editable and others not.
You should also be aware of the effects of Default Rules. Although a dimension item may not have been explicitly given a rule it may have assumed the Default Rule assigned for all the items in that dimension. For more explanation see Rules in the Profitability and Cost Management Modeling User Guide.
NoteConsolidated values representing Group totals are usually calculated values that are Read Only, so although the leaf items of Grid Values representing input data have Read/Write access by default, their consolidated totals are normally Read Only. Exceptions to this are the Data type Grid Values such as LineItemDataValue or MetricActualDataValue, which allow you to specify Consolidated values. See “Data Type Grid Values” in the Profitability and Cost Management Modeling User Guide.
3.2 Activity Related Grid Values
The Grid values held under the Activity Related category are described in the following topics.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 23
3.2.1 ActivityFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It represents the non-variable costs of <Line Items> assigned to specific <Resource Drivers>, that contribute to the <Activities> specified by the dimensions listed below. This amount of the ActivityValue will be unaffected by the Driver Analysis.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Resource Drivers>
Related Information
ActivityVariableValue Grid Value [page 27]LineItemCalculatedFixedValue Grid Value [page 118]
3.2.2 ActivityLineItemFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It represents the non-variable portion (including the fixed value) of the specified Line Item costs that contribute to the specified Activities in a particular <Version>, <Period>, and <Responsibility Center>. This amount of the ActivityLineItemValue will be unaffected by the Driver Analysis.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
Related Information
ActivityLineItemVariableValue Grid Value [page 25]LineItemCalculatedFixedValue Grid Value [page 118]
24 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.2.3 ActivityLineItemValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center>, this calculated value represents the component part of an <Activity> cost that derives from a specific <Line Item> before any <Activity> reassignments are applied. It is similar to the grid value ActivityValue where the cost is broken down further by <Resource Driver>.
The <Line Item> component of the cost is calculated using the proportion of ResourceDriverSplit to total ResourceDriverValue for the specified <Line Item>.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
3.2.4 ActivityLineItemVariableValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It represents the variable component of costs from the specified <Line Item> costs that contribute to the specified <Activities> in particular <Versions>, <Periods>, and <Responsibility Centers>. Only this amount of the ActivityLineItemValue will be affected by a Driver Analysis.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
Related Information
ActivityLineItemFixedValue Grid Value [page 24]LineItemCalculatedFixedValue Grid Value [page 118]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 25
3.2.5 ActivityUnitRate Grid Value
Description Calculated by dividing an ActivityLineItemValue by the total ResourceDriverValue of the associated <Line Item> and <Responsibility Center>. This is one of the fundamental parameters used in Driver Analysis to calculate revised <Line Item> costs derived from new target values.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Resource Drivers>
Related Information
ActivityLineItemValue Grid Value [page 25]ResourceDriverValue Grid Value [page 114]
3.2.6 ActivityValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center>, this calculated value represents the component part of an <Activity> cost that derives from specific combinations of <Line Item> and <Resource Driver>. It is similar to the grid value ActivityLineItemValue but is broken down further, by Resource Driver.
This component cost is calculated using the proportion of ResourceDriverSplit to total ResourceDriverValue for the specified <Line Item>. <Resource Drivers> that are not used by the specified combination of <Line Item> and <Responsibility Center> produce a value of zero.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Resource Drivers>
Related Information
ResourceDriverSplit Grid Value [page 113]
26 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
ResourceDriverValue Grid Value [page 114]ActivityLineItemValue Grid Value [page 25]
3.2.7 ActivityVariableValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It represents the variable costs of <Line Items> assigned to specific <Resource Drivers> that contribute to the <Activities> specified by the dimensions listed below. Only this amount of the ActivityValue will be affected by a Driver Analysis.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Resource Drivers>
Related Information
ActivityFixedValue Grid Value [page 24]LineItemCalculatedFixedValue Grid Value [page 118]
3.2.8 ExternalActivityFixedValue Grid Value
Description <Activity> costs can have a separate external cost in addition to their calculated value. This grid value has similar characteristics to ExternalActivityValue.
Access Leaf Items:
● Read/Write – cannot be set by a rule.
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
Related Information
ExternalActivityVariableValue Grid Value [page 28]LineItemFixedValue Grid Value [page 120]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 27
3.2.9 ExternalActivityValue Grid Value
Description <Activity> costs can have a separate external cost in addition to their calculated value (ActivityLineItemValue). This grid value represents the external cost of Line Items that contribute to <Activities> in specified <Versions>, <Periods>, and <Responsibility Centers>.
Access Leaf Items: Read/Write - if a Detailed rule does not exist
Consolidated Totals: Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
3.2.10 ExternalActivityVariableValue Grid Value
Description <Activity> costs can have a separate external cost in addition to their calculated value. This grid value is calculated as: ExternalActivityVariableValue = ExternalActivityValue – ExternalActivityFixedValue
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
Related Information
ExternalActivityFixedValue Grid Value [page 27]
3.2.11 PostReassignLineItemFixedValue Grid Value
Description This calculated value represents the fixed part of the summary activity value analyzed by line item after Activity Reassignments have been applied.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
28 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.2.12 PostReassignLineItemValue Grid Value
Description This calculated value represents the summary activity value analyzed by line item after Activity Reassignments have been applied.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
3.2.13 PostReassignLineItemVariableValue Grid Value
Description This calculated value represents the variable part of the summary activity value analyzed by line item after Activity Reassignments have been applied.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
3.2.14 ReassignActivityLineItemValue Grid Value
Description This calculated value represents the reassigned costs component of an <Activity> that derives from specific contributing <Line Items>. While <Line Item> costs cannot be re-allocated directly in a Profitability and Costing model, they are a natural constituent of any <Activity> cost and are thus the basic contributors in any <Activity> reassignment.
Although drivers control the distribution of reassigned costs across the <Activities> performed in the <Target Responsibility Centers>, these are not required by this grid value. You are required to specify not only the recipient <Responsibility Centers> and <Activities> of the reassigned costs but also the <Responsibility Centers >from which the <Line Item> costs originate; all of these within specific <Versions> and <Periods>.
NoteThe supplied reassigned costs are shown negative, the received costs are positive.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 29
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
3.2.15 ReassignActivityServiceValue Grid Value
Description This calculated value represents the reassigned costs component of an <Activity> that derives from specific contributing <Services>. <Service> costs can be a constituent of any <Activity> cost and are thus basic contributors in any <Activity> reassignment. Although drivers control the distribution of reassigned costs across the <Activities> performed in the <Target Responsibility Centers>, these are not required by this grid value. You are required to specify not only the recipient <Responsibility Centers> and <Activities> of the reassigned costs but also the <Responsibility Centers> from which the <Service> costs originate; all of these within specific <Versions> and <Periods>.
NoteThe supplied reassigned costs are shown negative, the received costs are positive.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>, <Target Responsibility Centers>, <Target Activities>
3.2.16 ReassignedFinalValue Grid Value
Description This calculated value gives the total of reassigned <Activity> costs for the specified <Target Responsibility Center> and <Target Activity> that originate from specific source <Responsibility Centers>, <Activities>, and <Line Items>. This value
30 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
records what remains after all reassigned costs have been received, dispatched and reiterated.
NoteThe path of a reassigned <Activity> cost, ActivityLineItemValue, may move through several other reassigned <Activities>, which in turn may partially reassign them to the original <Activity>. This produces a reiterative reassignment, which will follow the same path until all of the cost has been distributed. This value only becomes available when all reassigned costs have been fully reallocated.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Related Information
ActivityLineItemValue Grid Value [page 25]
3.2.17 ReassignedInValue Grid Value
Description This calculated value gives the reassigned <Activity> costs received by the specified <Target Responsibility Center> and <Target Activity> that originate from specific source <Responsibility Centers>, <Activities>, and <Line Items>. This is the received value after all reiterations of reassigned costs have been concluded and is available by <Version>, <Period>, and <Responsibility Center>.
NoteThe path of a reassigned Activity cost, ActivityLineItemValue, may move through several other reassigned Activities, which in turn may partially reassign them to the original <Activity>. This produces a reiterative reassignment, which will follow the same path until all of the cost has been distributed. This value only
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 31
becomes available when all reassigned costs have been fully reallocated.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
3.2.18 ReassignedMoveValue Grid Value
Description This calculated value identifies the difference between reassigned <Activity> costs received and dispatched for the specified <Target Responsibility Center> and <Target Activity> that originate from specific source combinations of <Responsibility Center>, <Activity>, and <Line Item>. Activity reallocation disperses costs across a range of <Responsibility Center Activitie>s, which can include the original <Activity> and <Responsibility Center>. Recipient <Responsibility Center Activities> can continue this process, which can influence the costs available to the original <Activity> reassignments. This leads to a complex redistribution of costs that contribute to a final figure for each <Responsibility Center Activity> . Inward costs are positive, outward costs negative.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Line Items,> <Target Responsibility Centers>, <Target Activities>
Related Information
ReassignedFinalValue Grid Value [page 30]
3.2.19 ReassignedOutValue Grid Value
Description This calculated value gives the reassigned <Activity> costs dispatched by the specified <Target Responsibility
32 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Center> and <Target Activity> that originate from specific source <Responsibility Centers>, <Activities>, and <Line Items>. This is the dispatched value after all reiterations of reassigned costs have been concluded and is available by <Version>, <Period>, and <Responsibility Center>.
NoteThe path of a reassigned <Activity> cost, ActivityLineItemValue, may move through several other reassigned <Activities>, which in turn may partially reassign them to the original <Activity>. This produces a reiterative reassignment, which will follow the same path until all of the cost has been distributed. This value only becomes available when all reassigned costs have been fully reallocated.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Related Information
ActivityLineItemValue Grid Value [page 25]ReassignedOutValue Grid Value [page 32]
3.2.20 ReassignSplitInValue Grid Value
Description This calculated value gives the percentage of reassigned costs received by <Target Responsibility Center Activities> that originate from specific <Responsibility Center Activities>.
NoteThe path of a reassigned <Activit>y cost may move through several other reassigned <Activities>, which in turn may partially reassign them to the original <Activity>. This produces a reiterative reassignment, which will follow the same path until all of the cost has been distributed. This value only becomes available when
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 33
all reassigned costs have been fully reallocated and can amount to more than 100% due to the reiterations.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Target Responsibility Centers>, <Target Activities>
3.2.21 ReassignSplitOutValue Grid Value
Description This calculated value gives the percentage of reassigned <Activity >costs sent out from <Target Responsibility Centers> and <Target Activities> that originate from specific <Responsibility Center Activities>.
NoteThe path of a reassigned <Activity> cost may move through several other reassigned <Activities>, which in turn may partially reassign them to the original <Activity>. This produces a reiterative reassignment, which will follow the same path until all of the cost has been distributed. This value only becomes available when all reassigned costs have been fully reallocated and can amount to more than 100% due to the reiterations.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Target Responsibility Centers>, <Target Activities>
3.2.22 ReassignSplitPostValue Grid Value
Description This calculated value gives the percentage of the original cost of a source <Responsibility Center Activity> that ends up in <Target Responsibility Center Activities> after any reiteration of reassignments has occurred.
34 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
NoteThe path of a reassigned <Activity> cost may move through several other reassigned <Activities>, which in turn may partially reassign them to the original <Activity>. This produces a reiterative reassignment, which will follow the same path until all of the cost has been distributed. This value only becomes available when all reassigned costs have been fully reallocated and will never exceed 100%.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Target Responsibility Centers>, <Target Activities>
3.2.23 ReassignSplitValue Grid Value
Description This calculated value gives the percentage of reassigned <Activity> costs received by <Target Responsibility Centers> and <Target Activities> before any reiteration of reassignments occurs, that originate from specific <Responsibility Center Activities>.
NoteThe path of a reassigned <Activity> cost may move through several other reassigned <Activities>, which in turn may partially reassign them to the original <Activity>. This produces a reiterative reassignment, which will follow the same path until all of the cost has been distributed. This value records the percentage split before any reiterations occur.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Target Responsibility Centers>, <Target Activities>
Related Information
ReassignSplitPostValue Grid Value [page 34]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 35
3.2.24 ServiceActivityUnitRate Grid Value
Description Calculated by dividing a ServiceActivityValue cost by the total ResourceDriverValue of the associated <Service >and <Responsibility Center>. This is one of the fundamental parameters used in Driver Analysis to calculate revised <Service> costs derived from new target values.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>, <Activities>, <Resource Drivers>
3.2.25 ServiceActivityValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center>, this calculated value represents the component part of an <Activity> cost that derives from a specific combination of <Service> and <Resource Driver>. It is similar to the grid value SummaryServiceActivityValue but is broken down further, by <Resource Driver>.
This component cost is calculated using the proportion of ResourceDriverSplit to total ResourceDriverValue for the specified <Service>. <Resource Drivers> that are not used by the specified combination of <Service> and <Responsibility Center> produce a value of zero.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>, <Activities>, <Resource Drivers>
3.2.26 SourceActivityLineItemFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the non-variable portion of specified <Line Items> that contribute to target <Activity> costs after Activity Reassignments have been applied. The <Activity> is specified through the <Target Responsibility
36 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Centers> and <Target Activities> dimensions listed below and the source <Line Items> through the <Responsibility Center >and <Line Items> dimensions, all of these with respect to the specified <Versions> and <Periods>.
NoteThis value includes all costs reassigned to the target <Activity>.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Related Information
LineItemCalculatedFixedValue Grid Value [page 118]
3.2.27 SourceActivityLineItemValue Grid Value
Description This calculated value represents the component part of a target <Activity> cost that derives from specific <Line Items> after Activity Reassignments have been applied. The <Activity> is specified through the <Target Responsibility Centers> and <Target Activities> dimensions listed below and the source <Line Items> through the <Responsibility Centers> and <Line Items> dimensions, all of these with respect to the specified <Versions> and <Periods>.
NoteThe Line Item component of an <Activity> cost in a <Responsibility Center> is calculated as the proportion of the ResourceDriverSplit value to the total ResourceDriverValue for the specified <Activity> and <Responsibility Center>.
Access Read Only
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 37
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
3.2.28 SourceActivityLineItemVariableValue Grid Value
Description This calculated value is the variable portion of specified <Line Items> that contribute to target <Activity >costs after Activity Reassignments have been applied. The <Activity> is specified through the <Target Responsibility Centers> and <Target Activities> dimensions listed below and the source <Line Items> through the <Responsibility Centers >and <Line Items> dimensions, all of these with respect to the specified <Versions> and <Periods>.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Related Information
LineItemVariability Grid Value [page 121]
3.2.29 SummaryActivityFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It represents the component part of an <Activity> cost in a specific <Version>, <Period>, and <Responsibility Center> that has been derived from the non-variable portions of contributing <Line Items>. <Line Item> costs associated with reassigned <Activities> that contribute to the specified activities are included in this total.
NoteThis value includes all costs reassigned to the specified <Activity>.
38 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>
Related Information
LineItemCalculatedFixedValue Grid Value [page 118]
3.2.30 SummaryActivityValue Grid Value
Description The final calculated cost of a particular <Activity> in a specific <Version>, <Period>, and <Responsibility Center>. <Line Items>, <Services>, and reassigned <Activity> costs all contribute to this value.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>
3.2.31 SummaryActivityVariableValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It represents the component part of an <Activity> cost in a specific <Version>, <Period>, and <Responsibility Center> that has been derived from the variable portions of contributing <Line Items>. <Line Item> costs associated with reassigned <Activities> that contribute to the specified activities are included in this total.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, Activities
Related Information
LineItemVariability Grid Value [page 121]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 39
3.2.32 SummaryMovementValue Grid Value
Description This calculated value is the total reassigned <Activity> costs that have been moved into the specified <Target Activities> (in <Target Responsibility Centers>) from the specified <Responsibility Centers> and <Activities>. It includes reiterated reassignments that can originate from other <Activities> and is also constrained by <Version> and <Period>. It takes no account of the drivers specified in the reassignments and is not broken down to <Line Item> level.
NoteThis should not be confused with the various reassigned values—ReassignedInValue grid value, ReassignedOutValue grid value, ReassignedMoveValue grid value, and ReassignedFinalValue grid value—which record reassigned costs that originate from specific source <Responsibility Centers> and <Activities>. The reassignment path of these costs may drift through several other reassigned <Activities>, which in turn may partially reassign them to the original <Activity> before they eventually arrive at the specified target. For the same source and target items, SummaryMovementValue records the reassigned costs from any reassigned <Activity> that contribute to the target through the specified source <Activity>.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Target Responsibility Centers>, <Target Activities >
Related Information
ReassignedFinalValue Grid Value [page 30]ReassignedInValue Grid Value [page 31]ReassignedMoveValue Grid Value [page 32]ReassignedOutValue Grid Value [page 32]
40 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.2.33 SummaryServiceActivityValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center>, this calculated value represents the component part of an <Activity> cost that derives from a specific <Service>. It is similar to the grid value ServiceActivityValue but its value is independent of <Resource Driver>. This component cost is calculated using the proportion of ResourceDriverSplit to total ResourceDriverValue for the specified <Service>. <Resource Drivers> that are not used by the specified combination of <Service> and <Responsibility Center> produce a value of zero.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>, <Activities>
3.3 Boundary Grid Values
Boundary Grid Values are available only in Objectives and Metrics models. The Grid values held under the Boundary Values category are described in the following topics.
3.3.1 EmployeePercentBoundaryValue Grid Value
Description This specifies a <Boundary> value for an <Employee> item in terms of its Achievement percentages. The item is identified through the dimension items shown below. This value may also be a calculated through associated rules.
Access Leaf Items:
● Read/Write - if not calculated by a Percent <Boundary> Rule
● Read Only - if calculated by a Percent <Boundary> Rule
Consolidated Totals: Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Employees>, <Boundaries>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 41
3.3.2 MetricActualBoundaryValue Grid Value
Description This specifies a <Boundary> value for a <Metric> item in terms of its Actual values. The item is identified through the dimension items shown below. This value may also be a calculated through associated rules.
Access Leaf Items:
● Read/Write - if not calculated by an Actual <Boundary> Rule
● Read Only - if calculated by an Actual <Boundary> Rule
Consolidated Totals: Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Boundaries>
Related Information
Access Rights [page 23]
3.3.3 MetricPercentBoundaryValue Grid Value
Description This specifies a <Boundary> value for a <Metric> item in terms of its Achievement percentages. The item is identified through the dimension items shown below. This value may also be a calculated through associated rules.
Access Leaf Items:
● Read/Write - if not calculated by a Percent <Boundary> Rule
● Read Only - if calculated by a Percent <Boundary> Rule
Consolidated Totals: Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>,< Metrics>, <Boundaries>
Related Information
Access Rights [page 23]
42 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.3.4 ObjectiveActualBoundaryValue Grid Value
Description This specifies a <Boundary >value for an objective item in terms of its Actual values. The item is identified through the dimension items shown below. This value may also be a calculated through associated rules.
Access Leaf Items:
● Read/Write - if not calculated by an Actual <Boundary> Rule
● Read Only - if calculated by an Actual <Boundary> Rule
Consolidated Totals: Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Boundaries>
Related Information
Access Rights [page 23]
3.3.5 ObjectivePercentBoundaryValue Grid Value
Description This specifies a <Boundary> value for an objective item in terms of its Achievement percentages. The item is identified through the dimension items shown below. This value may also be a calculated through associated rules.
Access Leaf Items:
● Read/Write - if not calculated by a Percent <Boundary> Rule
● Read Only - if calculated by a Percent <Boundary> Rule
Consolidated Totals: Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Boundaries>
Related Information
Access Rights [page 23]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 43
3.4 Cost Object Related Grid Values
The grid values held under the Cost Object Related category are described in the following topics.
3.4.1 ActivityCostObjectFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the summarized value of the calculated fixed <Line Item> costs that contribute to a <Cost Object> from all <Responsibility Centers> and <Line Items>. It identifies the cost by <Version>, <Period>, <Activity>, and <Cost Object> combination (from the five different levels of <Cost Object> item).
It includes all reassigned costs to the specified <Activity>, from all <Responsibility Centers>. It also includes all contributions from <Service> costs and <External Cost Object> values. Direct costs are also visible as they are held against <Activity Unassigned>.
NoteThis grid value does not have <Line Items> and <Responsibility Centers> as key dimensions although <Cost Object> values would normally include these. As a result, all items in these dimensions are contributors to its value, including those specified as non-consolidation in their dimension hierarchies. <RC Unassigned> costs are also included.
Access Read Only
Dimensions <Versions>, <Periods>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemCalculatedFixedValue Grid Value [page 118]
44 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.4.2 ActivityCostObjectValue Grid Value
Description This is the summarized cost of a <Cost Object> across all <Responsibility Centers> and <Line Items>. It identifies the cost by <Version>, <Period>, <Activity>, and <Cost Object> combination from the five different levels of <Cost Object> item.
It includes all reassigned costs to the specified <Activity>, from all <Responsibility Centers>. It also includes all contributions from <Service> costs and <External Cost Object> values. Direct costs are also visible because they are held against <Activity Unassigned>.
NoteThis grid value does not have <Line Items> and <Responsibility Centers> as key dimensions although <Cost Object> values would normally include these. As a result all items in these dimensions are contributors to its value, including those specified as non-consolidation in their dimension hierarchies. <RC Unassigned> costs are also included.
Access Read Only
Dimensions <Versions>, <Periods>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.3 ActivityCostObjectVariableValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the summarized value of the variable portion of <Line Item> costs that contribute to a <Cost Object> from all <Responsibility Centers> and <Line Items>. It identifies the cost by <Version>, <Period>, <Activity>, and <Cost Object> combination from the five different levels of <Cost Object> item.
It includes all reassigned costs to the specified <Activity>, from all <Responsibility Centers>. It also includes all contributions from <Service> costs and <External Cost Object> values. Direct costs are also visible as they are held against <Activity Unassigned>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 45
NoteThis grid value does not have <Line Items> and <Responsibility Centers> as key dimensions although <Cost Object> values would normally include these. As a result all items in these dimensions are contributors to its value, including those specified as non-consolidation in their dimension hierarchies. <RC Unassigned> costs are also included.
Access Read Only
Dimensions <Versions>, <Periods>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemVariability Grid Value [page 121]
3.4.4 Contribution Grid Value
Description Contribution is the contributory profit of a <Cost Object> towards total profits where a <Cost Object> can be a combination of five different levels of <Cost Object> item. It is the difference between the Revenue value and the SummaryCostObjectValue of a <Cost Object> in a specific combination of <Version>, <Period>, and <Responsibility Center>.
NoteThe costs here involve all cost sources including both normal and direct <Line Items> and <Services> costs and Post Gross Contribution costs from <Line Items> and <Services> with the Post Gross Contribution Type Line Item attribute.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
46 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.4.5 CostObjectActivityFixedUnitRate Grid Value
Description This value represents the non-variable portion (including the fixed value) of the CostObjectActivityUnitRate .
This grid value is available by default in a Transactional Costing type of model. It is available to Profitability and Costing and Bill of Materials type models if the correct Model Calculation Options are set. For more information, see the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Access Read only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.6 CostObjectActivityLineItemFixedUnitRate Grid Value
Description This value represents the non-variable portion (including the fixed value) of the CostObjectActivityLineItemUnitRate .
This grid value is available by default in a Transactional Costing type of model. It is available to Profitability and Costing and Bill of Materials type models if the correct Model Calculation Options are set. For more information, see the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Access Read only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Line Items>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.7 CostObjectActivityLineItemUnitRate Grid Value
Description This value is the calculated unit rate broken down by <Activities> and <Line Items> for the Cost Object value that is applied to the transactional volumes.
This grid value is available by default in a Transactional Costing type of model. It is available to Profitability and
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 47
Costing and Bill of Materials type models if the correct Model Calculation Options are set. For more information, see the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Access Read only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Line Items>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.8 CostObjectActivityUnitRate Grid Value
Description This value is the calculated unit rate for the Activity Cost Object cost that is applied to the transactional volumes.
This grid value is available by default in a Transactional Costing type of model. It is available to Profitability and Costing and Bill of Materials type models if the correct Model Calculation Options are set. For more information, see the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Access Read only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.9 CostObjectFixedValue Grid Value
Description This calculated value represents the non-variable costs of <Line Items> that contribute through specific <Activities> to the <Cost Objects> specified by the dimensions listed below. The <Cost Object> can be a combination of five different levels of <Cost Object> item.
NoteThis value includes all costs reassigned to the specified <Activity> but does not include any contribution from <Service> costs or <Direct> costs (those that originate from <Line Item>/<Service> costs that are
48 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
transmitted directly to <Cost Objects> avoiding <Activities>).
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemCalculatedFixedValue Grid Value [page 118]
3.4.10 CostObjectValue Grid Value
Description This is the component cost of a <Cost Object> identified by the dimension items listed below, where the <Cost Object> can be a combination of five different levels of <Cost Object> item.
This value includes all costs reassigned to the specified Activities but does not include any contribution from <Service> costs or direct costs (those that originate from <Line Item>/<Service> costs that are transmitted directly to <Cost Objects> avoiding <Activities>).
NoteThis value identifies the <Responsibility Centers> where <Line Item> costs from all <Responsibility Centers> end up after reassignment. In reassignment terms these are <Target Responsibility Centers>. To obtain the equivalent <Line Item> costs that originate from source <Responsibility Centers>, use SourceCostObjectValue. This a trace value which can only be calculated after CostObjectValues have been fully generated, so will take longer to appear.
For greater detail you can use TracebackValue, which identifies these costs through both Source and Target dimensions. But be aware of the massive amount of
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 49
calculated values this may generate, which need careful handling to avoid performance problems.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.11 CostObjectVariableValue Grid Value
Description This calculated value represents the variable costs of <Line Items> that contribute through specific <Activities> to the <Cost Objects> specified by the dimensions listed below. The <Cost Object> can be a combination of five different levels of <Cost Object> item.
NoteThis does not include any contribution from <Service> costs or Direct costs (those that originate from <Line Item>/<Service> costs that are transmitted directly to <Cost Objects> avoiding <Activities>).
Access Read Only
Dimensions <Version,> <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
CostObjectValue Grid Value [page 49]LineItemVariability Grid Value [page 121]
50 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.4.12 DirectCostObjectFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the non-variable costs of <Cost Object Type Line Items> that contribute to the <Cost Objects> specified by the dimensions listed below. The <Line Items> must have been defined as <Cost Object Type Line Items> in the Line Items dimension screen. This means their costs avoid being distributed across <Activities> and are directly assigned to <Cost Objects>.
NoteThis value does not include any contribution from <Service> costs or direct <Service> costs.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemCalculatedFixedValue Grid Value [page 118]
3.4.13 DirectCostObjectValue Grid Value
Description This is the component cost of a <Cost Object> that derives from specific <Cost Object Type Line Items>, where the <Cost Object> can be a combination of five different levels of <Cost Object> item. The <Line Item> must have been defined as <Cost Object Type Line Item> in the <Line Items> dimension screen. This means its costs avoid being distributed across <Activities> and are directly assigned to <Cost Objects>.
NoteThis value does not include any contribution from Service costs or direct Service costs.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 51
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.14 DirectCostObjectVariableValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the variable costs of <Cost Object Type Line Items> that contribute to the <Cost Objects> specified by the dimensions listed below. The <Line Items> must have been defined as <Cost Object Type Line Items> in the Line Items dimension screen. This means their costs avoid being distributed across< Activities> and are directly assigned to <Cost Objects>.
NoteThis value does not include any contribution from <Service> costs or direct <Service> costs.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>,< Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemVariability Grid Value [page 121]
3.4.15 DirectPrimaryDriverUnitRate Grid Value
Description This is an activity driver unit rate associated with the primary (or “first”) driver specified in the Cost Object Assignment screen for a particular <Cost Object Type Line Item> and <Responsibility Center>. It is calculated as
52 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
LineItemValue / DirectPrimaryDriverVolume where DirectPrimaryDriverVolume is the total of all the primary ActivityDriverValues that drive the specified Cost Object Type LineItemValue through to <Cost Objects>. Where the <Line Item> has been assigned across multiple dimensions, such as several products and customers, all relevant driver values will be aggregated in the total. This unit rate measures the unit cost of distributing a Direct Cost in a <Responsibility Center>, Cost Object Type LineItemValue, across all of its assigned <Cost Objects>.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity Drivers>
Related Information
DirectPrimaryDriverVolume Grid Value [page 53]
3.4.16 DirectPrimaryDriverVolume Grid Value
Description This is the total of all activity driver values for the primary, or first, driver specified in the Cost Object Assignment screen for a particular Direct Cost in a <Responsibility Center>, Cost Object Type LineItemValue. It applies across a specific <Responsibility Center>, <Period>, and <Version>. Where the <Line Item> has been assigned across multiple dimensions, like several products and customers, and all relevant driver values will be aggregated in the total.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity Drivers>
3.4.17 DirectServiceCostObjectValue Grid Value
Description This value is the component cost of a <Cost Object> that derives from a specific combination of <Version>, <Period>, <Responsibility Center>, and <Cost Object Type Service>, where the <Cost Object >can
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 53
be a combination of five different levels of <Cost Object> item. The <Service> must have been defined as Cost Object Type in the Services dimension screen. This means its costs avoid being distributed across <Activities> and are directly available for assignment to <Cost Objects>.
NoteThis value does not include any contribution from <Line Item> or <Activity> costs.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Service>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.18 DirectServicePrimaryDriverUnitRate Grid Value
Description This is an activity driver unit rate associated with the primary (or “first”) driver specified in the Cost Object Assignment screen for a particular Cost Object Type Service and <Responsibility Center>. It is calculated as SummaryServiceActivityValue / DirectServicePrimaryDriverVolume where DirectServicePrimaryDriverVolume is the total of all the primary ActivityDriverValues that drive the specified Cost Object Type Service cost through to <Cost Objects>. Where the <Service> has been assigned across multiple dimensions, like several products and customers, and all relevant driver values will be aggregated in the total. This unit rate measures the unit cost of distributing a direct <Service> cost in a <Responsibility Center>, Cost Object Type Service Cost, across all of its assigned <Cost Objects>.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Services>, <Activity Drivers>
54 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.4.19 DirectServicePrimaryDriverVolume Grid Value
Description This is the total of all activity driver values for the primary, or first, driver specified in the Cost Object Assignment screen for a particular Direct <Service> Cost in a <Responsibility Center>, Cost Object Type Service. It applies across a specific <Responsibility Center>, <Period>, and <Version>. Where the <Service> has been assigned across multiple dimensions, like several products and customers, and all relevant driver values will be aggregated in the total.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Services>, <Activity Drivers>
3.4.20 ExtActivityCostObjectFixedUnitRate Grid Value
Description This grid value is only available in a Transactional Costing type of model. Activity Cost Object costs can have a separate external cost in addition to their calculated unit rate. This grid value can be set to represent the Fixed part of the ExtActivityCostObjectUnitRate.
Access Leaf Items: Read/Write – cannot be set by a rule
Consolidated Totals: Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.21 ExtActivityCostObjectUnitRate Grid Value
Description This grid value is only available in a Transactional Costing type of model. Activity Cost Object costs can have a separate external unit Rate in addition to their calculated unit rate. This grid value is the external unit rate, and can be entered or calculated via a rule.
Access Read/Write - if a Detailed rule does not exist.
NoteConsolidated values are Read only.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 55
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.22 ExtActivityCostObjectVariableUnitRate Grid Value
Description This grid value is only available in a Transactional Costing type of model. This grid value is calculated as: ExtActivityCostObjectVariableUnitRate = ExtActivityCostObjectUnitRate – ExtActivityCostObjectFixedUnitRate
Access Read only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.23 ExternalCostObjectFixedValue Grid Value
Description <Cost Object >costs can have a separate external cost in addition to their calculated value. External costs have similar characteristics to CostObjectValue.
Access Leaf Items:
● Read/Write – cannot be set by a rule.
Consolidated Totals – Read Only
Dimensions <Version,> <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemFixedValue Grid Value [page 120]
56 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.4.24 ExternalCostObjectValue Grid Value
Description <Cost Object> costs can have a separate external cost in addition to their calculated value. This external cost has similar characteristics to CostObjectValue.
Access Leaf Items: Read/Write – if a Detailed rule does not exist.
Consolidated Totals: Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.25 ExternalCostObjectVariableValue Grid Value
Description This grid value is calculated as: ExternalCostObjectVariableValue = ExternalCostObjectValue – ExternalCostObjectFixedValue
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>,< Line Item>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
ExternalCostObjectFixedValue Grid Value [page 56]
3.4.26 GrossContribution Grid Value
Description GrossContribution is the contributory profit of a <Cost Object>, ignoring any Post Gross Contribution costs, where a <Cost Object> can be a combination of five different levels of <Cost Object> item. It is the difference between the Revenue value and the SummaryPreCostObjectValue of a <Cost Object> in a specific combination of <Version>, <Period>, and <Responsibility Center>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 57
NoteThe costs here include both normal and direct <Line Items> and <Services> costs, but ignore Post Gross Contribution costs from <Line Items> and <Services> with the< Post Gross Contribution Type Line Item> attribute.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
Revenue Grid Value [page 63]SummaryPreCostObjectValue Grid Value [page 70]
3.4.27 JointCostObjectFixedValue Grid Value
Description The sum of the CostObjectFixedValue and the ExternalCostObjectFixedValue
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
ExternalCostObjectFixedValue Grid Value [page 56]CostObjectFixedValue Grid Value [page 48]JointCostObjectFixedValue [page 196]
58 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.4.28 JointCostObjectValue Grid Value
Description The sum of the CostObjectValue and the ExternalCostObjectValue.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
CostObjectValue Grid Value [page 49]ExternalCostObjectValue Grid Value [page 57]JointCostObjectValue [page 196]
3.4.29 JointCostObjectVariableValue Grid Value
Description The sum of the CostObjectVariableValue and the ExternalCostObjectVariableValue
Access Read Only
Parameters <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Object 4>, <Cost Objects 5>
Related Information
CostObjectVariableValue Grid Value [page 50]ExternalCostObjectVariableValue Grid Value [page 57]JointCostObjectVariableValue [page 197]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 59
3.4.30 LineItemCostObjectFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the summarized value of the calculated fixed <Line Item> costs that contribute to a <Cost Object> from all <Responsibility Centers> and all <Activities>. It identifies the cost by <Version>, <Period>, <Line Item>, and< Cost Object> combination from the five different levels of Cost Object item.
It includes the reassigned costs across all <Responsibility Centers> and <Activities> that originate from the specified Line Item, but unlike CostObjectValue, also includes the Direct costs from Cost Object Type Line Items held against <Activity Unassigned> and External <Cost Object> values. It does not use <Activities> as a key dimension so <Activity Unassigned> costs are included. <Responsibility Centers> are also missing as a key dimension so costs associated with <RC Unassigned> are included.
Access Read Only
Dimensions <Versions>, <Periods>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5 >
Related Information
CostObjectValue Grid Value [page 49]LineItemCalculatedFixedValue Grid Value [page 118]
3.4.31 LineItemCostObjectValue Grid Value
Description This is the summarized cost of a <Cost Object> across all <Responsibility Centers> and <Activities> that originates from a specified <Line Item>. It identifies the cost by <Version>, <Period>, <Line Item>, and <Cost Object> combination from the five different levels of <Cost Object> item.
60 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
It includes the reassigned costs across all <Responsibility Centers> and <Activities> that originate from the specified Line Item, but unlike CostObjectValue, also includes the Direct costs from Cost Object Type Line Items held against <Activity Unassigned> and External Cost Object values. It does not use <Activities> as a key dimension so <Activity Unassigned> costs are included. <Responsibility Centers> are also missing as a key dimension so costs associated with <RC Unassigned> are included.
Access Read Only
Dimensions <Versions>, <Periods>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
CostObjectValue Grid Value [page 49]
3.4.32 LineItemCostObjectVariableValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the summarized value of the variable portion of <Line Item> costs that contribute to a <Cost Object> from all <Responsibility Centers> and all <Activities>. It identifies the cost by <Version>, <Period>, <Line Item>, and <Cost Object> combination from the five different levels of <Cost Object> item.
It includes the reassigned costs across all <Responsibility Centers> and <Activities> that originate from the specified Line Item, but unlike CostObjectValue, also includes the Direct costs from Cost Object Type Line Items held against <Activity Unassigned> and External Cost Object values. It does not use <Activities> as a key dimension so <Activity Unassigned> costs are included. <Responsibility Centers> are also missing as a key dimension so costs associated with <RC Unassigned> are included.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 61
Access Read Only
Dimensions <Versions>, <Periods>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5 >
Related Information
CostObjectValue Grid Value [page 49]LineItemVariability Grid Value [page 121]
3.4.33 PrimaryDriverUnitRate Grid Value
Description This is an activity driver unit rate associated with the primary (or “first”) driver specified in the Cost Object Assignment screen for a particular Responsibility Center Activity Line Item. It gives the unit rate of a specific <Line Item> that contributes to that <Activity>. It is calculated as ActivityLineItemValue / PrimaryDriverVolume where PrimaryDriverVolume is the total of all the primary <Activity Driver> values that calculate the specified Activity Line Item through to <Cost Objects>. Where the activity has been assigned across multiple dimensions, such as several products and customers, all relevant driver values will be aggregated in the total. This unit rate measures the unit cost of distributing an ActivityLineItemValue across all of its assigned <Cost Objects>.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activities>, <Activity Drivers>
3.4.34 PrimaryDriverVolume Grid Value
Description This is the total of all activity driver values for the primary (or “first”) driver for a particular <Activity> and <Line Item> combination in a specific <Responsibility Center>, <Period>, and <Version>. Note that if the activity has been assigned across multiple dimensions, such as several products and customers, and all relevant driver values will be aggregated in the total.
62 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activities>, <Activity Drivers>
3.4.35 Revenue Grid Value
Description This value is the revenue obtained for a specific <Cost Object> identified through the dimension items shown below. It has a unique built-in relationship with the grid values Revenue and UnitsSold, which is implemented through rules associated with items in the <Revenue Types> dimension. The three are linked by the formula shown next, but this can function in two different ways depending on whether you operate with a known unit price or you want to derive it from revenue gained from units sold.
Revenue = UnitPrice * UnitsSold
A value for Revenue can only be entered when its equivalent UnitPrice has a value of zero. UnitPrice cannot then be written to, and becomes the calculated value Revenue / UnitsSold, with the proviso that when UnitsSold is zero so is UnitPrice.
Conversely, when a value is entered for UnitPrice, Revenue becomes Read Only and is calculated as UnitsSold * UnitPrice.
Dimensions <Version>, <Period>, <Responsibility Center>, <Revenue Type>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Access Leaf Items:
● Read Only - if UnitPrice has a non zero value● Read//Write - if UnitPrice is zero
Consolidated Totals: Read Only
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 63
3.4.36 ServiceCostObjectValue Grid Value
Description This value is the component cost of a <Cost Object> that derives from a specific combination of <Version>, <Period>, <Responsibility Center>, <Service>, and <Activity>, where the <Cost Object> can be a combination of five different levels of <Cost Object> item.
NoteThis does not include any contribution from <Line Item> costs or Direct costs (those that originate from <Line Item>/<Service> costs that are transmitted directly to <Cost Objects> avoiding <Activities>).
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Service>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.37 ServicePrimaryDriverUnitRate Grid Value
Description This is an activity driver unit rate associated with the primary (or “first”) driver specified in the Cost Object Assignment screen for a particular Responsibility Center Activity. It gives the unit rate for a specific service that contributes to that <Activity>. It is calculated as SummaryServiceActivityValue / ServicePrimaryDriverVolume where ServicePrimaryDriverVolume is the total of all the primary <Activity Driver> values that drive the specified <Activity> cost through to <Cost Objects>. Where the <Service> has been assigned across multiple dimensions, like several products and customers, and all relevant driver values will be aggregated in the total. This unit rate measures the unit cost of distributing a particular service cost associated with a specific Responsibility Center Activity across all of its assigned <Cost Objects>.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Services>, <Activities>, <Activity Drivers>
64 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.4.38 ServicePrimaryDriverVolume Grid Value
Description This is the total of all activity driver values for the primary, or first, driver specified in the Cost Object Assignment screen for a particular <Activity>. It applies across a specific <Responsibility Center>, <Period>, and <Version>. Where the <Service> has been assigned across multiple dimensions, like several products and customers, and all relevant driver values will be aggregated in the total.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Services>, <Activities>, <Activity Drivers>
3.4.39 SourceCostObjectFixedValue Grid Value
Description This calculated value represents the nonvariable costs of <Line Items> that are identified in SourceCostObjectValue.
NoteThis value includes all reassigned costs but does not include any contribution from <Service> costs or Direct costs (those that originate from <Line Item>/<Service> costs that are transmitted directly to <Cost Objects> avoiding <Activities>).
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Item>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemCalculatedFixedValue Grid Value [page 118]SourceCostObjectValue Grid Value [page 66]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 65
3.4.40 SourceCostObjectValue Grid Value
Description This calculated value represents the component cost of a <Cost Object> that derives from specific source <Responsibility Centers> and <Line Items> after reassignment, where the C<ost Object> can be a combination of five different levels of <Cost Object> item.
Although this value does not specify <Activities>, reassignments may cause some of the specified source values to be reallocated across activities they would otherwise not be associated with. <Cost Object> assignments distribute these costs to Cost Objects in different proportions to those in a model with no reassignments. For any <Cost Object>, this value traces the contribution that originated from specific <Responsibility Centers> and <Line Items>.
It does not include any contribution from <Service> costs or Direct costs (those that originate from <Line Item>/<Service> costs that are transmitted directly to <Cost Objects> avoiding <Activities>).
This value can only be obtained once all CostObjectValues have been calculated because only then can costs be traced back to their source. As a result, these values are not available in a calculated model and are only generated when asked for. For greater detail you can use TracebackValue, which identifies these costs through both Source and Target dimensions. This action can create massive amounts of calculated values and needs careful handling to avoid performance problems.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Item>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.41 SourceCostObjectVariableValue Grid Value
Description This calculated value represents the variable costs of <Line Items> that are identified in SourceCostObjectValue.
66 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
NoteThis does not include any contribution from <Service >costs or Direct costs (those that originate from <Line Item>/<Service> costs that are transmitted directly to <Cost Objects> avoiding <Activities>).
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Line Item>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemVariability Grid Value [page 121]SourceCostObjectValue Grid Value [page 66]
3.4.42 SummaryCostObjectFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the summarized value of the calculated fixed <Line Item> costs that contribute to a <Cost Object> from all <Activities> in a specified <Responsibility Center>. The <Cost Object> can be a combination of five different levels of <Cost Object >item.
It includes all the costs reassigned into the specified <Responsibility Center>, some of which can originate from other <Responsibility Centers>. Unlike CostObjectValue, it also includes the Direct costs from <Line Items>, <Services> (both normal and Direct) and External <Cost Object> values.
Direct costs originate from Cost Object Type Line Items/<Services> and are held against <Activity Unassigned>. This Grid Value does not use <Activities> as a key dimension so <Activity Unassigned> costs are included.
Access Read Only
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 67
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
CostObjectValue Grid Value [page 49]LineItemCalculatedFixedValue Grid Value [page 118]
3.4.43 SummaryCostObjectValue Grid Value
Description This is the summarized cost of a <Cost Object> in a specific <Responsibility Center> for all <Activities> and <Line Items>, where the <Cost Object> can be a combination of five different levels of <Cost Object> item.
It includes all the costs reassigned into the specified <Responsibility Center>, some of which can originate from other <Responsibility Centers>. Unlike CostObjectValue, it also includes the Direct costs from <Line Items>, <Services> (both normal and Direct) and External Cost Object values.
Direct costs originate from Cost Object Type Line Items/<Services> and are held against <Activity Unassigned>. This Grid Value does not use <Activities> as a key dimension so< Activity Unassigned> costs are included.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5 >
Related Information
CostObjectValue Grid Value [page 49]
68 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.4.44 SummaryCostObjectVariableValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the summarized value of the variable portion of all <Line Item> costs that contribute to a <Cost Object> from all <Activities> in a specified <Responsibility Center>. The Cost Object can be a combination of five different levels of Cost Object item.
It includes all the costs reassigned into the specified Responsibility Center, some of which can originate from other <Responsibility Centers>. Unlike CostObjectValue, it also includes the Direct costs from <Line Items>, <Services> (both normal and Direct) and External Cost Object values.
Direct costs originate from Cost Object Type Line Items/<Services> and are held against <Activity Unassigned>. This Grid Value does not use <Activities> as a key dimension so <Activity Unassigned> costs are included.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
CostObjectValue Grid Value [page 49]LineItemVariability Grid Value [page 121]
3.4.45 SummaryPostCostObjectValue Grid Value
Description Displays the component cost for the <Cost Object >with the specified parameters that derive from the <Post Gross Contribution Type Line Items> and <Post Gross Contribution Type Service> attributes.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 69
3.4.46 SummaryPreCostObjectValue Grid Value
Description This is the component cost of a <Cost Object> specified by the key dimensions below, which ignores Post Contribution costs, from <Line Items> and <Service>s with the Post Gross Contribution Type Line Item attribute, but includes costs from <Line Items> and <Services>, both normal and Direct, for example:
SummaryPreCostObjectValue = SummaryCostObjectValue – SummaryPostCostObjectValue
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.47 TargetCostObjectValue Grid Value
Description This trace value records the component cost of a <Cost Object> that is contributed through specific Target Responsibility Centers Activities after reallocation has occurred, that derives from the pre-reallocation costs of specific Source Responsibility Centers Activities. It is similar to TracebackValue which records the proportion of these costs that originate from specific <Line Items> rather than <Activities>.
Reassigned costs in TargetCostObjectValue are restricted to those that are generated through the Target Activities in the Target <Responsibility Centers>. These costs will have been directed there from a restricted set of Source <Responsibility Centers> and< Activities>. Although these source costs are the activity costs prior to any reassignment, when reassignment does take place, some of their values may be redistributed across other <Responsibility Centers>. This affects the values that appear at the Targets.
CostObjectValues do not specify Target dimensions, so even when the same the Source items are specified, these grid values will only be the same in very specific cases. One example would be when all Source and Target items are top level items in each hierarchy.
70 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
NoteThese are liable to generate a vast range of values which can only be calculated after the Calculation Engine has fully calculated your model. You should examine your model statistics for this Grid Value to ascertain how many of these results exist. If you attempt to retrieve too many of these, performance may be adversely affected, so try to only target the sections of data that you really need. Consolidated values have to gather their leaf values to generate a result and this can also contribute to poor performance.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Target Responsibility Centers>, <Target Activities>, <Cost Objects 1>, <Cost Objects 2>,< Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.48 TotalCostObjectFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the summarized value of all the calculated fixed <Line Item> costs that contribute to a <Cost Object> from all <Responsibility Centers> and all <Activities>. It identifies the cost by <Version>, <Period>, and <Cost Object> combination from the five different levels of <Cost Object> item.
It includes the reassigned costs across all <Activities> but unlike CostObjectValue, also includes the Direct costs from Cost Object Type Line Items held against <Activity Unassigned>, and External Cost Object values.
This Grid Value does not use <Activities> as a key dimension so <Activity Unassigned> costs are included. <Responsibility Centers> are also missing as a key dimension so costs associated with <RC Unassigned> are included.
NoteThese totals will include items that do not contribute to the consolidated group totals as specified by your dimension hierarchies. For example, if you have a Line Item
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 71
that does not contribute to its group total, it will be included in this grid value.
Access Read Only
Dimensions <Versions>, <Periods>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
CostObjectValue Grid Value [page 49]LineItemCalculatedFixedValue Grid Value [page 118]
3.4.49 TotalCostObjectValue Grid Value
Description This is the summarized cost of a <Cost Object> across all <Responsibility Centers>, <Line Items>, and <Activities>. It identifies the cost by <Version>, <Period>, and <Cost Objec>t combination from the five different levels of <Cost Object> item.
It includes the reassigned costs across all <Activities> but unlike CostObjectValue, also includes all contributions from <Service> costs, Direct costs and External <Cost Object> values. Direct costs originate from Cost Object Type Line Items/<Services> and are held against <Activity Unassigned>.
This Grid Value does not use <Activities> as a key dimension, so <Activity Unassigned> costs are included. <Responsibility Centers> are also missing as a key dimension so costs associated with <RC Unassigned> are included.
NoteThese totals will include all items, including those that do not contribute to the consolidated group totals as specified by your dimension hierarchies. For example, if a <Line Item> in your hierarchy does not contribute to its group total, it will still be included in this grid value.
72 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Access Read Only
Dimensions <Versions>, <Periods>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5 >
Related Information
CostObjectValue Grid Value [page 49]
3.4.50 TotalCostObjectVariableValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It is the summarized value of the variable portion of all <Line Item> costs that contribute to a <Cost Object> from all <Responsibility Centers> and all <Activities>. It identifies the cost by <Version>, <Period>, and <Cost Object> combination from the five different levels of <Cost Object> item.
It includes the reassigned costs across all <Activities> but unlike CostObjectValue, also includes the Direct costs from Cost Object Type Line Items held against <Activity Unassigned>, and External Cost Object values.
This Grid Value does not use <Activities> as a key dimension, so <Activity Unassigned> costs are included. <Responsibility Centers> are also missing as a key dimension, so costs associated with <RC Unassigned> are included.
NoteThese totals will include all items, including those that do not contribute to the consolidated group totals as specified by your dimension hierarchies. For example, if a <Line Item> in your hierarchy does not contribute to its group total, it will still be included in this grid value.
Access Read Only
Dimensions <Versions>, <Periods>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 73
Related Information
CostObjectValue Grid Value [page 49]LineItemVariability Grid Value [page 121]
3.4.51 TracebackFixedValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It represents the component of <Cost Objects> costs that derives from the non-variable portion of specific <Responsibility Center> <Line Items> that contribute to the specified <Cost Objects> through targeted <Responsibility Center> <Activities>. The cost object can be a combination of any of five different types of <Cost Object> item.
NoteThis value includes all costs reassigned to the specified <Activity>.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Target Responsibility Centers>, <Target Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemCalculatedFixedValue Grid Value [page 118]TracebackValue Grid Value [page 74]
3.4.52 TracebackValue Grid Value
Description This calculated value represents the component of <Cost Objects> costs that derives from specific <Responsibility Center>< Line Items> that are
74 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
driven through targeted <Responsibility Center> <Activities>. The specified <Cost Objects> can be combinations of five different <Cost Object> dimension items.
This differs from CostObjectValue which does not specify any <Target Responsibility Center> or <Activity>. Reassigned costs that apply to the <Cost Object> are restricted to those that are generated through the <Target Activities> in the <Target Responsibility Centers>. These costs will have been directed there from a restricted set of Source <Responsibility Centers> and <Line Items> . These <Line Item> costs will have first been assigned to <Activities> in the same <Responsibility Centers> and perhaps reassigned before finally being assigned through to <Cost Objects>. When reassignment takes place, some of these values may be redistributed across other <Responsibility Centers>, which will affect the values that appear at the Targets.
CostObjectValues do not specify either <Line Items> or Targets, so even when the same the Source items are specified, these grid values will only be the same in very specific cases. One example would be when all Source and Target items are top level items in each hierarchy.
NoteThis Grid Value can only be calculated after the Calculation Engine has fully calculated your model. It generates many more values in addition to those produced by the Calculation Engine and as a result these can take some time to appear. Consider using the CalculateSlice function if this causes you problems.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line items>, <Target Responsibility Centers>, <Target Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 75
3.4.53 TracebackVariableValue Grid Value
Description This calculated value is mainly used in Driver Analysis. It represents the component of <Cost Objects> costs that derives from the variable portion of specific <Responsibility Center> <Line Items> that contribute to the specified <Cost Objects> through targeted <Responsibility Center> <Activities>. The <Cost Object> can be a combination of any of five different types of <Cost Object> item.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Target Responsibility Centers>, <Target Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
LineItemVariability Grid Value [page 121]TracebackValue Grid Value [page 74]
3.4.54 UnitPrice Grid Value
Description This value is the unit price of a <Cost Object> identified through the dimension items shown below. It has a unique built-in relationship with the Grid Values Revenue and UnitsSold, which is implemented through rules associated with items in the <Revenue Types> dimension. The three are linked by the formula shown next, but this can function in two different ways depending on whether you operate with a known unit price or you want to derive it from revenue gained from units sold.
Revenue = UnitPrice * UnitsSold
A value for UnitPrice can only be entered when the grid value Revenue for the same <Cost Object> has a value of zero. Revenue cannot then be written to, and becomes the calculated value UnitsSold * UnitPrice.
Conversely, when a value is entered for Revenue, UnitPrice becomes Read Only and is calculated as
76 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Revenue / UnitsSold, with the proviso that when UnitsSold is zero so is UnitPrice.
NoteThese default rules in the <Revenue Types> dimension can be altered to suit your own requirements.
Access Leaf Items:
● Read Only - if Revenue has a non zero value● Read//Write - if Revenue is zero
Consolidated Totals: Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.55 UnitsSold Grid Value
Description This is number of units sold for a specific <Cost Object> identified through the dimension items shown below. It has a unique built-in relationship with the Grid Values Revenue and UnitPrice, which is implemented through rules associated with items in the <Revenue Types> dimension. The three are linked by the formula shown next, but this can function in two different ways depending on whether you operate with a known unit price or you want to derive it from revenue gained from units sold.
Revenue = UnitPrice * UnitsSold
When UnitPrice has a non zero value, Revenue cannot be written to and is calculated automatically using the formula.
Conversely, when Revenue has a non zero value, UnitPrice cannot be written to and is calculated automatically using the formula, with the proviso that when UnitsSold is zero so is UnitPrice.
NoteThese default rules in the <Revenue Types> dimension can be altered to suit your own requirements.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 77
Access Leaf Items - Read/Write
Consolidated Totals – Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.4.56 Bill of Materials Cost Object Related Grid Values
These are Cost Object Related grid values that are only found in a Bill of Materials type model.
3.4.56.1 BOMComponentExternalUnitRate Grid Value
Description The BOMComponentExternalUnitRate grid value is only available in a Bill of Materials type of model. It shows the same value as the ExternalBOMUnitRate now applied to each relevant component under the products (defined in <Cost Objects 1>).
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>
Related Information
ExternalBOMUnitRate Grid Value [page 83]
3.4.56.2 BOMComponentFixedUnitRate Grid Value
Description The BOMComponentFixedUnitRate grid value is only available in a Bill of Materials type of model. It represents the non-variable portion (including the fixed value) of the BOMComponentUnitRate.
Access Read Only
78 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Components> (virtual dimension)
Related Information
BOMComponentUnitRate Grid Value [page 79]
3.4.56.3 BOMComponentUnitRate Grid Value
Description The BOMComponentUnitRate grid value is only available in a Bill of Materials type of model. It shows the same value as the BOMUnitRate now applied to each relevant component under the products (defined in <Cost Objects 1>).
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Components> (virtual dimension)
Related Information
BOMUnitRate Grid Value [page 82]
3.4.56.4 BOMComponentVolume Grid Value
Description The BOMComponentVolume grid value is only available in a Bill of Materials type of model. It shows the number of units of each component in a product, both direct and implied, that have an associated unit rate (either calculated or external).
This is effectively the “rolled up” BOMMakeupVolume for each product, but unlike the BOMMakeupVolume, it shows the components that are associated both directly with a product and also indirectly by association with a subassembly.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 79
No value is displayed for components that do not have an associated unit rate.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Components> (virtual dimension)
3.4.56.5 BOMFixedUnitRate Grid Value
Description The BOMFixedUnitRate grid value is only available in a Bill of Materials type of model. It represents the non-variable portion (including the fixed value) of the BOMUnitRate, when the related <Line Item> has the attribute <Fixed Cost Line Item> set.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>
Related Information
BOMUnitRate Grid Value [page 82]
3.4.56.6 BOMMakeupVolume Grid Value
Description The BOMMakeupVolume grid value is only available in a Bill of Materials type of model. It shows the BOMComponentVolume for each product and is dimensioned by <Version> and <Period>. Initially this contains the value of the DefaultBOMMakeupVolume, but can be overridden for any <Version> / <Period> combination. In a grid, you can only edit the volume for a component within the product or subassembly that it is directly part of. Once a new value is entered, it applies to all consecutive <Periods> for that <Version>. The BOMMakeupVolume grid value is required for BOM calculations.
Access Read/Write - if directly part of a subassembly or product
80 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Read Only - anything other than directly part of a subassembly or product
NoteThe value for a product against itself = 1
Dimensions <Versions>, <Periods>, <Cost Objects 1>, <Components> (virtual dimension)
Related Information
DefaultBOMMakeupVolume Grid Value [page 82]
3.4.56.7 BOMProductFixedUnitRate Grid Value
Description The BOMProductFixedUnitRate grid value is only available in a Bill of Materials type of model. It shows the non-variable portion (including the fixed value) of the cost of a product by applying the component volume to the fixed component unit rate for that product. It is calculated as:
BOMProductFixedUnitRate = BOMComponentFixedUnitRate * BOMComponentVolume
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Components> (virtual dimension)
3.4.56.8 BOMProductUnitRate Grid Value
Description The BOMProductUnitRate grid value is only available in a Bill of Materials type of model. It shows the cost of a product by applying the component volume to both the internal and
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 81
external component unit rates for that product. It is calculated as:
BOMProductUnitRate = (BOMComponentUnitRate + BOMComponentExternalUnitRate) * BOMComponentVolume
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Components> (virtual dimension)
3.4.56.9 BOMUnitRate Grid Value
Description The BOMUnitRate grid value is only available in a Bill of Materials type of model. This value shows the cost of producing one unit of each component. For each component that has an associated activity cost, in other words, ActivityLineItemValue, it calculates the cost of making that component. It is calculated as:
BOMUnitRate = Component's ActivityLineItemValue / Component's BOMProductionVolume
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>
3.4.56.10 DefaultBOMMakeupVolume Grid Value
Description The DefaultBOMMakeupVolume grid value is only available in a Bill of Materials type of model. It is the default number of units of each component that make up each product. These values can be entered in the BOM Makeup assignment screen or in the grid.
Access Read/Write
Dimensions <BOM Makeup> (virtual dimension)
82 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.4.56.11 ExternalBOMUnitRate Grid Value
Description The ExternalBOMUnitRate grid value is only available in a Bill of Materials type of model. This value shows the external costs associated with components; for example some components may be bought in from an external provider, rather than produced in-house.
Access Leaf items - Read / Write
Consolidated totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>
3.5 Data Grid Values
The Grid values held under the Data Values category for the all model types are described in the following topics. Where a Grid Value is available to only specific model types or does not apply to a specific model type, this is noted in the relevant topic.
3.5.1 ActivityDriverDataValue Grid Value
Description If the <Activity Driver> has no associated rule, this grid value is the same as ActivityDriverValue Grid Value. If a rule exists, it records a value that can be entered against the <Activity Driver> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
NoteConsolidated totals are also Read/Write.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 83
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>,< Cost Objects 5>
Related Information
ActivityDriverValue Grid Value [page 111]
3.5.2 DataRevenue Grid Value
Description A value associated with a <Cost Object> identified through the dimension items shown below. It has the same value as the grid value Revenue unless Revenue is a calculated value. This depends on a set of default rules associated with items in the <Revenue Types> dimension. These arrange that Revenue is a calculated value if UnitPrice is entered for the <Cost Object> before Revenue.
Alternatively, if you specify a Revenue before UnitPrice, the value of DataRevenue is the same and the UnitPrice of the <Cost Object> becomes a calculated value. These default rules can be altered to produce different effects, but DataRevenue will differ from Revenue only if Revenue is a calculated value.
NoteThe default rules in the <Revenue Types> dimension can be altered to suit your own requirements.
Access Read/Write – whether Revenue is calculated or not
NoteConsolidated totals are also Read/Write.
Dimensions <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects> , <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
84 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Related Information
Revenue Grid Value [page 63]
3.5.3 DataUnitPrice Grid Value
Description A value associated with the UnitPrice of a <Cost Object> identified through the dimension items shown below. It has the same value as the grid value UnitPrice unless UnitPrice is a calculated value. This depends on a set of default rules associated with items in the <Revenue Types> dimension. These arrange that UnitPrice is a calculated value if Revenue is entered for the <Cost Object> before UnitPrice.
Alternatively, if you specify a UnitPrice before Revenue, the value of DataUnitPrice is the same and the Revenue of the <Cost Object> becomes a calculated value. These default rules can be altered to produce different effects, but DataUnitPrice will differ from UnitPrice only if UnitPrice is a calculated value.
NoteThe default rules in the <Revenue Types> dimension can be altered to suit your own requirements.
Access Read/Write – whether UnitPrice is calculated or not.
NoteConsolidated totals are also Read/Write.
Dimensions <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
UnitPrice Grid Value [page 76]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 85
3.5.4 DataUnitsSold Grid Value
Description A value associated with a <Cost Object> identified through the dimension items shown below. It has the same value as the grid value UnitsSold unless UnitsSold is a calculated value. This can be arranged through alterations and additions to various rules associated with items in the <Revenue Types> dimension.
Access Read/Write – whether UnitsSold is calculated or not.
NoteConsolidated totals are also Read/Write.
Dimensions <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
UnitsSold Grid Value [page 77]
3.5.5 EmployeePercentBoundaryDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Employee> Item identified through the dimension items shown below. If the <Employee >does not have an associated Percent <Boundary> Rule, this grid value is the same as EmployeePercentBoundaryValue. If a rule exists, it records a value that can be entered against the <Employee> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
Access Read/Write – whether a Percent <Boundary> Rule exists or not
NoteConsolidated totals are also Read/Write.
86 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Employees>, <Boundaries>, <Cost Object 1>, <Cost Object 2>
Related Information
EmployeePercentBoundaryValue Grid Value [page 41]
3.5.6 ExtActivityCostObjectDataUnitRate Grid Value
Description This grid value is only available in a Transactional Costing type of model. It is an entered unit rate associated with a particular external <Activity> <Cost Object> identified through the dimension items listed below.
NoteData unit rates can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for unit rates of this type.
Access Read/Write - Cannot be set by a rule.
NoteConsolidated values are also Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.5.7 ExternalActivityDataValue Grid Value
Description An entered value associated with a particular External <Activity> identified through the dimension items listed below. If an External <Activity> does not have an associated rule, the ExternalActivityDataValue is the same as the ExternalActivityValue grid value. If a rule exists, ExternalActivityDataValue records a value that can be added against the External <Activity> in addition to the computed value obtained by a rule. This could be used by the rule to influence its computed value.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 87
NoteData values can be entered against consolidation totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write - if a Detailed rule does not exist.
NoteConsolidated values are also Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers,> <Line Items>, <Activities>
Related Information
ExternalActivityValue Grid Value [page 28]ExternalActivityDataValue [page 166]
3.5.8 ExternalCostObjectDataValue Grid Value
Description An entered value associated with a particular external <Cost Object> identified through the dimension items listed below. If the <Cost Object> does not have an associated rule, the ExternalCostObjectDataValue is the same as the ExternalCostObjectValue grid value. If a rule exists, ExternalCostObjectDataValue records a value that can be added against the External <Cost Object> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write - if a Detailed rule does not exist.
NoteConsolidated values are also Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>,
88 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
<Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
ExternalCostObjectValue Grid Value [page 57]
3.5.9 LineItemDataValue Grid Value
Description A value associated with a particular <Line Item> identified through the dimension items shown below. If the <Line Item> has no associated rule, this grid value is the same as LineItemValue Grid Value. If a rule exists, it records a value that can be entered against the <Line Item> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>
Related Information
LineItemValue Grid Value [page 121]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 89
3.5.10 LineItemDetailDataValue Grid Value
Description A value associated with a particular <Line Item Detail> identified by the dimension items shown below. If the <Line Item Detail> has no associated rule, this grid value is the same as the LineItemDetailValue Grid Value. If a rule exists, it records a value that can be held against the <Line Item Detail> in addition to the computed value obtained by the rule.
When <Line Items> have a range of characteristics that can influence their value, this grid value can be used to represent some of these. LineItemDataValue Grid Value and LineItemDetailValueNC Grid Value can also be used in this way. These provide a rich basis for constructing rules to compute the values of complex <Line Items> and <Line Item Details>.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Line Item Details>
Related Information
LineItemDataValue Grid Value [page 89]LineItemDetailValue Grid Value [page 119]LineItemDetailValueNC Grid Value [page 120]
3.5.11 MetricActualBoundaryDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Metric >Item
90 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
identified through the dimension items shown below. If the <Metric> has no associated Actual <Boundary> Rule, this grid value is the same as MetricActualBoundaryValue. If a rule exists, it records a value that can be entered against the <Metric> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether an Actual <Boundary> Rule exists or not.
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Boundaries>, <Cost Object 1>, <Cost Object 2>
Related Information
MetricActualBoundaryValue Grid Value [page 42]
3.5.12 MetricActualDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Metric> Item identified through the dimension items shown below. If the <Metric> has no associated Actual Rule, this grid value is the same as MetricActualValue. If a rule exists, it records a value that can be entered against the <Metric> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether an Actual Rule exists or not
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 91
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
Related Information
MetricActualValue Grid Value [page 131]
3.5.13 MetricBasePointDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Metric> Item identified through the dimension items shown below. If the <Metric> has no associated BasePoint Rule, this grid value is the same as MetricBasepointValue. If a rule exists, it records a value that can be entered against the <Metric> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Basepoint Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
Related Information
MetricBasePointValue Grid Value [page 132]
92 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.5.14 MetricPercentBoundaryDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Metric> Item identified through the dimension items shown below. If the <Metric> has no associated Percent <Boundary> Rule, this grid value is the same as MetricPercentBoundaryValue. If a rule exists, it records a value that can be entered against the <Metric> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Percent <Boundary> Rule exists or not.
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>,< Metrics>, <Boundaries>, <Cost Object 1>, <Cost Object 2>
Related Information
MetricPercentBoundaryValue Grid Value [page 42]
3.5.15 MetricTargetDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Metric> Item identified through the dimension items shown below. If the <Metric> has no associated Target Rule, this grid value is the same as MetricTargetValue. If a rule exists, it records a value that can be entered against the <Metric> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 93
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Target Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
Related Information
MetricTargetValue Grid Value [page 132]
3.5.16 ObjectiveActualBoundaryDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Objective> Item identified through the dimension items shown below. If the <Objective> has no associated Actual <Boundary> Rule, this grid value is the same as ObjectiveActualBoundaryValue. If a rule exists, it records a value that can be entered against the <Objective> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether an Actual <Boundary> Rule exists or not.
NoteConsolidated totals are also Read/Write.
94 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>,< Boundaries>, <Cost Object 1>, <Cost Object 2>
Related Information
ObjectiveActualBoundaryValue Grid Value [page 43]
3.5.17 ObjectiveActualDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Objective> Item identified through the dimension items shown below. If the <Objective> has no associated Actual Rule, this grid value is the same as ObjectiveActualValue. If a rule exists, it records a value that can be entered against the Objective in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether an Actual Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
ObjectiveActualValue Grid Value [page 135]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 95
3.5.18 ObjectiveBasePointDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Objective> Item identified through the dimension items shown below. If the <Objective> has no associated BasePoint Rule, this grid value is the same as ObjectiveBasepointValue. If a rule exists, it records a value that can be entered against the <Objective> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Basepoint Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
ObjectiveBasePointValue Grid Value [page 135]
3.5.19 ObjectiveMetricWeightingDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Objective> Item identified through the dimension items shown below. If the <Objective> has no associated Weighting Rule, this grid value is the same as ObjectiveMetricWeightingValue. If a rule exists, it records a value that can be entered against the <Objective >in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
96 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Metrics>, <Cost Object 1>, <Cost Object 2>
Related Information
ObjectiveMetricWeightingValue Grid Value [page 142]
3.5.20 ObjectivePercentBoundaryDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Objective >Item identified through the dimension items shown below. If the <Objective> has no associated Percent <Boundary> Rule, this grid value is the same as ObjectivePercentBoundaryValue. If a rule exists, it records a value that can be entered against the <Objective> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Percent <Boundary> Rule exists or not
NoteConsolidated totals are also Read/Write.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 97
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Boundaries>, <Cost Object 1>, <Cost Object 2>
Related Information
ObjectivePercentBoundaryValue Grid Value [page 43]
3.5.21 ObjectiveTargetDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Objective> Item identified through the dimension items shown below. If the <Objective> has no associated Target Rule, this grid value is the same as ObjectiveTargetValue. If a rule exists, it records a value that can be entered against the <Objective> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether an Target Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
ObjectiveTargetValue Grid Value [page 137]
98 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.5.22 ObjectiveWeightingDataValue Grid Value
Description This value is available only to Objectives and Metrics models. A value associated with a particular <Objective> Item identified through the dimension items shown below. If the <Objective> has no associated Weighting Rule, this grid value is the same as ObjectiveWeightingValue. If a rule exists, it records a value that can be entered against the <Objective> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether an Weighting Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Linked Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
ObjectiveWeightingValue Grid Value [page 143]
3.5.23 ResourceDriverDataSplit Grid Value
Description If the specified <Resource Driver> has no associated Detailed Resource Driver Split rule, this grid value is the same as ResourceDriverSplit Grid Value. If a rule exists, it records a value that can be entered against the ResourceDriverSplit in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 99
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Split Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>, <Activities>
Related Information
ResourceDriverSplit Grid Value [page 113]
3.5.24 ResourceDriverDataValue Grid Value
Description If the specified <Resource Driver> has no associated Detailed Resource Driver rule, this grid value is the same as ResourceDriverValue Grid Value. If a rule exists, it records a value that can be entered against the <Resource Driver> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>
100 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Related Information
ResourceDriverValue Grid Value [page 114]
3.5.25 ServiceDriverDataValue Grid Value
Description If the Service Driver has no associated rule, this grid value is the same as ServiceDriverValue Grid Value. If a rule exists, it records a value that can be entered against the Service Driver in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>
Related Information
ServiceDriverValue Grid Value [page 115]
3.5.26 SpreadDataValue Grid Value
Description This grid value identifies individual values in a set that is spread across a range of periods in a specific <Version>. If the <Spread> item has no associated rule, this grid value is the same as SpreadValue grid value. If a rule exists, it records a value that can be entered against the Spread item
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 101
in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Spreads>
Related Information
SpreadValue Grid Value [page 122]
3.5.27 WorkSheetDataValue Grid Value
Description This is the value of a single element in a 2-dimensional array, derived from a combination of both <Work Sheets 1> and <Work Sheets 2> dimension items in a specific <Responsibility Center>, <Version>, and <Period>. If the <Work Sheets 1> item has no associated rule, this grid value is the same as WorkSheetValue grid value.
If a rule exists, it records a value that can be entered against the <Work Sheets> item in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
102 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
NoteConsolidated totals are also Read/Write.
Dimensions <Version>, <Period>, <Responsibility Center>, <Work Sheets 1>, <Work Sheets 2>
Related Information
WorkSheetValue Grid Value [page 123]
3.5.28 Bill of Materials Data Grid Values
These are Data Values grid values that are only found in a Bill of Materials type model.
3.5.28.1 BOMDataUnitsSold Grid Value
Description The BOMDataUnitsSold grid value is only available in a Bill of Materials type of model. If the product defined in <Cost Objects 1> has no associated rule, this grid value is the same as the BOMUnitsSold Grid Value. If a rule exists, it records a value that can be entered against the product in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Cost Objects 1>, <Cost Objects 2> , <Cost Objects 3>, <Cost Objects 4> , <Cost Objects 5>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 103
Related Information
BOMUnitsSold Grid Value [page 116]
3.5.28.2 BOMMakeupDataVolume Grid Value
Description The BOMMakeupDataVolume grid value is only available in a Bill of Materials type of model. It shows the value associated with a particular <Component> identified through the dimension items shown below. If the <Component> has no associated rule, this grid value is the same as the BOMMakeupVolume Grid Value. If a rule exists, it records a value that can be entered against the <Component> in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>
Related Information
BOMMakeupVolume Grid Value [page 80]
3.5.28.3 BOMProductionDataVolume Grid Value
Description The BOMProductionDataVolume grid value is only available in a Bill of Materials type of model. If the product
104 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
defined in <Cost Objects 1> has no associated rule, this grid value is the same as the BOMProductionVolume Grid Value. If a rule exists, it records a value that can be entered against the product in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Cost Objects 1>
Related Information
BOMProductionVolume Grid Value [page 116]
3.5.28.4 ExternalBOMDataUnitRate Grid Value
Description The ExternalBOMDataUnitRate grid value is only available in a Bill of Materials type of model. If the product defined in <Cost Objects 1> has no associated rule, this grid value is the same as the ExternalBOMUnitRate Grid Value. If a rule exists, it records a value that can be entered against the product in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
NoteData values can be entered against consolidated totals as well as individual line items, so the consolidation feature does not operate for values of this type.
Access Read/Write – whether a Detailed Rule exists or not
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 105
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>
Related Information
ExternalBOMUnitRate Grid Value [page 83]
3.6 Delta Grid Values
Delta values are the difference, or variance, between the original starting values and the target values. Delta values are generated during the process of Driver Analysis and Cost Analysis. Target values are inputted when starting analysis. Original values are those values already in the model when analysis is started.
In the descriptions that follow, three stages of analysis are used to denote the changes of access rights for values, these are: before analysis, during analysis, and after analysis.
3.6.1 ActivityDriverDeltaValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center >this value represents the difference between the Activity Driver Original value and the resultant Activity Driver value produced by Driver Analysis.
This value is generated by the Driver Analysis process.
Access Leaf Items - Read Only before, Read/Write during and after.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
106 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.6.2 ActivityDriverOriginalValue Grid Value
Description This is the ActivityDriverValue of an Activity Driver in a specific Version, Period, and Responsibility Center, before a Driver Analysis is performed. This value is maintained throughout the Driver Analysis process.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
ActivityDriverValue Grid Value [page 111]
3.6.3 ActivityDriverTargetValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center>, this value represents the value of the Activity Driver to be attained by the Driver Analysis process. This value is entered before Driver Analysis is performed.
Access Leaf Items - Read/Write before, Read Only during
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Cost Objects 1>, <Cost Objects 2,> <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
3.6.4 LineItemDeltaValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center>, this value represents the difference between the Line Item Original value and the resultant Line Item value produced by Cost Analysis.
Access Leaf Items - Read Only before, Read/Write during and after
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 107
3.6.5 LineItemOriginalValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center>, this value represents the value of the <Line Item> before Cost Analysis is performed. This value is maintained through the Cost Analysis process.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>
3.6.6 ResourceDriverDeltaSplit Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center >this value represents the difference between the <Resource Driver> original Split value and the resultant <Resource Driver> Split value produced by Driver Analysis.
This value is generated by the Driver Analysis process.
Access Leaf Items - Read Only before, Read/Write during and after.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>, <Activities>
3.6.7 ResourceDriverDeltaValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center> this value represents the difference between the <Resource Driver> original value and the resultant Resource Driver value produced by Driver Analysis.
This value is generated by the Driver Analysis process.
Access Leaf Items - Read Only before, Read/Write during and after.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>
108 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.6.8 ResourceDriverOriginalSplit Grid Value
Description This is the ResourceDriverSplit value of a <Resource Driver> in a specific <Version>, <Period>, and <Responsibility Center>, before a Driver Analysis is performed. This value is maintained throughout the Driver Analysis process.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>, <Activities>
Related Information
ResourceDriverSplit Grid Value [page 113]
3.6.9 ResourceDriverOriginalValue Grid Value
Description This is the ResourceDriverValue of a <Resource Driver> in a specific <Version>, <Period>, and <Responsibility Center>, before a Driver Analysis is performed. This value is maintained throughout the Driver Analysis process.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>
Related Information
ResourceDriverValue Grid Value [page 114]
3.6.10 ResourceDriverTargetSplit Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center>, this value represents the value of the <Resource Driver> Split to be attained by the Driver Analysis process. This value is entered before Driver Analysis is performed.
Access Leaf Items - Read/Write before, Read Only during
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 109
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>, <Activities>
3.6.11 ResourceDriverTargetValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center>, this value represents the value of the <Resource Driver> to be attained by the Driver Analysis process. This value is entered before Driver Analysis is performed.
Access Leaf Items - Read/Write before, Read Only during
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>
3.6.12 ServiceDriverOriginalValue Grid Value
Description This is the ServiceDriverValue of a <Service> in a specific <Version>, <Period>, and < Responsibility Center>, before a Driver Analysis is performed. This value is maintained throughout the Driver Analysis process.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>
Related Information
ServiceDriverValue Grid Value [page 115]
3.6.13 ServiceDriverDeltaValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center> this value represents the difference between the Service Driver Original value and the resultant Service Driver value produced by Driver Analysis.
This value is generated by the Driver Analysis process.
Access Leaf Items - Read Only before, Read/Write during and after.
110 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>
3.6.14 ServiceDriverTargetValue Grid Value
Description In a specific <Version>, <Period>, and <Responsibility Center> this value represents the value of the Service Driver to be attained by the Driver Analysis process. This value is entered before Driver Analysis is performed.
Access Leaf Items - Read/Write before, Read Only during
Dimensions <Version>, <Period>, <Responsibility Center>, <Service>
3.7 Driver Value Grid Values
The Grid values held under the Driver Values category are described in the following topics.
3.7.1 ActivityDriverValue Grid Value
Description This value is a measure of an appropriate operational quantity such as Number of Sales or Number of Invoices, which is used to distribute costs across a range of <Cost Objects>. It drives costs from <Line Items>, <Services>, or <Activities> through to <Cost Objects> in a specific <Version>, <Period>, and <Responsibility Center>, where a <Cost Object> can be a combination of up to five distinct <Cost Object> dimensions. Each value is associated with a particular <Cost Object> whose costs are calculated as the proportion of the value to its total.
Access Leaf Items
Read/Write - if no Detailed Rule exists.
Read Only - if calculated by the Detailed Rule.
Consolidated Totals – Read Only
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 111
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Activity Drivers>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Related Information
Access Rights [page 23]
3.7.2 EmployeeResourceDriverDataSplit Grid Value
Description If the specified <Resource Driver> does not have an associated Detailed Resource Driver Split rule, this grid value is the same as the EmployeeResourceDriverSplit Grid Value. If a rule exists, it records a value that can be entered against the EmployeeResourceDriverSplit in addition to the computed value obtained by the rule. This could be used by the rule to influence its computed value.
Access Read/Write – whether a Detailed Split Rule exists or not
NoteConsolidated totals are also Read/Write.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Employees>, <Resource Drivers>, <Activities>
3.7.3 EmployeeResourceDriverSplit Grid Value
Description A value associated with a particular <Activity> and <Resource Driver> which is split across the total number of <Employees> for a particular <Version>, <Period>, and <Responsibility Center>.
Access Leaf Items
Read/Write - if a Detailed Rule does not exist.
Read Only - if calculated by the Detailed Rule.
112 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Employees>, <Activities>, <Resource Drivers>
3.7.4 ResourceDriverPctSplit Grid Value
Description A percentage value (range 0-100) associated with a particular <Activity> and <Resource Driver> in a specific <Version>, <Period>, and <Responsibility Center>. It is used to distribute <Line Item> and <Service> Costs across the <Activities> performed in a specific <Version>, <Period>, and <Responsibility Center>. <Activity> costs are calculated as the percentage of the total for that <Resource Driver>.
NoteIt is possible to over/under allocate costs using these values.
Access Leaf Items
Read/Write - if no Detailed Rule exists.
Read Only - if calculated by the Detailed Rule.
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>, <Activities>
Related Information
Access Rights [page 23]
3.7.5 ResourceDriverSplit Grid Value
Description A value associated with a particular <Activity> and <Resource Driver> in a specific <Version>, <Period>,
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 113
and <Responsibility Center>. It is used to distribute <Line Item> and <Service> Costs across the <Activities> performed in a specific <Version>, <Period>, and <Responsibility Center>. <Activity> costs are calculated according to the proportion of the value relative to the total for that <Resource Driver>.
NoteThis total may not be the same as the equivalent ResourceDriverValue, which can mean that costs are over/under allocated.
Access Leaf Items
Read/Write - if no Detailed Rule exists.
Read Only - if calculated by the Detailed Rule.
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>, <Activities>
Related Information
Access Rights [page 23]ResourceDriverValue Grid Value [page 114]
3.7.6 ResourceDriverValue Grid Value
Description A value that measures the quantity of a resource deployed in a particular <Responsibility Center> in a specific <Version> and <Period> for example, headcount, square meters. It is used along with ResourceDriverSplits and ResourceDriverPctSplit to spread <Line Item> and <Service> Costs across the <Activities> performed in a <Responsibility Center> in a specific <Version> and <Period>.
Access Leaf Items
Read/Write - if no Detailed Rule exists.
Read Only - if calculated by the Detailed Rule.
114 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Resource Drivers>
Related Information
Access Rights [page 23]
3.7.7 ServiceDriverValue Grid Value
Description A value that measures the consumption of a <Service> by a particular <Responsibility Center> in a specific <Version> and <Period>.
Access Leaf Items
Read/Write - if no Detailed Rule exists.
Read Only - if calculated by the Detailed Rule.
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>
Related Information
Access Rights [page 23]
3.7.8 Bill of Materials Driver Value Grid Values
These are Driver Values grid values that are only found in a Bill of Materials type model.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 115
3.7.8.1 BOMCalculatedUnitsSold Grid Value
Description The BOMCalculatedUnitsSold grid value is only available in a Bill of Materials type of model. It shows the consolidated value of every unit sold, whether as a complete finished product or as part of a subassembly, even if not sold as a separate item. So if an assembly requires two of a certain component, then the value of BOMCalculatedUnitsSold for that component will be twice the value of BOMCalculatedUnitsSold for the assembly.
Access Read Only
Dimensions <Versions>, <Periods>, <Cost Objects 1>
3.7.8.2 BOMProductionVolume Grid Value
Description The BOMProductionVolume grid value is only available in a Bill of Materials type of model. It shows the volume of items produced by <Version> and <Period>.
Access Leaf items: Read/Write
Consolidated totals: Read Only
Dimensions <Versions>, <Periods>, <Cost Objects 1>
3.7.8.3 BOMUnitsSold Grid Value
Description The BOMUnitsSold grid value is only available in a Bill of Materials type of model. It shows how many units are sold by Cost Object, such as customer. This includes the complete finished product and also parts of products that are sold separately. Units that are always sold as part of an assembly and are never sold separately have a value of zero.
Access Leaf items: Read/Write
Consolidated totals: Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Cost Objects 1>, <Cost Objects 2> , <Cost Objects 3>, <Cost Objects 4> , <Cost Objects 5>
116 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.8 General Grid Values
The Grid values held under the General category are described in the following topics.
3.8.1 CurrencyRate Grid Value
Description CurrencyRate is a multiplier that defines how many units of a specific currency equate to one unit of your base currency. Different CurrencyRate values can be set for all combinations of <Versions>, <Periods>, and <Currency> either by directly inputting a value or by using the <Currency> item Detailed Rule.
The default base currency is NON, which has a CurrencyRate of 1, but you can create a new currency as your base currency by assigning it a rate of 1. Then any other currencies you define can be given rates that are relative to your base.
NoteThis value is not an Exchange Rate; it is a multiplier.
Access Read/Write - if not calculated by a Rule
Read Only - if calculated by a Rule
Dimensions <Versions>, <Periods>, <Currencies>
NoteIn a Bill of Materials model, CurrencyRate is replaced by UOMFactor.
Related Information
Access Rights [page 23]UOMFactor Grid Value [page 122]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 117
3.8.2 EmployeeResultValue Grid Value
Description This value is available only to Objectives and Metrics models. The EmployeeResultValue is a summary <Objective> value of an <Employee> item. The value is calculated as a weighted average of the amount of objectives that are assigned to a specific employee.
Access Read only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Employees>, <Cost Object 1>, <Cost Object 2>
3.8.3 LineItemCalculatedFixedValue Grid Value
Description A calculated cost associated with a <Line Item> that remains unaffected by the results of any Driver Analysis. It comprises the Fixed value plus the non-variable value of the <Line Item>. For the purposes of Driver Analysis, LineItemValue is considered to have the following breakdown.
LineItemValue = (Fixed Value + Non-Variable Value) + Variable Value
where
LineitemCalculatedFixedValue = (Fixed Value + Non-Variable Value)
For example, if a LineItemValue is 11000, with a Fixed Value of 3000 and a Variability of 75 (representing 75%) then
Variable Value = (11000 - 3000) * 75/100 = 6000
Non-Variable Value = (11000 -3000) * 25/100 = 2000
LineitemCalculatedFixedValue = Fixed + Non-Variable = (3000 + 2000) = 5000
LineItemValue = LineitemCalculatedFixedValue+ Variable Value = 5000+6000=11000
Access Read Only
118 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>
Related Information
LineItemFixedValue Grid Value [page 120]LineItemFixedValue Grid Value [page 120]LineItemValue Grid Value [page 121]LineItemVariability Grid Value [page 121]
3.8.4 LineItemDetailValue Grid Value
Description A currency value associated with a particular <Line Item Detail> identified through the dimension items shown below. Values of this type have a currency conversion applied to them when viewed in a grid. If you do not want this to be applied you should use the LineItemDetailValueNC Grid Value.
When <Line Items> have a range of characteristics that can influence their value, this grid value can be used to represent some of these. LineItemDetailValueNC Grid Value and LineItemDetailDataValue Grid Value can also be used in this way. These provide a rich basis for constructing rules to compute the values of complex <Line Items>.
Access Leaf Items:
Read/Write - if not calculated by a Rule
Read Only - if calculated by a Rule
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Line Item Details>
Related Information
Access Rights [page 23]LineItemDetailDataValue Grid Value [page 90]LineItemDetailValueNC Grid Value [page 120]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 119
3.8.5 LineItemDetailValueNC Grid Value
Description A non-currency value associated with a particular <Line Item Detail> identified through the dimension items shown below. (Non-currency items have no currency conversion applied to them when they are viewed through a grid).
When <Line Items> have a range of characteristics that can influence their value, this grid value can be used to represent some of these. LineItemDataValue Grid Value and LineItemDetailDataValue Grid Value can also be used in this way. These provide a rich basis for constructing rules to compute the values of complex <Line Items>.
Access Leaf Items:
Read/Write - if not calculated by a Rule
Read Only - if calculated by a Rule
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Line Item Details>
Related Information
Access Rights [page 23]LineItemDataValue Grid Value [page 89]
3.8.6 LineItemFixedValue Grid Value
Description A cost associated with a <Line Item> that represents a portion of the LineItemValue that is to remain unchanged by any Driver Analysis calculations. The remainder of the LineItemValue is available for change depending on its LineItemVariability Grid Value.
Access Leaf Items
Read/Write – cannot be set by a rule.
Consolidated Totals – Read Only
120 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>
3.8.7 LineItemValue Grid Value
Description The cost associated with a particular <Line Item> identified through the dimension items shown below. This is primarily used to represent a General Ledger value, but may also be a calculated value resulting from associated rules. This is an input cost in any Cost Analysis.
Access Leaf Items:
Read/Write - if not calculated by a Rule
Read Only - if calculated by a Rule
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>
Related Information
Access Rights [page 23]
3.8.8 LineItemVariability Grid Value
Description A value used in Driver Analysis that represents a percentage. It is used in conjunction with the non-fixed portion of a LineItemValue to calculate the proportion that can be affected by the Driver Analysis.
NoteThe LineItemFixedValue Grid Value limits the amount of LineItemValue available to this percentage. The resulting variable value that is available for change is:
variable value = (LineItemValue – LineItemFixedValue) * Line ItemVariability/100
Range: 0-100, by default 100 representing 100%.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 121
Access Read/Write – cannot be set by a rule.
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Line Items>
Related Information
LineItemCalculatedFixedValue Grid Value [page 118]LineItemFixedValue Grid Value [page 120]LineItemFixedValue Grid Value [page 120]LineItemValue Grid Value [page 121]
3.8.9 SpreadValue Grid Value
Description This identifies individual values in a set that is spread across a range of periods in a specific <Version>. See “Data Spreading” in the Profitability and Cost Management User Help for further information.
Access Leaf Items:
Read/Write - if not calculated by a Rule
Read Only - if calculated by a Rule
Consolidated Totals – Read Only
Dimensions <Versions>, <Periods>, <Spreads>
Related Information
Access Rights [page 23]
3.8.10 UOMFactor Grid Value
In a Bill of Materials model, UOMFactor replaces the CurrencyRate Grid Value.
122 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Description UOMFactor is a multiplier that defines how many units of a specific UOM (unit of measure) equate to one unit of your base UOM. Different UOMFactor values can be set for all combinations of <Versions>, <Periods>, and <Units Of Measure> either by directly inputting a value or by using the <Units Of Measure> item Detailed Rule.
The default Base UOM is NON, which has a UOMFactor of 1, but you can create a new Unit Of Measure as your Base UOM by assigning it a rate of 1. Then any other Units Of Measure you define can be given rates that are relative to your base.
Access Read/Write - if not calculated by a Rule
Read Only - if calculated by a Rule
Dimensions <Versions>, <Periods>, <Units Of Measure>
Related Information
CurrencyRate Grid Value [page 117]
3.8.11 WorkSheetValue Grid Value
Description This is the value of a single element in a 2-dimensional array, derived from a combination of both <Work Sheets 1> and< Work Sheets 2> dimension items in a specific <Responsibility Center>, <Version>, and <Period>.
<Work Sheets> are not used directly in the Cost Analysis of a Profitability and Costing model, but can be used in conjunction with rules to affect other dimension values such as <Line Items>, which are part of the Cost Analysis.
Access Leaf Items:
Read/Write - if not calculated by a Rule
Read Only - if calculated by a Rule
Consolidated Totals – Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Work Sheets 1>, <Work Sheets 2>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 123
Related Information
Access Rights [page 23]
3.9 Icon and Color Grid Values
The Grid values held under the Icon and Color Values category are described in the following topics.
3.9.1 EmployeeResultDataColor Grid Value
Description This holds the Color value associated with the Result data of an <Employee> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Employees>, <Cost Object 1>, <Cost Object 2>
3.9.2 EmployeeResultIcon Grid Value
Description This holds the Icon associated with the Result values of an <Employee> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Employees>, <Cost Object 1>, <Cost Object 2>
3.9.3 EmployeeResultRangeColor Grid Value
Description This holds the Color value associated with ranges of the Result values of an <Employee> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Employees>, <Cost Object 1>, <Cost Object 2 >
124 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.9.4 MetricAchievementIcon Grid Value
Description This value holds the Icon associated with the Achievement values of a <Metric> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
3.9.5 MetricAchievementDataColor Grid Value
Description This value holds the Color value associated with the Achievement data of a <Metric> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2 >
3.9.6 MetricAchievementRangeColor Grid Value
Description This value holds the Color value associated with ranges of Achievement values of a <Metric> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
3.9.7 MetricTotalActualDataColor Grid Value
Description This value holds the Color value associated with the Total Actual data of a <Metric> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2 >
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 125
3.9.8 MetricTotalActualIcon Grid Value
Description This value holds the Icon associated with the Total Actual values of a <Metric> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2 >
3.9.9 MetricTotalActualRangeColor Grid Value
Description This value holds the Color value associated with ranges of Total Actual values of a <Metric> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
3.9.10 ObjectiveAchievementDataColor Grid Value
Description This value holds the Color value associated with the Achievement data of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.9.11 ObjectiveAchievementIcon Grid Value
Description This value holds the Icon associated with the Achievement values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>,< Cost Object 2 >
126 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.9.12 ObjectiveAchievementRangeColor Grid Value
Description This value holds the Color value associated with ranges of Achievement values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.9.13 ObjectiveLinkedResultDataColor Grid Value
Description This holds the Color value associated with the Linked Result data of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.9.14 ObjectiveLinkedResultIcon Grid Value
Description This holds the Icon associated with the Linked Result values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1,> <Cost Object 2>
3.9.15 ObjectiveLinkedResultRangeColor Grid Value
Description This holds the Color value associated with Linked Result values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 127
3.9.16 ObjectiveMetricAchievementDataColor Grid Value
Description This holds the Color value associated with the <Metric> Achievement data of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.9.17 ObjectiveMetricAchievementIcon Grid Value
Description This holds the Icon associated with the <Metric> Achievement values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.9.18 ObjectiveMetricAchievementRangeColor Grid Value
Description This holds the Color value associated with ranges of <Metric> Achievement values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.9.19 ObjectiveResultDataColor Grid Value
Description This holds the Color value associated with the Result data of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2 >
128 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.9.20 ObjectiveResultIcon Grid Value
Description This holds the Icon associated with the Result values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.9.21 ObjectiveResultRangeColor Grid Value
Description This holds the Color value associated with ranges of the Result values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.9.22 ObjectiveTotalActualDataColor Grid Value
Description This holds the Color value associated with the Total Actual data of a <Metric> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.9.23 ObjectiveTotalActualIcon Grid Value
Description This holds the Icon associated with the Total Actual values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 129
3.9.24 ObjectiveTotalActualRangeColor Grid Value
Description This holds the Color value associated with ranges of the Total Actual values of an <Objective> item identified through the dimension items shown below.
Access Read/Write
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.10 Metric Grid Values
The Grid values held under the Metric Values category are described in the following topics.
3.10.1 MetricAchievementValue Grid Value
Description This is a calculated value that represents the Achievement value, as a percentage, of a <Metric> item identified through the dimension items shown below. By default this will be calculated by the Achievement Rule associated with the <Metric> which by default uses the DefaultMetricAchievementValue function . An alternative rule can be created where necessary. Center is Best measures would use the DefaultMetricCenterAchievementValue function or some appropriate equivalent.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
Related Information
DefaultMetricAchievementValue [page 231]DefaultMetricCenterAchievementValue [page 232]
130 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.10.2 MetricActualAdjustmentValue Grid Value
Description This value holds an adjustment to the Actual value of a <Metric> item identified through the dimension items shown below. This value can also be a calculated value resulting from associated rules.
Access Leaf Items:
Read/Write
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
3.10.3 MetricActualValue Grid Value
Description This holds the value of a <Metric> item identified through the dimension items shown below. This may also be a calculated value resulting from associated rules.
Access Leaf Items:
Read/Write - if not calculated by an Actual Rule
Read Only - if calculated by an Actual Rule
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>,< Metrics>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 131
3.10.4 MetricBasePointValue Grid Value
Description This value holds the Basepoint value of a <Metric> item identified through the dimension items shown below. This value can also be a calculated value resulting from an associated rule.
Access Leaf Items:
Read/Write - if not calculated by a BasePoint Rule
Read Only - if calculated by a BasePoint Rule
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
3.10.5 MetricTargetAdjustmentValue Grid Value
Description This value holds an adjustment to the Target value of a <Metric> item identified through the dimension items shown below.
Access Leaf Items:
Read/Write
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
3.10.6 MetricTargetValue Grid Value
Description This value holds the target value of a <Metric> item identified through the dimension items shown below. This value can also be a calculated value resulting from an associated rule.
Access Leaf Items:
132 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Read/Write - if not calculated by a Target Rule
Read Only - if calculated by a Target Rule
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
3.10.7 MetricTotalActualValue Grid Value
Description This is a value calculated by the application that holds the total Actual value, including any Adjustment, of a <Metric> item identified through the dimension items shown below.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
3.10.8 MetricTotalTargetValue Grid Value
Description This is a value calculated by the application that holds the total Target value, including any Adjustment, of a <Metric> item identified through the dimension items shown below.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
3.10.9 MetricVarianceValue Grid Value
Description This is a calculated value that holds the difference between Total Target and Total Actual values of a <Metric> item identified through the dimension items shown below.
Access Read Only
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 133
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Metrics>, <Cost Object 1>, <Cost Object 2>
3.11 Objective Grid Values
The Grid values held under the Objective Values category are described in the following topics.
3.11.1 ObjectiveAchievementValue Grid Value
Description This is a calculated value that represents the Achievement value, as a percentage, of an <Objective> identified through the dimension items shown below. By default this will be calculated by the Achievement Rule associated with the <Objective> which by default uses the DefaultObjectiveAchievementValue function. An alternative rule can replace the default if required. Center is Best measures should use the DefaultObjectiveCenterAchievementValue function or some appropriate equivalent.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2 >
Related Information
DefaultObjectiveAchievementValue [page 236]DefaultObjectiveCenterAchievementValue [page 236]
3.11.2 ObjectiveActualAdjustmentValue Grid Value
Description This value holds an adjustment to the Actual value of an <Objective> item identified through the dimension items shown below.
Access Leaf Items:
Read/Write
134 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
3.11.3 ObjectiveActualValue Grid Value
Description This holds the value of an <Objective> item identified through the dimension items shown below. This may also be a calculated value resulting from associated rules.
Access Leaf Items:
Read/Write - if not calculated by an Actual Rule
Read Only - if calculated by an Actual Rule
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
3.11.4 ObjectiveBasePointValue Grid Value
Description This holds the Basepoint value of an <Objective> item identified through the dimension items shown below. This may also be a calculated value resulting from an associated rule.
Access Leaf Items:
Read/Write - if not calculated by a BasePoint Rule
Read Only - if calculated by a BasePoint Rule
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 135
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
3.11.5 ObjectiveLinkedResultValue Grid Value
Description This holds the Linked Result Value of an <Objective> item identified through the dimension items shown below. It is a calculated value derived from the weighted ObjectiveTotalActualValue of each linked <Objective> component.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.11.6 ObjectiveMetricResultValue Grid Value
Description This holds the Linked <Metric> Result Value of an <Objective> item identified through the dimension items shown below. It is a calculated value derived from the weighted MetricTotalActualValue of each linked <Objective> component.
Access Read Only
Dimensions <Versions>,< Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.11.7 ObjectiveResultValue Grid Value
Description This holds the Result Value of an <Objective> item identified through the dimension items shown below. It is a calculated value that is obtained through the Result Value rule associated with an <Objective>. By default this uses the
136 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
function DefaultObjectiveResultValue, although this can be replaced by an alternative where specific treatment is required.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
DefaultObjectiveResultValue [page 236]
3.11.8 ObjectiveTargetAdjustmentValue Grid Value
Description This holds an adjustment to the Target value of an <Objective> item identified through the dimension items shown below.
Access Leaf Items :
Read/Write
Consolidated Totals - Read Only
Dimensions < Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
3.11.9 ObjectiveTargetValue Grid Value
Description This holds the target value of an <Objective> item identified through the dimension items shown below. This may also be a calculated value resulting from associated rules.
Access Leaf Items:
Read/Write - if not calculated by a Target Rule
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 137
Read Only - if calculated by a Target Rule
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
3.11.10 ObjectiveTotalActualValue Grid Value
Description This is a calculated value that holds the total Actual value, including any Adjustment, of an <Objective> item identified through the dimension items shown below.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.11.11 ObjectiveTotalTargetValue Grid Value
Description This is a calculated value that holds the total Target value, including any Adjustment, of an <Objective> item identified through the dimension items shown below.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Cost Object 1>, <Cost Object 2>
3.12 Service Related Grid Values
The Grid values held under the Service Related category are described in the following topics.
138 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.12.1 ServiceCost Grid Value
Description This is a calculated value. It is the consumption cost of a <Service> in a particular <Responsibility Center> for a specific <Version> and <Period>.
For a Variable Rate <Service>, this cost is a proportion of the total cost of providing the <Service>, where the proportion is the number of units consumed by the <Responsibility Center> divided by the total number of units consumed by all.
For a Fixed Rate <Service>, the cost is simply the number of units consumed multiplied by the ServiceFixedUnitRate.
The ServiceVariableFactor value determines whether a <Service> is Variable or Fixed. If it is zero the <Service> is Fixed, otherwise it is Variable.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>
3.12.2 ServiceFixedUnitRate Grid Value
Description This value is the cost of a single unit of a Fixed Rate <Service> for a particular <Version> and <Period>. It can be set for the <Responsibility Center> that provides the service and is then fixed for the <Responsibility Centers> that consume it. For a Fixed Rate <Service>, service costs are calculated as the number of units used multiplied by this value. This value is ignored by Variable Rate <Services>.
Access Leaf Items
Read/Write for provider <Responsibility Center>
Read Only for consumer <Responsibility Centers>
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 139
3.12.3 ServiceIncome Grid Value
Description This is a calculated value that gives the income that a <Service> Provider (<Responsibility Center>) receives for a specific <Service> from its consumers in a particular <Version> and <Period>.
Access Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Services>
3.12.4 ServiceUnitRate Grid Value
Description This is the cost of a single unit of a Variable Rate <Service> in a particular <Version> and <Period>. It is calculated as the Variable Rate Cost Value / Service Driver Value * Service Variable Factor.
NoteVariable Rate Costs are determined through the <Service> rule called Variable Rate Cost Value.
Access Read Only
Dimensions <Version>, <Period>, <Responsibility Center>, <Service>
3.12.5 ServiceVariableFactor Grid Value
Description The ServiceVariableFactor value determines whether a <Service> is Variable or Fixed. A Variable Factor of zero indicates that the <Service> has a fixed cost, as determined by the ServiceFixedUnitRate. A Variable Factor of 1 specifies that the <Service> cost equates to the level of service consumption.
Any other value is a proportional relationship of cost to consumption, for example, if the service variable factor is 2, and the service user consumes 1 unit they will receive a charge equal to twice the service cost.
140 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
The variable factor is useful for relating the <Service> cost to consumption, so that as more people consume the <Service> the costs to all the users is lowered proportionally.
Dimensions <Version>, <Period>, <Responsibility Center>, <Service>
Access Leaf Items - Read/Write
Related Information
ServiceFixedUnitRate Grid Value [page 139]
3.13 Weighting Grid Values
The Grid values held under the Weighting Values category are described in the following topics.
3.13.1 ObjectiveMetricWeightingPctValue Grid Value
Description This calculated value represents the percentage Weighting value of a <Metric> item that has been assigned to an <Objective> through the Objectives/Metrics Assignment screen. The <Metric> item and the <Objective> it is assigned to are identified through the dimension items shown below.
This weighting value is interpreted as a proportion of the aggregated total of the weighting values of all <Metrics> that contribute to an <Objective>.
NoteBy default the weightings of <Linked Objectives> are equally distributed
Access Read Only
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 141
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Metrics>, <Cost Object 1>, <Cost Object 2 >
3.13.2 ObjectiveMetricWeightingValue Grid Value
Description This specifies a value that is interpreted as the Weighting value of a <Metric> that has been assigned to an <Objective> through the Objectives/Metrics Assignment screen. The <Metric> item and the <Objective> it is linked to are identified through the dimension items shown below. This value may also be a calculated through an <Objective> Weighting Rule.
ObjectiveMeticWeightingPctValue will automatically reflect the percentage contribution of each <Metric>.
NoteBy default the <Metric> weightings are equally distributed.
Access Leaf Items:
Read/Write - if not calculated by an <Objective> Weighting Rule
Read Only - if calculated by an <Objective> Weighting Rule
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Metrics>,< Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
142 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
3.13.3 ObjectiveWeightingValue Grid Value
Description This specifies a value that is interpreted as the Weighting value of a <Linked Objective>. The Linked item and the <Objective> it is linked to are identified through the dimension items shown below. This value may also be a calculated through an associated Weighting Rule.
ObjectiveWeightingPctValue will automatically reflect the percentage contribution of each <Linked Objective>.
NoteBy default the weightings of <Linked Objectives> are equally distributed.
Access Leaf Items:
Read/Write - if not calculated by a Weighting Rule
Read Only - if calculated by a Weighting Rule
Consolidated Totals - Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Objectives>, <Linked Objectives>, <Cost Object 1>, <Cost Object 2>
Related Information
Access Rights [page 23]
3.14 Grid Value Dependencies
In activity-based costing (ABC), a number of grid values are dependent on others. The Cost Tracing feature in View Builder takes these dependencies into account to trace the source or target of grid values.
The following diagram illustrates how costs are traced in ABC between sources and targets and the grid values dependencies that are involved; this is further explained in the text that follows:
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 143
Trace from LineItemValue values to target
LineItemValue values for non-<Cost Object> type <Line Items> are allocated to <Activities> via ratios determined by ResourceDriverValue values. The resulting values are ActivityLineItemValue values.
LineItemValue values for <Cost Object> type <Line Items> are allocated to <Cost Objects> via ratios determined by ActivityDriverValue values. The resulting grid values are DirectCostObjectValue values.
Trace from ActivityLineItemValues values to target
ActivityLineItemValue values are allocated to <Cost Objects> via ratios determined by ActivityDriverValue values. The resulting values are CostObjectValue values.
Trace to the source of ActivityCostObjectValue values
ActivityCostObjectValue values are a consolidation of all <Cost Objects> values, summarized by <Activity>. These values are a consolidation of contributing ExternalCostObjectValue values and CostObjectValue values.
144 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Grid Values
Trace to the source of LineItemCostObjectValue values
LineItemCostObjectValue values are a consolidation of all <Cost Object> values, summarized by <Line Item>. These values are a consolidation of contributing ExternalCostObjectValue values, DirectCostObjectValue values, and CostObjectValue values.
Trace to the source of <SummaryCostObjectValue> values
SummaryCostObjectValue values are a consolidation of contributing ExternalCostObjectValue values.
Trace to the source of SummaryActivityValue values
SummaryActivityValue values are a consolidation of contributing ActivityValue values, ReasssignedActivityLineItemValue values, and ExternalActivityValue values.
Trace to the source of ActivityLineItem values
ActivityLineItemValue values are the costs resulting from allocating the LineItemValue using the ratios calculated from the associated ResourceDriverSplit and ResourceDriverValue values.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideGrid Values P U B L I C 145
4 Predefined Model Functions
Rules can be created and associated with specific dimension items. They are written in VBScript and can include the use of predefined functions, user-defined functions, input values, and constant values.
Predefined functions are available in the Rules Editor from the Function Name list, in which the functions are grouped into categories. We present the same groupings in this document
Predefined functions for Profitability and Costing and Transactional Costing type models exist under the following categories:
● General Functions● Driver Value Functions● Activity Value Functions● Service Value Functions● Cost Object Value Functions● Delta Value Functions● Structure Functions
Predefined functions for Objectives and Metrics type models exist under the following categories:
General FunctionsMetric Value FunctionsObjective Value FunctionsBoundary Value FunctionsIcon and Color Value FunctionsStructure Functions
Where a specific function is available to only specific model types, this is noted in the relevant topic.
NoteThe return values from these functions impose some handling limitations on VBScript that you need to understand.
Related Information
Return Values [page 146]
4.1 Return Values
All of the values returned from these functions are of the Variant data type, which is a general data type that can hold any type of data. Many of the functions in a Profitability and Costing model will return a figure, a cost, an EPO
146 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
CODE, or a name. In order to assist you in understanding which specific data type is actually represented by the variant return value, we have defined the function’s return value in more detail.
Functions that return values will present these as decimals but can also return “Empty”. This should be borne in mind when using these return values in numeric calculations in VBScript, due to its methods of data conversion. For example, consider the following VB arithmetic calculations involving an empty Return Value.
NumericValue + “Empty” produces a NumericValue
“ Empty ”+ NumericValue produces “Empty”
As a result, we advise you use the construct, in this case 0 + Return Value, when you wish to ensure a correct numeric result.
4.2 General Functions
The Predefined Functions held under the General category are described in the following topics.
Each of these functions returns a value that may require special handling. The types of values that can be returned by SAP BusinessObjects Profitability and Cost Management functions have been defined in the appendix.
Related Information
Return Values [page 146]Function Data Type Variants [page 373]
4.2.1 AverageConsolidate
Description This function is usually found in consolidation rules. It returns the average item value of the children in a group item. Children that are group items will contribute their average to the parent group.
Parameters Dimension Name
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 147
4.2.2 CalculateSlice
Description This function does not appear in the drop-down list of predefined functions in the Rules Editor. It is selected through the Insert Function option in the Rules Editor.
This function returns the number of cells in the slice of data defined by the parameters. The first parameter specifies the Grid Value you want and the remaining parameters define the range of the slice, in terms of the key dimensions of the specified Grid Value. Two of these dimensions allow you specify the range of items you want to include under a specific parent item. These are defined by the Dimension and Depth parameters for Rows and Columns. The remaining key dimensions associated with your specified Grid Value allow you only to identify a particular item in each dimension; no range option is provided for these.
NoteAll parameters have to be specified; none can be left out. If no user-defined items exist in a dimension you should use the Unassigned or top-level item.
Parameters Grid Value Field ID, Row Dimension, Row Depth, Column Dimension, Column Depth
List of the remaining key dimension items for the specified Grid Value ID.
Returns Number of cells in the slice (decimal). All values included in the slice are calculated on separate threads. You can use ActiveCalculateSlices to display the number of active processes.
Related Information
Constant Names and Values [page 374]ActiveCalculateSlices [page 250]
148 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.2.3 CellMemo
Description Returns the memo string associated with a specific grid cell. Each cell has a specific Grid Value and memos can be recorded according to both Grid Value and cell.
Parameters Table Field, Grid Value parameters
Returns String
4.2.4 Consolidate
Description This is a function used by built-in code that is not for general use. It returns the Consolidated total of a group item, according to the consolidation type of the group item. Children that are group items will also be consolidated according to their individual consolidation types.
Parameters Dimension Name
Returns Decimal
4.2.5 CurrencyRate
Description Returns the value of the CurrencyRate for the specified parameters. The value returned is that which has been set in the Currency Rate detailed rule. A different currency rate can be set for each <Version> and <Period>, if required.
Parameters <Version>, <Period>, <Currency>
Returns Decimal
Related Information
CurrencyRate Grid Value [page 117]
4.2.6 LineItemCalculatedFixedValue
Description This function is not available for Objectives and Metrics type models. Returns the
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 149
LineItemCalculatedFixedValue for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, Line Item
Returns Decimal
Related Information
LineItemCalculatedFixedValue Grid Value [page 118]
4.2.7 LineItemDataValue
Description This function is not available for Objectives and Metrics type models. Returns the Data value for the <Line Item> specified by the dimension items listed below.
Parameters <Version>, <Period>,< Responsibility Center>, <Line Item>
Returns Decimal
Related Information
LineItemDataValue Grid Value [page 89]
4.2.8 LineItemDetailDataValue
Description This function is not available for Objectives and Metrics type models. Returns the Data value for the <Line Item Detail> item specified by the dimension items listed below. The <Line Item Detail> Data value is always referenced through an associated <Line Item>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item Detail>, <Line Item>
Returns Decimal
150 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Related Information
LineItemDetailDataValue Grid Value [page 90]
4.2.9 LineItemDetailValue
Description This function is not available for Objectives and Metrics type models. Returns the <Line Item Detail> value for the specified dimension items listed below. The <Line Item Detail> value is always referenced through an associated Line Item.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item Detail>, <Line Item>
Returns Decimal
Related Information
LineItemDetailValue Grid Value [page 119]
4.2.10 LineItemDetailValueNC
Description This function is not available for Objectives and Metrics type models. Returns the non-currency <Line Item Detail> value for the specified dimension items listed below. The <Line Item Detail> value is always referenced through an associated Line Item.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>
Returns Decimal
Related Information
LineItemDetailValueNC Grid Value [page 120]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 151
4.2.11 LineItemFixedValue
Description This function is not available for Objectives and Metrics type models. Returns the fixed value for the <Line Item> specified by dimension items listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>
Returns Decimal
Related Information
LineItemFixedValue Grid Value [page 120]
4.2.12 LineItemOriginalValue
Description This function is not available for Objectives and Metrics type models. This used in a Driver Analysis to return the original value for the <Line Item> specified by dimension items listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>
Returns Decimal
Related Information
LineItemOriginalValue Grid Value [page 108]
4.2.13 LineItemValue
Description This function is not available for Objectives and Metrics type models. Returns the <Line Item> value for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>
Returns Decimal
152 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.2.14 LineItemVariability
Description This function is not available for Objectives and Metrics type models. Returns the variability value of the Line Item for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>
Returns Decimal
Related Information
LineItemVariability Grid Value [page 121]
4.2.15 ModelValue
Description Returns the current value of a specified item from another model. This function is selected through the Insert Function option in the Rule Editor and does not appear in the drop down list of Functions. The Insert Function screen has a model selection field, which will automatically select this function when you specify any Profitability and Costing model other than the current one. You will then be able to select any Function from the drop down list followed by its specific parameters. A FieldID is generated for the Function you select.
NoteThe system maintains an internal dependency list of models so that if a value is changed in a source model, the target model is aware that it needs to check for that change and reflect that change in any results. For this to happen in real time, the model reference used in the rule function must be explicit and not a calculated value.
For more information on this function see the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Parameters Model Name, Item FieldID, Item Dimension1, Item Dimension2
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 153
4.2.16 PeriodPct
Description This is intended for use purely as a <Period> rule and provides the means to calculate the percentage in grid values between two <Periods>.
Example For example, to calculate the percentage values of two periods, Period1 and Period2, in another period called Period1Period2Pct, you might write a <Period> rule:
Function CellValue CellValue = PeriodPct("Period1","Period2")End Function
This will perform the automatic calculation
SafeDivide("Period1" * 100,"Period2")
on any required values in the Period1Period2Pct Period.
Currency is unaffected by this calculation and can be controlled through a Currency rule script.
Parameters <Period>, <Period>
Returns Decimal
4.2.17 PeriodValue
Description PeriodValue is primarily used to support the automatic calculation of variance values relating to a specific version. It will normally be part of a rule associated with a <Period> item that is intended to represent some variance that is to be applied to all the values in the specified version.
Example For example, to calculate the variance of two <Periods>, Period1 and Period2, in another period called Period1Period2Variance, you might write a rule like this:
Function CellValue CellValue = PeriodValue("Period1") - PeriodValue("Period2") End Function
Currency If the currency rate is calculated by a <Currency> rule then it will affect the value shown. The example above demonstrates the effect of applying a Currency Rate rule to display the
154 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
variance value as half of the base values used in Period1 and Period2 <Periods>.
Calculation When a cell value is calculated, the order of precedence in calculating dimensions is:
<VERSION>, <PERIOD>, <RESPONSIBILITY CENTER>, OTHER KEY ITEMS required by the cell in order to calculate the value requested.
If two <Periods> are being compared via a PeriodValue rule to produce a variance then the value of each <Period> will be calculated in the order shown above. Once the value of each <Period> has been established, the variance can be calculated.
Performance There is little performance overhead in using a PeriodValue rule despite the fact that it must calculate the variance of everything in the model. As a Profitability and Costing model calculates on demand (that is, whenever a value is shown in a grid, or is called from a rule) and caches calculated results there is a high degree of probability that the values for the periods being compared are already available to the variance calculation, and so the results will be presented quickly.
Method of calculating variance An alternative to using the PeriodValue function is to place a variance item as the parent of the two <Periods> that you wish to compare. You can then set one period to a sum consolidation type, and the other to subtract. Then the parent item will contain the difference between the two. This method is not as flexible as a PeriodValue rule, but it is easy to set up.
Parameters <Period >
Returns Decimal
4.2.18 PeriodPctVariance
Description This is intended for use purely as a <Period> rule and provides the means to calculate the percentage differences in grid values between two <Periods>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 155
Example For example, to calculate the percentage variance of two <Periods>, Period1 and Period2, in another period called Period1Period2PctVariance, you might write a <Period> rule:
Function CellValue CellValue = PeriodPctVariance("Period1","Period2")End Function
This will perform the automatic calculation
SafeDivide(("Period1" – "Period2") * 100,"Period2")
on any required values in the Period1Period2PctVariance Period.
<Currency> is unaffected by this calculation and can be controlled through a <Currency> rule script.
Parameters <Period>, <Period>
Returns Decimal
4.2.19 PeriodVariance
Description This is intended for use purely as a <Period> rule and provides the means to calculate the differences in grid values between two <Periods>.
Example For example, to calculate the variance of two <Periods>, Period1 and Period2, in another period called Period1Period2Variance, you might write a <Period> rule:
Function CellValue CellValue = PeriodVariance("Period1","Period2")End Function
This will perform the automatic calculation
("Period1" - "Period2")
on any required values in the Period1Period2Variance Period.
<Currency> is unaffected by this calculation and can be controlled through a Currency rule script.
Returns Decimal
Parameters <Period>, <Period>
156 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.2.20 RunDefaultRule
Description Runs the default rule defined for the currently selected rule type for the current dimension item. This could be used in a rule to run the default rule in some circumstances and alternative scripts in others.
Parameters None
Returns Decimal
4.2.21 SafeDivide
Description Returns the result of Numeric Value 1 divided by Numeric Value 2 avoiding the problem caused by arithmetic overflow when Numeric Value 2 is zero, null or empty. In the case of an invalid divisor the function returns a value of zero.
Parameters Numeric Value 1, Numeric Value 2
Returns Decimal
4.2.22 SpreadDataValue
Description This function is not available to Objectives and Metrics models. Returns the Data value for the <Spread> specified by the dimensions listed below. Although the <Spread> dimension was designed to contain values that are to be calculated across time, in fact this dimension can contain any calculated or input values that only need to be dimensioned by <Version> and <Period>, thus making it ideal for producing fast calculations.
Parameters <Version>, <Period>, <Spread>
Returns Decimal
Related Information
SpreadValue Grid Value [page 122]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 157
4.2.23 SpreadValue
Description Returns the value for the specified <Spread> for a particular <Version> and <Period> combination. The <Spread> dimension is intended to support a range of values across different time slots, through the <Versions> and <Periods> dimensions.
Parameters <Version>, <Period>, <Spread>
Returns Decimal
Related Information
SpreadValue Grid Value [page 122]
4.2.24 StoredModelValue
Description Returns the stored value of a specified item in another model. This function is selected through the Insert Function option in the Rule Editor and does not appear in the drop down list of Functions. The Insert Function screen has a model selection field, which will automatically select this function when you specify any model other than the current one. You will then be able to select any Function from the drop down list followed by its specific parameters. A FieldID is generated for the function you select.
Parameters Model Name, Item FieldID, Item Dimension1, Item Dimension2
Returns Decimal
4.2.25 VersionPct
Description This is intended for use purely as a <Version> rule and provides the means to calculate the percentage differences in grid values between two versions.
Example For example, to calculate the percentage variance of two <Versions> – Actual and Budget – in another version called ActualBudgetPct, you might write a version rule:
Function CellValue
158 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
CellValue = VersionPct("Actual","Budget") End Function
This will perform the automatic calculation:
SafeDivide("Actual" * 100,"Budget")
on all required values in the “ActualBudgetPct” version.
Currency is unaffected by this calculation and can be controlled through a Currency rule script.
Parameters <Version>, <Version>
Returns Decimal
4.2.26 VersionPctVariance
Description This is intended for use purely as a <Version> rule and provides the means to calculate the percentage differences in grid values between two versions.
Example For example, to calculate the percentage variance of two <Versions>, Actual and Budget, in another version called ActualBudgetPctVariance you might write a version rule:
Function CellValue CellValue = VersionPctVariance("Actual","Budget")End Function
This will perform the automatic calculation
SafeDivide(("Actual" – "Budget") * 100,"Budget")
on any required values in the ActualBudgetPctVariance version.
Currency is unaffected by this calculation and can be controlled through a Currency rule script.
Parameters <Version>, <Version>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 159
4.2.27 VersionPeriodValue
Description This operates in the same way as the Grid Values VersionValue and PeriodValue, but refines the granularity to a specific <Version>/<Period> combination. It will normally be part of a rule associated with a Timeline. It can be used to represent variance of all values between one Timeline and another.
Parameters <Version>
Returns Decimal
4.2.28 VersionValue
Description VersionValue is primarily used to support the automatic calculation of variance values relating to a specific <Version>. It will normally be part of a rule associated with a <Version> item that is intended to represent some variance that is to be applied to all the values in the specified version.
Example For example, to calculate the variance of two <Versions>, Actual and Budget, in another <Version> called ActualBudgetVariance, you might write a rule like this:
Function CellValue CellValue = VersionValue("Actual") - VersionValue("Budget") End Function
You are now in a position to view the variance of any values in your model by constructing a view in View Builder that will display the values you want against the Actual, Budget and ActualBudgetVariance <Versions>.
The variance in <Cost Object> Costs, <Line Item> values, <Activity> values, and all other values in your model can be displayed in this way.
Currency If the <Currency> rate is calculated by a <Currency> rule then it will affect the value shown. The example above demonstrates the effect of applying a <Currency> Rate rule to display the variance value as half of the base values used in Actual and Budget <Versions>.
Calculation When a cell value is calculated the order of precedence in calculating dimensions is:
<VERSION>, <PERIOD>, <RESPONSIBILITY CENTER>, OTHER KEY ITEMS required by the cell in order to calculate the value requested.
160 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
If two <Versions> are being compared via a VersionValue rule to produce a variance then the “value” of each <Version> will be calculated in the order shown above. Once the value of each <Version> has been established then the variance can be calculated.
Performance There is little performance overhead in using a VersionValue rule despite the fact that it must calculate the variance of everything in the model. As a Profitability and Costing model calculates on demand (that is, whenever a value is shown in a grid, or is called from a rule) and caches calculated results there is a high degree of probability that the values for the <Versions> being compared are already available to the variance calculation, and so the results will be presented quickly.
Method of calculating variance An alternative to using the VersionValue function is to place a variance item as the parent of the two versions that you wish to compare. You can then set one version to a "sum" consolidation type, and the other to "subtract". Then the parent item will contain the difference between the two. This method is not as flexible as a VersionValue rule, but it is easy to set up.
Parameters <Version>
Returns Decimal
4.2.29 VersionVariance
Description This is intended for use purely as a <Version> rule and provides the means to calculate the differences in grid values between two <Versions>.
Example To calculate the variance of two <Versions>, Actual and Budget, in another <Version> called ActualBudgetVariance, you might write a <Version> rule:
Function CellValue CellValue = VersionVariance("Actual","Budget")End Function
You are now in a position to view the variance of any values in your model by constructing a view in View Builder that will display the values you want against the Actual, Budget and ActualBudgetVariance <Versions>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 161
The variance in <Cost Object> Costs, <Line Item> values, <Activity> values and all other values in your model is calculated as:
("Actual" - "Budget")
<Currency> is unaffected by this calculation and can be controlled through a <Currency> rule script.
Parameters <Version>, <Version>
Returns Decimal
4.2.30 WorkSheetDataValue
Description Returns the Data value of the specified <Work Sheet>. <Work Sheet> values are paired due to the inter-relationship between <Work Sheets>. A <Work Sheets 1> value must have an associated <Work Sheets 2> value specified, and conversely a Work Sheets 2 value must have a <Work Sheets 1> value specified.
Parameters <Version>, <Period>, <Responsibility Center>, <Work Sheets 1>, <Work Sheets 2>
Returns Decimal
Related Information
WorkSheetDataValue Grid Value [page 102]
4.2.31 WorkSheetValue
Description This function is not available to Objectives and Metrics models. Returns the value of the specified <Work Sheet>. <Worksheet> values are paired due to the inter-relation between <Work Sheets>. A <Work Sheets 1> value must have an associated <Work Sheets 2> value specified, and conversely a <Work Sheets 2> value must have a <Work Sheets 1> value specified.
Parameters <Version>, <Period>, <Responsibility Center>, <Work Sheets 1>, <Work Sheets 2>
162 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Returns Decimal
Related Information
WorkSheetValue Grid Value [page 123]
4.3 Activity Value Functions
The Predefined Functions held under the Activity Values category are described in the following topics.
4.3.1 ActivityFixedValue
Description Returns the non-variable part of the <Line Item> costs that contribute to the <Activities> specified by the parameters listed below. These restrict the selection to <Activities> in specific <Versions>, <Periods>, and <Responsibility Centers> that use specific <Resource Drivers>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Resource Driver>
Returns Decimal
Related Information
ActivityFixedValue Grid Value [page 24]
4.3.2 ActivityLineItemFixedValue
Description Returns the non-variable part of the <Line Item> costs that contribute to the <Activities >in specific <Versions>, <Periods>, and <Responsibility Centers>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 163
Related Information
ActivityLineItemFixedValue Grid Value [page 24]
4.3.3 ActivityLineItemValue
Description Returns the ActivityLineItemValue for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>
Returns Decimal
Related Information
ActivityLineItemValue Grid Value [page 25]
4.3.4 ActivityLineItemVariableValue
Description Returns the variable part of the <Line Item> costs that contribute to the <Activities> in specific <Versions>, <Periods> and <Responsibility Centers>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>
Returns Decimal
Related Information
ActivityLineItemVariableValue Grid Value [page 25]
4.3.5 ActivityUnitRate
Description Returns the ActivityUnitRate value or the specified parameters.
164 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Resource Driver>
Returns Decimal
Related Information
ActivityUnitRate Grid Value [page 26]
4.3.6 ActivityValue
Description Returns the ActivityValue for the specified parameters.
Parameters <Version,> <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Resource Driver>
Returns Decimal
Related Information
ActivityValue Grid Value [page 26]
4.3.7 ActivityVariableValue
Description Returns the variable part of the <Line Item> costs that contribute to the <Activities> specified by the parameters listed below. These restrict the selection to <Activities> in specific <Versions>, <Periods>, and <Responsibility Centers> that use specific <Resource Drivers>.
Parameters <Version,> <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Resource Driver>
Returns Decimal
Related Information
ActivityVariableValue Grid Value [page 27]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 165
4.3.8 ExternalActivityDataValue
Description Returns the Data value for the External <Activity> specified by the parameters listed below
Parameters <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>
Returns Decimal
Related Information
ExternalActivityDataValue Grid Value [page 87]
4.3.9 ExternalActivityFixedValue
Description Returns the Fixed portion of the external costs associated with specific ActivityLineItemValues.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Resource Driver>
Returns Decimal
Related Information
ExternalActivityFixedValue Grid Value [page 27]
4.3.10 ExternalActivityValue
Description Returns the basic value of the external costs associated with specific ActivityLineItemValues.
Parameters <Version>, <Period>, <Responsibility Center,> <Line Item>, <Activity>, <Resource Driver>
Returns Decimal
166 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Related Information
ExternalActivityValue Grid Value [page 28]
4.3.11 ExternalActivityVariableValue
Description Returns the Variable portion of the external costs associated with specific ActivityLineItemValues.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Activity>, <Resource Driver>
Returns Decimal
Related Information
ExternalActivityVariableValue Grid Value [page 28]
4.3.12 ReassignActivityLineItemValue
Description Returns the value of any reassigned <Activity> costs that contribute to the target <Responsibility Centers> and <Activities> from the specified <Responsibility Centers> and <Line Items>.
Parameters <Version>, <Period,> <Responsibility Centers>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
Related Information
ReassignActivityLineItemValue Grid Value [page 29]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 167
4.3.13 ReassignActivityServiceValue
Description Returns the value of any reassigned <Activity> costs that contribute to the target <Responsibility Centers> and <Activities> from the specified <Responsibility Centers> and <Services>.
Parameters <Version>, <Period>, <Responsibility Centers>, <Services>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
Related Information
ReassignActivityServiceValue Grid Value [page 30]
4.3.14 ReassignedFinalValue
Description Returns the balanced final value of reassigned <Activity> costs after all reiterative reallocation and movement has been completed, that contribute to the target <Responsibility Centers> and <Activities> from specified <Responsibility Centers>, <Activities>, and <Line Items>.
Parameters <Version>, <Period>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
Related Information
ReassignedFinalValue Grid Value [page 30]
4.3.15 ReassignedInValue
Description Returns the total value of reassigned <Activity> costs after all reiterative reallocation has been completed, that have been received by the <Target Responsibility
168 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Centers> and <Target Activities> from the specified <Responsibility Centers>, <Activities>, and <Line Items>.
Parameters <Version>, <Period,> <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
Related Information
ReassignedInValue Grid Value [page 31]
4.3.16 ReassignedMoveValue
Description Returns the difference between reassigned <Activity> costs received and dispatched by the <Target Responsibility Centers> and <Target Activities> from specified <Responsibility Centers>, <Activities>, and <Line Items>, after all reiterative reallocation has been completed.
Parameters <Version>, <Period>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
Related Information
ReassignedMoveValue Grid Value [page 32]
4.3.17 ReassignedOutValue
Description Returns the total value of reassigned <Activity> costs dispatched by the <Target Responsibility Centers> and <Target Activities> after all reiterative reallocation has been completed, that originate from specified <Responsibility Centers>, <Activities>, and <Line Items>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 169
Parameters <Version>, <Period>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
Related Information
ReassignedOutValue Grid Value [page 32]
4.3.18 ReassignSplitInValue
Description Returns the percentage of reassigned <Activity> costs received by the <Target Responsibility Centers> and <Target Activities> after all required reiterative reallocations have been performed that originate from specified <Responsibility Centers>, <Activities>, and <Line Items>.
Parameters <Version>, <Period>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
Related Information
ReassignSplitInValue Grid Value [page 33]
4.3.19 ReassignSplitOutValue
Description Returns the percentage of reassigned <Activity> costs dispatched by the <Target Responsibility Centers> and <Target Activities> after all required reiterative reallocations have been performed, that originate from specified <Responsibility Centers>, <Activities>, and <Line Items>.
Parameters <Version>, <Period>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
170 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Returns Decimal
Related Information
ReassignSplitOutValue Grid Value [page 34]
4.3.20 ReassignSplitPostValue
Description Returns the percentage of reassigned <Activity> costs in the <Target Responsibility Centers> and <Target Activities> after all required reiterative reallocations have been performed, that originate from specified <Responsibility Centers>, <Activities>, and <Line Items>.
Parameters <Version>, <Period>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
Related Information
ReassignSplitPostValue Grid Value [page 34]
4.3.21 ReassignSplitValue
Description Returns the percentage of reassigned <Activity> costs received by the <Target Responsibility Centers> and <Target Activities> before any reiterative reallocations have been performed, that originate from specified <Responsibility Centers>, <Activities>, and <Line Items>.
Parameters <Version>, <Period>, <Responsibility Centers>, <Activities>, <Line Items>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 171
Related Information
ReassignSplitValue Grid Value [page 35]
4.3.22 ServiceActivityUnitRate
Description Returns the ServiceActivityUnitRate for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Resource Driver>
Returns Decimal
Related Information
ServiceActivityUnitRate Grid Value [page 36]
4.3.23 ServiceActivityValue
Description Returns the <ServiceActivityValue> for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Resource Driver>
Returns Decimal
Related Information
ServiceActivityValue Grid Value [page 36]
4.3.24 SourceActivityLineItemFixedValue
Description Returns the fixed part of the <Line Item> costs that contribute to the <Target Responsibility Centers> and <Target Activities> from specific <Versions>, <Periods>, and <Responsibility Centers>.
172 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Target Responsibility Center>, <Target Activity>
Returns Decimal
Related Information
SourceActivityLineItemFixedValue Grid Value [page 36]
4.3.25 SourceActivityLineItemValue
Description Returns the <Line Item> costs that contribute to the <Target Responsibility Centers> and <Target Activities> from specific <Versions>, <Periods>, and <Responsibility Centers>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Target Responsibility Center>, <Target Activity>
Returns Decimal
Related Information
SourceActivityLineItemValue Grid Value [page 37]
4.3.26 SourceActivityLineItemVariableValue
Description Returns the variable part of the <Line Item> costs that contribute to the <Target Responsibility Centers> and <Target Activities> from specific <Versions>, <Periods>, and <Responsibility Centers>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Target Responsibility Center>, <Target Activity>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 173
Related Information
SourceActivityLineItemVariableValue Grid Value [page 38]
4.3.27 SummaryActivityFixedValue
Description Returns the non-variable part of all <Line Items> that contribute to the <Activities> specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>
Returns Decimal
Related Information
SummaryActivityFixedValue Grid Value [page 38]
4.3.28 SummaryActivityValue
Description Returns the SummaryActivityValue for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center,> <Activity>
Returns Decimal
Related Information
SummaryActivityValue Grid Value [page 39]
4.3.29 SummaryActivityVariableValue
Description Returns the variable part of all <Line Items> that contribute to the <Activities> specified by the parameters listed below.
174 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>
Returns Decimal
Related Information
SummaryActivityVariableValue Grid Value [page 39]
4.3.30 SummaryMovementValue
Description Returns the Summary MovementValue for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Centers>, <Activities>, <Target Responsibility Centers>, <Target Activities>
Returns Decimal
Related Information
SummaryMovementValue Grid Value [page 40]
4.3.31 SummaryServiceActivityValue
Description Returns the SummaryServiceActivityValue for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>, <Activity>
Returns Decimal
Related Information
SummaryServiceActivityValue Grid Value [page 41]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 175
4.4 Boundary Value Functions
The Predefined Functions held under the Boundary Values category are described in the following topics.
4.4.1 EmployeePercentBoundaryValue Grid Value
Description This specifies a <Boundary> value for an <Employee> item in terms of its Achievement percentages. The item is identified through the dimension items shown below. This value may also be a calculated through associated rules.
Access Leaf Items:
● Read/Write - if not calculated by a Percent <Boundary> Rule
● Read Only - if calculated by a Percent <Boundary> Rule
Consolidated Totals: Read Only
Dimensions <Versions>, <Periods>, <Responsibility Centers>, <Employees>, <Boundaries>
4.4.2 MetricActualBoundaryDataValue
Description Returns the Actual <Boundary> Data Value for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Boundary>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
MetricActualBoundaryDataValue Grid Value [page 90]
176 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.4.3 MetricActualBoundaryValue
Description Returns the Actual <Boundary> Value for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Boundary>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
MetricActualBoundaryValue Grid Value [page 42]
4.4.4 MetricPercentBoundaryDataValue
Description Returns the percentage <Boundary> Data Value for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Boundary>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
MetricPercentBoundaryDataValue Grid Value [page 93]
4.4.5 MetricPercentBoundaryValue
Description Returns the percentage <Boundary> Value for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Boundary>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 177
Related Information
MetricPercentBoundaryValue Grid Value [page 42]
4.4.6 ObjectiveActualBoundaryDataValue
Description Returns the Actual <Boundary> Data Value for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Boundary>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
ObjectiveActualBoundaryDataValue Grid Value [page 94]
4.4.7 ObjectiveActualBoundaryValue
Description Returns the Actual <Boundary> Value for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Boundary>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
ObjectiveActualBoundaryValue Grid Value [page 43]
4.4.8 ObjectivePercentBoundaryDataValue
Description Returns the percentage <Boundary> Data Value for the <Objective> identified by the specified parameters.
178 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Boundary>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
ObjectiveActualBoundaryDataValue Grid Value [page 94]
4.4.9 ObjectivePercentBoundaryValue
Description Returns the percentage <Boundary> Value for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Boundary>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
ObjectivePercentBoundaryValue Grid Value [page 43]
4.5 Cost Object Value Functions
The Predefined Functions held under the Cost Object Values category are described in the following topics.
4.5.1 ActivityCostObjectFixedValue
Description Returns the ActivityCostObjectFixedValue for the specified parameters. These derive from all <Line Items> that contribute to the specified <Activities> in all <Responsibility Centers>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 179
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result, when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ActivityCostObjectFixedValue Grid Value [page 44]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.2 ActivityCostObjectValue
Description Returns the ActivityCostObjectValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
180 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ActivityCostObjectValue Grid Value [page 45]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.3 ActivityCostObjectVariableValue
Description Returns the ActivityCostObjectVariableValue for the specified parameters. These derive from all <Line Items> that contribute to the specified <Activities> in all <Responsibility Centers>.
NoteCostObjectValues are not calculated On Demand due to the large number of Cost Object combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCosatObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 181
Parameters <Versions>, <Periods>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ActivityCostObjectVariableValue Grid Value [page 45]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.4 ConsolidatedPrice
Description Returns the Consolidated Price for the specified <Cost Objects>.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
182 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.5 Contribution
Description Returns the Contribution value for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result, when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
Contribution Grid Value [page 46]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 183
4.5.6 CostObjectFixedValue
Description Returns the non-variable costs that contribute to the <Cost Object> specified by the parameters listed below. These derive from the <Line Items> that contribute through the specified <Responsibility Center> <Activities> to the <Cost Object>.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result, when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.7 DataUnitPrice
Description Returns the Data value for the Unit Price of the <Cost Object> specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects 1>, <Cost Objects
184 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
DataUnitPrice Grid Value [page 85]
4.5.8 CostObjectValue
Description Returns the CostObjectValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
CostObjectValue Grid Value [page 49]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 185
4.5.9 CostObjectVariableValue
Description Returns the Variable costs that contribute to the <Cost Object> specified by the parameters listed below. These derive from the <Line Items> that contribute through the specified <Responsibility Center> <Activities> to the <Cost Object>.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result, when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
CostObjectVariableValue Grid Value [page 50]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.10 DataRevenue
Description Returns the Data value for the Revenue of the <Cost Object> specified by the parameters listed below.
186 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
DataRevenue Grid Value [page 84]
4.5.11 DataUnitsSold
Description Returns the Data value for the Units Sold of the <Cost Object> specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Revenue Type>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
DataUnitsSold Grid Value [page 86]
4.5.12 DirectCostObjectFixedValue
Description Returns the non-variable costs that contribute to the <Cost Object> specified by the parameters listed below. These are part of the <Line Item> costs that contribute directly to the <Cost Object> avoiding any distribution to <Activity> costs.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 187
Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
DirectCostObjectFixedValue Grid Value [page 51]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.13 DirectCostObjectValue
Description Returns the DirectCostObjectValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated
188 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
DirectCostObjectValue Grid Value [page 51]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.14 DirectCostObjectVariableValue
Description Returns the variable costs from <Cost Object Type Line Items> that contribute to the <Cost Object> specified by the parameters listed below. These are part of the <Line Item> costs that contribute directly to the <Cost Object> avoiding any distribution to <Activity> costs.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 189
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
DirectCostObjectVariableValue Grid Value [page 52]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.15 DirectPrimaryDriverVolume
Description Returns the DirectPrimaryDriverVolume value for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity Drivers>
Returns Decimal
Related Information
DirectPrimaryDriverVolume Grid Value [page 53]
4.5.16 DirectPrimaryDriverUnitRate
Description Returns the DirectPrimaryDriverUnitRate for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity Drivers>
Returns Decimal
190 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Related Information
DirectPrimaryDriverUnitRate Grid Value [page 52]
4.5.17 DirectServiceCostObjectValue
Description Returns the DirectServiceCostObjectValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5 >
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]DirectServiceCostObjectValue Grid Value [page 53]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 191
4.5.18 DirectServicePrimaryDriverUnitRate
Description Returns the DirectServicePrimaryDriverUnitRate value for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Services>, <Activity Drivers>
Returns Decimal
Related Information
DirectServicePrimaryDriverUnitRate Grid Value [page 54]
4.5.19 DirectServicePrimaryDriverVolume
Description Returns the DirectServicePrimaryDriverVolume value for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Services>, <Activity Drivers>
Returns Decimal
Related Information
DirectServicePrimaryDriverVolume Grid Value [page 55]
4.5.20 ExternalCostObjectDataValue
Description Returns the Data value for the External <Cost Object >specified by the parameters listed below
Parameters <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
192 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Related Information
ExternalCostObjectDataValue Grid Value [page 88]
4.5.21 ExternalCostObjectFixedValue
Description Returns the Fixed external costs associated with specific CostObjectValues.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the function:
● RestrictCombinationCostObjectValue
This allows you to limit the number of combinations to those that have a value within a specific range.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ExternalCostObjectFixedValue Grid Value [page 56]RestrictCombinationCostObjectValue [page 273]
4.5.22 ExternalCostObjectValue
Description Returns the basic value of the external costs associated with specific CostObjectValues.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 193
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the function:
● RestrictCombinationCostObjectValue
This allows you to limit the number of combinations to those that have a value within a specific range.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ExternalCostObjectValue Grid Value [page 57]RestrictCombinationCostObjectValue [page 273]
4.5.23 ExternalCostObjectVariableValue
Description Returns the Variable external costs associated with specific CostObjectValues.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of
194 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ExternalCostObjectVariableValue Grid Value [page 57]IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.24 GrossContribution
Description Returns the GrossContribution value for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 195
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]GrossContribution Grid Value [page 57]
4.5.25 JointCostObjectFixedValue
Description Returns the JointCostObjectFixedValue for the parameters specified below.
Parameters <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
JointCostObjectFixedValue Grid Value [page 58]
4.5.26 JointCostObjectValue
Description Returns the JointCostObjectValue for the parameters specified below.
Parameters <Versions>, <Periods>, <Responsibility Centers>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
JointCostObjectValue Grid Value [page 59]
196 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.5.27 JointCostObjectVariableValue
Description Returns the JointCostObjectVariableValue for the parameters specified below
Parameters <Versions>, <Periods>, <Responsibility Centers>, <Line Items>, <Activities>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
JointCostObjectVariableValue Grid Value [page 59]
4.5.28 LineItemCostObjectFixedValue
Description Returns the LineItemCostObjectFixedValue for the specified parameters. These derive from the specified <Line Items> in all <Responsibility Centers> and <Activities>.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated ● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 197
Related Information
IsCostObjectCalculated [page 267]LineItemCostObjectFixedValue Grid Value [page 60]RestrictCombinationCostObjectValue [page 273]
4.5.29 LineItemCostObjectValue
Description Returns the LineItemCostObjectValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non zero value in specific Versions and Periods.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]LineItemCostObjectValue Grid Value [page 60]RestrictCombinationCostObjectValue [page 273]
198 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.5.30 LineItemCostObjectVariableValue
Description Returns the LineItemCostObjectVariableValue for the specified parameters. These derive from the specified <Line Items> in all <Responsibility Centers> and <Activities>.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]LineItemCostObjectVariableValue Grid Value [page 61]RestrictCombinationCostObjectValue [page 273]
4.5.31 PrimaryDriverUnitRate
Description Returns the PrimaryDriverUnitRate value for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Activity Drivers>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 199
4.5.32 PrimaryDriverVolume
Description Returns the PrimaryDriverVolume value for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Activity Drivers>
Returns Decimal
Related Information
PrimaryDriverVolume Grid Value [page 62]
4.5.33 Revenue
Description Returns the Revenue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you could consider making use of the function:
● RestrictCombinationDataRevenue
This allows you to limit the number of combinations to those that have had a Revenue value entered against them.
Parameters <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
RestrictCombinationDataRevenue [page 274]Revenue Grid Value [page 63]CalculateSlice [page 148]
200 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.5.34 ServiceCostObjectValue
Description Returns the ServiceCostObjectValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Service>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]ServiceCostObjectValue Grid Value [page 64]
4.5.35 ServicePrimaryDriverUnitRate
Description Returns the ServicePrimaryDriverUnitRate value for the specified parameters.
Parameters <Version>, <Period>,< Responsibility Center>, <Services>, <Activities>, <Activity Drivers>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 201
Related Information
ServicePrimaryDriverUnitRate Grid Value [page 64]
4.5.36 ServicePrimaryDriverVolume
Description Returns the ServicePrimaryDriverVolume value for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Services>, <Activities>, <Activity Drivers>
Returns Decimal
Related Information
ServicePrimaryDriverVolume Grid Value [page 65]
4.5.37 SourceCostObjectFixedValue
Description Returns the non-variable costs that contribute to the <Cost Object> specified by the parameters listed below. These derive from the <Line Items> that contribute through the specified <Responsibility Centers> to the <Cost Object>.
NoteSourceCostObjectFixedValues are trace values that can only be calculated after all CostObjectValues have been fully calculated, because it is only then that they can be traced back to their source. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
202 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]SourceCostObjectFixedValue Grid Value [page 65]
4.5.38 SourceCostObjectValue
Description Returns the SourceCostObjectValue for the specified parameters.
NoteSourceCostObjectValues are trace values that can only be calculated after all CostObjectValues have been fully calculated, because it is only then that they can be traced back to their source. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 203
SourceCostObjectValue Grid Value [page 66]
4.5.39 SourceCostObjectVariableValue
Description Returns the Variable costs that contribute to the <Cost Object> specified by the parameters listed below. These derive from the <Line Items> that contribute through the specified <Responsibility Centers> to the <Cost Object>.
NoteSourceCostObjectVariableValues are trace values that can only be calculated after all CostObjectValues have been fully calculated, because it is only then that they can be traced back to their source. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Items>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]SourceCostObjectVariableValue Grid Value [page 66]
204 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.5.40 SummaryCostObjectFixedValue
Description Returns the SummaryCostObjectFixedValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]SummaryCostObjectFixedValue Grid Value [page 67]
4.5.41 SummaryCostObjectValue
Description Returns the SummaryCostObjectValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 205
CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]SummaryCostObjectValue Grid Value [page 68]
4.5.42 SummaryCostObjectVariableValue
Description Returns the SummaryCostObjectVariableValue for the specified Parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
206 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]SummaryCostObjectVariableValue Grid Value [page 69]
4.5.43 SummaryPostCostObjectValue
Description Returns the SummaryPostCostObjectValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 207
4.5.44 SummaryPreCostObjectValue
Description Returns the SummaryPreCostObject Value for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
4.5.45 TargetCostObjectValue
Description Returns the TargetCostObjectValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the
208 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Target Responsibility Center>, <Target Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4,> <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]TargetCostObjectValue Grid Value [page 70]
4.5.46 TotalCostObjectFixedValue
Description Returns the TotalCostObjectFixedValue for the specified Parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result, when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 209
Parameters <Version>, <Period>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]TotalCostObjectFixedValue Grid Value [page 71]
4.5.47 TotalCostObjectValue
Description Returns the TotalCostObjectValue for the specified Parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated ● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version,> <Period>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]
210 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
TotalCostObjectValue Grid Value [page 72]
4.5.48 TotalCostObjectVariableValue
Description Returns the TotalCostObjectVariableValue for the specified Parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated ● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]TotalCostObjectVariableValue Grid Value [page 73]
4.5.49 TracebackValue
Description Returns the TracebackValue for the specified parameters.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 211
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Target Responsibility Center>, <Target Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]TracebackValue Grid Value [page 74]
4.5.50 TracebackFixedValue
Description Returns the TracebackFixedValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
212 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Target Responsibility Center>, <Target Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]TracebackFixedValue Grid Value [page 74]
4.5.51 TracebackVariableValue
Description Returns the TracebackVariableValue for the specified parameters.
NoteCostObjectValues are not calculated On Demand due to the large number of <Cost Object> combinations in a model. They are either calculated automatically by the Calculation Engine or by command using the CalculateSlice function. As a result when using this function you should consider making use of the functions:
● IsCostObjectCalculated● RestrictCombinationCostObjectValue
The first allows you to find out if the value you want has been calculated yet and the other allows you to limit the number of combinations to those that have a non-zero value in specific <Versions> and <Periods>.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 213
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Target Responsibility Center>, <Target Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
IsCostObjectCalculated [page 267]RestrictCombinationCostObjectValue [page 273]TracebackVariableValue Grid Value [page 76]
4.5.52 UnitPrice
Description Returns the Unit Price for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Revenue Types>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
UnitPrice Grid Value [page 76]
4.5.53 UnitsSold
Description Returns the Units Sold for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Revenue Type>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
214 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Related Information
UnitsSold Grid Value [page 77]
4.6 Delta Value Functions
The Predefined Functions held under the Delta Values category are described in the following topics.
4.6.1 ActivityDriverDeltaValue
Description This function is only relevant in Driver Analysis models and returns the total of all deltas values for the specified combination of <Activity Driver> and <Cost Objects>.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity Driver>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ActivityDriverDeltaValue Grid Value [page 106]
4.6.2 AddActivityDriverDelta
Description Only to be used in Delta Analysis Rules. This uses the parameter Delta Value, to create an additional delta for the specified combination of <Activity Driver> and <Cost Objects>. This is added to the list of deltas that already exist for the combination, These may have originated from target values you have specified in your Driver Analysis model but can also be generated by other AddActivityDriverDelta functions performed in the Delta rules of other items.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 215
NoteFor this delta to take effect the specified combination of <Activity Driver> and <Cost Objects> must either have no front rule that would override delta changes, no Driver Analysis rule, Back Rule, or if it does have a Back Rule this must have a return value of False.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity Driver>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>, <Delta Value>
Returns Decimal
4.6.3 AddLineItemDelta
Description Only to be used in Delta Analysis Rules. This uses the parameter Delta Value, to create an additional delta for the specified <Line Item>. This is added to the list of deltas that already exist for that <Line Item>, These may have originated from target values you have specified in your Driver Analysis model but can also be generated by other AddLineItemDelta functions performed in the Delta rules of other items.
NoteFor this delta to take effect the specified <Line Item> must either have no front rule that would override delta changes, no Driver Analysis rule, Back Rule, or if it does have a Back Rule this must have a return value of False.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>, <Delta Value>
Returns Decimal
4.6.4 AddResourceDriverDelta
Description Only to be used in Delta Analysis Rules. This uses the parameter Delta Value, to create an additional delta for the specified <Resource Driver>. This is added to the list of deltas that already exist for that <Resource Driver>,
216 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
These may have originated from target values you have specified in your Driver Analysis model but can also be generated by other AddResourceDriverDelta functions performed in the Delta rules of other items.
NoteFor this delta to take effect the specified <Resource Driver> must either have no front rule that would override delta changes, no Driver Analysis rule, Back Rule, or if it does have a Back Rule this must have a return value of False.
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>, <Delta Value>
Returns Decimal
4.6.5 AddResourceDriverSplitDelta
Description Only to be used in Delta Analysis Rules. This uses the parameter Delta Value, to create an additional delta for the specified <Resource Driver Split>. This is added to the list of deltas that already exist for that <Resource Driver Split>, These may have originated from target values you have specified in your Driver Analysis model but can also be generated by other AddResourceDriverSplitDelta functions performed in the Delta rules of other items.
NoteFor this delta to take effect the specified <Resource Driver Split> must either have no front rule that would override delta changes, no Driver Analysis rule, Back Rule, or if it does have a Back Rule this must have a return value of False.
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>, <Activity>, <Delta Value>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 217
4.6.6 AddServiceDriverDelta
Description Only to be used in Delta Analysis Rules. This uses the parameter Delta Value, to create an additional delta for the specified Service Driver. This is added to the list of deltas that already exist for that Service Driver, These may have originated from target values you have specified in your Driver Analysis model but can also be generated by other AddServiceDriverDelta functions performed in the Delta rules of other items.
NoteFor this delta to take effect the specified Service Driver must either have no front rule that would override delta changes, no Driver Analysis rule, Back Rule, or if it does have a Back Rule this must have a return value of False.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>, Delta Value
Returns Decimal
4.6.7 CurrentDeltaValue
Description Only to be used in Delta Analysis Rules. It returns the total of all delta values for the Delta Rule item.
Returns Decimal
4.6.8 LineItemDeltaValue
Description This function is only relevant in Driver Analysis models and returns the total of all delta values for the specified <Line Item>.
Parameters <Version>, <Period>, <Responsibility Center>, <Line Item>
Returns Decimal
218 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.6.9 ResourceDriverDeltaSplit
Description This function is only relevant in Driver Analysis models and returns the total of all delta values for the specified <Resource Driver Split.>
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>, <Activity>
Returns Decimal
4.6.10 ResourceDriverDeltaValue
Description This function is only relevant in Driver Analysis models and returns the total of all delta values for the specified <Resource Driver>.
Parameters <Version>, <Period,> <Responsibility Center>, <Resource Driver>
Returns Decimal
4.6.11 ServiceDriverDeltaValue
Description This function is only relevant in Driver Analysis models and returns the total of all delta values for the specified Service Driver.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
Returns Decimal
4.7 Driver Value Functions
The Predefined Functions held under the Driver Values category are described in the following topics.
4.7.1 ActivityDriverDataValue
Description Returns the Data value for the <Activity Driver> specified by the parameters listed below.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 219
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ActivityDriverDataValue Grid Value [page 83]
4.7.2 ActivityDriverOriginalValue
Description Returns the Original value for the <Activity Driver> specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ActivityDriverOriginalValue Grid Value [page 107]
4.7.3 ActivityDriverTargetValue
Description Returns the Target value for the <Activity Driver> specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
220 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Related Information
ActivityDriverTargetValue Grid Value [page 107]
4.7.4 ActivityDriverValue
Description Returns the ActivityDriverValue for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Activity>, <Cost Objects 1>, <Cost Objects 2>, <Cost Objects 3>, <Cost Objects 4>, <Cost Objects 5>
Returns Decimal
Related Information
ActivityDriverDataValue Grid Value [page 83]
4.7.5 ResourceDriverDataSplit
Description Returns the Data value for the Resource Driver Split specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center,> <Resource Driver>, <Activity>
Returns Decimal
Related Information
ResourceDriverDataSplit Grid Value [page 99]
4.7.6 ResourceDriverDataValue
Description Returns the Data value for the <Resource Driver> specified by the parameters listed below.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 221
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>
Returns Decimal
Related Information
ResourceDriverDataValue Grid Value [page 100]
4.7.7 ResourceDriverNonSpare
Description Returns the ResourceDriverNonSpare value for the specified parameters. Resources that have not been assigned, or are the residual remainder of a resource calculation, will end up being allocated to Spare by default. The ResourceDriverNonSpare value shows the amount of resource that has definitely been allocated, and consequently is not spare.
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>
Returns Decimal
4.7.8 ResourceDriverOriginalSplit
Description Returns the Original value for the <Resource Driver Split> specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>, <Activity>
Returns Decimal
Related Information
ResourceDriverOriginalSplit Grid Value [page 109]
222 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.7.9 ResourceDriverOriginalValue
Description Returns the Original value for the <Resource Driver> specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>
Returns Decimal
Related Information
ResourceDriverOriginalValue Grid Value [page 109]
4.7.10 ResourceDriverPctSplit
Description Returns the <Resource Driver Split> by percentage (range 0-100) for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>, <Activity>
Returns Decimal
Related Information
ResourceDriverPctSplit Grid Value [page 113]
4.7.11 ResourceDriverSplit
Description Returns the ResourceDriverSplit value for the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>, <Activity>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 223
Related Information
ResourceDriverSplit Grid Value [page 113]
4.7.12 ResourceDriverTargetSplit
Description Returns the Target value for the Resource Driver Split specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>, <Activity>
Returns Decimal
Related Information
ResourceDriverTargetSplit Grid Value [page 109]
4.7.13 ResourceDriverTargetValue
Description Returns the Target value for the <Resource Driver >specified by the parameters listed below.
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>
Returns Decimal
Related Information
ResourceDriverTargetValue Grid Value [page 110]
4.7.14 ResourceDriverValue
Description Returns the ResourceDriverValue for the specified parameters.
224 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Version>, <Period>, <Responsibility Center>, <Resource Driver>
Returns Decimal
Related Information
ResourceDriverValue Grid Value [page 114]
4.8 Icon and Color Value Functions
The Predefined Functions held under the Icon and Color Values category are described in the following topics.
4.8.1 EmployeeResultDataColor
Description Returns the Color Value associated with the Result data of an <Employee> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Employees>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.2 EmployeeResultIcon
Description Returns the EPO CODE of the Icon associated with the Result data of an <Employee> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Employees>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Integer
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 225
4.8.3 EmployeeResultRangeColor
Description Returns the Color associated with ranges of Result values of an <Employee> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>,< Employees>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.4 MetricAchievementDataColor
Description Returns the Color Value associated with Achievement data for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.5 MetricAchievementIcon
Description Returns the EPO CODE of the Icon associated with Achievement for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.6 MetricAchievementRangeColor
Description Returns the Color associated with ranges of Achievement values for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>,< Cost Object 1>, <Cost Object 2>
Returns Integer
226 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.8.7 MetricTotalActualDataColor
Description Returns the Color Value associated with Total Actual data for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.8 MetricTotalActualIcon
Description Returns the EPO CODE of the Icon associated with Total Actual data for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.9 MetricTotalActualRangeColor
Description Returns the Color Value associated with ranges of Total Actual values for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.10 ObjectiveAchievementDataColor
Description Returns the Color Value associated with Achievement data for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 227
4.8.11 ObjectiveAchievementIcon
Description Returns the EPO CODE of the Icon associated with Achievement for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.12 ObjectiveAchievementRangeColor
Description Returns the Color associated with ranges of Achievement values for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.13 ObjectiveLinkedResultDataColor
Description Returns the Color Value associated with Linked Result data for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.14 ObjectiveLinkedResultIcon
Description Returns the EPO CODE of the Icon associated with Linked Result data for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
228 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.8.15 ObjectiveLinkedResultRangeColor
Description Returns the Color associated with ranges of Linked Result values for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.16 ObjectiveMetricAchievementIcon
Description Returns the EPO CODE of the Icon associated with the <Metric> Achievement data of an objective identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.17 ObjectiveMetricAchievementDataColor
Description Returns the Color Value associated with the <Metric> Achievement data of an objective identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>,< Cost Object 2>
Returns Integer
4.8.18 ObjectiveMetricAchievementRangeColor
Description Returns the Color associated with ranges of <Metric> Achievement values of an objective identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Integer
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 229
4.8.19 ObjectiveResultDataColor
Description Returns the Color Value associated with the Result data of an objective identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.20 ObjectiveResultIcon
Description Returns the EPO CODE of the Icon associated with the Result data of an objective identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.21 ObjectiveResultRangeColor
Description Returns the Color associated with ranges of Result values of an objective identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.22 ObjectiveTotalActualDataColor
Description Returns the Color Value associated with the Total Actual data of an objective identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
230 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.8.23 ObjectiveTotalActualIcon
Description Returns the EPO CODE of the Icon associated with the Total Actual data of an objective identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.8.24 ObjectiveTotalActualRangeColor
Description Returns the Color associated with ranges of Total Actual values of an objective identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Integer
4.9 Metric Value Functions
The Predefined Functions held under the Metric Values category are described in the following topics.
4.9.1 DefaultMetricAchievementValue
Description Returns the default Achievement Value for a <Metric> identified by the specified parameters. This function is applied as the default rule for all <Metric> items. It is a percentage calculated as shown below: Achievement = (Actual - Basepoint) *100 / (Target – Basepoint)
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 231
4.9.2 DefaultMetricCenterAchievementValue
Description Returns the default Center is Best Achievement Value for a <Metric> identified by the specified parameters. This function can be applied to <Center is Best> <Metrics> as their default Achievement Rule. It takes into account the relative differences between Target and <Boundary> values in percentage terms that affect the Center is Best Achievement calculation.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.9.3 MetricAchievementValue
Description Returns the Achievement Value for a <Metric> identified by the specified parameters. This is obtained through the Achievement Rule for the <Metric> which by default uses the DefaultMetricAchievementValue function . An alternative rule can be created where special treatment is required. Center is Best measures would use the DefaultMetricCenterAchievementValue function or some appropriate equivalent.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
DefaultMetricAchievementValue [page 231]DefaultMetricCenterAchievementValue [page 232]
4.9.4 MetricActualAdjustmentValue
Description Returns the Actual Adjustment Value for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
232 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.9.5 MetricActualDataValue
Description Returns the Actual Data value for the <Metric> specified by the parameters below.
Parameters <Version>, <Period>, <Responsibility Center>,< Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
MetricActualDataValue Grid Value [page 91]
4.9.6 MetricActualValue
Description Returns the Actual Value for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.9.7 MetricBasePointDataValue
Description Returns the BasePoint Data value for the <Metric> specified by the parameters below.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
MetricBasePointDataValue Grid Value [page 92]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 233
4.9.8 MetricBasePointValue
Description Returns the BasePoint Value for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.9.9 MetricTargetAdjustmentValue
Description Returns the Target Adjustment Value for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.9.10 MetricTargetDataValue
Description Returns the BasePoint Data value for the <Metric> specified by the parameters below.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
MetricTargetDataValue Grid Value [page 93]
4.9.11 MetricTargetValue
Description Returns the Target Value for the <Metric> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
234 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Returns Decimal
4.9.12 MetricTotalActualValue
Description Returns the Total Actual Value for the <Metric> identified by the specified parameters.
Total Actual Value = Actual Value + Actual Adjustment Value
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.9.13 MetricTotalTargetValue
Description Returns the Total Target Value for the <Metric> identified by the specified parameters.
Total Target Value = Target Value + Target Adjustment Value
Parameters <Version>, <Period>, <Responsibility Center>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.9.14 MetricVarianceValue
Description Returns the Variance Value for the <Metric> identified by the specified parameters.
Variance Value = Target Value - Actual Value
Parameters <Version>, <Period>, <Responsibility Center>,< Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10 Objective Value Functions
The Predefined Functions held under the Objective Values category are described in the following topics.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 235
4.10.1 DefaultObjectiveAchievementValue
Description Returns the default Achievement Value for the <Objective> identified by the specified parameters. This function is applied as the default rule for all <Objective> items. It is a percentage calculated as shown below:
Achievement = (Actual - Basepoint) *100 / (Target – Basepoint)
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.2 DefaultObjectiveCenterAchievementValue
Description Returns the default Center is Best Achievement Value for an <Objective> identified by the specified parameters. This function can be applied to Center is Best <Objectives> as their default Achievement Rule. It takes into account the relative differences between Target and <Boundary> values in percentage terms that affect the Center is Best Achievement calculation.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.3 DefaultObjectiveResultValue
Description Returns the default Result Value for the <Objective> identified by the specified parameters. It is applied as the default Result Value rule for all <Objectives> and can be overridden for specific <Objectives> where special treatment is required. It is a calculated value that can produce one of three possible results depending on the values entered against this <Objective>. It could be:
● ObjectiveAchievementValue – when your <Objective> has its own value.
● ObjectiveLinkedResultValue – when your <Objective> is linked and the <sub-objectives> have a value.
236 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
● ObjectiveMetricResultValue – when your <Objective> is linked and the <sub-objectives> have <Metric> values.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
ObjectiveAchievementValue [page 237]
4.10.4 ObjectiveAchievementValue
Description Returns the Achievement Value for the <Objective> identified by the specified parameters . By default this will be calculated by the Achievement Rule associated with the <Objective> which by default uses the DefaultObjectiveAchievementValue function. An alternative rule can replace the default where special treatment is required. Center is Best measures should use the DefaultObjectiveCenterAchievementValue function or some appropriate equivalent.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
DefaultObjectiveAchievementValue [page 236]DefaultObjectiveCenterAchievementValue [page 236]
4.10.5 ObjectiveActualAdjustmentValue
Description Returns the Actual Adjustment Value for the <Objective> identified by the specified parameters.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 237
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.6 ObjectiveActualDataValue
Description Returns the Actual Data value for the <Objective> specified by the parameters below.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
ObjectiveActualDataValue Grid Value [page 95]
4.10.7 ObjectiveActualValue
Description Returns the Actual Value for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>,< Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.8 ObjectiveBasePointDataValue
Description Returns the BasePoint Data value for the <Objective> specified by the parameters below.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
238 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Related Information
ObjectiveBasePointDataValue Grid Value [page 96]
4.10.9 ObjectiveBasePointValue
Description Returns the BasePoint Value for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.10 ObjectiveLinkedResultValue
Description Returns the Linked Result Value for the <Objective> identified by the specified parameters. It is a calculated value derived from the weighted ObjectiveTotalActualValue of each linked <Objective> component.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.11 ObjectiveMetricResultValue
Description Returns the <Metric> Result Value for the <Objective> identified by the specified parameters. It is a calculated value that is the aggregate of the weighted MetricTotalActualValue of each linked objective component.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 239
4.10.12 ObjectiveMetricWeightingDataValue
Description Returns the Weighting Data Value for a <Metric> that has been assigned to a specific objective. The <Metric> and <Objective> are identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Metric>, <Cost Object 1>,< Cost Object 2>
Returns Decimal
Related Information
ObjectiveMetricWeightingDataValue Grid Value [page 96]
4.10.13 ObjectiveMetricWeightingPctValue
Description Returns the percentage Weighting Value for a <Metric >that has been assigned to a specific objective. The< Metric> and <Objective> are identified by the specified parameters. This percentage is interpreted as a proportion of the aggregated total of the weighting values of all <Metrics> that contribute to an <Objective>.
NoteBy default the <Metric> weightings are equally distributed.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.14 ObjectiveMetricWeightingValue
Description Returns the Weighting Value for a <Metric> that has been assigned to a specific objective through the Objectives/Metrics Assignment screen. The <Metric> and <Objective> are identified by the specified parameters.
240 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Metric>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.15 ObjectiveResultValue
Description Returns the Result Value for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
ObjectiveResultValue Grid Value [page 136]
4.10.16 ObjectiveTargetAdjustmentValue
Description Returns the Target Adjustment Value for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.17 ObjectiveTargetDataValue
Description Returns the Target Data value for the <Objective> specified by the parameters below.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 241
Related Information
ObjectiveTargetDataValue Grid Value [page 98]
4.10.18 ObjectiveTargetValue
Description Returns the Target Value for the <Objective> identified by the specified parameters.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.19 ObjectiveTotalActualValue
Description Returns the Total Actual Value for the <Objective> identified by the specified parameters.
Total Actual Value = Actual Value + Actual Adjustment Value
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.20 ObjectiveTotalTargetValue
Description Returns the Total Target Value for the <Objective> identified by the specified parameters.
Total Target Value = Target Value + Target Adjustment Value
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
242 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.10.21 ObjectiveWeightingDataValue
Description Returns the Weighting Data Value of a <Linked Objective>. The Linked item and the <Objective> it is linked to are identified through the dimension items shown below.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Linked Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
Related Information
ObjectiveWeightingDataValue Grid Value [page 99]
4.10.22 ObjectiveWeightingPctValue
Description Returns the percentage Weighting Value of a <Linked Objective>. The Linked item and the <Objective> it is linked to are identified through the dimension items shown below.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Linked Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
4.10.23 ObjectiveWeightingValue
Description Returns the Weighting Value of a <Linked Objective>. The Linked item and the <Objective> it is linked to are identified through the dimension items shown below.
Parameters <Version>, <Period>, <Responsibility Center>, <Objective>, <Linked Objective>, <Cost Object 1>, <Cost Object 2>
Returns Decimal
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 243
4.11 Service Value Functions
The Predefined Functions held under the Service Values category are described in the following topics.
4.11.1 ServiceCost
Description Returns the calculated cost of the service specified.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
Returns Decimal
Related Information
ServiceCost Grid Value [page 139]
4.11.2 ServiceDriverDataValue
Description Returns the Data value of the driver used in determining the cost for the service specified.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
Returns Decimal
Related Information
ServiceDriverDataValue Grid Value [page 101]
4.11.3 ServiceDriverOriginalValue
Description Returns the Original value of the driver used in determining the cost for the service specified.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
244 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Returns Decimal
Related Information
ServiceDriverOriginalValue Grid Value [page 110]
4.11.4 ServiceDriverTargetValue
Description Returns the Target value of the driver used in determining the cost for the service specified.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
Returns Decimal
Related Information
ServiceDriverTargetValue Grid Value [page 111]
4.11.5 ServiceDriverValue
Description Returns the value of the driver used in determining the cost for the service specified.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
Returns Decimal
Related Information
ServiceDriverValue Grid Value [page 115]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 245
4.11.6 ServiceFixedUnitRate
Description Returns the unit rate for a specified fixed rate service.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
Returns Decimal
Related Information
ServiceFixedUnitRate Grid Value [page 139]
4.11.7 ServiceIncome
Description Returns the income generated by the specified service.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
Returns Decimal
Related Information
ServiceIncome Grid Value [page 140]
4.11.8 ServiceUnitRate
Description Returns the unit rate for the specified service.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
Returns Decimal
Related Information
ServiceUnitRate Grid Value [page 140]
246 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.11.9 ServiceVariableFactor
Description Returns the ServiceVariableFactor for the specified service. A factor of 0 indicates that the service uses a fixed rate . A factor of 1 specifies that the service cost equates to the level of service consumption. Any other value is a proportional relationship of cost to consumption.
Parameters <Version>, <Period>, <Responsibility Center>, <Service>
Returns Decimal
Related Information
ServiceFixedUnitRate Grid Value [page 139]ServiceVariableFactor Grid Value [page 140]
4.11.10 TotalServiceDriverValue
Description Returns the total of all the driver values for a specified Service.
Parameters <Service>
Returns Decimal
4.12 Structure Functions
The Predefined Functions held under the Structure category allow you to interrogate the structural items in your model. Many of these functions share a common function over a range of dimensions and incorporate concepts that require some explanation. The following topics describe these concepts. Where a struture function is available to only to a specific model type, this is noted in the relevant topic.
4.12.1 EPO CODE
Many of the structural functions use EPO CODE as a parameter. An EPO CODE is the unique identifier for an item in your model and can be seen in the Data Aliases section of the Details pane on any of the Dimension screens when an item is selected. The EPO CODE is used to identify an individual dimension item in a rule, but you must avoid hard-coding an EPO CODE number into a rule, as it changes for each new copy of your model. EPO CODE numbers
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 247
are retained across a Database Backup and Restore operation but are different in a copy created using Copy Model or when Import is used to load new structures from an XML file generated by the Export function.
Some pre-defined EPO CODE numbers are provided to identify built-in Dimensions and Fields. These are listed in the topic on Constant Names and Values.
As a user, you identify a dimension item in your model by its name (which is unique) rather than its EPO CODE. Your model builders will also construct the logic of any rules in your model using the dimension item name. But many of the structural functions operate at a lower logical level and use the EPO CODE instead. The ItemName function provides the means to convert the EPO CODE of an item into its name.
Related Information
ItemName [page 268]Constant Names and Values [page 374]
4.12.2 Current Items
The Current item in a rule is the specific item in any dimension that the rule is currently being applied to. For example a <Line Item> rule will be executed for all combinations of the <Versions>, <Periods>, and <Responsibility Centers> that use that <Line Item>.
Within this rule, a Current item may be specified for all four dimensions, meaning that the function will be applied across all combinations of <Version>, <Period>, and <Responsibility Center>. All parameters in Profitability and Costing model functions default to the current item. This should not be confused with the Current Status of an item which can be found in the Status section of the Details panel of any dimension screen.
4.12.3 Using Restrict Functions
There are two main categories of Restrict function provided for code optimization and performance. One of these constrains script to apply only to specific dimension items; the other restricts it to certain combinations of dimensions.
A <Line Item> rule will be executed for all combinations of its key dimensions, namely the <Versions>, <Periods>, and <Responsibility Centers> that use that <Line Item>. You may wish it only to be run against a specific set of these combinations and you can achieve this using the RestrictDimension and RestrictDimensionParent functions. For more information see the topic on RestrictDimension.
There are several RestrictCombination functions. These are provided to improve performance of rules in models with large combinations of dimensions that are sparsely populated. <Activity Drivers> for example, have nine key dimensions, which creates a very large number of< Activity Driver> combinations when only a few may be in use.
These functions are based around the concept of the Data value of a dimension item. This is implemented through Grid values that only exist in their own right when data has been entered for that item; for example the
248 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
LineItemDataValue Grid Value. Execution of a rule can be restricted to only those combinations that have an associated Data value.
Related Information
LineItemDataValue Grid Value [page 89]RestrictCombinationActivityDriverDataValue [page 272]RestrictDimension [page 280]
4.12.3.1 Using RestrictDimension
A rule is normally run for all relevant combinations of the leaf item it has been written for, but RestrictDimension arranges for it to be run only for a limited selection of these. For example, a LineItemValue exists for all combinations of the items and groups across its key dimensions, <Versions>, <Periods>, and <Responsibility Centers>, but if the <Line Item> has a rule that is to be calculated for only some of these, you should use RestrictDimension. This offers a huge performance advantage over an IF construct, which will call the Script Engine for every combination, including those for which no action is required. Each such call represents a significant overhead which can be avoided.
RestrictDimension can be placed anywhere in the rule but logically should appear at the start, because it applies to the whole rule script rather than any code section within it. It identifies a key dimension, and arranges that within that dimension, the rule will be applied only to one specified item. For a <Line Item> rule, this limits the range of application of the rule to those combinations associated with both the <Line Item> and the specified item. Combinations are made up from the items and groups that exist in the remaining key dimensions.
Combinations associated with all unrestricted items in the specified key dimension will be unaffected by this rule. However you can include several instances of this function in a rule allowing you to target any number of specific items. Not only can it be applied progressively to other items in the same key dimension, it can also be applied to individual items in other key dimensions, so targeting a range of individual key items.
Restricted items can be either leaf items or groups, but here a group is just the parent item alone, it does not include its children. If your rule has been written for a leaf item, restricted items should also be at leaf level, because a group in this context identifies a selection of group totals for the leaf item, for which the rule does not apply.
To specify the children of a group, you can use the RestrictDimensionParent function. This can be particularly useful when your rule has to apply to several individual items. Instead of having multiple calls of RestrictDimension, you can create the required items under an Attribute group and use this as the parent.
Consolidated Rules are written against leaf items but are applied against group totals associated with the item. These groups exist in all of the key dimensions of the item the rule has been written for.
You are not recommended to develop your own Consolidated Rules because the default Consolidated Rule code is optimized to provide best performance. However if you find it necessary, you will find that you have to create the rule against a specific leaf item. The rule will be applied to all group items in the Key Dimensions that locate the leaf item, other than the leaf item dimension itself. So for example, if you have created a Consolidation Rule against a <Line Item> leaf, the rule will be applied to any groups in the <Version>, <Period>, and <Responsibility
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 249
Center> dimensions that are used in a reference to that <Line Item>. When you include Restrict functions, you must ensure that their effect leaves at least one group available to the rule, otherwise it will never be run. This group can either be specified in the RestrictDimension function or it must exist somewhere in the remaining key dimensions.
NoteThe calculated values of the restricted key combinations will be rendered Read Only, while the unrestricted combinations will remain unchanged. If you wish these to assume a Read Only zero value you must also apply the RestrictReturnZero function.
4.12.4 ActiveCalculateSlices
Description Returns the number of active CalculateSlice function calls that are currently being processed. It can be used to avoid contention issues between successive CalculateSlice calls in multi processor environments.
Parameters None
Returns Integer
Related Information
CalculateSlice [page 148]
4.12.5 ActivityCode
Description Returns the EPO CODE for the specified <Activity>.
Parameters <Activity> name (any alias) – must be a literal string
Returns Integer
4.12.6 ActivityDriverCode
Description Returns the EPO CODE for the specified <Activity Driver>.
Parameters <Activity Driver> name (any alias) – must be a literal string
250 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Returns Integer
4.12.7 BoundaryCode
Description This function is available to only Objectives and Metrics models. Returns the EPO CODE for the specified <Boundary>.
Parameters <Boundary> name (any alias) – must be a literal string
Returns Integer
4.12.8 ChildList
Description Returns a list of children of the parent item from the specified dimension. The value returned from this function is a variant array. If the dimension of the parent item is not known a parameter of –1 can be used.
Parameters Dimension Name, Dimension item name of parent (any alias)
Returns Variant array or empty.
4.12.9 CodeByLeafPosition
Description This function returns the EPO CODE of the required leaf item. The position of the required item is defined by a numeric value in relation to the supplied item, navigating through leaf-level items only (excluding any consolidation nodes). A value of -1 refers to the leaf item in the position before the supplied item, -2 is two places before the supplied item, -3 is three places before, and so on. Similarly, a value of 1 refers to the leaf item after the supplied item, a value of 2 is two places after, and so on. The value of 0 returns the supplied item.
Parameters Dimension Name, Dimension item name (any alias), Numeric Value
Returns Integer
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 251
4.12.10 CostObject1Code
Description Returns the EPO CODE for the specified <Cost Object>.
Parameters <Cost Objects 1> name (any alias) – must be a literal string
Returns Integer
4.12.11 CostObject2Code
Description Returns the EPO CODE for the specified <Cost Object>.
Parameters <Cost Objects 2> name (any alias)– must be a literal string
Returns Integer
4.12.12 CostObject3Code
Description Returns the EPO CODE for the specified <Cost Object>.
Parameters <Cost Objects 3> name (any alias)– must be a literal string
Returns Integer
4.12.13 CostObject4Code
Description Returns the EPO CODE for the specified <Cost Object>.
Parameters <Cost Objects 4> name (any alias)– must be a literal string
Returns Integer
4.12.14 CostObject5Code
Description Returns the EPO CODE for the specified <Cost Object>.
Parameters <Cost Objects 5> name (any alias)– must be a literal string
252 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Returns Integer
4.12.15 CostObjectTargets
Description Returns a list of all the items in a specific <Cost Object> dimension that are targeted by existing <Cost Object> Assignments that use specified <Responsibility Center> <Activities> in specific <Versions> and <Periods> as their source.
Parameters <Cost Object> Dimension, <Responsibility Centers>, <Activities>, <Versions>, <Periods>
Returns Variant Array or Empty
4.12.16 CurrencyCode
Description Returns the EPO CODE for the specified <Currency>.
Parameters <Currency> name (any alias)– must be a literal string
Returns Integer
4.12.17 CurrentActivity
Description This returns the EPO CODE for the current Activity.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 253
4.12.18 CurrentActivityDriver
Description This returns the EPO CODE for the current <Activity Driver> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.19 CurrentConsolidatingDimension
Description This returns the EPO CODE for the dimension that is currently consolidating. It can be used in consolidation rules for items that have a number of key dimensions, where you might wish to consolidate values differently for specific dimensions.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.20 CurrentCostObject1
Description This returns the EPO CODE for the current <Cost Object 1> item being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
254 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.12.21 CurrentCostObject2
Description This returns the EPO CODE for the current <Cost Object 2> item being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.22 CurrentCostObject3
Description This returns the EPO CODE for the current <Cost Object 3> item being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.23 CurrentCostObject4
Description This returns the EPO CODE for the current <Cost Object 4> item being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 255
4.12.24 CurrentCostObject5
Description This returns the EPO CODE for the current <Cost Object 5 >item being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.25 CurrentCurrency
Description This returns the EPO CODE for the <Currency> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.26 CurrentIcon
Description This function is available to only Objectives and Metrics models. This function returns the EPO CODE for the current Icon being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
256 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.12.27 CurrentLineItem
Description This returns the EPO CODE for the current <Line Item> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.28 CurrentLineItemDetail
Description This returns the EPO CODE for the current <Line Item Detail> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.29 CurrentMetric
Description This function is available to only Objectives and Metrics models. This function returns the EPO CODE for the current <Metric> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 257
4.12.30 CurrentModelName
Description This returns the name of the current model.
Parameters None
Returns String
4.12.31 CurrentModelType
Description This returns the type of the current model.
Parameters None
Returns The constants ProfitCostingModelType, TransactionCostingModelType, or ObjectiveMetricModelType depending on the type of the current model.
Related Information
Constant Names and Values [page 374]
4.12.32 CurrentObjective
Description This function is available to only Objectives and Metrics models. This function returns the EPO CODE for the current <Objective> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
258 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.12.33 CurrentPeriod
Description This returns the EPO CODE for the current <Period> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.34 CurrentResourceDriver
Description This returns the EPO CODE for the current <Resource Driver> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.35 CurrentRespCenter
Description This returns the EPO CODE for the current <Responsibility Center> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 259
4.12.36 CurrentRevenueType
Description This returns the EPO CODE for the current <Revenue Type >being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.37 CurrentRule
Description This returns the EPO CODE for the current Rule being run. This function is usually used from inside a <User Defined Rule>, to return the id of the rule that called it. For example from within a property rule, it returns the EPO CODE of the calling item.
Parameters None
Returns Integer
4.12.38 CurrentRuleNumber
Description This returns the number of the Rule Type for the current Rule being run. This function is usually used from inside a <User Defined Rule>, in conjunction with CurrentRule.
Parameters None
Returns Integer
Related Information
CurrentRule [page 260]
260 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.12.39 CurrentService
Description This returns the EPO CODE for the current <Service> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.40 CurrentSpread
Description This returns the EPO CODE for the current <Spread> item being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.41 CurrentTable
Description This returns the EPO CODE for the current Table being evaluated
Parameters None
Returns Integer
Related Information
Current Items [page 248]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 261
4.12.42 CurrentTableField
Description This returns the EPO CODE for the current Table Field being evaluated
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.43 CurrentVersion
Description This returns the EPO CODE for the current <Version> being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.44 CurrentWorkSheet1
Description This returns the EPO CODE for the current <Work Sheet 1> item being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
262 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.12.45 CurrentWorksheet2
Description This returns the EPO CODE for the current <Work Sheet 2> item being evaluated.
Parameters None
Returns Integer
Related Information
Current Items [page 248]
4.12.46 DirectCostObjectTargets
Description Returns a list of all the items in a specific <Cost Object >dimension that are targeted by existing <Cost Object> Assignments that use specified <Responsibility Center> direct <Line Items> in specific <Versions> and <Periods> as their source.
Parameters <Cost Object> Dimension, <Responsibility Centers>, <Line Items>, <Versions>, <Periods>
Returns Variant Array or Empty
4.12.47 DirectPrimaryActivityDriver
Description Returns the EPO CODE for the Primary <Activity Driver> assigned to Cost Object Type Line Items in specific <Responsibility Centers>.
Parameters <Responsibility Centers> (any alias), <Line Items> (any alias)
Returns Integer
4.12.48 EPOCodeFromName
Description Returns the EPO CODE for the specified dimension item.
Parameters Dimension item name (any alias)
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 263
Returns Integer
4.12.49 ExportComplete
Description Sends a signal to the database to indicate that all results exports have been completed. This allows any automated response on the database to react.
Parameters None
Returns Has no significance
4.12.50 ExportDimensions
Description Exports the complete structure of your model to your database to make it available in an SAP Business Objects Universe.
Parameters None
Returns Has no significance
Related Information
ExportResults [page 264]
4.12.51 ExportResults
Description This exports calculated results in your model to your database, to make them available in a Business Objects Universe. If no parameter is specified, all results tables are exported; otherwise each table can be exported individually by specifying its name (as displayed in the table list in the Export Results user interface screen).
Before exporting results tables you should call the ExportDimensions function to define the model structure that supports your results. On completion you may call ExportComplete if your database has an automated response to completion.
264 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
NoteThe Export functions described here should be implemented in a Capacity Rule because these are only run after the Calculation Engine has finished calculating your results.
Parameters Optional - Results Table Name (String)
Returns Has no significance
Related Information
ExportComplete [page 264]ExportDimensions [page 264]
4.12.52 IconCode
Description This function is available to only Objectives and Metrics models. Returns the EPO CODE for the specified Icon.
Parameters Icon name (any alias) – must be a literal string
Returns Integer
4.12.53 IncludeCombinationParent
Description This function can be used to obtain significant performance improvements in rules associated with derived <Activity Drivers> and <Revenue Types>. These have nine key dimensions, which means there can be many of these values in a model. For example, with only 10 items in each dimension there could be 10 to the power 9 (1000 million). Consider a derived Activity Driver such as:
AD1 = AD2*AD3
This represents a massive number-crunching task for models of even moderate size if the calculation was run for all possible combinations of <Cost Objects>. However, many of the combinations for AD2 and AD3 can be ignored by the
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 265
effective use of the RestrictDimension and RestrictCombination functions. These limit the intersections considered for calculation based on structure (RestrictDimension ) and data values (RestrictCombination).
However, it may be that AD1 is needed for combinations of AD2 and AD3 that never intersect. If AD2 is populated by CO1 (Cost Objects 1) and CO2; AD3 is populated by CO2 and CO3; and AD1 must be populated for CO1, CO2, and CO3, then additional combinations need to be included:
RestrictCombinationActivityDriverDataValue("AD2",,,"RC Unassigned") RestrictCombinationActivityDriverDataValue("AD3",,,"RC Unassigned") AD2 =ActivityDriverValue(,,,"AD2",,,"CO3 Unassigned","CO4 Unassigned","CO5 Unassigned") * ActivityDriverValue(,,,"AD3","CO1 Unassigned",,,"CO4 Unassigned","CO5 Unassigned")
The IncludeCombinationParent function enables this by “adding back in” combinations that have been excluded by the RestrictCombination functions.
In the code example, if AD1 is needed for all the children of the member CO1_ALL and CO3_ALL, then the following statements ensure that these combinations are included in the results set:
IncludeCombinationParent(CO1, CO1_ALL) IncludeCombinationParent(CO3, CO3_ALL)
This does result in the engine cycling through more combinations than is strictly necessary, however, this may be essential to ensure that all required combinations are calculated.
IncludeCombinationParent can also be used to reduce the number of combinations considered. Using the example above, suppose there is a derived driver (AD4) that needs to be populated for only CO1, which is derived from AD2 (populated by CO1 and Co2). in this case, the following rule limits the calculation to just the single member that needs to be calculated in the CO2 dimension:
RestrictCombinationActivityDriverDataValue("AD2",,,"RC Unassigned")
266 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
IncludeCombinationParent("CO2","Detail Total Customer") AD4 = ActivityDriverValue(,,,"AD2",,"Total Customers","CO3 Unassigned","CO4 Unassigned","CO5 Unassigned") * 10
You may have to define Attribute parents for the items you wish to use in this function. Like the Restrict function, this function can be used progressively across the same dimension and separately across several dimensions. The parent item you specify can specify an individual item.
Parameters Dimension Name, Name of parent item in the Dimension (any alias).
Returns Boolean
4.12.54 IsChild
Description Used to determine whether an item belongs to a specific parent item, where the parent can be at any level in the dimension hierarchy above the item.
Parameters Dimension Name, Dimension item name of parent (any alias), Dimension item name (any alias).
Returns Boolean
4.12.55 IsCostObjectCalculated
Description Used to determine whether an item is calculated to <Cost Object> level or not.
Parameters <Version>, <Period>
Returns Boolean
4.12.56 IsParent
Description Used to determine whether an item is a Parent item or not.
Parameters Dimension Name, Dimension item name (any alias)
Returns Boolean
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 267
4.12.57 ItemDimension
Description Returns the Dimension that the specified item belongs to, as a number. Dimensions are numbered from 0 upwards as shown in the Constants section that follows .
Parameters Dimension item name (any alias)
Returns Integer
Related Information
Constant Names and Values [page 374]
4.12.58 ItemName
Description Returns the Name of the specified member alias. You specify the member using an EPO CODE. You can use the EPO CODE returned by a Current function, such as CurrentLineItem, as the specified Dimension Name. You can also select the Name when specifying parameters in the Simple Expression Editor in a rule. The Name you select will automatically be converted into its equivalent EPO CODE.
Parameters Dimension item (EPO CODE), Data Alias (defaults to Default Alias)
Returns String
4.12.59 ItemPropertyValue
Description This function retrieves the item property value specified against the dimension item. The Property parameter should be an Item Property name defined in the Dimension Item Details pane of the appropriate dimension hierarchy screen.
NoteCurrent Item may not be used for the Dimension item name, and the required item must be specified.
Parameters Property, Dimension item name (any alias).
Returns String
268 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.12.60 LeafChildList
Description Returns a list of the children of the specified Dimension item that are leaf items.
Parameters Dimension name, Dimension item (any alias)
Returns Variant array [Integers] or Empty
4.12.61 LeafPosition
Description This is a System Property that gives the position of a leaf item within a dimension, excluding any parent items. Therefore the value returned will be 1 for the first leaf item, 2 for the second, and so on.
Parameters Dimension Name, Dimension item (any alias)
Returns Integer
4.12.62 LineItemCode
Description Returns the EPO CODE for the specified <Line Item>.
Parameters <Line Item> name (any alias) – must be a literal string
Returns Integer
4.12.63 LineItemDetailCode
Description Returns the EPO CODE for the specified <Line Item Detail>.
Parameters <Line Item Detail> name (any alias) – must be a literal string
Returns Integer
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 269
4.12.64 MetricCode
Description This function is available to only Objectives and Metrics models. Returns the EPO CODE for the specified <Metric> Item.
Parameters <Metric> Item name (any alias) – must be a literal string
Returns Integer
4.12.65 ObjectiveCode
Description This function is available to only Objectives and Metrics models. Returns the EPO CODE for the specified <Objective>.
Parameters <Objective> name (any alias) – must be a literal string
Returns Integer
4.12.66 Parent
Description Returns the EPO CODE for the parent of the item specified. If no parent exists then the ultimate parent (that is, the dimension name) is returned.
Parameters Dimension Name, Dimension item (any alias)
Returns Integer
4.12.67 ParentBelowGroup
Description Returns the EPO CODE of the first parent item below the specified parent item that contains the dimension member.
Parameters Dimension Name, Dimension item name (any alias), Dimension item name of parent (any alias).
Returns Integer
270 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.12.68 PeriodCode
Description Returns the EPO CODE for the <Period> specified.
Parameters <Period> name (any alias) – must be a literal string
Returns Integer
4.12.69 PrimaryActivityDriver
Description Returns the EPO CODE for the Primary <Activity Driver> assigned to <Activities> in specific <Responsibility Centers>.
Parameters <Responsibility Center> name (any alias), <Activities> name (any alias)
Returns Integer
4.12.70 RaiseAlert
Description This is a custom alert function to raise an alert that can be used in detailed rules for dimension leaf items. The message, severity, and recipients can all be customized. Refer to the “Custom alerts” section of the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Parameters Alert Message, Severity, Recipients
Returns A string value
4.12.71 RaiseCapacityAlert
Description This function is used to raise an alert with a specific severity and message for intended user groups. It is used in a Capacity Rule which is a type of rule that is run at the very end of a model calculation after all other values are calculated. More details about the use of Capacity rules can be found in the “Capacity Planning” section of the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Parameters Alert Message, Severity, Recipients
Returns A string value
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 271
4.12.72 ResourceDriverCode
Description Returns the EPO CODE for the <Resource Driver> specified.
Parameters <Resource Driver> name (any alias) – must be a literal string
Returns Integer
4.12.73 RespCenterCode
Description Returns the EPO CODE for the <Responsibility Center> specified.
Parameters <Responsibility Center> name (any alias) – must be a literal string
Returns Integer
4.12.74 RestrictCombinationActivityDriverDataValue
Description This function provides the means to target the code in an <Activity Driver> rule to those <Activity Drivers> that have been given a non zero value. <Activity Drivers> that have been given a value determine which <Cost Object> combinations are in use, and a model can easily contain a large number of <Cost Object> combinations that are only sparsely used. <Activity Driver> values derived through a rule will have a Data value that is the same as the original <Activity Driver> Value, which will be null for those that are not in use.
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against only the specified selection, and eliminates the need for IF THEN ELSE control logic statements in the rule. In rules that target specific items in this way it provides a significant performance improvement over other constructs which have to be run for all combinations when the intended action is aimed only at those that are used.
272 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Parameters <Activity Drivers>, <Versions>, <Periods>, <Responsibility Centers>; any alias name can be used for each
Returns No return value
Related Information
RestrictReturnZero [page 282]
4.12.75 RestrictCombinationCostObjectValue
Description This function provides the means to target <Cost Objects> whose TotalCostObjectValue is non-zero. These totals are calculated for each <Version>/<Period> combination and are stored in a database table for quick access. These values will be invalid if <Cost Objects> have not been fully calculated, and are aimed at improving the performance of <Revenue Types> rules.
A model can contain a large number of <Cost Object> combinations that are only sparsely used and some <Version>/<Period> combinations that are completely unused. When you are only interested in <Revenue Types> items that have incurred costs, this function can be used to target them exclusively providing a significant potential improvement in performance.
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against specific cost objects, and eliminates the need for IF THEN ELSE control logic statements in the rule. In rules that target specific items in this way, it provides a significant performance improvement over other constructs, which have to be run for all combinations when the intended action is aimed only at those that are used.
Parameters <Versions>, <Periods>; any alias name can be used for each
Returns No return value
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 273
Related Information
RestrictReturnZero [page 282]
4.12.76 RestrictCombinationDataRevenue
Description This function provides the means to target the code in a rule to <Cost Objects> that have had a Revenue value entered against them. A model can easily contain a large number of <Cost Object> combinations that are only sparsely used. When you are only interested in those that have had Revenue entered against them, this function can be used to target them exclusively—providing a huge potential improvement in performance.
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against only the specified dimension item, and eliminates the need for IF THEN ELSE control logic statements in the rule. In rules that target specific items in this way, it provides a significant performance improvement over other constructs, which have to be run for all combinations when the intended action is aimed only at those that are used.
Parameters <Revenue Types>, <Versions>, <Periods>, <Responsibility Centers>; any alias name can be used for each
Returns No return value
Related Information
RestrictReturnZero [page 282]
4.12.77 RestrictCombinationLineItemDataValue
Description This function provides the means to target the code in a rule to <Line Items> that have had a value entered against
274 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
them. A model can easily contain a large number of <Line Items> that are only sparsely used. When you are only interested in those that have had a value entered against them, this function can be used to target them exclusively—providing a huge potential improvement in performance.
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against only the specified dimension item, and eliminates the need for IF THEN ELSE control logic statements in the rule. In rules that target specific items in this way, it provides a significant performance improvement over other constructs, which have to be run for all combinations when the intended action is aimed only at those that are used.
Parameters <Line Items>, <Versions>, <Periods>, <Responsibility Centers>; any alias name can be used for each
Returns No return value
Related Information
RestrictReturnZero [page 282]
4.12.78 RestrictCombinationLineItemDetailDataValue
Description This function provides the means to target the code in a rule to <Line Item Details> that have had a value entered against them. A model can easily contain a large number of <Line Items> that are only sparsely used. When you are only interested in those that have had a value entered against them, this function can be used to target them exclusively—providing a huge potential improvement in performance.
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against only the specified dimension item, and eliminates the need for IF THEN ELSE control logic statements in the
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 275
rule. In rules that target specific items in this way, it provides a significant performance improvement over other constructs, which have to be run for all combinations when the intended action is aimed only at those that are used.
Parameters <Line Item Details>, <Versions>, <Periods>, <Responsibility Centers>; any alias name can be used for each
Returns No return value
Related Information
RestrictReturnZero [page 282]
4.12.79 RestrictCombinationResourceDriverDataSplit
Description This function provides the means to target the code in a rule to <Resource Driver> Splits that have had a value entered against them. A model can easily contain a large number of Splits that are only sparsely used across different <Responsibility Centers>. When you are only interested in those that have had a value entered against them, this function can be used to target them exclusively—providing a potential improvement in performance.
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against only the specified dimension item, and eliminates the need for IF THEN ELSE control logic statements in the rule. It can be applied progressively to target a specific combination of items in different dimensions. In rules that target specific items in this way, it provides a significant performance improvement over the use of IF THEN ELSE constructs' which have to be run for all combinations when the intended action is aimed only at those that are used.
Parameters <Resource Drivers>, <Versions>, <Periods>, <Responsibility Centers>; any alias name can be used for each
Returns No return value
276 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
Related Information
RestrictReturnZero [page 282]
4.12.80 RestrictCombinationResourceDriverDataValue
Description This function provides the means to target the code in a rule to <Resource Drivers> that have had a value entered against them. A model can easily contain a large number of <Resource Drivers> that are only sparsely used across different <Responsibility Centers>. When you are only interested in those that have had a value entered against them, this function can be used to target them exclusively—providing a potential improvement in performance.
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against only the specified dimension item, and eliminates the need for IF THEN ELSE control logic statements in the rule. It can be applied progressively to target a specific combination of items in different dimensions. In rules that target specific items in this way, it provides a significant performance improvement over the use of IF THEN ELSE constructs, which have to be run for all combinations when the intended action is aimed only at those that are used.
Parameters <Resource Drivers>, <Versions>, <Periods>, <Responsibility Centers>; any alias name can be used for each
Returns No return value
Related Information
RestrictReturnZero [page 282]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 277
4.12.81 RestrictCombinationServiceDriverDataValue
Description This function provides the means to target the code in a rule to Service Drivers that have had a value entered against them. A model can easily contain a large number of Service Drivers that are only sparsely used across different <Responsibility Centers>. When you are only interested in those that have had a value entered against them, this function can be used to target them exclusively—providing a potential improvement in performance.
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against only the specified dimension item, and eliminates the need for IF THEN ELSE control logic statements in the rule. It can be applied progressively to target a specific combination of items in different dimensions. In rules that target specific items in this way, it provides a significant performance improvement over the use of IF THEN ELSE constructs, which have to be run for all combinations when the intended action is aimed only at those that are used.
Parameters <Services>, <Versions>, <Periods>, <Responsibility Centers>; any alias name can be used for each
Returns No return value
Related Information
RestrictReturnZero [page 282]
4.12.82 RestrictCombinationSpreadDataValue
Description This function provides the means to target the code in a rule to <Spreads> that have had a value entered against them. A model may contain a large number of <Spreads> that are only sparsely used. When you are only interested in those that have had a value entered against them, this function can be used to target them exclusively—providing a potential improvement in performance.
278 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against only the specified dimension item, and eliminates the need for IF THEN ELSE control logic statements in the rule. It can be applied progressively to target a specific combination of items in different dimensions. In rules that target specific items in this way, it provides a significant performance improvement over the use of IF THEN ELSE constructs, which have to be run for all combinations when the intended action is aimed only at those that are used.
Parameters <Spreads>, <Versions>, <Periods>; any alias name can be used for each
Returns No return value
Related Information
RestrictReturnZero [page 282]
4.12.83 RestrictCombinationWorksheetDataValue
Description This function provides the means to target the code in a rule to <Work Sheet> values that have had a value entered against them. A model can easily contain a large number of <Work Sheet> values that are only sparsely used. When you are only interested in those that have had a value entered against them, this function can be used to target them exclusively—providing a potential improvement in performance.
To ensure that the correct rule text is returned in cells that are excluded by the RestrictCombination filter, the RestrictReturnZero function must be used in the rule.
This function precedes a section of code that you wish to run against only the specified dimension item, and eliminates the need for IF THEN ELSE control logic statements in the rule. It can be applied progressively to target a specific combination of items in different dimensions. In rules that target specific items in this way, it provides a significant
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 279
performance improvement over the use of IF THEN ELSE constructs, which have to be run for all combinations when the intended action is aimed only at those that are used.
Parameters <Work Sheets 1>, <Versions>, <Periods>, <Responsibility Centers>; any alias name can be used for each
Returns No return value
Related Information
RestrictReturnZero [page 282]
4.12.84 RestrictDimension
Description This function provides the means to target a rule exclusively to a specific item in a key dimension. It can be placed anywhere in the rule but logically should appear at the start, as it applies to the whole rule script rather than any code section within it. It can be applied several times to any of the key dimensions to target a selected set of key dimension items. The rule will then be applied only to the combinations of items defined by both the restricted set and all the items in the remaining key dimensions of the item the rule has been written for.
Rules that target specific items using RestrictDimension obtain a huge performance improvement over an IF construct, which has to be run for all combinations when the intended action is aimed at only one of these. Calling the Script engine to run a rule involves a significant overhead even when the rule does nothing. RestrictDimension causes these calls to be disregarded for dimension combinations that have not been targeted.
The calculated values of the restricted key combinations will be rendered Read Only, while the unrestricted combinations will remain unchanged. If you wish these to assume a Read Only zero value you must also apply the RestrictReturnZero function.
NoteWhen you specify a group item with this function, only the group is selected; none of its children are included. If you
280 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
want to select a set of child items you should use the RestrictDimensionParent function.
Parameters Dimension Name, Dimension item name (any alias)
Returns No return value
Related Information
RestrictDimensionParent [page 281]RestrictReturnZero [page 282]Using RestrictDimension [page 249]
4.12.85 RestrictDimensionParent
Description This function provides the means to target the code in a rule to all leaf items in a dimension hierarchy that exist under a specific parent, including those in sub groups. It can be applied several times along with the RestrictDimension function to target a specific combination of items in different key dimensions. In rules that target specific items in this way, it provides a significant performance improvement over the use of IsChild constructs, which have to be run for all combinations when the intended action is aimed at only one of these.
This function is primarily intended for use in Detailed Rules applied to leaf items, where it can be used along with RestrictDimension to target specific items in the Key Dimensions of the leaf item. You can also make use of hierarchy attributes groups to target specific selections of key items.
The calculated values of the restricted key combinations will be rendered Read Only, while the unrestricted combinations will remain unchanged. If you wish these to assume a Read Only zero value, you must also apply the RestrictReturnZero function.
NoteYou can specify a leaf item with RestrictDimensionParent, and it will operate
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 281
correctly on the leaf item, but you should really use the RestrictDimension function.
Parameters Dimension Name, Parent item name (any alias)
Returns No return value
Related Information
RestrictDimension [page 280]RestrictReturnZero [page 282]Using RestrictDimension [page 249]
4.12.86 RestrictReturnZero
Description This can be used in conjunction with the RestrictDimension, RestrictDimensionParent, and RestrictCombination functions to produce a zero result for all item combinations other than those targeted by the restrictions. If you do not include this function, these combinations will not be set to any value by the associated rule and as such will still be editable. When it is used, all these combinations will have a computed value and will be uneditable.
Parameters None
Returns No return value
Related Information
RestrictDimension [page 280]RestrictDimensionParent [page 281]
4.12.87 RevenueTypeCode
Description Returns the EPO CODE for the <Revenue Type s>pecified.
Parameters <Revenue Type> name (any alias) – must be a literal string
Returns Integer
282 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
4.12.88 ServiceCode
Description Returns the EPO CODE for the specified <Service>.
Parameters <Service> name (any alias) – must be a literal string
Returns Integer
4.12.89 ServiceCostObjectTargets
Description Returns a list of all the items in a specific <Cost Object> dimension that are targeted by <Cost Object> Assignments that use specific <Responsibility Center> <Services> as their source in specific <Versions> and <Periods>.
Parameters <Cost Object> Dimension, <Responsibility Centers>, <Services>, <Versions>, <Periods>
Returns Variant Array or Empty
4.12.90 ServicePrimaryActivityDriver
Description Returns the EPO CODE for the Primary <Activity Driver> assigned to a <Service> in specific <Responsibility Centers>.
Parameters <Responsibility Center> name (any alias), <Activities> name (any alias)
Returns Integer
4.12.91 SpreadCode
Description Returns the EPO CODE of the specified <Spread> item.
Parameters <Spread> item name (any alias) – must be a literal string
Returns Integer
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuidePredefined Model Functions P U B L I C 283
4.12.92 VersionCode
Description Returns the EPO CODE for the <Version> specified.
Parameters <Version> name (any alias) – must be a literal string
Returns Integer
4.12.93 WorkSheet1Code
Description Returns the EPO CODE for <Work Sheet 1> item specified.
Parameters <Work Sheets 1> item name (any alias) – must be a literal string
Returns Integer
4.12.94 Worksheet2Code
Description Returns the EPO CODE for the <Work Sheet 2> item specified.
Parameters <Work Sheets 2> item name (any alias) – must be a literal string
Returns Integer
284 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Predefined Model Functions
5 Book Objects
The properties and methods that are available to you when you write script in Books are described here.
Some special book control functions that allow you to navigate between books are described first. Then the book objects are described in separate sections categorizing each according to the type of operations it supports.
More information about the Profitability and Cost Management Workflow Object can be found in the Profitability and Cost Management Work Manager User Guide and the help section within the Work Manager application.
5.1 Definitions
The Properties and Methods of a Book object are:
● Property: a user-definable characteristic of the object, for example size and color.● Method: an action capable of being performed by the object, for example, to retrieve a value, to increase in
size, or to refresh data
Methods are further divided into Procedures and Functions. A procedure performs an action without returning a value, whereas a function does return a value.
5.2 Usage
Some of the properties and methods described in this document will only work from within a web page, as they utilize an ActiveX web object. These are listed as web only in the Type field.
NoteThe names of literal constants that are provided in Rule script differ from those available in Book script. In Book script, we recommend you use the integer value of a constant rather than its name to optimize performance.
Related Information
Constant Names and Values [page 374]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 285
5.3 Control Methods
The main purpose of these methods is to provide the means to pass parameters and navigate between books using URL strings. The structure of URL Strings is discussed in detail in the Profitability and Cost Management Modeling User Guide and is also available through F1 Help.
BookName
Type Function (String)
Purpose Returns the name of the current book
Parameters None
Example In the following example, a user clicks a button and the code retrieves the name of the current book and displays it in a text box:
Sub Button_OnClick() Edit.Text = BookName() End Sub
CurrentUser
Type Function (String)
Purpose Returns the username of the user currently logged in.
Parameters None
Example MyUser = CurrentUser()
GetFimURL
Type Function (String)
Purpose The GetFimURL() function can be used when Profitability and Cost Management is configured to communicate with the SAP BusinessObjects Financial Information Management application. The function returns the currently configured URL for the Financial Information Management application, which consists of the Financial Information Management server and web page, with the currently configured SSO
286 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
(Single Sign On) token appended to the URL. GetFimURL() calls the SSOToken() function to retrieve the SSO token.
An example of a typical return value for this function is as follows: External: http://Test_Fim_Server/Test_Fim_Page.html?fpmLogonToken = [ssotoken_string]
Parameters None
Example In the example that follows, when a user clicks the button, the code retrieves the currently configured URL for Financial Information Management, and adds to it the context information for a value in a grid. The code stores the information in the variable testURL, which it then passes as a parameter (a URL string) to the GotoURL() function. The GotoURL() function takes the user to the Financial Information Management site, which provides information on the origin of the value.
Sub Button_OnCLick() Dim testURL testURL=GetFimURL()&Grid.BookFimURLParams GotoURL(testURL)End sub
For more information on configuring the product to communicate with SAP BusinessObjects Financial Information Management, see the SAP BusinessObjects Profitability and Cost Management Installation Guide.
GotoURL
Type Procedure
Purpose Jump to the URL target
Parameters URLString (String)
Example GotoURL("MyBook")
IsWebClient
Type Function (Boolean)
Purpose Returns True if the script is running in Internet Explorer on a Web Client, False if running on the Web Server or Book
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 287
Viewer. This function assists in the use of native HTML in script.
Parameters None
Example If IsWebClient() then 'Plant HTML specific VB ScriptElse 'Plant VB Script End If
SSOToken
Type Function (String)
Purpose Returns the currently configured SSO (Single Sign On) token. An example of a typical return value is as follows:
fpmlogontoken=[ssotoken_string]
Parameters None
Example In the example below, when a user clicks the button named btnGetSSOToken, the code below retrieves the currently configured SSO token and stores it in the variable testURL, which it then displays as the text in the edit box named Edit.
function btnGetSSOToken_OnClick() {testURL = SSOToken();Edit.Text = testURL;
UTFEncode
Type Function (String)
Purpose The UTFEncode() function applies UTF-8 encoding to its parameters to handle special characters in the parameter strings, such as spaces or accented characters. This function is designed to help users to build custom parameter strings that provide context for a value. The parameter strings can be passed to the GotoURL() function in order to access SAP BusinessObjects Financial Information Management and replicate the result of the Drill-to-Origin option on the grid context menu. For example, a user can specify the
288 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
LineItemValue value as being derived from a selection in a Dimension Tree control as follows:
var lineitemParam = "LINEITEM=" = UTFEnCode(LineItemTree.SelectedName)
NoteUsers who want to create custom parameter strings must pass all values through the UTFEncode() function.
Parameters String
Example The code that follows is a function that builds a parameter string by passing selections in Dimension Trees through UTFEncode(). The parameter string provides the context for a value and, with the Financial Information Management URL and SSO token, can be used to build a string to pass to the GotoUrl() function in order to access the Financial Information Management application and locate information on the data specified by the Dimension Tree selections.
Function getSelectedParams() dim versionParamdim periodParamdim respcenterParamdim lineitemParamdim modelParamversionParam = "VERSION=" + UTFEncode(VersionTree.SelectedName)periodParam = "PERIOD=" + UTFEncode(PeriodTree.SelectedName)respcenterParam = "RESPCENTER=" + UTFEncode(RespCenterTree.SelectedName)lineitemParam = "LINEITEM=" + UTFEncode(lineItemTree.SelectedName)modelParam = "M=" + UTFEncode(EPOPP.CurrentModel)GetSelectedParams = "&" + modelParam + "&" + versionParam + "&" + periodParam + "&" + respcenterParam + "&" + lineitemParam End Function
For more information on accessing SAP BusinessObjects Financial Information Management from Books, see the SAP BusinessObjects Profitability and Cost Management Modeling User Guide
.
5.4 Book Events
You can write script that runs when a Book is opened. This can be useful, for example, to programmatically set the properties of certain Book objects, such as the multiselect mode for DimensionTree objects. Two events - Load and PageLoad - are provided for this purpose.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 289
The purpose of the Load event is to effect some action before a Book is loaded, so its script must be run on a Web Server and cannot include user interaction, because this causes the Web server to stop responding.
To support user interaction, the PageLoad event is available, which runs only the client.
For more information on the Load and PageLoad events, see the “Book Properties” and “Book Scripting Events” sections of the SAP BusinessObjects Profitability and Cost Management User Guide.
5.5 Button object
The Button object supports an OnClick event that can have script attached which will allow an End User to start a new course of action in the current book.
If you want to hide this control in a book, you can only achieve this by setting its width and height to 1, not 0. This will effectively make the control invisible.
5.5.1 Button Object General
Caption
Type Property (String)
Purpose Gets or sets the text that appears on the Button face.
Parameters None.
Example Button.Caption = "Click this button."
Enabled
Type Property (Boolean)
Purpose Determines whether the Button receives the focus, or responds to click events.
Parameters None.
Example Button.Enabled = TRUE
290 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
5.5.2 Button Object Appearance
Color
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the Button.
Parameters None.
Example Button.Color = 12211667 'Light orchid color
FontColor
Type Property (Integer)
Purpose Gets or sets the color of the font used in the Button.
Parameters None.
Example Button.FontColor = 255 'Set the color to red.
FontName
Type Property (String)
Purpose Gets or sets the name of the font used in the Button.
Parameters None.
Example Button.FontName = "Arial"
FontSize
Type Property (Integer)
Purpose Gets or sets the size of the font used in the Button.
Parameters None.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 291
Example Button.FontSize = 12
FontStyle
Type Property (Integer)
Purpose Gets or sets the style of the font used in the Button. The value can be set to be a combination of available styles, so Bold AND Italic text would be 3, like Bold=1 + Italic=2.
Parameters 0=Normal text, 1=Bold, 2=Italic, 4=Underlined text, 8=Strikethrough; also fsBold = 1; fsItalic = 2; fsUnderline = 4;
Example Button.FontStyle = 7
Height
Type Property (Integer)
Purpose Gets or sets the height of the Button in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example Button.Height = 30
Width
Type Property (Integer)
Purpose Gets or sets the width of the Button in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example Button.Width = 70
292 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
5.6 Chart object
The Chart object has no events directly associated with it, but can be linked to other objects that do support events and it is these that dictate what it displays. DataManager and Key objects define the dataset that should appear in the chart. Various forms of chart are supported, and control of the linkage to these associated objects can be driven through the Properties and Methods described next.
NoteIf you want to hide this control in a book, you can only achieve this by setting its width and height to 1, not 0. This will effectively make the control invisible.
5.6.1 Chart Object General
Active
Type Property (Boolean)
Purpose If set to False, the chart will not update, even if the linked DataManager changes.
Parameters None
Example Chart.Active = True
BeginUpdate
Type Procedure
Purpose Increments an internal counter operating as a transactional control that blocks the effect of any updates to this chart. These remain pending until the counter returns to zero following use of the EndUpdate procedure. Updates to a chart are caused by changes in the Keys object it is linked to.
Parameters None.
Example Chart.BeginUpdate
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 293
EndUpdate
Type Procedure
Purpose Decrements the internal counter that prevents updates being implemented on the chart. This counter should have been incremented by the Chart.BeginUpdate procedure. Updates to the chart remain pending until the counter returns to zero.
Parameters None.
Example Chart.EndUpdate
ObjectID
Type Property (Read Only Integer)
Purpose Returns an identifier number relating to the Chart object.
Parameters None.
Example MyReturnValue = Chart.ObjectID
ObsUpdate
Type Procedure
Purpose Notifies the Chart object that it has received an update from a specified linked control causing the Chart to refresh.
Parameters ObjectID (Integer)
UpdateType:
0 – data has changed
1 – structure has changed
Info (Cardinal number, reserved for internal use only)
Example Chart.ObsUpdate Keys.ObjectID, 0, 0
294 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
SetSubject
Type Procedure
Purpose Notifies a DataManager that this Chart wishes to be attached to it. Note that the recommended method of attachment is made in the opposite direction through the DataManager.Attach procedure, which ensures that the DataManager is in control of all its linked visual controls.
Parameters ObjectID (Integer)
Example 'Change the DataManager object that a Chart uses at runtime.
Chart.SetSubject DataManager1.ObjectID
Then force a refresh
Chart.ObsUpdate DataManager1.ObjectID,0
ValidityID
Type Property (Read Only Integer)
Purpose Used to check that the object is a valid Chart object.
Parameters None.
Example If Chart.ValidityID = 311075 Then Msgbox "That IS a valid Chart."
5.6.2 Chart Object Appearance
GraphType
Type Property (Type List)
Purpose Changes the basic type of the chart. Chart types can be : gtArea=0, gtBar=1, gtFastLine=2, gtHorizBar=3, gtLine=4, gtPie=5, gtPoint=6
Parameters None
Example Chart.GraphType = gtBar
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 295
Height
Type Property (Integer)
Purpose Gets or sets the height of the Chartin pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example Chart.Height = 30
Plot
Type Procedure
Purpose Repaints all visible series and points on the Chart.
Parameters None
Example Chart.Plot
PlotZeros
Type Property (Boolean)
Purpose If set to False, zeros are not plotted on the Chart.
Parameters None
Example Chart.PlotZeros = False
Width
Type Property (Integer)
Purpose Gets or sets the width of the Chart in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example Chart.Width = 70
296 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
ZoomIn
Type Procedure
Purpose Zooms in to the ChartParameters None
Example Chart.ZoomIn
ZoomOut
Type Procedure
Purpose Zooms out from the ChartParameters None
Example Chart.ZoomOut
ZoomOutFull
Type Procedure
Purpose Zooms out fully from the Chart control
Parameters None
Example Chart.ZoomOutFull
5.7 DataManager object
The DataManager is a non-visual control used by Grids, Charts, and Reports to specify the Layout to display. The Data Manager also linked to a Keys object that specifies any additional key dimensions required to locate the required dataset. The data in a Grid, Chart, or Report appears automatically when these objects have correctly specified links to the required DataManager and Keys objects.
The DataManager supports a OnReplaceKeys event, which is triggered for each item in a DataManager's view that has the Replace with Keys option set. OnReplaceKeys has a parameter, DimensionID, which describes which key dimension is being replaced.
You can create a script that calls the AddToKeyReplacement procedure during the OnReplaceWithKeys event to programmatically determine which items replace key dimensions in a view. AddToKeyReplacement can be
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 297
called as many times as required to add multiple key items. For the script to work correctly, the view associated with the DataManager must have the Replace with Keys option set. If the event adds no items to the keys replacement or the event does not occur, the default Replace with Keys behavior persists in the view.
NoteAdding an item from an incorrect dimension, or providing an invalid ID, creates a blank key item that does not return any results.
To force a view to refresh so that it displays the results of the programmatic key replacement, you can include a call to the Activate procedure in your script. For more information on the Replace with Keys feature, see the “Replace with Keys” section of the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
The DataManager can also be controlled through the script associated with any visible objects that it may be linked to. The following properties and methods allow you to control these links, to interrogate and set cell values and to control data updates both to individual objects and your model database.
5.7.1 DataManager General
Activate
Type Procedure
Purpose Activates a DataManager after the initial loading process and resets the axes back to their initial loaded state. If any of the attached Key items have changed while the DataManager has been inactive, the changes will be applied at the point of activation.
Parameters None.
Example (Enable and disable DataManagers)
Procedure ButtonActivate_Click Datamanager.Activate ButtonActivate.Enabled = false ButtonDeactivate.Enabled = true EndProcedure ButtonDeactivate_Click Datamanager.DeActivate ButtonActivate.Enabled = true ButtonDeactivate.Enabled = false End
AddToKeyReplacement
Type Procedure
298 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Purpose During an OnReplaceKeys event, this procedure is called to add a key dimension to a view. AddToKeyReplacement can be called as many times as required during the event to add multiple key items to a view.
NoteThe procedure has no effect if called outside the OnReplaceKeys event.
Parameters The application ID of the key item to be added to the view (Integer)
Example DataManager1.AddToKeyReplacement(DimensionList.SelectedID)
Alias
Type Function (String)
Purpose Sets the data display to the specified Alias at any time, within any Grid, Chart, or Report that is connected to the DataManager.
Parameters Alias Name (String)
Example Set the Data Alias to EPO CODE:
Sub book_load() DataManager.Alias = "EPO CODE" End Sub
AsHTML
Type Procedure
Purpose Returns an HTML representation of the data.
Parameters CurrencyDisplayType (Integer):
0 – No formatting
1 – Symbol
2 – ISO Code
Decimal Places (Integer) – Number of decimal places
ShowMemos(Boolean):
False – Gets Numeric data
True – Gets memos only
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 299
Example DataManager.AsHTML 0, 0, True
Attach
Type Procedure
Purpose Connects a specific user interface control to the DataManager. This is method of attachment is preferable to using SetSubject from the UI control.
Parameters ObjectID (Integer)
Example DataManager.Attach Grid.ObjectID
BeginUpdate
Type Procedure
Purpose Increments an internal counter operating as a transactional control that blocks the effect of any updates to this DataManager. These remain pending until the counter returns to zero following use of the EndUpdate procedure. Updates to a DataManager are caused by changes in the Keys object it is linked to. Any Grids or Charts that are linked to this DataManager will not react to updates until the counter returns to zero.
Parameters None.
Example DataManager.BeginUpdate
Deactivate
Type Procedure
Purpose Causes the DataManager to “sleep”; allowing a user to change the keys attached to a DataManager without the layout being reprocessed after each key item is changed. This feature will come in particularly useful where a user needs to setup several key dimensions for a layout that takes time to process.
Parameters None.
Example See the information on Activate at the beginning of this topic.
300 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Detach
Type Procedure
Purpose Disconnects the various user interface controls from the DataManagerParameters ObjectID (Integer)
Example DataManager.Detach Grid.ObjectID
EndUpdate
Type Procedure
Purpose Decrements the internal counter that prevents updates being implemented to this DataManager. This counter is incremented by the DataManager.BeginUpdate procedure. Updates to this DataManager and any Grids or Charts linked to it remain pending until the counter is zero.
Parameters None.
Example DataManager.EndUpdate
GetColumnCount
Type Function (Integer)
Purpose Returns the total number of available columns in the DataManager. Note that using this value, along with its row equivalent to control a loop that gets values, could be slow for large numbers of items.
Parameters None.
Example NumberofColumns = DataManager.GetColumnCount()
GetItemProperty
Type Function (String)
Purpose Returns the value of a named property for a specified dimension item.
Parameters Dimension Item ID (Integer), Property Name (String).
Example PropertyValue = DataManager.GetItemProperty(DimensionItemID,
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 301
PropertyName)
GetRowCount
Type Function (Integer)
Purpose Returns the total number of available rows in the DataManager.
NoteUsing this value along with its column equivalent to control a loop that gets values, could be slow for large numbers of items.
Parameters None.
Example NumberofRows = DataManager.GetRowCount()
GridStyleName
Type Property (String)
Purpose Gets and sets the set of grid styles to apply to Grid and Report controls connected to the DataManager.
Parameters None.
Example DataManager.GridStyleName="Business Style"
HasData
Type Function (Boolean Read Only)
Purpose Returns True if the DataManager currently has a non-empty view loaded.
Parameters None.
Example MyReturnValue = DataManager.HasData()
302 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
LoadLayoutFrom
Type Procedure
Purpose Loads a Layout from a specified file location. The location can also be a URL.
Parameters DataSource (String)
Example DataManager.LoadLayoutFrom "C:\PCM\myView.mvw"
ObjectID
Type Property (Read Only Integer)
Purpose Returns an identifier number for the DataManager object
Parameters None.
Example MyReturnValue = DataManager.ObjectID
ObsUpdate
Type Procedure
Purpose Notifies the DataManager that it has received an update from a specified linked Keys control. Called when a Keys object key value changes.
Parameters ObjectID (Integer)
UpdateType:
0 – data has changed
1 – structure has changed
Example DataManager.ObsUpdate Keys.ObjectID, 0
RemoveValues
Type Procedure
Purpose Removes values that are less than the set threshold value from a DataManager layout—that is, this works in the same way as the Autofilter function.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 303
Parameters Threshold value (double)
Example DataManager.RemoveValues 0.001
SaveLayoutTo
Type Procedure
Purpose Saves a Layout to a specified file location.
Parameters DataSource (String)
Example DataManager.SaveLayoutTo "C:\PCM\myView.mvw"
SetDataSource
Type Procedure
Purpose Tells the DataManager where to retrieve its data from. The “Data Source” is the link to the SAP BusinessObjects Profitability and Cost Management application.
Parameters Data Source ObjectID (Integer)
Example DataManager.SetDataSource parent.frames(0).document.Connection. DataSourceObjectID
SetSubject
Type Procedure
Purpose Notifies a Keys object that this DataManager wishes to be attached to it.
NoteThe recommended method of attachment is made in the opposite direction through the Keys.Attach procedure, which ensures that the Keys object is in control of all its linked controls.
Parameters ObjectID (Integer)
Example 'Change the Keys object that a DataManager uses at runtime DataManager.SetSubject Keys1.ObjectID 'Then force a refresh
304 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
DataManager.ObsUpdate Keys1.ObjectID,0
SwapDimensions
Type Procedure
Purpose Swaps the X and Y axes in the view. Causes all attached controls to be updated.
Parameters None.
Example DataManager.SwapDimensions
ValidityID
Type Property (Read Only Integer)
Purpose Used to check that the object is a valid DataManager.
Parameters None.
Example If DataManager.ValidityID = 311071 Then Msgbox "That IS a valid Data Manager"
5.7.2 DataManager Cell Functions
GetCanEdit
Type Function (Boolean)
Purpose Determines whether the specified cell can be edited.
Parameters Column number (Integer), Row number (Integer)
Example 'Checks the cell in the first column and first row. MyReturnValue = DataManager.GetCanEdit (0, 0)
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 305
GetCellIdentityArray
Type Function (Variant)
Purpose Returns a two-dimensional oleVariant array, the length of which corresponds to the number of dimensions that refer to the cell. The array is structured so that the dimension ID is stored in column 0 and the ID of the corresponding dimension item is stored in column 1. GetCellIdentityArray can be used to return the dimensionality (keys) of any cell in a DataManager grid. Using this function in combination with the Grid.OnCellSelected event and the properties Grid.SelectedColumn and Grid.SelectedRow it is possible to add context-based behaviors to books.
Parameters Column number (Integer), Row number (Integer)
Example ' This routine is attached to the ' 'OnCellSelected' event of a grid control.' When the user changes the selected cell,' this event is fired.' Here we use the routine to retrieve' the selected Objective and Responsibility Center' from the selected cell.' We pass these selections to ' two corresponding Dimension Trees.' As the user changes the selected cell,' the Dimension Trees will automatically' update to match selections referred' to by the cell. Sub Grid_OnCellSelected() ' Retrieve an array from the grid that ' will contain details describing the ' dimension item that refers to that cell. dim cellIdentity cellIdentity = DataManager.GetCellIdentityArray(Grid.SelectedColumn,Grid.SelectedRow) dim selectedID ' Fetch the selected Objective ' from the 'IdentityArray' selectedID = GetDimensionItem(cellIdentity,dtObjective) ' Update the corresponding treeview, ' selecting the Objective from above. ' DimensionTree2 is a treeview in the book, ' that has been setup to
306 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
' examine the Objectives dimension DimensionTree2.SelectedID = selectedID ' Fetch the selected Responsibility ' Center from the 'IdentityArray' selectedID = GetDimensionItem(cellIdentity,dtRespCenter) ' Update the corresponding treeview ' selecting the Responsibility ' Center from above. ' DimensionTree3 is a treeview in the book ' that has been setup to examine ' the Responsibility Centers dimension. DimensionTree3.SelectedID = selectedID End Sub' This is a 'helper' routine that has been' designed to make it easier to retrieve' selected dimension items from' a 'CellIdentityArray',' which is the object returned when' calling DataManager.GetCellIdentityArray.' By passing in the IdentityArray and the Id' of the dimension that we want to query' we can retrieve the ID of the corresponding' dimension item from the IdentityArray. Function GetDimensionItem(cellArray, DimId) GetDimensionItem = -1 dim i ' Loop through the 'rows' of the array ' until we find an item with a matching dimension ID. while (i <= UBound(cellArray,2)) and (GetDimensionItem = -1) if cellArray(0,i) = DimId then ' We have found an item for the right ' dimension - return the ID of the item GetDimensionItem = cellArray(1,i) end if i = i +1 wend End Function
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 307
GetCellTableField
Type Function (Integer)
Purpose Retrieves the GridValue ID of a specified cell.
Parameters Column number (Integer), Row number (Integer)
Example 'Gets the GridValue type of the cell in the first column and first row. MyGridValueType = DataManager.GetCellTableField (0,0)
GetCellValue
Type Function (Variant)
Purpose Retrieves the value of a specified cell.
Parameters Column number (Integer), Row number (Integer), Currency (Integer)
Example 'Gets the value of the cell in the first column and first row, using the default currency. MyCellValue = DataManager.GetCellValue (0,0,-1)
SetCellValue
Type Procedure
Purpose Sets the value of the specified cell. The string passed in can contain a currency code or symbol.
Parameters Column number (Integer), Row number (Integer), Value (String)
Example DataManager.SetCellValue 0,0,"GBP 32.7"
308 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
5.7.3 DataManager Web Only
ApplyUpdates
Type Procedure (Web Only)
Purpose Sends all pending data and memo changes to the model for processing.
NoteApplies to all outstanding changes to all objects and books.
Parameters None.
Example DataManager.ApplyUpdates
ClearCache
Type Procedure (Web only)
Purpose Throws away all pending data changes.
Parameters None
Example DataManager.ClearCache
5.8 DimensionTree object
The DimensionTree object can be linked to a Keys object that is used to specify the data that appears in a Grid, Chart, or Report. Any change to the selected item in the DimensionTree will then produce an automatic change in the displayed dataset.
Any change to the selected DimensionTree item also produces OnChange event that can have script written for it that can be used to alter the normal course of operation.
If you want to hide this control in a book, you can only achieve this by setting its width and height to 1, not 0. This will effectively make the control invisible.
The Properties and methods provided for the DimensionTree object are described next.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 309
5.8.1 DimensionTree General
CustomAliasName
Type Property (String)
Purpose Allows you to display dimension items using a specific Alias by name. If the Alias name given does not exist, the UseCustomAlias property will be set back to false and will ignore this setting.
Parameters AliasName (String)
Example DimensionTree.CustomAliasName = "EPO CODE"
DimensionNo
Type Property (Integer)
Purpose Gets or sets the dimension number for the DimensionTree control
Parameters None.
Example 'Can use Constant Names and Values DimensionTree.DimensionNo = 2
Enabled
Type Property (Boolean)
Purpose A toggle that enables or disables the DimensionTreeParameters None
Example DimensionTree.Enabled = True
ObjectID
Type Property (Read Only Integer)
310 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Purpose Returns an identifier number relating to the DimensionTree object.
Parameters None.
Example MyReturnValue = DimensionTree.ObjectID
ObsUpdate
Type Procedure
Purpose Notifies the DimensionTree that it has received an update from a specified linked Keys control, causing it to rebuild.
Parameters ObjectID (Integer)
UpdateType:
0 – data has changed
1 – structure has changed
Example DimensionTree.ObsUpdate Keys.ObjectID, 0
RootID
Type Property (Integer)
Purpose Gets or sets the root item as the top item in the DimensionTree
Parameters None
Example DimensionTree.RootID = 32060
SelectedID
Type Property (Integer)
Purpose Gets or sets the ID for the currently selected DimensionTree item.
Parameters None.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 311
Example MySelectedID = DimensionTree.SelectedID DimensionTree.SelectedID = 10567
SelectedName
Type Property (String)
Purpose Gets or sets the name of the currently selected DimensionTree item.
NoteWhen you write script for a dimension tree that contains a BOM Makeup, you must take into account that the same child item can appear under multiple parents in the same hierarchy. For more information, see the “Books in Bill of Materials Modeling” topic in the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Parameters None.
Example MyManager = DimensionTree.SelectedName DimensionTree.SelectedName = "Fred"
SetRootItemName
Type Procedure
Purpose This causes the treeview to rebuild using the provided item as the new root item. If the value passed as the new root name does not exist, or is not a valid item for the current tree dimension, it will do nothing.
Parameters Dimension Item Name (String)
Example DimensionTree.SetRootItemName DimensionItemName
SetSubject
Type Procedure
312 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Purpose Notifies a Keys object that this DimensionTree wishes to be attached to it.
NoteThe recommended method of attachment is made in the opposite direction through the Keys.Attach procedure, which ensures that the Keys object is in control of all its linked controls.
Parameters KeysObjectID (Integer)
Example 'Change the Keys object that a Dimension Tree uses at runtime DimensionTree.SetSubject Keys1.ObjectIDThen force a refresh DimensionTree.ObsUpdate Keys1.ObjectID,0
ShowRoot
Type Property (Boolean)
Purpose This toggles visibility of the root item in the DimensionTree
Parameters None
Example DimensionTree.ShowRoot = True
UseCustomAlias
Type Property (Boolean)
Purpose A toggle that switches the use of the Custom Alias On or Off
Parameters None
Example DimensionTree.UseCustomAlias = True
WideText
Type Property (String)
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 313
Purpose Gets or sets the text string in the DimensionTree, without selecting an item.
Parameters None
Example DimensionTree.WideText = "Fred"
ValidityID
Type Property (Read Only Integer)
Purpose Used to check that the object is a valid DimensionTree object.
Parameters None.
Example If DimensionTree.ValidityID = 311071 Then Msgbox "That IS a valid DimensionTree."
Related Information
Constant Names and Values [page 374]
5.8.2 DimensionTree Appearance
Color
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the selection box.
Parameters None.
Example DimensionTree.Color = 12211667
Down
Type Property (Boolean)
314 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Purpose Gets or sets whether the drop-down list is dropped or not.
Parameters None.
Example DimensionTree.Down = TRUE
DropHeight
Type Property (Integer)
Purpose Gets or sets the height of the drop-down section of the DimensionTree.
Parameters None.
Example DimensionTree.DropHeight = 50 NewDropHeight = DimensionTree.DropHeight
FontColor
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the font used in the DimensionTree.
Parameters None
Example DimensionTree.FontColor = 255 'Set the color to red
FontName
Type Property (String)
Purpose Gets or sets the name of the font used in the DimensionTree.
Parameters None.
Example DimensionTree.FontName = "Arial"
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 315
FontSize
Type Property (Integer)
Purpose Gets or sets the size of the font used in the DimensionTree.
Parameters None.
Example DimensionTree.FontSize = 12
FontStyle
Type Property (Integer)
Purpose Gets or sets the style of the font used in the DimensionTree. The value can be set to be a combination of available styles, so Bold AND Italic text would be 3, as in Bold=1 and Italic=2.
Parameters 0=Normal text, 1=Bold, 2=Italic, 4=Underlined text, 8=Strikethrough
also
fsBold = 1; fsItalic = 2; fsUnderline = 4
Example DimensionTree.FontStyle = 7
Height
Type Property (Integer)
Purpose Gets or sets the height of the DimensionTree in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example DimensionTree.Height = 30
316 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Width
Type Property (Integer)
Purpose Gets or sets the width of the DimensionTree in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example
5.8.3 DimensionTree Web Only
DataSourceObjectID
Type Property (Integer) – web only
Purpose Gets or sets a pointer to the application’s data source.
Parameters None.
Example MyDataSourceID = DimensionTree.DataSourceObjectID
5.9 DimensionList object
Like the DimensionTree object, the DimensionList object can be linked to a Keys object that is used to specify the data that appears in a Grid, Chart, or Report. Any change to the selected item in the DimensionList will then produce an automatic change in the displayed dataset.
Any change to the selected DimensionList item also produces OnChange event that can have script written for it that can be used to alter the normal course of operation.
The DimensionList object can also be programmed to operate in a multi-selection mode. This can be used in script to pass a selection of several dimension items on for use in other operations. When the DimensionList object is linked to a Keys object, only the initial selection will take effect.
If you want to hide this control in a book, you can only achieve this by setting its width and height to 1, not 0. This will effectively make the control invisible.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 317
5.9.1 DimensionList General
BeginUpdate
Type Procedure
Purpose Increments an internal counter operating as a transactional control that blocks the effect of any updates to this DimensionList. These remain pending until the counter returns to zero following use of the EndUpdate procedure.
Parameters None.
Example DimensionList.BeginUpdate
CustomAliasName
Type Property
Purpose Allows you to display dimension items using a specific Alias by name. If the Alias name given does not exist, the UseCustomAlias property will be set back to false and will ignore this setting.
Parameters AliasName (String)
Example DimensionList.CustomAliasName("EPO Code")
DimensionID
Type Property (Integer)
Purpose Gets or sets the dimension ID for the DimensionList control
Parameters None.
Example DimensionList.DimensionID = 2 SelectedDimensionID = DimensionList.DimensionID 'Can use Constant Names and Values
318 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Enabled
Type Property
Purpose A toggle that enables or disables the DimensionListParameters None
Example DimensionList.Enabled = True
EndUpdate
Type Procedure
Purpose Decrements the internal counter that prevents updates being implemented on this DimensionList. This counter is incremented by the DimensionList.BeginUpdate procedure. Updates to the DimensionList remain pending until the counter is zero.
Parameters None.
Example DimensionList.EndUpdate
GetSelID
Type Function (Integer)
Purpose Returns the application item identifier for the indexed item
Parameters Index in the range 0 -> SelCount-1
Example MyReturnValue = DimensionList.GetSelID (12)
GetSelName
Type Function (string)
Purpose Returns the name of the indexed item
Parameters Index in the range 0 -> SelCount-1
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 319
Example MyReturnValue = DimensionList.GetSelName (12)
MultiSelect
Type Property (Boolean)
Purpose A toggle that switches the DimensionList into/out of Multi-select mode.
Parameters None
Example DimensionList.MultiSelect = True
ObjectID
Type Property (Read Only Integer)
Purpose Returns an identifier number relating to the DimensionList object.
Parameters None.
Example MyReturnValue = DimensionList.ObjectID
ObsUpdate
Type Procedure
Purpose Notifies the DimensionList that it has received an update from a specified linked Keys control, causing it to rebuild.
Parameters ObjectID (Integer)
UpdateType:
0 – data has changed
1 – structure has changed
Info (Cardinal number – reserved for internal use only)
320 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Example DimensionList.ObsUpdate Keys.ObjectID, 0
RootID
Type Property (Integer)
Purpose Gets or sets the root item as the top item in the DimensionList
Parameters None
Example DimensionList.RootID = RootItemID
SelCount
Type Property (Integer)
Purpose In Multi-select mode, this returns the number of selected items
Parameters None
Example MySelectedItems = DimensionList.SelCount
SelectedID
Type Property (Integer)
Purpose Gets or sets the ID for the currently selected DimensionList item.
Parameters None
Example MyReturnValue = DimensionList.SelectedID DimensionList.SelectedID = DimensionItemID
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 321
SelectedName
Type Property (String)
Purpose Gets or sets the name of the currently selected DimensionList item.
NoteWhen you write script for a dimension list that contains a BOM Makeup, you must take into account that the same child item can appear under multiple parents in the same hierarchy. For more information, see the “Books in Bill of Materials Modeling” topic in the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Parameters None.
Example MyManager = DimensionList.SelectedName DimensionList.SelectedName = "Fred"
SetRootItemName
Type Procedure
Purpose This causes the treeview to rebuild using the provided item as the new root item. If the value passed as the new root name does not exist, or is not a valid item for the current tree dimension, it will do nothing.
Parameters Dimension Item Name (String)
Example DimensionList.SetRootItemName DimensionItemName
SetSubject
Type Procedure
Purpose Notifies a Keys object that this DimensionList wishes to be attached to it.
NoteThe recommended method of attachment is made in the opposite direction through the Keys.Attach procedure,
322 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
which ensures that the Keys object is in control of all its linked controls.
Parameters KeysObjectID (Integer)
Example 'Change the Keys object that a DimensionList uses at runtime DimensionList.SetSubject Keys1.ObjectID'Then force a refresh DimensionList.ObsUpdate Keys1.ObjectID,0
ShowRoot
Type Property (Boolean)
Purpose This toggles visibility of the root item in the DimensionList
Parameters None
Example DimensionList.ShowRoot = True
UseCustomAlias
Type Property (Boolean)
Purpose A toggle that switches the use of the Custom Alias On or Off
Parameters None
Example DimensionList.UseCustomAlias = True
Related Information
Constant Names and Values [page 374]
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 323
5.9.2 DimensionList Appearance
Color
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the selection box
Parameters None.
Example DimensionList.Color = 12211667
FontColor
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the font used in the DimensionList.
Parameters None
Example DimensionList.FontColor = 255 'Set the color to red
FontName
Type Property (String)
Purpose Gets or sets the name of the font used in the DimensionList.
Parameters None.
Example DimensionList.FontName = "Arial"
FontSize
Type Property (Integer)
Purpose Gets or sets the size of the font used in the DimensionList.
Parameters None.
324 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Example DimensionList.FontSize = 12
FontStyle
Type Property (Integer)
Purpose Gets or sets the style of the font used in the DimensionList. The value can be set to be a combination of available styles, so Bold AND Italic text would be 3, as in the example of Bold=1 and Italic=2.
Parameters 0=Normal text, 1=Bold, 2=Italic, 4=Underlined text, 8=Strikethrough
also
fsBold = 1; fsItalic = 2; fsUnderline = 4
Example DimensionList.FontStyle = 7
Height
Type Property (Integer)
Purpose Gets or sets the height of the DimensionList in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example DimensionList.Height = 30
Width
Type Property (Integer)
Purpose Gets or sets the width of the DimensionList in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 325
Example DimensionList.Width = 70
5.10 Drill object
Use the Drill object is available to Objectives and Metrics models only.The Drill object supports an OnDblClick (a double click) event that can have script attached, allowing an End User to navigate from a Gauge in the Drill control to a book that contains information descripting the Gauge which was clicked.
If you want to hide this control in a book, you can only achieve this by setting its width and height to 1, not 0. This will effectively make the control invisible.
5.10.1 Drill Object General
SelectedVersionID
Type Property (Read Only Integer)
Purpose Returns the ID of the <Version> item associated with the selected Gauge.
Parameters None.
Example MyReturnValue = Drill.SelectedVersionID
SelectedPeriodID
Type Property (Read Only Integer)
Purpose Returns the ID of the <Period> item associated with the selected Gauge.
Parameters None.
Example MyReturnValue = Drill.SelectedPeriodID
326 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
SelectedRespCenterID
Type Property (Read Only Integer)
Purpose Returns the ID of the <Responsibility Center> item associated with the selected Gauge.
Parameters None.
Example MyReturnValue = Drill.SelectedRespCenterID
SelectedObjectiveID
Type Property (Read Only Integer)
Purpose Returns the ID of the <Objective> item associated with the selected Gauge.
Parameters None.
Example MyReturnValue = Drill.SelectedObjectiveID
SelectedMetricID
Type Property (Read Only Integer)
Purpose Returns the ID of the <Metric> item associated with the selected Gauge.
Parameters None.
Example MyReturnValue = Drill.SelectedMetricID
SelectedTableFieldID
Type Property (Read Only Integer)
Purpose Returns the ID of the TableField associated with the selected Gauge.
Parameters None.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 327
Example MyReturnValue = Drill.SelectedTableFieldID
SelectedgaugeKind
Type Property (Read Only Integer) where
0 - MetricBaseActualTarget
1 - ObjectiveBaseActualTarget
2 - MetricAchieved
3 - ObjectiveResult
4 - AchievementComparison
Purpose Returns the ID of the Dimension associated with the selected Gauge.
Parameters None.
Example MyReturnValue = Drill.SelectedgaugeKind
SelectedDimensionID
Type Property (Read Only Integer)
Purpose Returns the ID of the dimension displayed as the title of the selected Gauge.
Parameters None.
Example MyReturnValue = Drill.SelectedDimensionID
DataStream
Type Property (String)
Purpose Returns a string defining the data associated with the selected Gauge.
Parameters None.
328 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Example MyReturnValue = Drill.DataStream
5.11 Edit Box object
The Edit Box object supports an OnChange event that can have script attached, which will allow an End User to start a new course of action in the current book.
NoteIf you set the Text property for an Edit Box object in the Book Editor, this is the text that is displayed whenever a book is opened. Users and book script can alter the text at run time, however the changes are not saved to the database. When the book is next opened, the text that you set at design time is displayed.
If you want to hide this control in a book, you can only achieve this by setting its width and height to 1, not 0. This will effectively make the control invisible.
Its Properties and Methods are described next.
5.11.1 Edit Box Object General
Enabled
Type Property (Boolean)
Purpose Gets or sets whether the Edit Box receives the focus or allows text to be entered.
Parameters None.
Example Edit.Enabled = False
MaxLength
Type Property (Integer)
Purpose Sets the maximum number of text characters that can be entered into the Edit Box.
Parameters None.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 329
Example Edit.MaxLength = 255
PasswordChar
Type Property (Character)
Purpose If this property is set then the Edit Box becomes a password entry field using the character specified in the property as the character mask.
Parameters None.
Example Edit.PasswordChar = "*"
ReadOnly
Type Property (Boolean)
Purpose Gets or sets whether text can be entered into the Edit Box.
Parameters True, False
Example Edit.ReadOnly = True
Text
Type Property (String)
Purpose Gets or sets the text contained within the Edit Box.
Parameters None.
Example Edit.Text = "Here is some text."
330 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
5.11.2 Edit Box Object Appearance
Color
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the Edit Box.
Parameters None.
Example Edit.Color = 12211667 'Light orchid color
FontColor
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the font used in the Edit Box.
Parameters None.
Example Edit.FontColor = 255 'Set the color to red.
FontName
Type Property (String)
Purpose Gets or sets the name of the font used in the Edit Box.
Parameters None.
Example Edit.FontName = "Arial"
FontSize
Type Property (Integer)
Purpose Gets or sets the size of the font used in the Edit Box. Measured in font points.
Parameters 8 to 72
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 331
Example Edit.FontSize = 12
FontStyle
Type Property (Integer)
Purpose Gets or sets the style of the font used in the Edit Box. The value can be set to be a combination of available styles, so Bold AND Italic text would be 3, like Bold=1 and Italic=2.
Parameters 0=Normal text, 1=Bold, 2=Italic, 4=Underlined text, 8=Strikethrough
also
fsBold = 1; fsItalic = 2; fsUnderline = 4
Example Edit.FontStyle = 7
Width
Type Property (Integer)
Purpose Gets or sets the width of the Edit Box in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example Edit.Width = 70
5.11.3 Edit Box Object Web Only
Clear
Type Procedure – web only
Purpose Clears the text from the Edit Box, leaving it empty.
Parameters None.
332 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Example Edit.Clear
Flat
Type Property (Boolean) – web only
Purpose Gets or sets whether the Edit Box is displayed with or without a border.
Parameters None
Example Edit.Flat = True
5.12 Grid object
The Grid object is used to display your model data, and its dataset is specified through several other objects that can be linked to the grid. The DimensionTree, DimensionList, DataManager, and Key objects can all contribute to defining the dataset that appears in the grid.
The Grid object supports only one event, OnCellSelected, which occurs every time you change the focused cell in a grid.
NoteIf you want to hide this control in a book, you can only achieve this by setting its width and height to 1, not 0. This will effectively make the control invisible.
Grids can be controlled and manipulated through the Properties and Methods listed below.
5.12.1 Grid General
BeginUpdate
Type Procedure
Purpose Increments an internal counter operating as a transactional control that blocks the effect of any updates to this Grid. These remain pending until the counter returns to zero following use of the EndUpdate procedure. Updates to a
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 333
Grid are caused by changes in the DataManager and Keys object it is linked to.
Parameters None.
Example Grid.BeginUpdate
BookFimURLParams
Type Parameter
Purpose This parameter can be used when Profitability and Cost Management is configured to communicate with the SAP BusinessObjects Financial Information Management application. The parameter returns the same result as the Drill-to-Origin right-click menu option in a grid. In other words, the result provides the context that enables Financial Information Management to track and locate the origin of a value. A typical example of a return value for this parameter is as follows: &VERSION=Actual&PERIOD=January&RESPCENTER=IT&LINEITEMRaw%20Materials&MEASURE=LINEITEMVALUE
Parameters None
Example Edit.Text = Grid1.BookFimURLParams
For more information on the Drill-to-Origin option, see the SAP BusinessObjects Profitability and Cost Management Modeling User Guide. For more information on configuring the product to communicate with SAP BusinessObjects Financial Information Management, see the SAP BusinessObjects Profitability and Cost Management Installation Guide.
CanEditCellMemo
Type Function (Boolean)
Purpose Returns whether a cell memo can be edited or not.
Parameters Column (Integer), Row (Integer)
Example 'Checks the memo for the cell in the first column and first row CanEditMemo=Grid.CanEditCellMemo(0,0)
334 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
CopySelectionToClipboard
Type Procedure
Purpose Copies the selected area to the clipboard in text format.
Parameters IncludeHeaders (Boolean)
When this is set to true the grid header labels are also copied. Set this parameter to false to copy only the values from the grid.
Example Grid.CopySelectionToClipboard False
CurrencyDisplay
Type Property (Type List)
Purpose Get or set the method of displaying currency-based data.
Parameters cdNone=0, cdSymbol=1, cdCode=2
Example Grid.CurrencyDisplay = 1
DecimalPlaces
Type Property (Integer)
Purpose Gets or sets the number of decimal places to be displayed in a grid.
Parameters None.
Example Grid.DecimalPlaces = 2
Enabled
Type Property (Boolean)
Purpose A toggle that enables/disables the grid.
Parameters None.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 335
Example Grid.Enabled = True
EndUpdate
Type Procedure
Purpose Decrements the internal counter that prevents updates being implemented on this Grid. This counter is incremented by the Grid.BeginUpdate procedure. Updates to the Grid remain pending until the counter is zero.
Parameters None.
Example Grid.EndUpdate
GetCellCanEdit
Type Function (Boolean)
Purpose Returns whether a cell can be edited or not.
Parameters Column (Integer), Row (Integer)
Example 'Checks the cell in the first column and first row. CanEdit = Grid.GetCellCanEdit(0,0)
GetCellCurrency
Type Function (Integer)
Purpose Returns the ID of a currency used by a particular grid cell.
Parameters Column (Integer), Row (Integer)
Example 'Checks the cell in the first column and first row. myCellCurrencyID = Grid.GetCellCurrency(0,0)
336 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
GetCellMemo
Type Function (String)
Purpose Returns the memo associated with a given cell.
Parameters Column (Integer), Row (Integer)
Example 'Gets the memo string in the first column and first row. myCellMemo = Grid.GetCellMemo(0,0)
GetCellTableField
Type Function (Integer)
Purpose Returns the ID of the table field used by a given cell.
Parameters Column (Integer), Row (Integer)
Example 'Gets the ID of the Grid Value in the first column and first row. myCellTableFieldID = Grid.GetCellTableField(0,0)
GetCellValue
Type Function (Variant)
Purpose Returns the value of a grid cell
Parameters Column (Integer), Row (Integer), Currency (Integer)
Example 'Gets the Value in the first column and first row, using the default currency. myCellValue = Grid.GetCellValue(0,0)
GetColumnCount
Type Function (Integer)
Purpose Returns the total number of columns in a grid.
Parameters None
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 337
Example NumberofColumns = Grid.GetColumnCount()
GetRowCount
Type Function (Integer)
Purpose Returns the total number of rows in a grid.
Parameters None
Example NumberofRows = Grid.GetRowCount()
ObjectID
Type Property (Read Only Integer)
Purpose Returns the identifier number of the Grid object
Parameters None.
Example MyReturnValue = Grid.ObjectID
ObsUpdate
Type Procedure
Purpose Notifies the Grid that it has received an update from a specified linked control, DataManager, or Keys, causing it to update.
Parameters ObjectID (Integer)
UpdateType:
0 – data has changed
1 – structure has changed
Example Grid.ObsUpdate DataManager.ObjectID,0
338 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
PasteClipboard
Type Procedure
Purpose Pastes the contents of the clipboard into the grid at the position where the cursor, or focus, was last placed.
Parameters None.
Example Grid.PasteClipboard
RangeSelect
Type Property (Boolean)
Purpose Gets or sets the ability to select a range of cells in the grid.
Parameters None.
Example Grid.RangeSelect = True
ReadOnly
Type Property (Boolean)
Purpose Gets or sets whether the grid is editable.
Parameters None.
Example Grid.ReadOnly = True
ReInitialize
Type Procedure
Purpose Causes the grid to return to its initial state, as it was when loaded from the database. Returns all column widths to their default size.
Parameters None.
Example Grid.ReInitialize
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 339
SelectAll
Type Procedure
Purpose Selects all cells in the grid when RangeSelect is True.
Parameters None.
Example Grid.SelectAll
SelectedColumn
Type Property (Read Only)
Purpose Returns the index of the currently selected Column. If no column is selected or range select is turned on then this will return -1.
Parameters None.
Example CurrentColumn = Grid.SelectedColumn
SelectedRow
Type Property (Read Only)
Purpose Returns the index of the currently selected row. If no row is currently selected, or range select is turned on, then this will return -1.
Parameters None.
Example CurrentRow = Grid.SelectedRow
SetCellMemo
Type Procedure
Purpose Sets the memo for a grid cell.
Parameters Column (Integer), Row (Integer), Memo (String)
340 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Example 'Sets the memo string in the first column and first . rowGrid.SetCellMemo 0,0,"My Cell Memo"
SetCellValue
Type Procedure
Purpose Sets the value of a grid cell
Parameters Column (Integer), Row (Integer), Value (Decimal)
Example 'Sets the value in the first column and first. rowGrid.SetCellValue 0,0, 10000
SetSubject
Type Procedure
Purpose Establishes a connection between the Grid and a Data Manager object. Notifies a DataManager that this Grid wishes to be attached to it.
NoteThe recommended method of attachment is made in the opposite direction through the DataManager.Attach procedure, which ensures that the DataManager is in control of all its linked visual controls.
Parameters DataManagerID (Integer)
Example 'Change the DataManager object that a Grid uses at runtime GridGrid.SetSubject DataManager1.ObjectID 'Then force a refresh Grid.ObsUpdate DataManager1.ObjectID,0
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 341
ValidityID
Type Property (Read Only Integer)
Purpose Used to check that the object is a valid Grid object.
Parameters None.
Example If Grid.ValidityID = 311073 Then Msgbox "That IS a valid Grid."
5.12.2 Grid Appearance
DefaultColWidth
Type Property (Integer)
Purpose Gets or sets the default width for Grid columns. Column width expressed in pixels.
Parameters None.
Example Grid.DefaultColWidth = 100
DefaultRowHeight
Type Property (Integer)
Purpose Gets or sets the default height for Grid rows. Row height is expressed in pixels.
Parameters None.
Example Grid.DefaultRowHeight = 20
FontColor
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the font used in the Grid and headers
Parameters None
342 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Example Grid.FontColor = 255 'Set the color to red.
FontName
Type Property (String)
Purpose Gets or sets the name of the font used in the Grid and headers.
Parameters None.
Example Grid.FontName = "Arial"
FontSize
Type Property (Integer)
Purpose Gets or sets the size of the font used in the Grid and headers.
Parameters None.
Example Grid.FontSize = 12
FontStyle
Type Property (Integer)
Purpose Gets or sets the style of the font used in the Grid. The value can be set to be a combination of available styles, so Bold AND Italic text would be 3, like Bold=1 and Italic=2.
Parameters 0=Normal text, 1=Bold, 2=Italic, 4=Underlined text, 8=Strikethrough
also
fsBold = 1; fsItalic = 2; fsUnderline = 4;
Example Grid.FontStyle = 7
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 343
Height
Type Property (Integer)
Purpose Gets or sets the height of the Grid in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example Grid.Height = 30
Width
Type Property (Integer)
Purpose Gets or sets the width of the Grid in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example Grid.Width = 70
5.13 Keys object
The Keys object is a non-visual control that specifies the location of a dataset as a list consisting of one selected item in each dimension and a specified Grid Value. It can be linked to a DataManager object that specifies the layout that is to be displayed in a Grid, Chart, or Report. When these links have been correctly specified the required data will be displayed automatically.
The Keys object has no events directly associated with it that script can be written against, but can be controlled through the script associated with any visible objects it may be linked to. The following properties and methods allow you to control these links and to interrogate and set cell values and memos.
5.13.1 Keys General
Attach
Type Procedure (Integer)
344 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Purpose Attaches a specific user interface control to the Keys object, for example DataManager, DimensionTree, or DimensionList. This is method of attachment is preferable to using SetSubject from the UI control.
Parameters ObjectID (Integer)
Example Keys.Attach DataManager.ObjectID
BeginUpdate
Type Procedure
Purpose Increments an internal counter operating as a transactional control that blocks the effect of any updates to this Keys object. These remain pending until the counter returns to zero following use of the EndUpdate procedure. Updates to a Keys object are caused by either programmatic changes or changes in the DimensionTrees/DimensionLists it is linked to. Any controls that are linked to this Keys object will not react to updates until the counter returns to zero.
Parameters None.
Example Keys.BeginUpdate
CanEditCellMemo
Type Function (Boolean)
Purpose Returns whether the memo currently referenced by the Keys object can be edited or not.
Parameters None
Example CanEditMemo=Keys.CanEditCellMemo
CellMemo
Type Property (String)
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 345
Purpose Gets or Sets the memo currently referenced by the Keys object, for example DataManager, DimensionTree, DimensionList
Parameters None
Example Keys.CellMemo = "my memo string" MyMemoString = Keys.CellMemo
Detach
Type Procedure (Integer)
Purpose Disconnects the various user interface controls from the Keys object.
Parameters ObjectID (Integer)
Example Keys.Detach DataManager.ObjectID
EndUpdate
Type Procedure
Purpose Decrements the internal counter that prevents updates being implemented to this Keys object. This counter is incremented by the Keys.BeginUpdate procedure. Updates to this Keys object and any controls linked to it remain pending until the counter is zero.
Parameters None.
Example Keys.EndUpdate
GetAssociatedValue
Type Function (Double)
Purpose Returns the Grid Value associated with a modified version of the current Keys object where the Grid value is replaced using the specified TableFieldID and the item defined for one of the dimensions is replaced using the specified DimensionID and ItemID. This is a convenient means for
346 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
retrieving values associated with a similar set of key dimensions. For example, with the keys set up to retrieve a LineItemValue for October we can retrieve the LineItemDataValue for September specifying LineItemDataValue as the tablefield together with the Period's DimensionID and the ItemID for September.
Parameters TableFieldID (Integer), DimensionID (Integer), ItemID (Integer)
Example 'Returns LineItemDataValue for September when the current Keys object specifies LineItemValue for October. MyLineItemDataValue = Keys.GetAssociatedValue(6054,1,SeptemberID)
GetItemMemo
Type Function (String)
Purpose Returns the memo associated with a specific dimension item.
Parameters DimensionID (Integer), Dimension Item ID (Integer)
Example 'Returns the memo associated with a specific dimension item Memo.Text = Keys.GetItemMemo(3,DimensionTree.SelectedID)
GetKeyItemName
Type Function (String)
Purpose Returns the name of the key value for a specified dimension.
Parameters DimensionID (Integer)
Example 'Returns the name of the Responsibility Center key value MyReturnValue = Keys.GetKeyItemName(2)
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 347
GetKeyValue
Type Function (Integer)
Purpose Returns the itemID of the key value for a specified dimension.
Parameters DimensionID (Integer)
Example 'Returns the ID of the Responsibility Center key value MyItemID = Keys.GetKeyValue(2)
GetTableFieldValue
Type Function (Double)
Purpose Returns the Grid Value specified by the TableFieldID, rather than the Grid Value specified in the current Keys object, for the cell specified by the current key dimensions. This is a convenient means for retrieving values associated with the same set of key dimensions.
Parameters TableFieldID (Integer)
Example 'Returns ActivityDriverTargetValue when the current Keys object specifies ActivityDriverValue. MyActivityDriverTargetValue = Keys.GetTableFieldID(6105)
GetValue
Type Function (Double)
Purpose Returns the (GridValue) value of the cell specified by the current key dimensions.
Parameters None.
Example MyGridValue = Keys.GetValue()
NoteThe use of brackets is required for this function to work on the web.
348 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
HasData
Type Function (Boolean)
Purpose Used to detect whether the keys is connected to a model or not
Parameters none
Example If Keys.HasData() then Keys.SaveToFile "C:\MyLayout.kvw" End if
KeyTableField
Type Property (Integer)
Purpose Gets or sets the ID of the GridValue for the current Keys object.
Parameters None.
Example 'Tell the keys that its GridValue is 'LineItemValue' Keys.KeyTableField = 540010
NoteNames of Dimensions and Grid Value constants are available in Rule script but not in Book script to minimize overheads.
LoadFromFile
Type Procedure
Purpose Loads a saved Keys object from a file in a specified location. The location can also be a URL (internet location).
Parameters Filename (String)
Example Keys.LoadFromFile "C:\PCM\myView.kvw"
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 349
ObjectID
Type Property (Read Only Integer)
Purpose Returns an identifier number relating to the Keys object
Parameters None.
Example MyReturnValue = Keys.ObjectID
SaveToFile (FileName)
Type Procedure
Purpose Saves the current state of the Keys object to a specified location.
Parameters Filename (String)
Example Keys.SaveToFile "C:\PCM\myView.kvw"
SetItemMemo
Type Procedure
Purpose Sets a memo string for a specified dimension item.
Parameters DimensionID (Integer), Dimension Item ID (Integer), Memotext (String)
Example 'Creates a memo against a specific dimension item Keys.SetItemMemo 3, DimensionTree.SelectedID, Memo.Text
NoteEnd users need at least Edit Data access in dimension item security to update memos with this method.
SetKeyItemName
Type Procedure
350 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Purpose Sets the key value for a specified dimension to a specific item by name.
NoteWhen you write script for a Keys object that contains a BOM Makeup, you must take into account that the same child item can appear under multiple parents in the same hierarchy. For more information, see the “Books in Bill of Materials Modeling” topic in the SAP BusinessObjects Profitability and Cost Management Modeling User Guide.
Parameters DimensionID (Integer), ItemName(String)
Example 'Sets the name of the Responsibility Center key value for the Keys item to be the same as the Keys1 Responsibility Center key item name. Keys.SetKeyItemName 2, Keys1.GetKeyItemName(2)
NoteNames of Dimensions and Grid Value constants are available in Rule script but not in Book script to minimize overheads
SetKeyValue
Type Procedure
Purpose Sets the key value for a specified dimension by item ID.
Parameters DimensionID (Integer), ID (Integer)
Example 'Sets the ID of the Responsibility Center key value for the Keys item to be the same as the Keys1 Responsibility Center key value. Keys.SetKeyValue 2, Keys1.GetKeyValue(2)
NoteNames of Dimensions and Grid Value constants are available in Rule script but not in Book script to minimize overheads
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 351
SetValue
Type Procedure
Purpose Sets the value of the item specified by the current key dimensions.
Parameters Value (Double)
Example Keys.SetValue "3.14159265"
ValidityID
Type Property (Read Only Integer)
Purpose Used to check that the object is a valid Keys object.
Parameters None.
Example If Keys.ValidityID = 311072 Then Msgbox "That IS a valid Keys object."
Related Information
Constant Names and Values [page 374]
5.13.2 Keys Web Only
DefaultCurrency
Type Property (Integer) – web only
Purpose Gets or sets the ID of the currency that is to be the default for the current Keys object.
Parameters None.
Example Keys.DefaultCurrency = 3001
352 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
5.14 Memo object
The Memo object operates like a multi-line Edit Box, but has no events associated with it. This means you can enter text that can be read from script entered against events raised through other objects in the current book, like Button_OnClick.
NoteIf you set the Text property for a Memo object in the Book Editor, this is the text that is displayed whenever a book is opened. Users and book script can alter the text at runtime, however the changes are not saved to the database. When the book is next opened, the text that you set at design time is displayed.
If you want to hide this control in a book, you can only achieve this by setting its width and height to 1, not 0. This will effectively make the control invisible.
5.14.1 Memo General
Enabled
Type Property (Boolean)
Purpose Gets or sets whether the Memo control receives the focus or allows text to be entered.
Parameters None.
Example Memo.Enabled = True
Text
Type Property (String)
Purpose Gets or sets the text contained within the Memo box.
Parameters None.
Example Memo.Text = "Here is some text."
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 353
5.14.2 Memo Appearance
Color
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the font used in the Memo box.
Parameters None.
Example Memo.FontColor = 255 'Set the color to red.
FontColor
Type Property (OLE_COLOR)
Purpose Gets or sets the color of the font used in the Memo box.
Parameters None
Example Memo.FontColor = 255 'Set the color to red.
FontName
Type Property (String)
Purpose Gets or sets the name of the font used in the Memo box.
Parameters None.
Example Memo.FontName = "Arial"
FontSize
Type Property (Integer)
Purpose Gets or sets the size of the font used in the Memo box. Measured in font points.
Parameters 8 to 72
354 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Example Memo.FontSize = 12
FontStyle
Type Property (Integer)
Purpose Gets or sets the style of the font used in the Memo box. The value can be set to be a combination of available styles, so Bold AND Italic text would be 3, like Bold=1 and Italic=2.
Parameters 0=Normal text, 1=Bold, 2=Italic, 4=Underlined text, 8=Strikethrough
also
fsBold = 1; fsItalic = 2; fsUnderline = 4;
Example Memo.FontStyle = 7
Height
Type Property (Integer)
Purpose Gets or sets the height of the Memo in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example Memo.Height = 30
Width
Type Property (Integer)
Purpose Gets or sets the width of the Memo in pixels. Must be greater than 0. The object can be rendered invisible by setting height and width to a value of 1.
Parameters None
Example Memo.Width = 70
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 355
5.15 Model object
The Model object properties and methods deal mainly with the QueryString, a mechanism that can store parameters and their values. These can be planted as Name and Value pairs in URL strings, which support navigation to other books where the parameters can be retrieved by further use of QueryString functions.
For more information on using the QueryString and URL format please refer to the Profitability and Cost Management Modeling User Guide or F1 Help.
5.15.1 Model Object General Properties and Methods
CurrentModel
Type Property (String)
Purpose Gets or sets the name of the current model in use by the Model object.
Parameters None.
Example EPOPP.CurrentModel = "The ABC Model"
GetQueryStringValue
Type Function (String)
Purpose Returns the value of the named QueryString parameter.
Parameters Name (String)
Example MyManagerName = EPOPP.GetQueryStringValue("Manager name")
QueryString
Type Property (String)
Purpose Gets or sets the value of the QueryString URL.
Parameters None.
356 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Example MyURL = EPOPP.QueryString
QueryStringClear
Type Procedure
Purpose Clears the value of the QueryString URL.
Parameters None.
Example EPOPP.QueryStringClear
SetQueryStringValue
Type Procedure
Purpose Sets the named QueryString parameter to the specified value.
Parameters Name (String), Value (String).
Example EPOPP.SetQueryStringValue "Manager name","Fred"
UniqueModelID
Type Property (Integer)
Purpose Returns the Unique Model ID (UMID) for a model.
Parameters None
Example modelUniqueIDParam = "UMID=" + CStr(EPOPP.UniqueModelID)
5.16 Tree Filter object
The Tree Filter object supports an OnChange event that can have script attached to it. The OnChange event is triggered when the filter string of the Filter property is changed.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 357
If you want to hide this control in a book, set its width to 0. This effectively makes the control invisible. The properties and methods of the Tree Filter object are described in the topics that follow.
5.16.1 Tree Filter Object General
Attach
Type Procedure
Purpose Connects a specific user interface control to a Tree Filter object
Parameters ObjectID (Integer)
Example TreeFilter.Attach DimensionTree.ObjectID
Detach
Type Procedure
Purpose Disconnects a specific user interface control to a Tree Filter object
Parameters ObjectID (Integer)
Example TreeFilter.Detach DimensionTree.ObjectID
Filter
Type Property (String)
Purpose Gets or sets the text by which to filter a Dimension Tree or Dimension List.
Parameters None
Example TreeFilter.Filter = "Budget"
358 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Filtered
Type Property (Boolean)
Purpose Determines whether the filtering functionality is enabled or not.
Parameters None
Example TreeFilter.Filtered = TRUE
5.16.2 Tree Filter Object Appearance
Width
Type Property (Integer)
Purpose Gets or sets the width of a Tree Filter in pixels. Must be 0 or higher. A setting of 0 renders the object invisible in a Book
Parameters None
Example TreeFilter.Width = 200
5.17 Workflow object
This Workflow object acts as a host in your book to the current instance of a Workflow process being conducted by the Work Manager application. It has no properties, but supports a number of functions and procedures, some of which are reserved for internal use in managing the connection between the Workflow object and the Work Manager Server.
Work Manager has access to a more significant range of Properties and Methods that are fully described in the section on Work Manager Process Functions.
The interaction between Work Manager and your books is normally initiated when a Workflow process calls one of your books using a URL String. This contains an ActiveWorkflowID that is automatically retrieved by the BookOpen script and integrated into the book's Workflow object. By this means the book can validate this instance of the workflow and examine its properties. It can also start new workflow processes and stimulate workflow in existing processes by sending events to Work Manager.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 359
Related Information
Work Manager Process Functions [page 364]
5.17.1 Workflow General
ActiveWorkflowID
Type Procedure (Internal)
Purpose Gets or sets the ID of the current workflow instance. Used when a book opens, to obtain the ID of the workflow instance that has opened the book.
Parameters None
Example MyCurrentInstanceID = Workflow1.ActiveWorkflowID Workflow1.ActiveWorkflowID = NewCurrentInstanceID
ConnectToWorkflow
Type Procedure (Internal)
Purpose Connects a Workflow Object to the data communication mechanism.
Parameters ObjectID
Example Workflow1.ConnectToWorkflow(ObjectID)
CreateWorkflow
Type Procedure (Internal)
Purpose Initiates a new workflow of a specific Workflow Process Type. This will not necessarily produce a new instance of the workflow as this depends on the initial code in the Workflow Process.
Parameters Workflow Process Name (String)
360 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Creation Data Parameters Variant Array):
Parameter 0 – Model Name
Parameter 1 – Manager Name
Parameter 2 – List of Users
Example Workflow1.CreateWorkflowbyName(WorkflowProcessTypeID,CreationData)
CreateWorkflowByName
Type Procedure (preferred book user method for creating a workflow)
Purpose Initiates a new workflow of a specific named Workflow Process Type. This will not necessarily produce a new instance of the workflow as this depends on the initial code in the Workflow Process.
Parameters Workflow ProcessType Name (String)
Creation Data Parameters Variant Array:
Parameter 0 – Model Name
Parameter 1 – Manager Name
Parameter 2 – List of Users
Example Workflow1.CreateWorkflowbyName (WorkflowProcessTypeName,CreationData)
GetProperty
Type Function (String)
Purpose Returns the value of a Workflow property (defined by the Workflow Manager). Can be used to determine what State the current workflow process has reached.
Parameters Property Name (String)
Example MyManager = Workflow1.GetProperty("ManagerName")
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 361
or
MyProcessState = Workflow1.GetProperty("State")
GetSessionID
Type Function (String) - Internal
Purpose Returns the User SessionID as a string
Parameters None
Example MySessionID = Workflow1.GetSessionID()
IsValid
Type Function (Boolean)
Purpose Checks the validity of the current Workflow
Parameters Property Name (String)
Example Valid = Workflow1.IsValid()
SendEvent
Type Procedure
Purpose Sends a named event to Work Manager.
Parameters Event Name (String)
Example Workflow1.SendEvent "Revise Estimated Budget"
SetProperty
Type Procedure
362 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Book Objects
Purpose Sets the value of a Workflow property defined in the Workflow Manager script.
Parameters Property Name (String), Property Value (String)
Example Workflow1.SetProperty "Status","Updated"
SetSessionID
Type Procedure (Internal)
Purpose Sets the User SessionID as a string
Parameters None
Example Workflow1.GetSessionID = SessionID
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideBook Objects P U B L I C 363
6 Work Manager Process Functions
Work Manager has a set of built-in functions to help designers create the work processes required for their modeling objectives in SAP BusinessObjects Profitability and Cost Management. These come in the form of the properties and methods listed next.
The most common use of a Work Manager process involves organizing work requests for individual users to perform specific tasks through the use of books in your model. To do this, it has functions that enable it to identify users and their email addresses. These, along with other required characteristics, are created as Object Properties in the workflow process. They can be incorporated into URL strings as user defined parameters, which are referred to as QueryStrings.
These also hold built-in parameters as well as the target book address which is opened by calling a GotoURL function. Once in the book the QueryStrings can be retrieved by functions of the book's Workflow object which acts as a host for the current Work Manager workflow.
6.1 EmailAddressForProperty
Description Read Only property that returns the e-mail address string for the specified user in the application.
Parameters WorkflowID, Work Manager Object Property Name(string)
NoteThe named Object Property must exist in the current Work Manager process.
Example EmailAddress = EmailAddressforProperty (WorkflowID, "ManagerName")
6.2 ObjectProperty
Description Stores and retrieves built-in and user defined properties of a workflow process instance.
Parameters WorkflowID, Property name
364 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Work Manager Process Functions
Example ObjectProperty (WorkflowID, "ManagerName") = "Fred Smith"
or
MyManager = ObjectProperty (WorkflowID, "ManagerName")
or
strCurrentState = ObjectProperty(WorkflowID, "State")
6.3 AddInstanceToGroup
Description Adds a workflow instance into an existing group of workflow instances.
Parameters WorkflowID, Group ID
Example AddInstanceToGroup WorkflowID, GroupID
6.4 BuildBookURL
Description Returns a valid URL string constructed from the supplied parameters. The Web Server parameter should be in the format http:// with the DNS name or IP address of the web server for the application, for example http://10 .1 0.10 .10/EP
Parameters WorkflowID, Web Server, Model name, Book name (Returns the modified string)
Example MyURLString = BuildBookURL (WorkflowID, "http://10.10.10.10/PCM", "My Model", "My Book")
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideWork Manager Process Functions P U B L I C 365
6.5 BuildBookViewerString
Description Returns a URL like WAIS link that will open the specified book in Book Viewer or an attached EBK file that can be used for the same purpose or both.
Parameters ● WorkflowID● Type of Book Viewer link:
wfEmailWais - URL type WAIS linkwfEmailAttachment - Attachment as EBK filewfEmailAttachmentAndWais - both of the above
● Name of link (for EBK file)● Mode name● Book name● Additional string parameters
Example MyBVURL = BuildBookViewerString(WorkflowID, BuildBookViewerString(WorkflowID, wfEmailAttachment, "MyEBKLink", "My Model", "My Book", "My Manager")
6.6 ClearStateTimeout
Description Informs Work Manager that this process state does not have an expiry timeout value.
Parameters WorkflowID
Example ClearStateTimeout WorkflowID
6.7 ConvertToURLCompliantString
Description Converts characters in a string that would be illegal to internet browsers, so that they are recognized correctly. The following conversions are applied:
[space] -> %20'%' -> %25
366 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Work Manager Process Functions
'&' -> %26'#' -> %23'~' -> %7E'_' -> %5F
Parameters: String for conversion
Returns The modified string
Example: MyConvertedString = ConvertToURLCompliantString (MyURLString)ConvertToURLCompliantString (MyURLString)
6.8 CreateNewGroup
Description Creates a group to contain existing workflow instances.
Parameters Group name (Returns a Group ID)
Example MyNewGroupID = CreateNewGroup ("MyNewGroup")
6.9 CreateWorkFlowObject
Description Initiates a Work Manager process.
Parameters Workflow Process Type
Returns WorkflowID
Example MyNewWorkflowID = CreateWorkFlowObject (WorkflowType)
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideWork Manager Process Functions P U B L I C 367
6.10 DebugLogEvent
DescriptionNote
Superseded by DebugLogEventEx.
Sends a message to the Windows Event Log. The first parameter acts as an On/Off control on debugging.
Parameters True (On)/False (Off), Message text
Example DebugLogEvent True, "MyMessage"
6.11 DebugLogEventEx
Description Sends a message to the Windows and the Work Manager Event Logs. The first parameter acts as an On/Off control on debugging.
Parameters True (On)/False (Off), WorkflowID, Message text
Example DebugLogEventEx True, WorkflowID, "MyMessage"
6.12 GetEmailAddressForUserID
Description Returns the email address string for the specified user in the application.
Parameters ID of user
Example UserEmailString = GetEmailAddressForUserID (UserID)
368 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Work Manager Process Functions
6.13 GetFullNameForUserID
Description Returns the full name string of the specified user.
Parameters ID of user
Example UserNameString = GetFullNameForUserID (UserID)
6.14 GetFullNameForProperty
Description Returns the full name string of a user whose UserID is held in a named Work Manager object property.
Parameters WorkflowID, WorkManagerObjectPropertyNameContainingUserID
NoteThe named Object Property must exist in the current Work Manager process. The named Object Property must exist in the current Work Manager process.
Example UserNameString = GetFullNameForProperty (WorkflowID, "ManagerUserID")
6.15 GetIDForUserName
Description Returns the SAP BusinessObjects Profitability and Cost Management User ID for a named user.
Parameters User name
Example MyUserID = GetIDForUserName ("Fred")
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideWork Manager Process Functions P U B L I C 369
6.16 GetUserIDListForGroup
Description Returns a list (variant array) of User IDs for a named User Group.
Parameters User Group name
Example MyUserList = GetUserIDListForGroup (GroupName)
6.17 RaiseAlert
Description Posts a message and information string to a Security Alert screen.
Parameters Message text, Information string
Example RaiseAlert "Email sent to", "Fred Smith"
6.18 SendEmail
Description Sends an email to the listed people. Both the recipients and the “copy to” addresses can be multiples by placing semicolons between addresses.
Parameters WorkflowID, Recipient address, Copy to address, From address, Subject line, Message text
Example SendEmail WorkflowID, "[email protected]", "[email protected]", "[email protected]", "My Subject", "Message"
370 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Work Manager Process Functions
6.19 SetTimeout
DescriptionNote
Superseded by SetTimeoutDelta.
Sets an expiry time as a specific date and time (absolute), then triggers the named event on that date.
Parameters WorkflowID, Date and Time (14 character string YYYYMMDDHHNNSS recording down to minutes and seconds), Event name
Example SetTimeout WorkflowID, "20061027095900", "Event Name"
6.20 SetTimeoutDelta
Description Sets an expiry time as a date and time relative to the current time, then triggers the named event.
Parameters WorkflowID, Days (integer), Hours (integer), Minutes (integer), Seconds (integer), Event name (string)
Example SetTimeoutDelta WorkflowID, Days, Hours, Mins, Secs, "Event Name"
6.21 SetNewTimeoutDelta
DescriptionNote
Superseded by SetTimeoutDelta.
Sets an expiry time for the current state. Timing starts from the time the function was called.
Parameters WorkflowID, Weeks (integer), Days (integer), Seconds (integer)
Example SetNewTimeoutDelta WorkflowID, Weeks, Days, Secs
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideWork Manager Process Functions P U B L I C 371
6.22 SetNextEvent
Description Triggers the Work Manager or workflow specified event.
Parameters WorkflowID, Event name (string)
Example SetNextEvent WorkflowID, "Event Name"
6.23 StartConsoleJob
Description Runs a job in SAP BusinessObjects Profitability and Cost Management Console. To allow for the substitution of Work Manager instance properties within the Console command file, the existing file is used as a template and Console runs a copy, containing substituted values, which is then deleted.
The Work Manager server process must have write access to the directory where the Console .ini template file is located.
Parameters InstanceId - the current Instance ID for the Work Manager event. The value is supplied automatically from the Work Manager server when the Console job is started.Console job .ini template file - the local Work Manager server full path to a Console .ini template file.
Returns Process id
Example startConsoleJob(InstanceId,“c:\ConsoleJob01.ini”)
6.24 WorkflowComplete
Description Ends the specified workflow process, causing the workflow instance to be archived.
Parameters WorkflowID
Example WorkflowComplete WorkflowID
372 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Work Manager Process Functions
7 Function Data Type Variants
The function data types described here describe the values returned from model functions. Refer to the individual functions to determine the expected return value.
NoteSAP BusinessObjects Profitability and Cost Management applications use VBScript as their default scripting language. Within VBScript, all data types are of the Variant type. You can still create Date values, String values, and Double values, but they must be created according to the rules of the Variant data type.
Data Type Range Example
Boolean 0 to 1 TRUE/FALSE, or 0/1
Byte 0 to 255 166
Decimal 0 through +/-79,228,162,514,264,337,593,543,950,335 with no decimal point;
0 through +/-7.9228162514264337593543950335 with 28 places to the right of the decimal
£95.96532167
Date 0:00:00 on January 1, 0001 through 11:59:59 PM on December 31, 9999.
10:15:00 on February 10, 2003
Double -1.79769313486231570E+308 through
-4.94065645841246544E-324 for negative values;
4.94065645841246544E-324 through 1.79769313486231570E+308 for positive values.
-333.61242564978
Integer -2,147,483,648 through 2,147,483,647. 89,127
Long Integer -9,223,372,036,854,775,808 through 9,223,372,036,854,775,807.
1,035,286,000,000
String 0 to approximately 2 billion Unicode characters.
"A sample string."
Variant Depends upon which data type the variant represents.
Any of the above.
A full list of supported Visual Basic data types can be found on the Microsoft MSDN site.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideFunction Data Type Variants P U B L I C 373
8 Constant Names and Values
Constants have been provided that identify dimensions and fields. These allow scripting rules to refer to specific types of item in your model. They are listed in this section in groups that relate to their context.
8.1 Dimension Constants
Rule Script Name Book Script Name Number
VersionDimension dtVersion 0
PeriodDimension dtPeriod 1
RespCenterDimension dtRespCenter 2
LineItemDimension dtLineItem 3
ActivityDimension dtActivity 4
CostObject1Dimension dtCostObject1 5
CostObject2Dimension dtCostObject2 6
CostObject3Dimension dtCostObject3 7
CostObject4Dimension dtCostObject4 8
CostObject5Dimension dtCostObject5 9
RevenueTypeDimension dtRevenueType 10
CurrencyDimension dtCurrency 11
ResourceDriverDimension dtResourceDriver 12
ActivityDriverDimension dtActivityDriver 13
ServiceDimension dtService 14
SpreadDimension dtSpread 15
WorkSheet1Dimension dtWorkSheet1 16
WorkSheet2Dimension dtWorkSheet2 17
CapacityRuleDimension dtCapacityRule 18
UserRuleDimension dtUserRule 19
IconDimension dtIcon 20
BoundaryDimension dtBoundary 21
TargetRespCenterDimension dtTargetRespCenter 22
374 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Constant Names and Values
Rule Script Name Book Script Name Number
LineItemDetailDimension dtLineItemDetail 23
TargetActivityDimension dtTargetActivity 24
ObjectiveDimension dtObjective 25
MetricDimension dtMetric 26
* InitiativeDimension dtInitiative 27
EmployeeDimension dtEmployee 28
LinkedObjectiveDimension dtLinkedObjective 29
DetailCostObject1Dimension dtDetailCostObject1 30
DetailCostObject2Dimension dtDetailCostObject2 31
DetailCostObject3Dimension dtDetailCostObject3 32
DetailCostObject4Dimension dtDetailCostObject4 33
DetailCostObject5Dimension dtDetailCostObject5 34
ComponentDimension dtComponent 35
BOMMakeupDimension dtBOMMakeup 36
NoteThese Dimension constants have different names in Rule Script and Book script. Item(s) marked with a * have not been implemented for this release.
8.2 Grid Value Constants
General(Rule Script Only) Values
CurrencyRateFieldID 6050
SpreadValueFieldID 6061
SpreadDataValueFieldID 6062
WorkSheetValueFieldID 6063
WorkSheetDataValueFieldID 6064
Boundaries Values Fields (Rule Script Only) Values
MetricActualBoundaryDataValueFieldID 6205
MetricActualBoundaryValueFieldID 6204
MetricPercentBoundaryDataValueFieldID 6207
MetricPercentBoundaryValueFieldID 6206
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideConstant Names and Values P U B L I C 375
Boundaries Values Fields (Rule Script Only) Values
ObjectiveActualBoundaryDataValueFieldID 6201
ObjectiveActualBoundaryValueFieldID 6200
ObjectivePercentBoundaryDataValueFieldID 6203
ObjectivePercentBoundaryValueFieldID 6202
Icon and Color Fields(Rule Script Only) Values
MetricAchievementDataColorFieldID 6213
MetricAchievementIconFieldID 6211
MetricAchievementRangeColorFieldID 6212
MetricTotalActualDataColorFieldID 6210
MetricTotalActualIconFieldID 6208
MetricTotalActualRangeColorFieldID 6209
ObjectiveAchievementDataColorFieldID 6219
ObjectiveAchievementIconFieldID 6217
ObjectiveAchievementRangeColorFieldID 6218
ObjectiveLinkedResultDataColorFieldID 6225
ObjectiveLinkedResultIconFieldID 6223
ObjectiveLinkedResultRangeColorFieldID 6224
ObjectiveMetricAchievementDataColorFieldID 6222
ObjectiveMetricAchievementIconFieldID 6220
ObjectiveMetricAchievementRangeColorFieldID
6221
ObjectiveResultDataColorFieldID 6229
ObjectiveResultIconFieldID 6227
ObjectiveResultRangeColorFieldID 6228
ObjectiveResultValueFieldID 6226
ObjectiveTotalActualDataColorFieldID 6216
ObjectiveTotalActualIconFieldID 6214
ObjectiveTotalActualRangeColorFieldID 6215
Line Items(Rule Script Only) Values
LineItemCalculatedFixedValueFieldID 6057
LineItemDataValueFieldID 6054
LineItemDeltaValueFieldID 6052
LineItemDetailDataValueFieldID 6060
376 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Constant Names and Values
Line Items(Rule Script Only) Values
LineItemDetailValueFieldID 6058
LineItemDetailValueNCFieldID 6059
LineItemFixedValueFieldID 6055
LineItemOriginalValueFieldID 6053
LineItemValueFieldID 6051
LineItemVariabilityFieldID 6056
Service Fields (Rule Script Only) Values
ServiceCostFieldID 6154
ServiceDriverDataValueFieldID 6150
ServiceDriverDeltaValueFieldID 6147
ServiceDriverOriginalValueFieldID 6148
ServiceDriverTargetValueFieldID 6149
ServiceDriverValueFieldID 6146
ServiceFixedUnitRateFieldID 6152
ServiceIncomeFieldID 6155
ServiceUnitRateFieldID 6153
ServiceVariableFactorFieldID 6151
Metric Values Fields (Rule Script Only) Values
MetricAchievementValueFieldID 6180
MetricActualAdjustmentValueFieldID 6171
MetricActualDataValueFieldID 6170
MetricActualValueFieldID 6169
MetricBasePointDataValueFieldID 6176
MetricBasePointValueFieldID 6175
MetricTargetAdjustmentValueFieldID 6174
MetricTargetDataValueFieldID 6173
MetricTargetValueFieldID 6172
MetricTotalActualValueFieldID 6177
MetricTotalTargetValueFieldID 6178
MetricVarianceValueFieldID 6179
Objective Values Fields (Rule Script Only) Values
ObjectiveAchievementValueFieldID 6191
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideConstant Names and Values P U B L I C 377
Objective Values Fields (Rule Script Only) Values
ObjectiveActualAdjustmentValueFieldID 6183
ObjectiveActualDataValueFieldID 6182
ObjectiveActualValueFieldID 6181
ObjectiveBasePointDataValueFieldID 6188
ObjectiveBasePointValueFieldID 6187
ObjectiveLinkedResultValueFieldID 6195
ObjectiveMetricResultValueFieldID 6199
ObjectiveMetricWeightingDataValueFieldID 6197
ObjectiveMetricWeightingPctValueFieldID 6198
ObjectiveMetricWeightingValueFieldID 6196
ObjectiveTargetAdjustmentValueFieldID 6186
ObjectiveTargetDataValueFieldID 6185
ObjectiveTargetValueFieldID 6184
ObjectiveTotalActualValueFieldID 6189
ObjectiveTotalTargetValueFieldID 6190
ObjectiveWeightingDataValueFieldID 6193
ObjectiveWeightingPctValueFieldID 6194
ObjectiveWeightingValueFieldID 6192
Resource Drivers(Rule Script Only) Values
ResourceDriverDataSplitFieldID 6075
ResourceDriverDataValueFieldID 6069
ResourceDriverDeltaSplitFieldID 6072
ResourceDriverDeltaValueFieldID 6066
ResourceDriverOriginalSplitFieldID 6073
ResourceDriverOriginalValueFieldID 6067
ResourceDriverPctSplitFieldID 6071
ResourceDriverSplitFieldID 6070
ResourceDriverTargetSplitFieldID 6074
ResourceDriverTargetValueFieldID 6068
ResourceDriverValueFieldID 6065
Activity Fields(Rule Script Only) Values
ActivityFixedValueFieldID 6078
378 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Constant Names and Values
Activity Fields(Rule Script Only) Values
ActivityLineItemFixedValueFieldID 6081
ActivityLineItemValueFieldID 6080
ActivityLineItemVariableValueFieldID 6082
ActivityUnitRateFieldID 6079
ActivityValueFieldID 6076
ActivityVariableValueFieldID 6077
ExternalActivityFixedValueFieldID 6091
ExternalActivityValueFieldID 6089
ExternalActivityVariableValueFieldID 6090
ReassignActivityLineItemValueFieldID 6101
ReassignActivityServiceValueFieldID 6156
ReassignedFinalValueFieldID 6094
ReassignedInValueFieldID 6092
ReassignedMoveValueFieldID 6095
ReassignedOutValueFieldID 6093
ReassignSplitInValueFieldID 6099
ReassignSplitOutValueFieldID 6100
ReassignSplitPostValueFieldID 6098
ReassignSplitValueFieldID 6097
ServiceActivityValueFieldID 6158
SourceActivityLineItemFixedValueFieldID 6087
SourceActivityLineItemValueFieldID 6086
SourceActivityLineItemVariableValueFieldID 6088
SummaryActivityFixedValueFieldID 6084
SummaryActivityValueFieldID 6083
SummaryActivityVariableValueFieldID 6085
SummaryMovementValueFieldID 6096
SummaryServiceActivityValueFieldID 6157
Activity Driver Fields (Rule Script Only) Values
ActivityDriverDataValueFieldID 6106
ActivityDriverDeltaValueFieldID 6103
ActivityDriverOriginalValueFieldID 6104
ActivityDriverTargetValueFieldID 6105
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideConstant Names and Values P U B L I C 379
Activity Driver Fields (Rule Script Only) Values
ActivityDriverValueFieldID 6102
Cost Object Fields(Rule Script Only) Values
ActivityCostObjectFixedValueFieldID 6135
ActivityCostObjectValueFieldID 6134
ActivityCostObjectVariableValueFieldID 6136
CostObjectFixedValueFieldID 6121
CostObjectValueFieldID 6120
CostObjectVariableValueFieldID 6122
DirectCostObjectFixedValueFieldID 6124
DirectCostObjectValueFieldID 6123
DirectCostObjectVariableValueFieldID 6125
DirectServiceCostObjectValueFieldID 6161
ExternalCostObjectFixedValueFieldID 6144
ExternalCostObjectValueFieldID 6143
ExternalCostObjectVariableValueFieldID 6145
LineItemCostObjectFixedValueFieldID 6138
LineItemCostObjectValueFieldID 6137
LineItemCostObjectVariableValueFieldID 6139
ServiceCostObjectValueFieldID 6160
SourceCostObjectFixedValueFieldID 6167
SourceCostObjectValueFieldID 6166
SourceCostObjectVariableValueFieldID 6168
SummaryCostObjectFixedValueFieldID 6114
SummaryCostObjectValueFieldID 6113
SummaryCostObjectVariableValueFieldID 6115
SummaryPostCostObjectValueFieldID 6117
SummaryPreCostObjectValueFieldID 6116
TargetCostObjectValueFieldID 6133
TotalCostObjectFixedValueFieldID 6141
TotalCostObjectValueFieldID 6140
TotalCostObjectVariableValueFieldID 6142
TraceBackFixedValueFieldID 6131
TraceBackValueFieldID 6130
380 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Constant Names and Values
Cost Object Fields(Rule Script Only) Values
TraceBackVariableValueFieldID 6132
Model Types (Rule Script Only) Values
ProfitCostingModelType 1
ObjectiveMetricModelType 4
TransactionCostingModelType 8
Revenue and Profit Fields (Rule Script Only) Values
ContributionFieldID 6118
DataRevenueFieldID 6112
DataUnitPriceFieldID 6110
DataUnitsSoldFieldID 6111
GrossContributionFieldID 6119
RevenueFieldID 6109
UnitPriceFieldID 6107
UnitsSoldFieldID 6108
Volume and Unit Rate Fields (Rule Script Only) Values
DirectPrimaryDriverUnitRateFieldID 6129
DirectPrimaryDriverVolumeFieldID 6128
DirectServicePrimaryDriverVolumeFieldID 6164
DirectServicePrimaryDriverUnitRateFieldID 6165
PrimaryDriverUnitRateFieldID 6127
PrimaryDriverVolumeFieldID 6126
ServiceActivityUnitRateFieldID 6159
ServicePrimaryDriverVolumeFieldID 6162
ServicePrimaryDriverUnitRateFieldID 6163
8.3 TableID Constants
The numeric values of the TableID constants are not detailed because they are liable to change over time, and it is therefore preferable to use the constant name.
Activity Driver Fields (Rule Script Only)
ActivityDriverDeltaTableID
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideConstant Names and Values P U B L I C 381
Activity Driver Fields (Rule Script Only)
ActivityDriverTargetTableID
ActivityDriverValueTableID
DirectPrimaryActivityDriverTableID
PrimaryActivityDriverTableID
PrimaryActivityDriverVolumeTableID
ServiceDirectPrimaryActivityDriverTableID
ServicePrimaryActivityDriverTableID
Activity Fields(Rule Script Only)
ActivityLineItemValueTableID
ActivityReassignSplitValueTableID
ActivityReassignTableID
ActivityValueTableID
ExternalActivityValueTableID
ReassignActivityLineItemValueTableID
ReassignActivityServiceValueTableID
ReassignMovementSplitTableID
SourceActivityLineItemValueTableID
SourceActivityValueTableID
SummaryActivityValueTableID
SummaryMovementValueTableID
SummaryServiceActivityValueTableID
Cost Object Fields(Rule Script Only)
ActivityCostObjectValueTableID
CostObjectActivityUnitRateTableID
CostObjectUnitRateTableID
CostObjectValueTableID
DirectCostObjectValueTableID
DirectServiceCostObjectValueTableID
ExternalCostObjectValueTableID
JointCostObjectValueTableID
LineItemCostObjectValueTableID
ReassignTraceTableID
382 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Constant Names and Values
Cost Object Fields(Rule Script Only)
ServiceCostObjectValueTableID
SourceCostObjectValueTableID
SummaryCostObjectValueTableID
TargetCostObjectValueTableID
TotalCostObjectValueTableID
TracebackValueTableID
General (Rule Script Only)
CurrencyRateTableID
SpreadValueTableID
WorksheetValueTableID
Line Items(Rule Script Only)
LineItemDeltaTableID
LineItemDetailValueTableID
LineItemFixedValueTableID
LineItemValueTableID
LineItemVariableTableID
Resource Drivers(Rule Script Only)
EmployeeResourceDriverSplitTableID
ResourceDriverDeltaTableID
ResourceDriverSplitDeltaTableID
ResourceDriverSplitTableID
ResourceDriverSplitTargetTableID
ResourceDriverTargetTableID
ResourceDriverValueTableID
Revenue and Profit Fields (Rule Script Only)
ContributionTableID
RevenueTableID
Volume and Unit Rate Fields (Rule Script Only)
ServiceActivityValueTableID
ServiceDriverDeltaTableID
ServiceDriverTargetTableID
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideConstant Names and Values P U B L I C 383
Volume and Unit Rate Fields (Rule Script Only)
ServiceDriverValueTableID
ServiceFactorTableID
ServiceValueTableID
384 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Constant Names and Values
9 Reserved Names
The default modeling environments in the application contain elements that are identified by name. These names are reserved and duplicates are not supported, so any attempt to use these names for new items as you develop your models will produce misleading effects.
● <CO1 All>● <CO2 All>● <CO3 All>● <CO4 All> ● <CO5 All>● Activities● Activity Attributes● Activity Driver Attributes● Activity Drivers● Activity Summary LineItem● Activity Unassigned● Base UOM● Blank Icon● BOM Production Units Sold Reconciliation● BOMMakeup● BOMMakeup Attributes● Boundaries● Boundary Attributes● Capacity Rule Attributes● Capacity Rules● Ceiling Boundary● CO1 All ● CO1 Unassigned● CO2 All● CO2 Unassigned● CO3 All● CO3 Unassigned● CO4 All● CO4 Unassigned● CO5 All● CO5 Unassigned● Component● Component Attributes● Cost Object Type Line Item● Cost Object Type Service
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideReserved Names P U B L I C 385
● Cost Objects 1● Cost Objects 1 Attributes● Cost Objects 2● Cost Objects 2 Attributes● Cost Objects 3● Cost Objects 3 Attributes● Cost Objects 4● Cost Objects 4 Attributes● Cost Objects 5● Cost Objects 5 Attributes● Currencies● Currency Attributes● Currency UOM● DCO1 Unassigned● DCO2 Unassigned● DCO3 Unassigned● DCO4 Unassigned● DCO5 Unassigned● Default Boundary● Default Transaction Activity Driver● Detailed Cost Objects 1● Detailed Cost Objects 1 Attributes● Detailed Cost Objects 2● Detailed Cost Objects 2 Attributes● Detailed Cost Objects 3● Detailed Cost Objects 3 Attributes● Detailed Cost Objects 4● Detailed Cost Objects 4 Attributes● Detailed Cost Objects 5● Detailed Cost Objects 5 Attributes● Direct Activities Driver● Employee Attributes● Employees● Fixed Cost Line Item● Floor Boundary● High Volume Assignable Detail Cost Object 1● High Volume Assignable Detail Cost Object 2● High Volume Assignable Detail Cost Object 3● High Volume Assignable Detail Cost Object 4● High Volume Assignable Detail Cost Object 5● Icon Attributes● Icons● Initiative Atrributes
386 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Reserved Names
● Initiatives● Line Item Attributes● Line Item Detail Attributes● Line Item Details● Line Items● Linked Objective Attributes● Linked Objectives● Metric Attributes● Metrics● NON● Objective Attributes● Objectives● Other UOM● Period Attributes● Periods● Post Gross Contribution Type Line Item● Post Gross Contribution Type Service● RC Unassigned● RD Unassigned● Reassigned Activities● Resource Driver Attributes● Resource Drivers● Responsibility Center Attributes● Responsibility Centers● Revenue Activity Driver● Revenue Type Attributes● Revenue Types● Service Attributes● Services● Spare Resource● Spread Attributes● Spreads● Target Activities● Target Activity Attributes● Target Responsibility Center Attributes● Target Responsibility Centers● TimeLinePreviousPeriod● TimeLinePreviousVersion● Transaction Activity Drivers● Transaction RC Activity Drivers ● Units Sold Activity Driver● User Defined Rule Attributes● User Defined Rules
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideReserved Names P U B L I C 387
● Version Attributes● Versions● Volume UOM● Weight UOM● Work Sheets 1● Work Sheets 1 Attributes● Work Sheets 2 ● Work Sheets 2 Attributes
388 P U B L I CSAP BusinessObjects Profitability and Cost Management Modeling Reference Guide
Reserved Names
Important Disclaimers and Legal Information
HyperlinksSome links are classified by an icon and/or a mouseover text. These links provide additional information.About the icons:
● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your agreements with SAP) to this:
● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.
Beta and Other Experimental FeaturesExperimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the experimental features in a live operating environment or with data that has not been sufficiently backed up.The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.
Example CodeAny software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Gender-Related LanguageWe try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.
SAP BusinessObjects Profitability and Cost Management Modeling Reference GuideImportant Disclaimers and Legal Information P U B L I C 389
go.sap.com/registration/contact.html
© 2018 SAP SE or an SAP affiliate company. All rights reserved.No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. The information contained herein may be changed without prior notice.Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies.Please see https://www.sap.com/about/legal/trademark.html for additional trademark information and notices.