Show TOC

Background documentationExport and Import of XML Data

 

You can convert BRFplus objects into an XML representation. This is helpful if you want to transfer objects between systems that are not located in the same system landscape, or if there is no transport connection provided by the SAP transport system.

Prerequisites

You are running the BRFplus workbench in Expert Mode.

Features

Export

The XML export function works in an object-based manner, that is, you start by selecting a BRFplus object that you want to export. However, it is possible to extend the scope of an XML export in the following ways:

  • Include Referenced Objects: With this option set, the selected object is exported together with all objects that are directly or indirectly referenced by the selected object.

  • Include Application: With this option set, the selected object is exported together with the BRFplus application to which the object belongs.

In addition to the scope selection as described above, you can further fine-tune the export by choosing a particular XML version and an XML schema for the export. Depending on the selection you make, the system adapts the format and syntax of the exported data. This is helpful in situations where you have to transport BRFplus objects to a system with a lower release than the source system. Of course, it is always recommendable to choose the highest XML version for the export that is supported by the target system so that the system can profit from as many features as possible.

The purpose of the XML schema selection is to let you choose between different flavors of an XML-based object representation:

  • Internal

    As the name suggests, the Internal schema renders the schema element names in the same way that is used internally by BRFplus. Therefore, with this schema, the system does not need to perform any transformations during XML import or export.

  • External

    The External schema is functional equivalent to the Internal schema, but renders all schema element names in upper camel case notation rather than in capitals. This makes the XML data more readable, which is useful if you want to analyze the XML data manually.

Note Note

To find out which is the highest XML version supported by the target system, start the import function in the target system. The highest version supported is displayed on the screen.

The XML schema selection is only available if you have chosen the respective setting in the Personalization dialog.

End of the note.
Import

The XML import function is the complementary to the export function. It is used to reimport XML data that have previously been exported from BRFplus into a different system.

Prior to actually importing data, we recommend to first start the import as a Test Run. The system then checks the import data to be uploaded for inconsistencies and other possible problems, without actually writing any data into the target system. You can use the check results for cleaning up and correcting the import data before you start the actual data import.

If the target system into which you want to import the data is not located at the end of the transport chain in your system landscape, the imported data has to be transported to the subsequent systems. To accomplish this, you have to enter the ID of a suitable transport request that you have previously created in the import target system.

Import Types

For XML data to be imported into the system, BRFplus offers the following import types:

  • Standard

    With this option, you can import changes for objects that are changeable in the target system.

  • Repair

    With this option, you can repair content that is normally not changeable in the system due to the fact that it was imported to the system by a normal transport. The repair option should only be used to import content changes provided by an SAP correction note. You may use this option to apply a content correction to a system before the corresponding support package with the corrected content is imported into the system.

  • Local Copy

    With this option, you can create a local copy of a non-local application in the source file.

    Note Note

    You can use this option only if the application in the source file is not local and has not yet reached the target system via a normal transport. This check ensures that local copies cannot overwrite transported data.

    End of the note.

Note that selecting a particular import type is only possible if the corresponding personalization setting has been activated. Otherwise, the import type selection is not visible, and the system uses the Standard import type.

Handling of Import Conflicts

If the system detects an object in the import data with the same ID as an already existing object in the target system, the further processing depends on the versioning setting of that object:

  • Versioning is active

    The object contained in the import data is imported as a new version of the object in the target system.

  • Versioning is not active

    The object contained in the import data overwrites the existing object in the target system without further notice. There is no way for a user to influence this behavior.

Export and Import Across Applications

Both export and import of XML data can only be performed for objects belonging to the same BRFplus application. If you have to transfer objects from different applications, you have to split the export and import process such that for each application involved, you have to use a separate data file. When importing such a multi-application project into the target system, make sure that the data files are processed according to the usage relationships between the different applications: Start by importing objects that are used by objects from a different application before importing the using objects. Otherwise, the import fails due to object references that the system cannot resolve.

Activities

Export

To export a BRFplus object from the current system, proceed as follows:

  1. Choose Start of the navigation path Tools Next navigation step XML Export End of the navigation path.

    The system displays the XML Export screen.

  2. Click Select an Object to choose from all BRFplus objects that are available in the current system the one that you want to export.

  3. Choose Include Referenced Objects if you want to include all objects in the export that are referenced by the selected object.

  4. Choose Include Application if you want to include the application object in the export to which the selected object belongs.

  5. From the XML Version dropdown list, choose the highest version number that is supported by the target system.

  6. From the XML Schema dropdown list, choose the XML schema that fits your needs best.

  7. Click Generate XML File to start the XML conversion process.

    Note Note

    The Generate XML File is active only after you have selected an object for export.

    End of the note.

  8. Click Download XML File to define a folder in the file system where the system shall store the XML file generated in the previous step.

Import

To import a file containing BRFplus object data into the current system, proceed as follows:

  1. Choose Start of the navigation path Tools Next navigation step XML Import End of the navigation path.

    The system displays the XML Import screen.

  2. Make sure the XML version of the data to be imported is less than or equal to the Highest XML Version Supported as outlined on the XML Import screen.

  3. Enter the name of the XML File to be imported. You can also select the file by clicking the Browse button and navigating through the file system.

  4. Choose the appropriate Import Type.

  5. Decide whether the data to be imported shall be written to a transport request:

    • For BRFplus objects that are used only local in the target system, no transport is needed. The same applies if there are no subsequent systems in your system landscape receiving transports from the import target system.

    • For BRFplus objects defined as customizing objects, enter a Customizing Transport Request ID. This is necessary for customer-defined objects.

    • For BRFplus objects defined as system objects, enter a Workbench Transport Request ID. This is necessary for objects delivered by SAP.

  6. Decide whether you want to execute the XML import as Test Run or not.

    The Test Run mode is a simulation mode where the system performs all import steps except for actually writing data into the target system. You can use this mode for checking if the import data is consistent and complete before making physical changes to the target system.

  7. Click Upload File to start either the test run or the XML data import.

More Information

Storage Types

Versioning