oracle.epm.api.model

Class AllocationParameters

java.lang.Object

oracle.epm.api.model.AllocationParameters

public class AllocationParameters
extends java.lang.Object

This object represent the parameters required for an ASO allocation.

Example call from Groovy:

 /*RTPS: {curYear}*/
  AllocationParameters allocationParameters = new AllocationParameters()
  allocationParameters.pov = 'Crossjoin(Crossjoin(Crossjoin(Crossjoin(
  Crossjoin(Crossjoin(Crossjoin({[Bonus]},{[No Currency]}),{[No Entity]}),
  {[No Manager]}),{[Jan]}),{[Current]}),{[BU Version_1]}),
  {${mdxParams(rtps.curYear)}})'
  allocationParameters.amount = '([No Employee])'
  allocationParameters.zeroAmountOption = ZeroAmountOption.ABORT
  allocationParameters.targetTimeSpanOption = TargetTimeSpanOption.DIVIDE_AMOUNT
  allocationParameters.range = '{Descendants([Total Employees], [Total Employees].dimension.Levels(0))}'
  allocationParameters.basis = '([Salary], [Actual])'
  allocationParameters.basisTimeSpanOption = BasisTimeSpanOption.COMBINE_BASIS
  allocationParameters.zeroBasisOption = ZeroBasisOption.ABORT
  allocationParameters.negativeBasisOption = NegativeBasisOption.DEFAULT
  allocationParameters.allocationMethod = AllocationMethod.SHARE
  allocationParameters.roundDigits = 2
  allocationParameters.roundMethod = RoundingMethod.ERRORS_TO_HIGHEST
  operation.cube.executeAsoAllocation(allocationParameters)
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AllocationParameters.AllocationMethod An enumeration containing a list of valid allocation methods to be used in Allocation.
static class	AllocationParameters.BasisTimeSpanOption An enumeration containing a list of valid basis timespan options to be used in Allocation.
static class	AllocationParameters.DataLoadOption An enumeration containing a list of valid data load options to be used in Allocation.
static class	AllocationParameters.NegativeBasisOption An enumeration containing a list of valid negative basis options to be used in Allocation.
static class	AllocationParameters.RoundingMethod An enumeration containing a list of valid rounding methods to be used in Allocation.
static class	AllocationParameters.SpreadSkipOption An enumeration containing a list of valid spread skip options to be used in Allocation.
static class	AllocationParameters.TargetTimeSpanOption An enumeration containing a list of valid target timespan options to be used in Allocation.
static class	AllocationParameters.ZeroAmountOption An enumeration containing a list of valid zero amount options to be used in Allocation.
static class	AllocationParameters.ZeroBasisOption An enumeration containing a list of valid zero basis options to be used in Allocation.

Constructor Summary

Constructors

Constructor and Description
AllocationParameters() Construct an instance of this class.

Method Summary

Modifier and Type	Method and Description
AllocationParameters	setAllocationMethod(AllocationParameters.AllocationMethod allocationMethod) Specifies the allocation method to be used.
AllocationParameters	setAmount(java.lang.String amount) Specifies an MDX numeric value expression indicating the source of the amount to be allocated.
AllocationParameters	setAmountContext(java.lang.String amountContext) Specifies an MDX tuple with one member from each dimension missing from POV and amount, indicating the context for the amount.
AllocationParameters	setAmountTimeSpan(java.lang.String amountTimeSpan) Specifies an MDX set indicating one or more time periods to be considered for the amount.
AllocationParameters	setBasis(java.lang.String basis) Specifies an MDX tuple that, when combined with the range, defines the location of basis values that determine how the amount is allocated.
AllocationParameters	setBasisTimeSpan(java.lang.String basisTimeSpan) Specifies an MDX set that indicate one or more time periods to be considered for the basis.
AllocationParameters	setBasisTimeSpanOption(AllocationParameters.BasisTimeSpanOption basisTimeSpanOption) Specifies the option how basis is computed across time periods specified in setBasisTimeSpan.
AllocationParameters	setCreditMember(java.lang.String creditMember) Specifies an MDX member expression indicating the member to which negative result values are written, if double-entry accounting is used.
AllocationParameters	setDataLoadOption(AllocationParameters.DataLoadOption dataLoadOption) Specifies how the allocated data is handled.
AllocationParameters	setDebitMember(java.lang.String debitMember) Specifies an MDX member expression indicating the member to which positive result values are written, if double-entry accounting is used.
AllocationParameters	setExcludedRange(java.lang.String excludedRange) Specifies an MDX set expression that specifies a subset of range that will be used to calculate allocated values but will not be written to.
AllocationParameters	setNegativeBasisOption(AllocationParameters.NegativeBasisOption negativeBasisOption) Specifies negative basis option to be used when basis values are negative.
AllocationParameters	setOffset(java.lang.String offset) Specifies an optional MDX tuple defining the location in the database where an offsetting value is written for each source amount, if offsetting entries are used.
AllocationParameters	setPov(java.lang.String pov) Specifies an MDX set specifying the region in which the allocation is performed.
AllocationParameters	setRange(java.lang.String range) Specifies an MDX set indicating the region in which allocated values are calculated and written.
AllocationParameters	setRoundDigits(java.lang.String roundDigits) Specifies an MDX numeric value expressiont that represents number of digits to round.
AllocationParameters	setRoundMethod(AllocationParameters.RoundingMethod roundMethod) Specifies how the allocated values the rounded.
AllocationParameters	setRoundToLocation(java.lang.String roundToLocation) Specifies an optional MDX tuple expression where rounding errors should be written to.
AllocationParameters	setSpreadSkipOption(AllocationParameters.SpreadSkipOption spreadSkipOption) Specifies which the basis values should be skipped.
AllocationParameters	setTarget(java.lang.String target) Specifies an MDX tuple defining the region where results are written.
AllocationParameters	setTargetTimeSpan(java.lang.String targetTimeSpan) Specifies an MDX set indicating one or more time periods to be considered for the target.
AllocationParameters	setTargetTimeSpanOption(AllocationParameters.TargetTimeSpanOption targetTimeSpanOption) Specifies an option to divide the amount evenly or repeated across time periods.
AllocationParameters	setZeroAmountOption(AllocationParameters.ZeroAmountOption zeroAmountOption) This option tells allocation what to do when the value to be allocated is either zero or missing.
AllocationParameters	setZeroBasisOption(AllocationParameters.ZeroBasisOption zeroBasisOption) Specifies an option to handle when the sum of all basis values is zero and the allocation method is SHARE or all of the basis values have been skipped and allocation method is SPREAD.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AllocationParameters

