Codeunit "Config. XML Exchange"

ID 8614
Namespace: System.IO

Methods

ApplyPackageFilter

procedure ApplyPackageFilter(ConfigPackageTable: Record "Config. Package Table", var RecRef: RecordRef)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
RecRef RecordRef

ExportPackageXMLToStream

Export the provided configuration package to an OutStream.

procedure ExportPackageXMLToStream(ConfigPackage: Record "Config. Package", PackageOutStream: OutStream)

Parameters

Name Type Description
ConfigPackage Table System.IO."Config. Package"

Configuration package to export.

PackageOutStream OutStream

OutStream object that the content of the package will be written to.

GetImportedPackageCode

procedure GetImportedPackageCode(): Code[20]

Returns

Type Description
Code[20]

ImportPackageXML

procedure ImportPackageXML(XMLDataFile: Text): Boolean

Parameters

Name Type Description
XMLDataFile Text

Returns

Type Description
Boolean

ImportPackageXMLFromStream

procedure ImportPackageXMLFromStream(InStream: InStream): Boolean

Parameters

Name Type Description
InStream InStream

Returns

Type Description
Boolean

ImportPackageXMLWithCodeFromStream

procedure ImportPackageXMLWithCodeFromStream(InStream: InStream, PackageCode: Code[20]): Boolean

Parameters

Name Type Description
InStream InStream
PackageCode Code[20]

Returns

Type Description
Boolean

GetElementName

procedure GetElementName(NameIn: Text[250]): Text[250]

Parameters

Name Type Description
NameIn Text[250]

Returns

Type Description
Text[250]

GetFieldElementName

procedure GetFieldElementName(NameIn: Text[250]): Text[250]

Parameters

Name Type Description
NameIn Text[250]

Returns

Type Description
Text[250]

GetTableElementName

procedure GetTableElementName(NameIn: Text[250]): Text[250]

Parameters

Name Type Description
NameIn Text[250]

Returns

Type Description
Text[250]

GetMediaFolderName

procedure GetMediaFolderName(): Text

Returns

Type Description
Text

GetXSDType

procedure GetXSDType(TableID: Integer, FieldID: Integer): Text[30]

Parameters

Name Type Description
TableID Integer
FieldID Integer

Returns

Type Description
Text[30]

SetAdvanced

procedure SetAdvanced(NewAdvanced: Boolean)

Parameters

Name Type Description
NewAdvanced Boolean

SetCalledFromCode

procedure SetCalledFromCode(NewCalledFromCode: Boolean)

Parameters

Name Type Description
NewCalledFromCode Boolean

SetExcelMode

procedure SetExcelMode(NewExcelMode: Boolean)

Parameters

Name Type Description
NewExcelMode Boolean

SetHideDialog

procedure SetHideDialog(NewHideDialog: Boolean)

Parameters

Name Type Description
NewHideDialog Boolean

SetExportFromWksht

procedure SetExportFromWksht(NewExportFromWksht: Boolean)

Parameters

Name Type Description
NewExportFromWksht Boolean

SetPrefixMode

procedure SetPrefixMode(PrefixMode: Boolean)

Parameters

Name Type Description
PrefixMode Boolean

TableObjectExists

procedure TableObjectExists(TableId: Integer): Boolean

Parameters

Name Type Description
TableId Integer

Returns

Type Description
Boolean

DecompressPackageToBlob

procedure DecompressPackageToBlob(var TempBlob: Codeunit "Temp Blob", var TempBlobUncompressed: Codeunit "Temp Blob")

Parameters

Name Type Description
TempBlob Codeunit System.Utilities."Temp Blob"
TempBlobUncompressed Codeunit System.Utilities."Temp Blob"

GetFileDialogFilter

procedure GetFileDialogFilter(): Text

Returns

Type Description
Text

Events

OnAfterAddFieldAttributes

[IntegrationEvent(False,False)]
local procedure OnAfterAddFieldAttributes(var ConfigPackageField: Record "Config. Package Field", FieldNode: DotNet "System.Xml.XmlNode")

Parameters

Name Type Description
ConfigPackageField Table System.IO."Config. Package Field"
FieldNode DotNet "System.Xml.XmlNode"

OnAfterAddTableAttributes

[IntegrationEvent(False,False)]
local procedure OnAfterAddTableAttributes(ConfigPackageTable: Record "Config. Package Table", PackageXML: DotNet "System.Xml.XmlDocument", TableNode: DotNet "System.Xml.XmlNode")

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
PackageXML DotNet "System.Xml.XmlDocument"
TableNode DotNet "System.Xml.XmlNode"

