Updating Aeon to Version 4.0

Print Friendly and PDF Follow

System Requirements

Check server and workstation requirements for the new version by reviewing the Aeon 4.0 Release Notes and reading over the Aeon System Requirements.

Client Installation Directory

The client defaults install to C:\Program Files (x86)\Aeon\ on your local workstation.

Scheduling an Update

Remember that if you are hosted by Atlas, you need to schedule a server update before you can use the new client. There may be a brief period of downtime while the server update runs- it is usually brief enough that you do not need to communicate it to end users ahead of time. Contact your Atlas Customer Service Agent to schedule your update.

Contact your Aeon Customer Service Agent by emailing service@atlas-sys.com or calling 800-567-7401 x1 or 757-467-7872.


Server Update Process

The Aeon server installer will no longer install the Aeon client. Additionally, the Aeon client, Staff Manager, and Customization Manager will be removed from the server for existing installations. If these applications are needed on the Aeon server, they can be found on Aeon 4.0 Downloads.

Obtaining the Aeon Client Update File

The System Manager stores the installer files and other necessary information in a web folder named AeonUpdates. There, it hosts a file named ClientUpdates.xml which details the latest available version and the path to retrieve that file. Every 15 minutes, the System Manager will see if it needs to download the latest versions from Atlas and make them available for its Clients. Read more about this process at The System Manager.

There are two types of installers:

  • the installer ("setup"), which is used for new installations and major updates (updates that involve a major version number change, for example updating from 3.8.2 to 3.9.0)
  • the updater ("update") which is used for updating existing clients within a major version, for example, 3.8.0 to 3.8.3.

The System Manager will only keep the latest version of the setup and update installers. Older versions are overwritten.

The System Manager runs using the following process:

  1. Checks the value of the VersionClient customization key to see what version of the Client is currently running. 
  2. Retrieves the ClientUpdates.xml file from Atlas. This file provides the latest client version and the location of the setup and updates installers for each major release (e.g. 3.7, 3.8, 3.9). 
  3. Compares its VersionClient customization key against the latest version available from Atlas. 
    1. If a newer version is available, or if the versions match but System Manager does not currently have its AeonUpdates directory and files set up, it will update its hosted files.
    2. Special case: If for some reason System Manager has a later version of the Client than Atlas has made available, it will not download the latest Atlas versions even if its AeonUpdates directory has not yet been created.
  4. Updating its hosted files involves:
    1. Downloading the two latest Client installers for its release and copying them into a subdirectory of AeonUpdates named Client.
    2. Building its own ClientUpdates.xml file for its Aeon Clients to read, which will be hosted in AeonUpdates and will point to the installer files in AeonUpdates/Client.
    3. Updating its VersionClient customization key to the version number of the newest Clients it has made available.


Client Update Process

The Client Updater updates or installs the Aeon Client, Aeon Customization Manager, and Aeon Staff Manager. Note that the default location for the client installation is C:\Program Files\Aeon\.

Running the Aeon Client Updates

When the client is started it compares the value of the VersionClient customization key against its own file version.If the VersionClient version is higher than the Client's version, it will attempt to update with the following steps:

  1. Checks its local webserver's AeonUpdates directory (e.g. www.school.edu/aeon/AeonUpdates/ClientUpdates.xml) to see if it is hosting the newer version. If so, it will prompt the user to update.
  2. If this is a minor update, the Client will try to download the update installer, and the entire update process is optional. The staff user can dismiss the update prompt and simply continue loading the client. Since this is all within the same major-version release, the client will still be compatible with the database.
    1. If this is a major update, the Client will try to download the setup installer, and the entire update process is required to continue loading the Client. The staff user can dismiss the update prompt, but the Client will exit at that point because it may not be compatible with the Aeon database after a new major-version release.
  3. If the Client can't reach the local Aeon webserver or for whatever reason the ClientUpdates.xml file is not available and we're within a major release, the Client will simply log a warning and continue on.
  4. The Client main form also displays a notification label in the bottom-right corner that informs the user if a new update is available and allows them to download the update. This update happens twice a day and allows staff users to be notified of newly available updates even if they haven't closed their Client recently.



Additional Update Notes

Server Addons

A new Addons table has been added to the database. It will contain the server addons. During the update for existing sites, a conversion utility will be run that will change the ServerAddons and migrate them to this new database structure.

Conversion Utility

During product update, the conversion utility will run and take existing addons, convert them into a lua file and config xml file, save it as a zip file, and convert it so that it can be stored in the new Addons database table. The addon package will use the customized settings as the default settings in the addon package so any exported addons will contain the sites local settings of the addon unless they modify the config.xml in the exported package.

Verify location of log4d.props file for Aeon.dll

The log4d.props file for the Aeon dll has been updated and would look similar to the lines below.

#---- begin log4d.props ----
# root priority - valid values are 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'
# root appender
log4d.appender.ROOT.fileName=C:\Program Files (x86)\Aeon\logs\AeonDLL.log
log4d.appender.ROOT.layout.dateFormat=yyyy-mm-dd hh:MM:ss,zzz
log4d.appender.ROOT.layout.pattern=%d [%p] %c (%t) - %m%n
#---- end log4d.props ----
All new/existing sites will have the default log files updated to match the following. Note that this could change the name or location of the log file (specified in log4d.appender.ROOT.fileName) if it was changed from the initial setting. Sites should make sure to edit the log4d.props file to restore the log file name and location if necessary. The previous log4d.props file will be backed up in the Aeon\Update\Backup\030900000 folder if needed for reference.

Update Document Templates from .doc to .docx

The default template documents have been updated from the ".doc" to the ".docx" format.

Sites who have customized their own templates will have to manually update them. The steps for doing so are included below.  

First, update the template document following these steps:
  1. Back up templates to another location before updating.
  2. Navigate to the folder containing the print templates
  3. Open old .doc document
  4. Go to 'File -> Save As' and change the document type to "Word Document (*.docx)"
  5. Hit save and the new document docx document should be open on in Word now
  6. *Go to 'File -> Info' and click the "Convert" button to the left of the Compatibility Mode text
  7. Optionally, to remove personal information from the template, click "Check for Issues" on the 'File -> Info' page and then click "Inspect Document"
  8. Uncheck all the boxes except for "Comments, Revisions, Versions, and Annotations" and "Document Properties and Personal Information"
  9. Click Inspect
  10. Then Click "Remove All" and resave your document
  11. *If there are additional problems, try the process again but skip the step about converting the document from Compatibility Mode
Then remove the old template files from the Print Directory.
Finally, update the value of the following customization keys:
  • PrintCallslipDocs
  • PrintDigitizationRequestDocs
  • PrintInvoiceDocs
  • PrintInvoiceStatementDocs
  • PrintRequestDocs
  • PrintUserDocs


If this article didn’t resolve your issue, please take a moment and answer a few questions to help improve our documentation: