You are here

Home › Newsletters › ams › Coding Practices

Upgrade Methodology

Subscribe to Syndicate
All upgrade routines should be placed in the UpgradeRoutines code class.
  • Each version has a Steps and Update method.
    • E.g. For version 8.24.xx there are methods called “Steps 8.24.xx” and “Update 8.24.xx”.
    • It is expected that each upgrade performed in Update has a matching step in Steps.
  • There is also a method called 'versionUpdates' that adds the update step to a list. This must be set for the upgrade to be invoked
  • All changes to the file fSystemPreferences must be made in 'addSystemPreferencesFields' as these particular fields are sensitive and must be set up prior to login or creating other upgrade steps
  • All other new fields or tables are established in 'addAllNewDBFields' which is done before any of the update steps are run. This ensures the database consistency before any steps begin