The XML Export tool is a command line wrapper of the XML export that you find in the swArchitect and swExplorer clients. Depending on your needs, it can be suitable to export meta model and/or metadata in the form of an XML file. Note that it is not possible to produce XMI or ReqIF file output. The tool is 64-bit. As this tool is not part of our standard delivery, to obtain it, contact [email protected]


Prerequisites

  • Server, port and login information for the database from which you want to export.
  • An installation of the swXMLExport tool including all necessary dll files.
    Note: In pre-R40 versions, the tool is called swExport.
  • The machine on which you are running the command must have sufficient RAM. Example: very large structure exports including all versions (95,000 items) and all attachments (584 MB attachment file structure) could be completed in approx. one hour with a 16 GB laptop.


Installing the Tool 

Save the swXmlExport directory to a suitable location on your drive. The directory should contain the following files: 

Creating the Command Line

Below are two example command lines to illustrate how to include parameters: 


Example 1

Exports an xml file containing the meta model and all config items:

swXmlExport.exe XmlFileName=c:\temp\MMExport.xml ExportConfigItems=true ServerName=sys7 ServerPort=1345 ServerUserName=XXX ServerPassword=XXX


Example 2

Exports an xml file that does NOT contain the meta model (ExportMetadata) (You may want to exclude it if the target database is already prepared with a compatible meta model). It also excludes plain descriptions (This may be excluded if, for example, the import will use the formatted descriptions). The export will include previous versions and attachments: 

swXmlExport.exe XmlFileName=c:\Temp\Export.xml ServerName=abc23 ServerPort=3022 ItemId= IncludePreviousVersions=true ExportMetadata=false IncludeAttachments=true ServerUserName=XXX ServerPassword=XXX


Optional and Mandatory Parameters

Below are all available parameters for command line XML export:


ParameterExpected value typeCommentExample
ServerPortIntegerRequiredServerPort=1768
ServerNameStringRequiredServerName=localhost
ServerUserNameStringIf not supplied, network authentication will be used.ServerUserName=user
ServerPasswordStringIf not supplied, network authentication will be used.ServerPassword=pass
XmlFileNameStringRequired  XmlFileName=D:\test.xml
ItemIdSystemWeaver xIdOptionalItemId=x0000001D04533514
IncludeLaterVersionsBooleanOptional, Default=falseIncludeLaterVersions=true
IncludePreviousVersionsBooleanOptional, Default=falseIncludePreviousVersions=true
ExportMetadataBooleanOptional, Default=trueExportMetadata=true
ExportConfigItemsBooleanOptional, Default=falseExportConfigItems=true
IgnoreErrorsBooleanOptional, Default=falseIgnoreErrors=true
IncludePlainDescriptionBooleanOptional, Default=falseIncludePlainDescription=true
IncludeAttachmentsBooleanOptional, Default=falseIncludeAttachments=true
IncludeItemOwnerBooleanOptional, Default=falseIncludeItemOwner=true
SwapInForeignIdBooleanOptional, Default=falseSwapInForeignId=true
ForeignIdNamespaceStringOptionalForeignIdNamespace=DB1_QA
ConfigFileStringOptionalConfigFile=C:\Exports\config.xml


Example 3

Export only the meta model.

swXmlExport.exe XmlFileName=c:\temp\test.xml ServerName=sys7 ServerPort=1111 ServerUserName=XXX ServerPassword=XXX


Using a Config File

There is an option to use a configuration XML file placed in the same directory as the tool, instead of setting the options directly in the command line. 



There are also currently more options when using a configuration file, e.g., IncludedParts. See System Default Settings for XML Export for a list of the settings that can be used in a configuration file. Below is an example command line that uses a configuration file called config.xml and the content of the example config file is shown below.


swXmlExport.exe XmlFileName=C:\exports\2023export.xml ServerName=sys7 ServerPort=1111 ServerUserName=XXX ServerPassword=XXX ConfigFile=C:\exports\configs\config.xml


Example File

<ExportToXMLConfig id="AB1 2023 Export" sid="I">
  <IncludedParts>XESX</IncludedParts>
  <IncludePlainDescriptionsValue>True</IncludePlainDescriptionsValue>
  <IncludeAttachmentsValue>True</IncludeAttachmentsValue>
</ExportToXMLConfig>

Things to Consider

  • If you are exporting a large amount of data, your export could effect performance for other system users. Keep this in mind when scheduling your export
  • A list of any errors will be included in the log file, and can be used to take action in resolving them if desired.


Example of a Completed Export Command

To use the tool, run your command line from the location of the executable and related files.