Codeunit "Custom Layout Reporting"

ID 8800

Namespace: Microsoft.Foundation.Reporting

Properties

Name	Value
EventSubscriberInstance	Manual

Methods

GetLayoutIteratorKeyFilter

procedure GetLayoutIteratorKeyFilter(var FilterRecordRef: RecordRef, var FilterRecordKeyFieldRef: FieldRef, CustomReportLayoutCode: Code[20])

Parameters

Name	Type	Description
FilterRecordRef	RecordRef
FilterRecordKeyFieldRef	FieldRef
CustomReportLayoutCode	Code[20]

ProcessReportData

procedure ProcessReportData(ReportUsage: Enum "Report Selection Usage", var DataRecordRef: RecordRef, SourceJoinFieldName: Text, DataRecordJoinTable: Integer, IteratorTableFieldName: Text, DataItemTableSameAsIterator: Boolean)

Parameters

Name	Type	Description
ReportUsage	Enum Microsoft.Foundation.Reporting."Report Selection Usage"
DataRecordRef	RecordRef
SourceJoinFieldName	Text
DataRecordJoinTable	Integer
IteratorTableFieldName	Text
DataItemTableSameAsIterator	Boolean

SetOutputOption

procedure SetOutputOption(OutputOption: Integer)

Parameters

Name	Type	Description
OutputOption	Integer

GetPrintOption

procedure GetPrintOption(): Integer

Returns

Type	Description
Integer

GetEmailOption

procedure GetEmailOption(): Integer

Returns

Type	Description
Integer

GetPreviewOption

procedure GetPreviewOption(): Integer

Returns

Type	Description
Integer

GetExcelOption

procedure GetExcelOption(): Integer

Returns

Type	Description
Integer

GetPDFOption

procedure GetPDFOption(): Integer

Returns

Type	Description
Integer

GetWordOption

procedure GetWordOption(): Integer

Returns

Type	Description
Integer

GetXMLOption

procedure GetXMLOption(): Integer

Returns

Type	Description
Integer

SetSavePath

procedure SetSavePath(SavePath: Text)

Parameters

Name	Type	Description
SavePath	Text

SetOutputSupression

procedure SetOutputSupression(SupressOutputFlag: Boolean)

Parameters

Name	Type	Description
SupressOutputFlag	Boolean

CallReportSaveAs

procedure CallReportSaveAs(ReportID: Integer, RequestParameterText: Text, ReportFormatValue: ReportFormat, var FileStream: OutStream, var RecRef: RecordRef): Boolean

Parameters

Name	Type	Description
ReportID	Integer
RequestParameterText	Text
ReportFormatValue	ReportFormat
FileStream	OutStream
RecRef	RecordRef

Returns

Type	Description
Boolean

IsWebClient

procedure IsWebClient(): Boolean

Returns

Type	Description
Boolean

SetOutputFileBaseName

procedure SetOutputFileBaseName(FileBaseName: Text)

Parameters

Name	Type	Description
FileBaseName	Text

SetTestModeWebClient

procedure SetTestModeWebClient(TestModeSpoofWebClient: Boolean)

Parameters

Name	Type	Description
TestModeSpoofWebClient	Boolean

HasRequestParameterData

procedure HasRequestParameterData(ReportID: Integer): Boolean

Parameters

Name	Type	Description
ReportID	Integer

Returns

Type	Description
Boolean

SetTableFilterForReportID

procedure SetTableFilterForReportID(ReportID: Integer, CustomerNo: Text)

Parameters

Name	Type	Description
ReportID	Integer
CustomerNo	Text

GetReportRequestPageParameters

procedure GetReportRequestPageParameters(ReportID: Integer): Text

Parameters

Name	Type	Description
ReportID	Integer

Returns

Type	Description
Text

SaveReportRequestPageParameters

procedure SaveReportRequestPageParameters(ReportID: Integer, XMLText: Text, OptionDataEncoding: TextEncoding)

Parameters

Name	Type	Description
ReportID	Integer
XMLText	Text
OptionDataEncoding	TextEncoding

SaveReportRequestPageParameters

procedure SaveReportRequestPageParameters(ReportID: Integer, XMLText: Text)

Parameters

Name	Type	Description
ReportID	Integer
XMLText	Text

CheckForCustomLayoutReportingJob

procedure CheckForCustomLayoutReportingJob()

SetRunReportOncePerFilter