public AllocationParameters()

Construct an instance of this class.

Method Detail

setAllocationMethod

public AllocationParameters setAllocationMethod(AllocationParameters.AllocationMethod allocationMethod)

Specifies the allocation method to be used.

Parameters:

allocationMethod - allocation method

Returns:

a reference to this object

setAmount

public AllocationParameters setAmount(java.lang.String amount)

Specifies an MDX numeric value expression indicating the source of the amount to be allocated. This could be a tuple or a constant number.

Parameters:

amount - amount to allocate

Returns:

a reference to this object

setAmountContext

public AllocationParameters setAmountContext(java.lang.String amountContext)

Specifies an MDX tuple with one member from each dimension missing from POV and amount, indicating the context for the amount.

This is specified only when amount is an arithmetic expression and POV does not specify two or more dimensions.

Parameters:

amountContext - context for the amount

Returns:

a reference to this object

See Also:

setAmount(java.lang.String), setPov(java.lang.String)

setAmountTimeSpan

public AllocationParameters setAmountTimeSpan(java.lang.String amountTimeSpan)

Specifies an MDX set indicating one or more time periods to be considered for the amount.

The amount value is aggregated over the specified time periods, and the aggregated amount value is allocated. Time periods must be level zero members from the time dimension.

Parameters:

amountTimeSpan - amount timespan for the amount

Returns:

a reference to this object

See Also:

setAmount(java.lang.String)

setBasis

public AllocationParameters setBasis(java.lang.String basis)

Specifies an MDX tuple that, when combined with the range, defines the location of basis values that determine how the amount is allocated.

The basis can consist of upper-level or level zero members.

This is optional if the allocation method used is SPREAD , and no values are skipped.

Basis must be omitted when the allocation method is SPREAD and used without skip options.

Parameters:

basis - basis for the amount

Returns:

a reference to this object

setBasisTimeSpan

public AllocationParameters setBasisTimeSpan(java.lang.String basisTimeSpan)

Specifies an MDX set that indicate one or more time periods to be considered for the basis.

The amount value is aggregated over the time periods specified in amount timespan and the resulting aggregated value is allocated across range.

Time periods must be level 0 members from the time dimension.

Parameters:

basisTimeSpan - timespan expression specifying time periods

Returns:

a reference to this object

setBasisTimeSpanOption

public AllocationParameters setBasisTimeSpanOption(AllocationParameters.BasisTimeSpanOption basisTimeSpanOption)

Specifies the option how basis is computed across time periods specified in setBasisTimeSpan.

Parameters:

basisTimeSpanOption - basis timespan option

Returns:

a reference to this object

See Also:

setBasisTimeSpan(java.lang.String)

setCreditMember

public AllocationParameters setCreditMember(java.lang.String creditMember)

Specifies an MDX member expression indicating the member to which negative result values are written, if double-entry accounting is used.

If credit member or debit member is not specified, debit/credit processing is not performed.

Parameters:

creditMember - member where credit processing is written to

Returns:

a reference to this object

setDataLoadOption

public AllocationParameters setDataLoadOption(AllocationParameters.DataLoadOption dataLoadOption)

Specifies how the allocated data is handled.

This option specifies if the value should be added, subtracted or set during the allocation.

Parameters:

dataLoadOption - data load option

