Transfer XML configuration between environments for export and import

This procedure defines how to transfer XML configuration between environments or companies. This procedure is performed by creating a configuration data file which is a ZIP file that contains an XML file. Then, imports the ZIP file into the receiving environment and company. When performing the import step in the destination environment, ensure that the 25='Reset to standard' option in 'List and Printer programs. Configure' is performed. This action ensures that the configurable output configurations for the program are up to date and that we get the latest XML structure before we do customizations

Export configuration data file

This activity is performed to extract configuration in the source environment or company, and is used as configuration in the receiving environment or company. Export configuration is completed in two ways:
  • Using option 27='Export Configuration' in 'List and Printer programs. Configure' (CMS005)
  • Using option 21='Export Configuration' in 'XML Structure. Open' (CMS006).

Before you start

  1. Enable the global sequence number on (CMS005/E) of the printer file. The purpose of the global sequence number is to validate which table should be read first.
  2. Perform the export configuration either in (CMS005) or (CMS006).

Creating export configuration data file at the printer file level

  1. Start 'List and Printer programs. Configure' (CMS005).
  2. In the 'Select' field, select Printer files.
  3. Select the printer file and use option 27='Export configuration'.
  4. Specify the file name and version, description and discrepancy and click OK on the window.
  5. To check the export XML file, start 'Configuration Data Jobs. Open' (MNS200). Select the start date and job number, and use option 20='Display XML file'.

The name of the ZIP file is 'ConfigData_<File name>.xml.xip'.

Creating export configuration data file at the XML structure level

  1. Start 'XML Structure. Open' (CMS006).
  2. Select the XML structure and use option 21='Export Configuration'.
  3. Specify the file name and version, description and discrepancy and click OK on the pop-up window.
  4. To check the export XML file, start 'Configuration Data Jobs. Open' (MNS200). Select the start date and job number, and use option 20='Display XML file'.

The actual name of the ZIP file is 'ConfigData_<File name>.xml.xip'.

Import configuration data file

This activity is used to migrate information from one environment or company to another. After the import is complete, a dialog box is displayed indicating the import status, successful or failed.

You must select the Log to File field in the Import Configuration Data window during import since it shows the information completed during the import process.

Before you start

  1. Perform option 25='Reset to standard' on (CMS005/B) to ensure that the XML structure for the printer file is up to date.
  2. Run the global sequence number when necessary.
  3. Ensure that all information in the originating environment or company is found in the receiving environment or company, such as sorting orders, custom tables etc.
  4. Perform import.

Import is performed in M3 BE Administration Tools.

  1. In H5, select the application menu. In the expanded menu, navigate to Administration Tools.
  2. Select Business Engine Configuration Data.
  3. Select Exported tab to see a list of all export XML file. The list is similar in (MNS200).
  4. Select the XML file and click Import. The import tool reads the XML file and runs the required API programs to write the data to the M3 BE database. The API program and transaction to be run are specified in the XML file. During import, decide if the existing data should be replaced or not. If data should be replaced, a Delete transaction is run before the Add transaction.

Checking import logs

An import log is generated once Log to file on the Import Configuration Data window is selected. An option Download logs is displayed once import is successfully executed. Import log displays the configurations, such as transaction name, table name, field name and information describing a certain transaction that is not imported.
Note: Import log must be checked if there is a discrepancy between the source environment or company, and the destination environment or company. The log gives information about what could be missing or incorrect configuration to make the import complete.

Details about configuration data XML file

The content part of the configuration data file always includes these sections: Check, Delete, and Add. It is processed from beginning to end.

  • Check

    Optional section.

    Specification of API transactions that must be checked for related data before starting the processing of delete and add transactions. If error message is received from the API transactions, the process ends, and the add and delete sections are not processed.

  • Delete

    Required section.

    Specification of API transactions requiring deletion of existing data. The Delete section is only processed if check box 'Replace existing data' is selected in the tool wizard. There is usually one API transaction specified, but if required, several API transactions are listed. Error or warning messages from API transactions are logged but XML continues to process the next API transaction.

  • Add

    Required section

    Specification of API transactions requiring additional data. The Add section is always processed if no errors are found during the Check section. Usually, one API transaction is specified, but if required, several API transactions are listed. Error or warning messages from API transactions are logged but XML continues to process the next API transaction.

Related topics