Use XML Schemas to Prepare Data Exchange Definitions

To enable import/export of data in XML files through the data exchange framework in Business Central, you can use XML schemas to define which data elements you want to exchange with Business Central. You perform this work on the XML Schema Viewer page by loading the XML schema file, selecting the relevant data elements, and then initializing a data exchange definition.

When you have defined which data elements to include based on the XML schema, you can use the Generate Data Exchange Definition action to initialize a data exchange definition based on the selected data elements, which you then complete in the Data Exchange Framework. This creates a record on the Posting Exchange Definition page where you continue by defining which elements in the file map to which fields in Business Central. For more information, see Set Up Data Exchange Definitions.

This topic contains the following procedures:

  • To load an XML schema file

  • To select or clear nodes in an XML schema

  • To generate a data exchange definition that is based on an XML schema

To load an XML schema file

  1. Make sure that the relevant XML schema file is available. The file extension is .xsd.

  2. Choose the Lightbulb that opens the Tell Me feature. icon, enter XML Schemas, and then choose the related link.

  3. Choose the New action.

  4. Fill the fields as described in the following table.

    Field Description
    Code Specify a code to identify the XML schema.
    Description Specify a description of the XML schema.

    The Target Namespace field specifies any namespace in the XML schema file that has been loaded for the line.

  5. Choose the Load Schema action, and then select the XML schema file.

    When the file is loaded, the rest of the fields on the line are filled with information from the file, and the Schema is Loaded check box is selected.

    Note

    Note:
    The tree of the loaded XML schema is collapsed by default. You expand each node by choosing the + button on the node. To expand all nodes, choose Expand All on the ribbon.

To select or clear nodes in an XML schema

  1. Choose the Lightbulb that opens the Tell Me feature. icon, enter XML Schema Viewer, and then choose the related link.

  2. Fill the fields on the header as described in the following table.

    Field Description
    XML Schema Code Specify the XML schema file that you loaded in step 5 in the "To load an XML schema file" section.
    New XMLport No. Specify the number of the XMLport that is created from this XML schema when you choose the Generate XMLport action.

    The lines are now filled with nodes representing all elements in the XML schema. Nodes for elements that are mandatory according to the XML schema are selected by default.

  3. On the first line, in the Node Name column, expand the Document node, and then gradually expand underlying nodes that you want to review.

    Alternatively, right-click on a node and then choose Expand All.

  4. Choose either of the following actions to change which nodes are displayed.

    Action Description
    Show All All nodes are shown.
    Hide Non-Mandatory Only nodes representing elements that are required according to the XML schema are shown. These nodes are typically indicated by a 1 in the MinOccurs field.

    Choose Show All to reverse the view.
    Hide Non-Selected Only nodes where the Selected check box is selected are shown.

    Choose Show All to reverse the view.

  5. Choose the Edit action.

  6. In the Selected check box, specify for each node if you want the element to be supported in the data exchange definition for the related SEPA bank file.

    Note

    Note:
    When you select a mandatory child node, all parent nodes above it are also selected.

  7. Choose the Select All Mandatory Elements action to reselect all nodes that represent elements that are mandatory according to the XML schema.

  8. Choose the Deselect All action to clear all selections.

    The Choice field specifies that the node has two or more sibling nodes that function as options.

To generate a data exchange definition that is based on an XML schema

  1. Choose the Lightbulb that opens the Tell Me feature. icon, enter XML Schemas, and then choose the related link.

  2. Select the relevant XML schema, and then choose the Open XML Schema Viewer action.

  3. Make sure the relevant nodes are selected. For more information, see the "To select or clear nodes in an XML schema" section.

  4. On the XML Schema Viewer page, choose the Generate Data Exchange Definition action.

A data exchange definition is created on the Posting Exchange Definition page, which you can complete by specifying which elements in the file map to which fields in Business Central. For more information, see Set Up Data Exchange Definitions.

Note

Note:
You can also use the Get File Structure function from the Posting Exchange Definition page, which uses the functionality of the XML Schema Viewer page to prefill the Column Definitions TastTab.

Note

Note:
In 2019 release wave 1 and earlier versions, you could generate an XMLport that was based on the schema and then import that into your solution. This is no longer supported.

See also

Set Up Data Exchange Definitions
Export Payments to a Bank File
Collect Payments with SEPA Direct Debit
About the Data Exchange Framework

Find free e-learning modules for Business Central here