Codeunit "Matrix Management"

ID 9200
Namespace: Microsoft.Finance.Analysis

Methods

SetPeriodColumnSet

procedure SetPeriodColumnSet(DateFilter: Text, PeriodType: Enum "Analysis Period Type", Direction: Option, var FirstColumn: Date, var LastColumn: Date, NoOfColumns: Integer)

Parameters

Name Type Description
DateFilter Text
PeriodType Enum Microsoft.Foundation.Enums."Analysis Period Type"
Direction Option
FirstColumn Date
LastColumn Date
NoOfColumns Integer

SetDimColumnSet

procedure SetDimColumnSet(DimensionCode: Code[20], DimFilter: Text, SetWanted: Option, var RecordPosition: Text, var FirstColumn: Text, var LastColumn: Text, NoOfColumns: Integer)

Parameters

Name Type Description
DimensionCode Code[20]
DimFilter Text
SetWanted Option
RecordPosition Text
FirstColumn Text
LastColumn Text
NoOfColumns Integer

DimToCaptions

procedure DimToCaptions(var CaptionSet: array[32] of Text[80], var MatrixRecords: array[32] of Record "Dimension Code Buffer", DimensionCode: Code[20], FirstColumn: Text, LastColumn: Text, var NumberOfColumns: Integer, ShowColumnName: Boolean, var CaptionRange: Text, DimensionValueFilter: Text)

Parameters

Name Type Description
CaptionSet array[32] of Text[80]
MatrixRecords array[32] of Record "Dimension Code Buffer"
DimensionCode Code[20]
FirstColumn Text
LastColumn Text
NumberOfColumns Integer
ShowColumnName Boolean
CaptionRange Text
DimensionValueFilter Text

GenerateMatrixData

procedure GenerateMatrixData(var RecRef: RecordRef, SetWanted: Option, MaximumSetLength: Integer, CaptionFieldNo: Integer, var RecordPosition: Text, var CaptionSet: array[32] of Text[80], var CaptionRange: Text, var CurrSetLength: Integer)

Parameters

Name Type Description
RecRef RecordRef
SetWanted Option
MaximumSetLength Integer
CaptionFieldNo Integer
RecordPosition Text
CaptionSet array[32] of Text[80]
CaptionRange Text
CurrSetLength Integer

GenerateMatrixDataExtended

procedure GenerateMatrixDataExtended(var RecRef: RecordRef, SetWanted: Option, MaximumSetLength: Integer, CaptionFieldNo: Integer, var RecordPosition: Text, var CaptionSet: array[32] of Text, var CaptionRange: Text, var CurrSetLength: Integer, MaxCaptionLength: Integer)

Parameters

Name Type Description
RecRef RecordRef
SetWanted Option
MaximumSetLength Integer
CaptionFieldNo Integer
RecordPosition Text
CaptionSet array[32] of Text
CaptionRange Text
CurrSetLength Integer
MaxCaptionLength Integer

GeneratePeriodMatrixData

procedure GeneratePeriodMatrixData(SetWanted: Option, MaximumSetLength: Integer, UseNameForCaption: Boolean, PeriodType: Enum "Analysis Period Type", DateFilter: Text, var RecordPosition: Text, var CaptionSet: array[32] of Text[80], var CaptionRange: Text, var CurrSetLength: Integer, var PeriodRecords: array[32] of Record Date)

Parameters

Name Type Description
SetWanted Option
MaximumSetLength Integer
UseNameForCaption Boolean
PeriodType Enum Microsoft.Foundation.Enums."Analysis Period Type"
DateFilter Text
RecordPosition Text
CaptionSet array[32] of Text[80]
CaptionRange Text
CurrSetLength Integer
PeriodRecords array[32] of Record Date

SetIndentation

procedure SetIndentation(var TextString: Text[1024], Indentation: Integer)

Parameters

Name Type Description
TextString Text[1024]
Indentation Integer

GetPKRange

procedure GetPKRange(var RecRef: RecordRef, KeyFieldNo: Integer, RecordPosition: Text, CurrSetLength: Integer): Text[100]

Parameters

Name Type Description
RecRef RecordRef
KeyFieldNo Integer
RecordPosition Text
CurrSetLength Integer

Returns

Type Description
Text[100]

GenerateDimColumnCaption

procedure GenerateDimColumnCaption(DimensionCode: Code[20], DimFilter: Text, SetWanted: Option, var RecordPosition: Text, FirstColumn: Text, LastColumn: Text, var CaptionSet: array[32] of Text[80], var DimensionCodeBuffer: array[32] of Record "Dimension Code Buffer", var NumberOfColumns: Integer, ShowColumnName: Boolean, var CaptionRange: Text)

Parameters

Name Type Description
DimensionCode Code[20]
DimFilter Text
SetWanted Option
RecordPosition Text
FirstColumn Text
LastColumn Text
CaptionSet array[32] of Text[80]
DimensionCodeBuffer array[32] of Record "Dimension Code Buffer"
NumberOfColumns Integer
ShowColumnName Boolean
CaptionRange Text

RoundAmount

procedure RoundAmount(Amount: Decimal, RoundingFactor: Enum "Analysis Rounding Factor"): Decimal

Parameters

Name Type Description
Amount Decimal
RoundingFactor Enum Microsoft.Foundation.Enums."Analysis Rounding Factor"

Returns

Type Description
Decimal

FormatAmount

procedure FormatAmount(Value: Decimal, RoundingFactor: Enum "Analysis Rounding Factor", AddCurrency: Boolean): Text[30]