procedure SetRunReportOncePerFilter(NewRunReportOncePerFilter: Boolean)

Parameters

Name	Type	Description
NewRunReportOncePerFilter	Boolean

Events

OnIsTestMode

[IntegrationEvent(False,False)]
local procedure OnIsTestMode(var TestMode: Boolean)

Parameters

Name	Type	Description
TestMode	Boolean

OnAfterProcessReport

[IntegrationEvent(False,False)]
local procedure OnAfterProcessReport()

OnBeforeCallReportSaveAs

[IntegrationEvent(False,False)]
local procedure OnBeforeCallReportSaveAs(ReportID: Integer, ReportFormatValue: ReportFormat)

Parameters

Name	Type	Description
ReportID	Integer
ReportFormatValue	ReportFormat

OnBeforePrintReport

[IntegrationEvent(False,False)]
local procedure OnBeforePrintReport(var DataRecRef: RecordRef, ReportID: Integer)

Parameters

Name	Type	Description
DataRecRef	RecordRef
ReportID	Integer

OnBeforeRunReport

[IntegrationEvent(False,False)]
local procedure OnBeforeRunReport(var DataRecRef: RecordRef, var ReportSelections: Record "Report Selections", var EmailPrintIfEmailIsMissing: Boolean, var TempBlobIndicesNameValueBuffer: Record "Name/Value Buffer" temporary, var TempBlobList: Codeunit "Temp Blob List", var OutputType: Option, var AnyOutputExists: Boolean, var InHandled: Boolean)

Parameters

Name	Type	Description
DataRecRef	RecordRef
ReportSelections	Table Microsoft.Foundation.Reporting."Report Selections"
EmailPrintIfEmailIsMissing	Boolean
TempBlobIndicesNameValueBuffer	Table Microsoft.Utilities."Name/Value Buffer"
TempBlobList	Codeunit System.Utilities."Temp Blob List"
OutputType	Option
AnyOutputExists	Boolean
InHandled	Boolean

OnBeforeRunReportWithCustomReportSelection

[IntegrationEvent(False,False)]
local procedure OnBeforeRunReportWithCustomReportSelection(var DataRecRef: RecordRef, var ReportID: Integer, var CustomReportSelection: Record "Custom Report Selection", var EmailPrintIfEmailIsMissing: Boolean, var TempBlobIndicesNameValueBuffer: Record "Name/Value Buffer" temporary, var TempBlobList: Codeunit "Temp Blob List", var OutputType: Option, var AnyOutputExists: Boolean, var InHandled: Boolean)

Parameters

Name	Type	Description
DataRecRef	RecordRef
ReportID	Integer
CustomReportSelection	Table Microsoft.Foundation.Reporting."Custom Report Selection"
EmailPrintIfEmailIsMissing	Boolean
TempBlobIndicesNameValueBuffer	Table Microsoft.Utilities."Name/Value Buffer"
TempBlobList	Codeunit System.Utilities."Temp Blob List"
OutputType	Option
AnyOutputExists	Boolean
InHandled	Boolean

OnBeforeSetIteratorJoinFieldRef

[IntegrationEvent(False,False)]
local procedure OnBeforeSetIteratorJoinFieldRef(var ReportDataRecordRef: RecordRef, var BalAcctTypeFieldRef: FieldRef, var AcctTypeFieldRef: FieldRef, var IsHandled: Boolean)

Parameters

Name	Type	Description
ReportDataRecordRef	RecordRef
BalAcctTypeFieldRef	FieldRef
AcctTypeFieldRef	FieldRef
IsHandled	Boolean

OnCreateReportWithExtensionOnBeforeHtmlFileClose

[IntegrationEvent(False,False)]
local procedure OnCreateReportWithExtensionOnBeforeHtmlFileClose(ReportID: Integer, RepFormat: ReportFormat, var DataRecRef: RecordRef, var FileStream: OutStream)

Parameters

Name	Type	Description
ReportID	Integer
RepFormat	ReportFormat
DataRecRef	RecordRef
FileStream	OutStream

OnCreateReportWithExtensionOnBeforePdfFileClose

[IntegrationEvent(False,False)]
local procedure OnCreateReportWithExtensionOnBeforePdfFileClose(ReportID: Integer, RepFormat: ReportFormat, var DataRecRef: RecordRef, var FileStream: OutStream)

Parameters

