Codeunit "Batch Processing Mgt."

ID 1380

Namespace: Microsoft.Foundation.BatchProcessing

Properties

Name	Value
Permissions	TableData "Batch Processing Parameter" = rimd, TableData "Batch Processing Session Map" = rimd

Methods

BatchProcess

procedure BatchProcess(var RecRef: RecordRef)

Parameters

Name	Type	Description
RecRef	RecordRef

BatchProcess

procedure BatchProcess(SourceRecord: Variant, SourceRecordProcessingCodeunitId: Integer, ErrorHandlingOptions: Enum "Error Handling Options", NoSelected: Integer, NoSkipped: Integer)

Parameters

Name	Type	Description
SourceRecord	Variant
SourceRecordProcessingCodeunitId	Integer
ErrorHandlingOptions	Enum Microsoft.Utilities."Error Handling Options"
NoSelected	Integer
NoSkipped	Integer

BatchProcess

procedure BatchProcess(var RecRef: RecordRef, ErrorHandlingOptions: Enum "Error Handling Options")

Parameters

Name	Type	Description
RecRef	RecordRef
ErrorHandlingOptions	Enum Microsoft.Utilities."Error Handling Options"

BatchProcessGenJournalLine

procedure BatchProcessGenJournalLine(var GenJournalLine: Record "Gen. Journal Line", PostingCodeunitId: Integer)

Parameters

Name	Type	Description
GenJournalLine	Table Microsoft.Finance.GeneralLedger.Journal."Gen. Journal Line"
PostingCodeunitId	Integer

FillBatchProcessingMap

procedure FillBatchProcessingMap(var RecRef: RecordRef)

Parameters

Name	Type	Description
RecRef	RecordRef

GetErrorMessages

procedure GetErrorMessages(var TempErrorMessageResult: Record "Error Message" temporary)

Parameters

Name	Type	Description
TempErrorMessageResult	Table System.Utilities."Error Message"

ResetBatchID

procedure ResetBatchID()

AddArtifact

procedure AddArtifact(ArtifactType: Enum "Batch Processing Artifact Type", ArtifactName: Text[1024], var TempBlobArtivactValue: Codeunit "Temp Blob")

Parameters

Name	Type	Description
ArtifactType	Enum Microsoft.Foundation.BatchProcessing."Batch Processing Artifact Type"
ArtifactName	Text[1024]
TempBlobArtivactValue	Codeunit System.Utilities."Temp Blob"

HasArtifacts

procedure HasArtifacts(ArtifactType: Enum "Batch Processing Artifact Type"): Boolean

Parameters

Name	Type	Description
ArtifactType	Enum Microsoft.Foundation.BatchProcessing."Batch Processing Artifact Type"

Returns

Type	Description
Boolean

GetArtifacts

procedure GetArtifacts(ArtifactType: Enum "Batch Processing Artifact Type", var TempBatchProcessingArtifact: Record "Batch Processing Artifact" temporary): Boolean

Parameters

Name	Type	Description
ArtifactType	Enum Microsoft.Foundation.BatchProcessing."Batch Processing Artifact Type"
TempBatchProcessingArtifact	Table Microsoft.Foundation.BatchProcessing."Batch Processing Artifact"

Returns

Type	Description
Boolean

DeleteBatchProcessingSessionMapForRecordId

procedure DeleteBatchProcessingSessionMapForRecordId(RecordIdToClean: RecordId)

Parameters

Name	Type	Description
RecordIdToClean	RecordId

SetParameter

procedure SetParameter(ParameterId: Enum "Batch Posting Parameter Type", Value: Variant)

Parameters

Name	Type	Description
ParameterId	Enum Microsoft.Foundation.BatchProcessing."Batch Posting Parameter Type"
Value	Variant

SetParametersForPageID

procedure SetParametersForPageID(PageID: Integer)

Parameters

Name	Type	Description
PageID	Integer

GetTextParameter

procedure GetTextParameter(RecordID: RecordId, ParameterId: Enum "Batch Posting Parameter Type", var ParameterValue: Text[250]): Boolean

Parameters

Name	Type	Description
RecordID	RecordId
ParameterId	Enum Microsoft.Foundation.BatchProcessing."Batch Posting Parameter Type"
ParameterValue	Text[250]

Returns

Type	Description
Boolean

GetBooleanParameter