OnAfterExportPackageXMLDocument

[IntegrationEvent(False,False)]
local procedure OnAfterExportPackageXMLDocument(var ConfigPackage: Record "Config. Package", HideDialog: Boolean)

Parameters

Name Type Description
ConfigPackage Table System.IO."Config. Package"
HideDialog Boolean

OnAfterImportPackageXMLDocument

[IntegrationEvent(False,False)]
local procedure OnAfterImportPackageXMLDocument(PackageCode: Code[20], ExcelMode: Boolean, var Result: Boolean)

Parameters

Name Type Description
PackageCode Code[20]
ExcelMode Boolean
Result Boolean

OnBeforeApplyPackageFilter

[IntegrationEvent(False,False)]
local procedure OnBeforeApplyPackageFilter(ConfigPackageTable: Record "Config. Package Table", var RecRef: RecordRef)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
RecRef RecordRef

OnBeforeCreateRecordNodes

[IntegrationEvent(False,False)]
local procedure OnBeforeCreateRecordNodes(var ConfigPackageTable: Record "Config. Package Table", var ConfigPackageField: Record "Config. Package Field", var TypeHelper: Codeunit "Type Helper", var XMLDOMManagement: Codeunit "XML DOM Management", var WorkingFolder: Text, var ExcelMode: Boolean, var Advanced: Boolean, var HideDialog: Boolean, var IsHandled: Boolean)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
ConfigPackageField Table System.IO."Config. Package Field"
TypeHelper Codeunit System.Reflection."Type Helper"
XMLDOMManagement Codeunit System.Xml."XML DOM Management"
WorkingFolder Text
ExcelMode Boolean
Advanced Boolean
HideDialog Boolean
IsHandled Boolean

OnBeforeEvaluateMinCountForAsyncImport

[IntegrationEvent(False,False)]
local procedure OnBeforeEvaluateMinCountForAsyncImport(var ConfigPackage: Record "Config. Package", var Value: Text, var IsHandled: Boolean)

Parameters

Name Type Description
ConfigPackage Table System.IO."Config. Package"
Value Text
IsHandled Boolean

OnBeforeGetXSDType

[IntegrationEvent(False,False)]
local procedure OnBeforeGetXSDType(TableID: Integer, FieldID: Integer, var Result: Text[30], var IsHandled: Boolean)

Parameters

Name Type Description
TableID Integer
FieldID Integer
Result Text[30]
IsHandled Boolean

OnBeforeGetElementName

[IntegrationEvent(False,False)]
local procedure OnBeforeGetElementName(var NameIn: Text[250])

Parameters

Name Type Description
NameIn Text[250]

OnCreateRecordNodesOnAfterConfigPackageFieldSetFilters

[IntegrationEvent(False,False)]
local procedure OnCreateRecordNodesOnAfterConfigPackageFieldSetFilters(ConfigPackageTable: Record "Config. Package Table", var ConfigPackageField: Record "Config. Package Field")

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
ConfigPackageField Table System.IO."Config. Package Field"

OnCreateRecordNodesOnBeforeRecRefLoopIteration

[IntegrationEvent(False,False)]
local procedure OnCreateRecordNodesOnBeforeRecRefLoopIteration(ConfigPackageTable: Record "Config. Package Table", ConfigPackage: Record "Config. Package", var RecRef: RecordRef, var ConfigProgressBar: Codeunit "Config. Progress Bar", var IsHandled: Boolean)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
ConfigPackage Table System.IO."Config. Package"
RecRef RecordRef
ConfigProgressBar Codeunit System.IO."Config. Progress Bar"
IsHandled Boolean

OnCreateRecordNodesOnAfterApplyPackageFilter

[IntegrationEvent(False,False)]
local procedure OnCreateRecordNodesOnAfterApplyPackageFilter(ConfigPackageTable: Record "Config. Package Table", ConfigPackage: Record "Config. Package", var RecRef: RecordRef)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
ConfigPackage Table System.IO."Config. Package"
RecRef RecordRef

OnCreateRecordNodesOnAfterRecordProcessed

[IntegrationEvent(False,False)]
local procedure OnCreateRecordNodesOnAfterRecordProcessed(ConfigPackageTable: Record "Config. Package Table", var ConfigPackageField: Record "Config. Package Field", var RecRef: RecordRef, PackageXML: DotNet "System.Xml.XmlDocument", RecordNode: DotNet "System.Xml.XmlNode", FieldNode: DotNet "System.Xml.XmlNode", ExcelMode: Boolean)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
ConfigPackageField Table System.IO."Config. Package Field"
RecRef RecordRef
PackageXML DotNet "System.Xml.XmlDocument"
RecordNode DotNet "System.Xml.XmlNode"
FieldNode DotNet "System.Xml.XmlNode"
ExcelMode Boolean

