New article
Recently updated
Managing module exports
Who is this article for?
Module Developers
A Module Developer license and Area access is required.
Since module definitions exist solely as metadata, moving a module from one area to another (a critical component of the SQA process) is much easier than trying to install and configure traditional enterprise software on a server or cluster of servers.
Moving modules consists of a three-step process:
- A Single Module Export or Multiple Module Export from the source area
- Save the resulting XML or ZIP file to your local disk
- Import the XML or ZIP file into your target area
Backup Modules Before Changes
It is strongly recommended to backup modules before replacing them in the target area, especially when promoting to a user-facing area. That way, if unexpected behavior occurs that could impact a customer, the module can be quickly returned to the previous state.
Single Module Export
Clicking Export Module from the Module Builder screen creates a single module export XML file that contains the module definition. This export does not include reference data, or translation information.
Multiple Module Export
The Export tool creates and manages packages that can be moved as a group from one area to another that can be exported; the tool creates a ZIP file containing:
- A package configuration file.
- An individual module or group of module export XML files, the same file(s) as generated from the Module Builder export option.
- Optionally
- If the module has been prepared for translations the full translations database. See Moving Translations Between Subscriber Areas for more information.
- If data is included, JSON files of the data.
Once a package is created it can be re-exported to get the most current version of the modules and data.