procedure GetBooleanParameter(RecordID: RecordId, ParameterId: Enum "Batch Posting Parameter Type", var ParameterValue: Boolean): Boolean

Parameters

Name	Type	Description
RecordID	RecordId
ParameterId	Enum Microsoft.Foundation.BatchProcessing."Batch Posting Parameter Type"
ParameterValue	Boolean

Returns

Type	Description
Boolean

GetIntegerParameter

procedure GetIntegerParameter(RecordID: RecordId, ParameterId: Enum "Batch Posting Parameter Type", var ParameterValue: Integer): Boolean

Parameters

Name	Type	Description
RecordID	RecordId
ParameterId	Enum Microsoft.Foundation.BatchProcessing."Batch Posting Parameter Type"
ParameterValue	Integer

Returns

Type	Description
Boolean

GetDateParameter

procedure GetDateParameter(RecordID: RecordId, ParameterId: Enum "Batch Posting Parameter Type", var ParameterValue: Date): Boolean

Parameters

Name	Type	Description
RecordID	RecordId
ParameterId	Enum Microsoft.Foundation.BatchProcessing."Batch Posting Parameter Type"
ParameterValue	Date

Returns

Type	Description
Boolean

GetTimeParameter

procedure GetTimeParameter(RecordID: RecordId, ParameterId: Enum "Batch Posting Parameter Type", var ParameterValue: Time): Boolean

Parameters

Name	Type	Description
RecordID	RecordId
ParameterId	Enum Microsoft.Foundation.BatchProcessing."Batch Posting Parameter Type"
ParameterValue	Time

Returns

Type	Description
Boolean

IsActive

procedure IsActive(): Boolean

Returns

Type	Description
Boolean

GetIsCustomProcessingHandled

procedure GetIsCustomProcessingHandled(): Boolean

Returns

Type	Description
Boolean

GetKeepParameters

procedure GetKeepParameters(): Boolean

Returns

Type	Description
Boolean

GetRecRefForCustomProcessing

procedure GetRecRefForCustomProcessing(var RecRef: RecordRef)

Parameters

Name	Type	Description
RecRef	RecordRef

GetBatchFromSession

procedure GetBatchFromSession(SourceRecordID: RecordId, SourceSessionID: Integer)

Parameters

Name	Type	Description
SourceRecordID	RecordId
SourceSessionID	Integer

SetRecRefForCustomProcessing

procedure SetRecRefForCustomProcessing(RecRef: RecordRef)

Parameters

Name	Type	Description
RecRef	RecordRef

SetProcessingCodeunit

procedure SetProcessingCodeunit(NewProcessingCodeunitID: Integer)

Parameters

Name	Type	Description
NewProcessingCodeunitID	Integer

Events

OnVerifyRecord

[IntegrationEvent(True,False)]
local procedure OnVerifyRecord(var RecRef: RecordRef, var Result: Boolean)

Parameters

Name	Type	Description
RecRef	RecordRef
Result	Boolean

OnBeforeBatchProcess

[IntegrationEvent(True,False)]
local procedure OnBeforeBatchProcess(var RecRef: RecordRef)

Parameters

Name	Type	Description
RecRef	RecordRef

OnBeforeBatchProcessGenJournalLine

[IntegrationEvent(False,False)]
local procedure OnBeforeBatchProcessGenJournalLine(var GenJournalLine: Record "Gen. Journal Line")

Parameters

Name	Type	Description
GenJournalLine	Table Microsoft.Finance.GeneralLedger.Journal."Gen. Journal Line"

OnBeforeBatchProcessing

[IntegrationEvent(True,False)]
local procedure OnBeforeBatchProcessing(var RecRef: RecordRef, var BatchConfirm: Option)

Parameters

Name	Type	Description
RecRef	RecordRef
BatchConfirm	Option

OnBeforeSetParametersForPageID

[IntegrationEvent(True,False)]
local procedure OnBeforeSetParametersForPageID(PageID: Integer, var IsHandled: Boolean)

Parameters

Name	Type	Description
PageID	Integer
IsHandled	Boolean

OnAfterBatchProcess

[IntegrationEvent(True,False)]
local procedure OnAfterBatchProcess(var RecRef: RecordRef, var CounterPosted: Integer, ProcessingCodeunitID: Integer)

Parameters

Name	Type	Description
RecRef	RecordRef
CounterPosted	Integer
ProcessingCodeunitID	Integer

OnAfterBatchProcessing

