Scope

• Starting from release 1.11 YADE requires XML configuration files.
• SOS provides migration tools that convert existing .ini configuration files to YADE - XML Configuration files - and vice versa.
• The migrations tools are shipped with the XML Editor and can be used for previous YADE releases:
  • The XML Editor can be used to convert .ini files to .xml configuration files.
  • The XML Editor can be configured to create XML configuration files and compatible .ini configuration files in parallel for use with YADE releases 1.8 up to 1.10.

Migration Tools

Conversion of .ini configuration files to .xml configuration files

• The conversion is provided by a number of Java classes that are available with the XML Editor and that are located in the plugins installation folder. 

Scope of conversion

Limitations

• The converter tries to identify existing profiles and fragments from your YADE settings file (.ini format):
  • A fragment is a section in the settings file that is included by other sections, mainly profiles.
  • The remaining sections of a settings file are identfied as profiles if they
    • do not represent global sections (section header: [globals]) and
    • include an operation setting (having resolved any include statements from the profile section).
• The converter provides limited accuracy when identifying profiles:
  • If a profile from a settings file is included by any other profile then it will be considered a fragment and not a profile.
  • Settings file sections that are not used, are incomplete or invalid are subject to conversion and might result in conversion errors. We recommend to clean-up existing settings files before conversion.
  • For some profiles no operation setting might have been specified as this can be added by direct parameterization of the YADE Client. Such profiles will not be identified as candidates for conversion and will be skipped.
• The XML result file of a conversion might not be valid if
  • empty settings have been used, i.e. settings without assignment, e.g. a missing recipient for a mail_to= setting. Such empty settings are valid for the settings file format, however, they are not valid for the XML configuration file format that implements strict checking.
  • settings are missing, e.g. have been completed by use of command line parameters or job parameters.
  • The converter will report evident errors and missing parameters, additional errors might become visible when opening the converted configuration file with the XML Editor that validates the file against the YADE XSD Schema.

Implications

• Profiles from settings files that use send/receive operation settings are converted to the respective XML operations Copy or Move (should the setting remove_files=true have been used).
  • Send/receive operations are deprecated, see  YADE-280 - Getting issue details... STATUS
• The YADE XML configuration clearly distinguishes between fragments and profiles. Therefore, the source and target settings from settings files are moved to separate branches of the YADE XML configuration.
  • The names of fragment elements are created from 
    • the fragment type
      • for file transfer sources and targets this includes the file transfer protocol in use (FTP, SFTP etc.)
      • for mail and other elements the element name is used
    • a consecutive number
    • Examples include: SFTPFragment#1234, FTPFragment#3421, MailFragment#2143 etc.
  • You can modify fragment names easily with the XML Editor that will automatically update references to the fragment.

Importing files for conversion

tbd: Usage & Screenshots

Conversion of .xml configuration files to .ini configuration files

tbd