Name	Type	Description
ReportID	Integer
RepFormat	ReportFormat
DataRecRef	RecordRef
FileStream	OutStream

OnGenerateFileNameOnAfterAssignFileName

[IntegrationEvent(False,False)]
local procedure OnGenerateFileNameOnAfterAssignFileName(var FileName: Text, ReportID: Integer, Extension: Text, DataRecRef: RecordRef)

Parameters

Name	Type	Description
FileName	Text
ReportID	Integer
Extension	Text
DataRecRef	RecordRef

OnSaveAsReportOnBeforeFileClose

[IntegrationEvent(False,False)]
local procedure OnSaveAsReportOnBeforeFileClose(ReportSaved: Boolean, var DataRecRef: RecordRef, ReportID: Integer, RepFormat: ReportFormat, var FileStream: OutStream)

Parameters

Name	Type	Description
ReportSaved	Boolean
DataRecRef	RecordRef
ReportID	Integer
RepFormat	ReportFormat
FileStream	OutStream

OnSetOutputTypeOnAfterSetOutputMethod

[IntegrationEvent(False,False)]
local procedure OnSetOutputTypeOnAfterSetOutputMethod(var OutputMethod: Text)

Parameters

Name	Type	Description
OutputMethod	Text

OnAfterGetSendToEmailID

[IntegrationEvent(False,False)]
local procedure OnAfterGetSendToEmailID(var CustomReportSelection: Record "Custom Report Selection", var EmailID: Text[250])

Parameters

Name	Type	Description
CustomReportSelection	Table Microsoft.Foundation.Reporting."Custom Report Selection"
EmailID	Text[250]

OnAfterGetSendToEmailIDFromSource

[IntegrationEvent(False,False)]
local procedure OnAfterGetSendToEmailIDFromSource(var CustomReportSelection: Record "Custom Report Selection", var EmailID: Text[250])

Parameters

Name	Type	Description
CustomReportSelection	Table Microsoft.Foundation.Reporting."Custom Report Selection"
EmailID	Text[250]

OnRunRequestPageOnBeforeReportRunRequestPage

[IntegrationEvent(False,False)]
local procedure OnRunRequestPageOnBeforeReportRunRequestPage(ReportId: Integer, var SavedParameters: Text)

Parameters

Name	Type	Description
ReportId	Integer
SavedParameters	Text

OnProcessReportPerObjectOnBeforeReportDataRecordRefLoop

[IntegrationEvent(False,False)]
local procedure OnProcessReportPerObjectOnBeforeReportDataRecordRefLoop(ReportDataAndIteratorDiffer: Boolean, IteratorRecordRef: RecordRef)

Parameters

Name	Type	Description
ReportDataAndIteratorDiffer	Boolean
IteratorRecordRef	RecordRef

OnProcessReportPerObjectOnBeforeRunReport

[IntegrationEvent(False,False)]
local procedure OnProcessReportPerObjectOnBeforeRunReport(ReportDataAndIteratorDiffer: Boolean, IteratorRecordRef: RecordRef, var IsHandled: Boolean)

Parameters

Name	Type	Description
ReportDataAndIteratorDiffer	Boolean
IteratorRecordRef	RecordRef
IsHandled	Boolean

OnProcessReportPerObjectOnAfterRunReport

[IntegrationEvent(False,False)]
local procedure OnProcessReportPerObjectOnAfterRunReport(ReportDataAndIteratorDiffer: Boolean, IteratorRecordRef: RecordRef)

Parameters

Name	Type	Description
ReportDataAndIteratorDiffer	Boolean
IteratorRecordRef	RecordRef

OnAfterProcessReportPerObject

[IntegrationEvent(False,False)]
local procedure OnAfterProcessReportPerObject(ReportDataAndIteratorDiffer: Boolean)

Parameters

Name	Type	Description
ReportDataAndIteratorDiffer	Boolean

OnBeforeGenerateFileNameForReport

[IntegrationEvent(False,False)]
local procedure OnBeforeGenerateFileNameForReport(IteratorRecordRef: RecordRef, var NameFieldRef: FieldRef, ReportDataRecordRef: RecordRef, var ObjectName: Text, var IsHandled: Boolean)

Parameters

Name	Type	Description
IteratorRecordRef	RecordRef
NameFieldRef	FieldRef
ReportDataRecordRef	RecordRef
ObjectName	Text
IsHandled	Boolean

See also

• Codeunit