[IntegrationEvent(True,False)]
local procedure OnAfterBatchProcessing(var RecRef: RecordRef, PostingResult: Boolean)

Parameters

Name	Type	Description
RecRef	RecordRef
PostingResult	Boolean

OnCustomProcessing

[IntegrationEvent(True,False)]
local procedure OnCustomProcessing(var RecRef: RecordRef, var Handled: Boolean, var KeepParameters: Boolean)

Parameters

Name	Type	Description
RecRef	RecordRef
Handled	Boolean
KeepParameters	Boolean

OnBatchProcessOnBeforeShowMessage

[IntegrationEvent(True,False)]
local procedure OnBatchProcessOnBeforeShowMessage(CounterPosted: Integer, CounterTotal: Integer, var IsHandled: Boolean, var ErrorMessageHandler: Codeunit "Error Message Handler", var ErrorMessageMgt: Codeunit "Error Message Management", FullBatchProcessed: Boolean)

Parameters

Name	Type	Description
CounterPosted	Integer
CounterTotal	Integer
IsHandled	Boolean
ErrorMessageHandler	Codeunit System.Utilities."Error Message Handler"
ErrorMessageMgt	Codeunit System.Utilities."Error Message Management"
FullBatchProcessed	Boolean

OnBatchProcessOnBeforeResetBatchID

[IntegrationEvent(True,False)]
local procedure OnBatchProcessOnBeforeResetBatchID(var RecRef: RecordRef, ProcessingCodeunitID: Integer)

Parameters

Name	Type	Description
RecRef	RecordRef
ProcessingCodeunitID	Integer

OnBatchProcessOnAfterIncreaseCounterPosted

[IntegrationEvent(True,False)]
local procedure OnBatchProcessOnAfterIncreaseCounterPosted(var RecRef: RecordRef, ProcessingCodeunitID: Integer)

Parameters

Name	Type	Description
RecRef	RecordRef
ProcessingCodeunitID	Integer

OnBeforeBatchShouldBeProcessedInBackground

[IntegrationEvent(False,False)]
local procedure OnBeforeBatchShouldBeProcessedInBackground(var RecRef: RecordRef, var IsProcessed: Boolean)

Parameters

Name	Type	Description
RecRef	RecordRef
IsProcessed	Boolean

OnIsPostWithJobQueueEnabled

[IntegrationEvent(False,False)]
local procedure OnIsPostWithJobQueueEnabled(var Result: Boolean)

Parameters

Name	Type	Description
Result	Boolean

OnSetParameterOnBeforeParameterInsert

[IntegrationEvent(False,False)]
local procedure OnSetParameterOnBeforeParameterInsert(BatchProcessingParameter: Record "Batch Processing Parameter", var IsProcessed: Boolean)

Parameters

Name	Type	Description
BatchProcessingParameter	Table Microsoft.Foundation.BatchProcessing."Batch Processing Parameter"
IsProcessed	Boolean

OnProcessBatchInBackground

[IntegrationEvent(False,False)]
local procedure OnProcessBatchInBackground(var RecRef: RecordRef, var SkippedRecordExists: Boolean)

Parameters

Name	Type	Description
RecRef	RecordRef
SkippedRecordExists	Boolean

OnGetICBatchFileName

[IntegrationEvent(False,False)]
local procedure OnGetICBatchFileName(var Result: Text)

Parameters

Name	Type	Description
Result	Text

OnInvokeProcessingOnBeforeRunProcessingCodeunitID

[IntegrationEvent(False,False)]
local procedure OnInvokeProcessingOnBeforeRunProcessingCodeunitID(RecordRef: RecordRef)

Parameters

Name	Type	Description
RecordRef	RecordRef

OnInvokeProcessingOnAfterRunProcessingCodeunitID

[IntegrationEvent(False,False)]
local procedure OnInvokeProcessingOnAfterRunProcessingCodeunitID(RecordRef: RecordRef)

Parameters

Name	Type	Description
RecordRef	RecordRef

OnSetParametersForPageIDOnAfterCalcDoInvoice

[IntegrationEvent(False,False)]
local procedure OnSetParametersForPageIDOnAfterCalcDoInvoice(var PageID: Integer, var DoInvoicePurchase: Boolean, var DoInvoiceSales: Boolean)

Parameters

Name	Type	Description
PageID	Integer
DoInvoicePurchase	Boolean
DoInvoiceSales	Boolean

See also

• Codeunit