Parameters

Name Type Description
Value Decimal
RoundingFactor Enum Microsoft.Foundation.Enums."Analysis Rounding Factor"
AddCurrency Boolean

Returns

Type Description
Text[30]

FormatRoundingFactor

procedure FormatRoundingFactor(RoundingFactor: Enum "Analysis Rounding Factor", AddCurrency: Boolean): Text

Parameters

Name Type Description
RoundingFactor Enum Microsoft.Foundation.Enums."Analysis Rounding Factor"
AddCurrency Boolean

Returns

Type Description
Text

FormatRoundingFactor

procedure FormatRoundingFactor(RoundingFactor: Enum "Analysis Rounding Factor", AddCurrency: Boolean, NegativeAmountFormat: Enum "Analysis Negative Format"): Text

Parameters

Name Type Description
RoundingFactor Enum Microsoft.Foundation.Enums."Analysis Rounding Factor"
AddCurrency Boolean
NegativeAmountFormat Enum Microsoft.Foundation.Enums."Analysis Negative Format"

Returns

Type Description
Text

Events

OnAfterGetCaption

[IntegrationEvent(False,False)]
local procedure OnAfterGetCaption(var RecRef: RecordRef, CaptionFieldNo: Integer, var Caption: Text)

Parameters

Name Type Description
RecRef RecordRef
CaptionFieldNo Integer
Caption Text

OnBeforeGeneratePeriodAndCaption

[IntegrationEvent(False,False)]
local procedure OnBeforeGeneratePeriodAndCaption(PeriodType: Enum "Analysis Period Type", Calendar: Record Date, var IsHandled: Boolean, UseNameForCaption: Boolean, var CurrSetLength: Integer, var CaptionSet: array[32] of Text[80], var PeriodRecords: array[32] of Record Date)

Parameters

Name Type Description
PeriodType Enum Microsoft.Foundation.Enums."Analysis Period Type"
Calendar Table System.Utilities.Date
IsHandled Boolean
UseNameForCaption Boolean
CurrSetLength Integer
CaptionSet array[32] of Text[80]
PeriodRecords array[32] of Record Date

OnSetDimColumnSetOnAfterDimValSetFilters

[IntegrationEvent(False,False)]
local procedure OnSetDimColumnSetOnAfterDimValSetFilters(DimensionCode: Code[20], DimFilter: Text, var DimensionValue: Record "Dimension Value")

Parameters

Name Type Description
DimensionCode Code[20]
DimFilter Text
DimensionValue Table Microsoft.Finance.Dimension."Dimension Value"

OnFormatRoundingFactorOnElse

[IntegrationEvent(False,False)]
local procedure OnFormatRoundingFactorOnElse(var AmountDecimal: Text, RoundingFactor: Enum "Analysis Rounding Factor")

Parameters

Name Type Description
AmountDecimal Text
RoundingFactor Enum Microsoft.Foundation.Enums."Analysis Rounding Factor"

OnFormatRoundingFactorNegativeFormatOnElse

[IntegrationEvent(False,False)]
local procedure OnFormatRoundingFactorNegativeFormatOnElse(AmountDecimal: Text, NegativeAmountFormat: Enum "Analysis Negative Format", var Result: Text)

Parameters

Name Type Description
AmountDecimal Text
NegativeAmountFormat Enum Microsoft.Foundation.Enums."Analysis Negative Format"
Result Text

OnRoundAmountOnElse

[IntegrationEvent(False,False)]
local procedure OnRoundAmountOnElse(var Amount: Decimal, RoundingFactor: Enum "Analysis Rounding Factor")

Parameters

Name Type Description
Amount Decimal
RoundingFactor Enum Microsoft.Foundation.Enums."Analysis Rounding Factor"

OnGenerateMatrixDataExtendedOnBeforeValidatePreviousStep

[IntegrationEvent(False,False)]
local procedure OnGenerateMatrixDataExtendedOnBeforeValidatePreviousStep(Steps: Integer, MaximumSetLength: Integer, var IsHandled: Boolean)

Parameters

Name Type Description
Steps Integer
MaximumSetLength Integer
IsHandled Boolean

OnGeneratePeriodMatrixDataOnBeforeAdjustPeriodWithDateFilter

[IntegrationEvent(False,False)]
local procedure OnGeneratePeriodMatrixDataOnBeforeAdjustPeriodWithDateFilter(DateFilter: Text, var TempPeriodRecords: array[32] of Record Date, var CurrSetLength: Integer, var IsHandled: Boolean)

Parameters

Name Type Description
DateFilter Text
TempPeriodRecords array[32] of Record Date
CurrSetLength Integer
IsHandled Boolean

OnGeneratePeriodMatrixDataOnBeforeFindDateBasedOnStepType

[IntegrationEvent(False,False)]
local procedure OnGeneratePeriodMatrixDataOnBeforeFindDateBasedOnStepType(SetWanted: Option, var CalendarDate: Record Date, PeriodType: Enum "Analysis Period Type")

Parameters

Name Type Description
SetWanted Option
CalendarDate Table System.Utilities.Date
PeriodType Enum Microsoft.Foundation.Enums."Analysis Period Type"

OnMatrixPageStepTypeInGenerateMatrixDataExtended

[IntegrationEvent(False,False)]
local procedure OnMatrixPageStepTypeInGenerateMatrixDataExtended(SetWanted: Option, MaximumSetLength: Integer, var RecRef: RecordRef)

Parameters

Name Type Description
SetWanted Option
MaximumSetLength Integer
RecRef RecordRef

See also