OnCreateRecordNodesOnNotFoundOnAfterConfigPackageFieldSetFilters

[IntegrationEvent(False,False)]
local procedure OnCreateRecordNodesOnNotFoundOnAfterConfigPackageFieldSetFilters(ConfigPackageTable: Record "Config. Package Table", var ConfigPackageField: Record "Config. Package Field")

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
ConfigPackageField Table System.IO."Config. Package Field"

OnCreateRecordNodesOnAfterNotFoundRecordProcessed

[IntegrationEvent(False,False)]
local procedure OnCreateRecordNodesOnAfterNotFoundRecordProcessed(ConfigPackageTable: Record "Config. Package Table", var ConfigPackageField: Record "Config. Package Field", var RecRef: RecordRef, PackageXML: DotNet "System.Xml.XmlDocument", RecordNode: DotNet "System.Xml.XmlNode", FieldNode: DotNet "System.Xml.XmlNode", ExcelMode: Boolean)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
ConfigPackageField Table System.IO."Config. Package Field"
RecRef RecordRef
PackageXML DotNet "System.Xml.XmlDocument"
RecordNode DotNet "System.Xml.XmlNode"
FieldNode DotNet "System.Xml.XmlNode"
ExcelMode Boolean

OnExportPackageXMLDocumentOnAfterSetAttributes

[IntegrationEvent(False,False)]
local procedure OnExportPackageXMLDocumentOnAfterSetAttributes(var ConfigPackage: Record "Config. Package", var XMLDOMMgt: Codeunit "XML DOM Management", DocumentElement: DotNet "System.Xml.XmlElement")

Parameters

Name Type Description
ConfigPackage Table System.IO."Config. Package"
XMLDOMMgt Codeunit System.Xml."XML DOM Management"
DocumentElement DotNet "System.Xml.XmlElement"

OnExportPackageXMLDocumentOnBeforeConfigProgressBarInit

[IntegrationEvent(False,False)]
local procedure OnExportPackageXMLDocumentOnBeforeConfigProgressBarInit(var ConfigPackageTable: Record "Config. Package Table", var ConfigPackage: Record "Config. Package", var XMLDOMMgt: Codeunit "XML DOM Management", Advanced: Boolean, HideDialog: Boolean)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
ConfigPackage Table System.IO."Config. Package"
XMLDOMMgt Codeunit System.Xml."XML DOM Management"
Advanced Boolean
HideDialog Boolean

OnExportPackageXMLOnAfterAssignToFile

[IntegrationEvent(False,False)]
local procedure OnExportPackageXMLOnAfterAssignToFile(ConfigPackage: Record "Config. Package", var ToFile: Text[50])

Parameters

Name Type Description
ConfigPackage Table System.IO."Config. Package"
ToFile Text[50]

OnOnExportPackageXMLOnAfterAssignToFileOnAfterSetCompressedFileName

[IntegrationEvent(False,False)]
local procedure OnOnExportPackageXMLOnAfterAssignToFileOnAfterSetCompressedFileName(var CompressedFileName: Text, XMLDataFile: Text)

Parameters

Name Type Description
CompressedFileName Text
XMLDataFile Text

OnFillPackageMetadataFromXMLOnAfterGetPackageTableValueFromXML

[IntegrationEvent(False,False)]
local procedure OnFillPackageMetadataFromXMLOnAfterGetPackageTableValueFromXML(ConfigPackageTable: Record "Config. Package Table", TableNode: DotNet "System.Xml.XmlNode")

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
TableNode DotNet "System.Xml.XmlNode"

OnFillPackageDataFromXMLOnAfterConfigPackageDataInit

[IntegrationEvent(False,False)]
local procedure OnFillPackageDataFromXMLOnAfterConfigPackageDataInit(var ConfigPackageData: Record "Config. Package Data", var ConfigPackageField: Record "Config. Package Field")

Parameters

Name Type Description
ConfigPackageData Table System.IO."Config. Package Data"
ConfigPackageField Table System.IO."Config. Package Field"

OnFillPackageDataFromXMLOnAfterCalcShouldShowTableContainsRecordsQst