Returns:

a reference to this object

setDebitMember

public AllocationParameters setDebitMember(java.lang.String debitMember)

Specifies an MDX member expression indicating the member to which positive result values are written, if double-entry accounting is used.

If credit member or debit member is not specified, debit/credit processing is not performed.

Parameters:

debitMember - member where debit processing is written to

Returns:

a reference to this object

setExcludedRange

public AllocationParameters setExcludedRange(java.lang.String excludedRange)

Specifies an MDX set expression that specifies a subset of range that will be used to calculate allocated values but will not be written to.

Parameters:

excludedRange - range to exclude

Returns:

a reference to this object

setNegativeBasisOption

public AllocationParameters setNegativeBasisOption(AllocationParameters.NegativeBasisOption negativeBasisOption)

Specifies negative basis option to be used when basis values are negative.

When allocation method is SPREAD, then only following options are valid:

• DEFAULT
• NEXT_AMOUNT
• ABORT

Parameters:

negativeBasisOption - negative basis option

Returns:

a reference to this object

setOffset

public AllocationParameters setOffset(java.lang.String offset)

Specifies an optional MDX tuple defining the location in the database where an offsetting value is written for each source amount, if offsetting entries are used.

Parameters:

offset - member where offset values are written to

Returns:

a reference to this object

setPov

public AllocationParameters setPov(java.lang.String pov)

Specifies an MDX set specifying the region in which the allocation is performed.

Parameters:

pov - area of allocation

Returns:

a reference to this object

setRange

public AllocationParameters setRange(java.lang.String range)

Specifies an MDX set indicating the region in which allocated values are calculated and written.

Parameters:

range - region of cube

Returns:

a reference to this object

setRoundDigits

public AllocationParameters setRoundDigits(java.lang.String roundDigits)

Specifies an MDX numeric value expressiont that represents number of digits to round.

The value must be between 100 and -100, and is truncated if it is not a whole number.

If the rounding method is NONE, then this must be empty.

Parameters:

roundDigits - number of digits to round

Returns:

a reference to this object

See Also:

setRoundMethod(oracle.epm.api.model.AllocationParameters.RoundingMethod)

setRoundMethod

public AllocationParameters setRoundMethod(AllocationParameters.RoundingMethod roundMethod)

Specifies how the allocated values the rounded.

Parameters:

roundMethod - rounding method

Returns:

a reference to this object

setRoundToLocation

public AllocationParameters setRoundToLocation(java.lang.String roundToLocation)

Specifies an optional MDX tuple expression where rounding errors should be written to.

Parameters:

roundToLocation - rounding error location

Returns:

a reference to this object

setSpreadSkipOption

public AllocationParameters setSpreadSkipOption(AllocationParameters.SpreadSkipOption spreadSkipOption)

Specifies which the basis values should be skipped.

When allocation method is SHARE, this argument must be NO_OPTION.

When allocationMethod is SPREAD, this option tells which basis values should be skipped.

Parameters:

spreadSkipOption - spread skip option

Returns:

a reference to this object

setTarget

public AllocationParameters setTarget(java.lang.String target)

Specifies an MDX tuple defining the region where results are written.

Parameters:

target - location where allocations will be performed

Returns:

a reference to this object

setTargetTimeSpan

public AllocationParameters setTargetTimeSpan(java.lang.String targetTimeSpan)

Specifies an MDX set indicating one or more time periods to be considered for the target. Time periods must be level zero members from the time dimension.

This is used in combination with setTargetTimeSpanOption which determines how values are allocated across time periods in target timespan.

Parameters:

targetTimeSpan - time periods to consider for target

Returns:

a reference to this object

See Also:

setTargetTimeSpanOption(oracle.epm.api.model.AllocationParameters.TargetTimeSpanOption)

setTargetTimeSpanOption

public AllocationParameters setTargetTimeSpanOption(AllocationParameters.TargetTimeSpanOption targetTimeSpanOption)

Specifies an option to divide the amount evenly or repeated across time periods. Required only if setTargetTimeSpan is used.

Parameters:

targetTimeSpanOption - target timespan option

Returns:

a reference to this object

See Also:

setTargetTimeSpan(java.lang.String)

setZeroAmountOption

public AllocationParameters setZeroAmountOption(AllocationParameters.ZeroAmountOption zeroAmountOption)

This option tells allocation what to do when the value to be allocated is either zero or missing.

If omitted, zero or #MISSING amount values are allocated.

Parameters:

zeroAmountOption - zero amount option

Returns:

a reference to this object

setZeroBasisOption

public AllocationParameters setZeroBasisOption(AllocationParameters.ZeroBasisOption zeroBasisOption)

Specifies an option to handle when the sum of all basis values is zero and the allocation method is SHARE or all of the basis values have been skipped and allocation method is SPREAD.

Note that if allocation encounters any other unexpected errors, it will always cancel the entire allocation.

Parameters:

zeroBasisOption - zero basis option

Returns:

a reference to this object