What is Apex Auto Upgrade?

What is Apex Auto Upgrade?

1. Introduction

Apex Users will now have the ability to upgrade Apex by themselves. Users that have access will be able to use the "Check for updates" feature in the support menu. Internet access is required.

This feature connects to a location in HTI's Google cloud environment and checks if a newer version is available, than what is currently running.  Should there be a newer release it allows the user to start the upgrade process which automatically runs through all of the actions that would normally take place during an upgrade including the database update. 
All of the applications mentioned open themselves when required, the user only needs to start the process. 

2. How to Start the Upgrade process
  1. To check for any new updates, navigate to the Support tab and select the "Check for Updates" option.


  • If a newer version is available, the user will be prompted to log out all workstations, close interfaces and stop Apex services.



    • 2.1 Logout of all Workstations
    1. Before Apex can be upgraded all users must be logged out of Apex. To check if users are still logged into Apex navigate to Processing -> Audit -> Station Control.
    1. All logged in computers will be listed, please ensure that they are "Logged out".


    2.2 How to close an Apex Interface
    1. Usually all the Apex Interfaces will be loaded on the server, so access to the server is needed to perform the actions mentioned.
    1. When access is gained the Interfaces will be minimised or will already be opened on the server as seen below.





    1. In order to close the Interfaces click on the in the corner of the Interface Controller. The Controller will ask for a password to be submitted before it can be closed, this password is the word "close".


    1. Once the password has been entered select the "Ok" button. This needs to be done for every Interface.
    Please Note
    After the upgrade has taken place the interfaces need to be reopened on the server by double clicking on the Apex Interface Icons and opening them.

    2.3  How to stop an Apex Interface loaded as a Service
    1. In order to check which Interfaces are loaded as services navigate to Administration -> General Administration -> Interface Configuration.
    1. When checking all the interfaces that are listed, the ones which have the "Load as Service" ticked will need to be stopped by stopping the service on the Server.
    1. To accomplish this navigate to the windows search field on the Server and enter "services.msc", and click the "Enter" button.
    1. The Services page will be loaded, the interfaces will be listed under "Apex" as seen below.


    1. Next select a service for example, the Apex GenSurv Interface, right click on it and select "Stop" to stop the services.
    Please Note
    Please remember to "Start" the services again after the upgrade. This can be done by repeating the above steps, and then selecting "Start" instead of "Stop".

    2.4 Download and Installation
    1. Once all the Interfaces has been closed and all the Workstations have been closed select the "Download and Install the Update" button.
    1. A warning message will be displayed select "Yes".

    1. The below message will be displayed informing the user that the New release is being downloaded.

    1. Once the files have been downloaded, the ApexDBUtility will automatically open thereafter a message will be displayed informing the user that the upgrade has been completed successfully and all interfaces need to be restarted.

    1. The downloaded files can be seen in the main Apex folder.


    1. The upgrade has been successful and the user can reopen Apex to check that the correct release is displayed at the top of the screen, and the all of the Interfaces can now be reopened.
    2.5 Multiple Interface Controllers
    1. When multiple Interfaces exist they also need to be upgraded before they can be opened.
    1. These Interfaces will usually be located in different folders in the main Apex folder. The folder can be accessed by logging onto the Server and right clicking on the Apex icon on the desktop. 
    1. Next click on the "Open file location" option.

    1. The Apex folder will be opened. The user will now be able to see all the individual Interface folders for example: eRes Interface and Survey Interface as seen below.

    1. Inside each of these folders there will be an ApexInterface.exe, this file will need to be replaced with the new file. To accomplish this scroll down in the main folder until you have reached the ApexInterface.exe and copy the file.

    1. Next open the eRes interface folder, right click and paste the new file in the folder. If prompted select "Replace the file in the folder".

    1. The new ApexInterface.exe will now be present in the folder. Once this has been done all the Interfaces can be reopened.
    Please Note
    These steps must be followed for every Interface folder that exists.

    3. Latest Upgrade
    1. Should the system be up to date and no other upgrade exist the below message will be displayed when the "Check for Updates" button is selected.