[IntegrationEvent(False,False)]
local procedure OnFillPackageDataFromXMLOnAfterCalcShouldShowTableContainsRecordsQst(var ConfigPackageTable: Record "Config. Package Table", PackageCode: Code[20], TableID: Integer, var HideDialog: Boolean, var ShouldShowTableContainsRecordsQst: Boolean)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
PackageCode Code[20]
TableID Integer
HideDialog Boolean
ShouldShowTableContainsRecordsQst Boolean

OnFillPackageDataFromXMLOnAfterCalcShouldAssignValue

[IntegrationEvent(False,False)]
local procedure OnFillPackageDataFromXMLOnAfterCalcShouldAssignValue(var ConfigPackageField: Record "Config. Package Field", var ConfigPackageData: Record "Config. Package Data", var ConfigPackageRecord: Record "Config. Package Record", var TempConfigPackageField: Record "Config. Package Field" temporary, var ShouldAssignValue: Boolean)

Parameters

Name Type Description
ConfigPackageField Table System.IO."Config. Package Field"
ConfigPackageData Table System.IO."Config. Package Data"
ConfigPackageRecord Table System.IO."Config. Package Record"
TempConfigPackageField Table System.IO."Config. Package Field"
ShouldAssignValue Boolean

OnFillPackageDataFromXMLOnAfterConfigPackageDataInsert

[IntegrationEvent(False,False)]
local procedure OnFillPackageDataFromXMLOnAfterConfigPackageDataInsert(var ConfigPackageData: Record "Config. Package Data", var ConfigPackageField: Record "Config. Package Field", ExcelMode: Boolean)

Parameters

Name Type Description
ConfigPackageData Table System.IO."Config. Package Data"
ConfigPackageField Table System.IO."Config. Package Field"
ExcelMode Boolean

OnImportPackageXMLDocumentOnDefaultDimOnAfterConfigPackageRecordSetFilters

[IntegrationEvent(False,False)]
local procedure OnImportPackageXMLDocumentOnDefaultDimOnAfterConfigPackageRecordSetFilters(var ConfigPackageRecord: Record "Config. Package Record", ConfigPackageData: Record "Config. Package Data", PackageCode: Code[20])

Parameters

Name Type Description
ConfigPackageRecord Table System.IO."Config. Package Record"
ConfigPackageData Table System.IO."Config. Package Data"
PackageCode Code[20]

OnCreateRecordNodesOnBeforeApplyPackageFilter

[IntegrationEvent(False,False)]
local procedure OnCreateRecordNodesOnBeforeApplyPackageFilter(var ConfigPackageTable: Record "Config. Package Table", var RecordReference: RecordRef, var IsHandled: Boolean)

Parameters

Name Type Description
ConfigPackageTable Table System.IO."Config. Package Table"
RecordReference RecordRef
IsHandled Boolean

OnImportPackageXMLDocumentOnBeforeModify

[IntegrationEvent(False,False)]
local procedure OnImportPackageXMLDocumentOnBeforeModify(var ConfigPackage: Record "Config. Package", DocumentElement: DotNet "System.Xml.XmlElement")

Parameters

Name Type Description
ConfigPackage Table System.IO."Config. Package"
DocumentElement DotNet "System.Xml.XmlElement"

OnFillPackageMetadataFromXMLOnBeforeConfigPackageFieldModify

[IntegrationEvent(False,False)]
local procedure OnFillPackageMetadataFromXMLOnBeforeConfigPackageFieldModify(var ConfigPackageField: Record "Config. Package Field", var Value: Text, FieldNode: DotNet "System.Xml.XmlNode")

Parameters

Name Type Description
ConfigPackageField Table System.IO."Config. Package Field"
Value Text
FieldNode DotNet "System.Xml.XmlNode"

OnFormatFieldValueOnBeforeExitInnerText

[IntegrationEvent(False,False)]
local procedure OnFormatFieldValueOnBeforeExitInnerText(var FieldRef: FieldRef, ConfigPackage: Record "Config. Package", var InnerText: Text)

Parameters

Name Type Description
FieldRef FieldRef
ConfigPackage Table System.IO."Config. Package"
InnerText Text

OnAfterGetDefaultDimensionNoLinkFieldNumber

[IntegrationEvent(False,False)]
local procedure OnAfterGetDefaultDimensionNoLinkFieldNumber(TableID: Integer, var FieldNumber: Integer)

Parameters

Name Type Description
TableID Integer
FieldNumber Integer

OnVerifyCanImportConfigurationPackage

[IntegrationEvent(False,False)]
local procedure OnVerifyCanImportConfigurationPackage(var CanImportConfigurationPackage: Boolean)

Parameters

Name Type Description
CanImportConfigurationPackage Boolean

See also