public class AllocationParameters
extends java.lang.Object
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)
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 and Description |
---|
AllocationParameters()
Construct an instance of this class.
|
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)
|
public AllocationParameters()
public AllocationParameters setAllocationMethod(AllocationParameters.AllocationMethod allocationMethod)
allocationMethod
- allocation methodpublic AllocationParameters setAmount(java.lang.String amount)
amount
- amount to allocatepublic AllocationParameters setAmountContext(java.lang.String amountContext)
This is specified only when amount is an arithmetic expression and POV does not specify two or more dimensions.
amountContext
- context for the amountsetAmount(java.lang.String)
,
setPov(java.lang.String)
public AllocationParameters setAmountTimeSpan(java.lang.String amountTimeSpan)
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.
amountTimeSpan
- amount timespan for the amountsetAmount(java.lang.String)
public AllocationParameters setBasis(java.lang.String basis)
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.
basis
- basis for the amountpublic AllocationParameters setBasisTimeSpan(java.lang.String basisTimeSpan)
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.
basisTimeSpan
- timespan expression specifying time periodspublic AllocationParameters setBasisTimeSpanOption(AllocationParameters.BasisTimeSpanOption basisTimeSpanOption)
setBasisTimeSpan
.basisTimeSpanOption
- basis timespan optionsetBasisTimeSpan(java.lang.String)
public AllocationParameters setCreditMember(java.lang.String creditMember)
If credit member or debit member is not specified, debit/credit processing is not performed.
creditMember
- member where credit processing is written topublic AllocationParameters setDataLoadOption(AllocationParameters.DataLoadOption dataLoadOption)
This option specifies if the value should be added, subtracted or set during the allocation.
dataLoadOption
- data load optionpublic AllocationParameters setDebitMember(java.lang.String debitMember)
If credit member or debit member is not specified, debit/credit processing is not performed.
debitMember
- member where debit processing is written topublic AllocationParameters setExcludedRange(java.lang.String excludedRange)
excludedRange
- range to excludepublic AllocationParameters setNegativeBasisOption(AllocationParameters.NegativeBasisOption negativeBasisOption)
When allocation method is SPREAD, then only following options are valid:
negativeBasisOption
- negative basis optionpublic AllocationParameters setOffset(java.lang.String offset)
offset
- member where offset values are written topublic AllocationParameters setPov(java.lang.String pov)
pov
- area of allocationpublic AllocationParameters setRange(java.lang.String range)
range
- region of cubepublic AllocationParameters setRoundDigits(java.lang.String roundDigits)
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.
roundDigits
- number of digits to roundsetRoundMethod(oracle.epm.api.model.AllocationParameters.RoundingMethod)
public AllocationParameters setRoundMethod(AllocationParameters.RoundingMethod roundMethod)
roundMethod
- rounding methodpublic AllocationParameters setRoundToLocation(java.lang.String roundToLocation)
roundToLocation
- rounding error locationpublic AllocationParameters setSpreadSkipOption(AllocationParameters.SpreadSkipOption spreadSkipOption)
When allocation method is SHARE, this argument must be NO_OPTION.
When allocationMethod is SPREAD, this option tells which basis values should be skipped.
spreadSkipOption
- spread skip optionpublic AllocationParameters setTarget(java.lang.String target)
target
- location where allocations will be performedpublic AllocationParameters setTargetTimeSpan(java.lang.String targetTimeSpan)
This is used in combination with setTargetTimeSpanOption
which determines how values are allocated across time periods in target
timespan.
targetTimeSpan
- time periods to consider for targetsetTargetTimeSpanOption(oracle.epm.api.model.AllocationParameters.TargetTimeSpanOption)
public AllocationParameters setTargetTimeSpanOption(AllocationParameters.TargetTimeSpanOption targetTimeSpanOption)
setTargetTimeSpan
is used.targetTimeSpanOption
- target timespan optionsetTargetTimeSpan(java.lang.String)
public AllocationParameters setZeroAmountOption(AllocationParameters.ZeroAmountOption zeroAmountOption)
If omitted, zero or #MISSING amount values are allocated.
zeroAmountOption
- zero amount optionpublic AllocationParameters setZeroBasisOption(AllocationParameters.ZeroBasisOption zeroBasisOption)
Note that if allocation encounters any other unexpected errors, it will always cancel the entire allocation.
zeroBasisOption
- zero basis optionCopyright © 2017, 2024, Oracle and/or its affiliates. All rights reserved.