Enabler Upgrades

From EnablerWiki

Jump to: navigation, search

Contents

Where Do I Get The Upgrade Files From?

Note: When a new version is released, clients will be notified via email. We recommend internal testing of the new version in a test environment prior to upgrading stores in the live environment.

Downloading upgrade packs from the web site

Browse to our website: www.magentaretail.com.au and select Support then Downloads.

Enabler Upgrades Figure 1 New.jpg

The Downloads page will contain the latest upgrade and install packs and relevant documentation.

Clicking on the title of the upgrade pack will enable the file to be opened or downloaded.

Contact Magenta Support for credentials to log onto the FTP site to download files

Click on save to download upgrade packs to a local directory.

The upgrade version and type of upgrade can be identified by the file name.

The auto upgrade pack is a zip file and identified by the file name starting with _u ie: _u406602.zip. Do NOT extract this file. The upgrade file is copied to branches and Enabler executes the upgrade process as a scheduled task. Nibbler must be running on all online tills in the branch during upgrade process. Refer to the Auto Upgrades section for further details

A Manual Upgrade file should be extracted and the upgrade is executed via a command prompt manually. All Enabler applications including nibbler must be shut down prior to running the upgrade command. The upgrade process only upgrades the till it is being applied on. Refer to the Manual Upgrades section for further details

Note: If you are looking for a specific version of Enabler other than the latest release, please contact Magenta Support and we will provide details for downloading required version.

Manual Upgrades

Note: The Head Office branch MUST be upgraded prior to upgrading stores

It is recommended that the upgrade process is applied on Head Office Server and tills (nodes) manually after a backup has been performed. Manual upgrade can also be used for upgrading store servers/tills that cannot be upgraded automatically due to network issues etc or new tills that are being added/ rebuilt.

Note: If the Head Office branch is upgraded using the auto upgrades pack nibbler must be running on the Head Office server and on ALL Head Office nodes at the scheduled time of the upgrade. A backup of the enabler folder is suggested prior to running an upgrade.

How do I install the Manual Upgrade?

  1. Download the manual upgrade package and unzip into an empty folder
    Note: In the examples provided, the manual upgrade pack has been unzipped into a folder called MAGENTA on the C: drive. This folder has also been shared as 'Magenta'.
  2. Close ALL Enabler applications including Nibbler
  3. Open a command prompt and go to the Enabler folder. EG: C:\Users\POS> cd\enabler
  4. Enter the following command and press Enter to run the upgrade
    c:\magenta\upgrade c:\magenta\ 
    Note: Ensure you include the '\' on the end
  5. The following screen will be displayed:
    Enabler Upgrades Figure 2.jpg
  6. Press <enter> to start the upgrade
  7. The upgrade should complete with no errors. If you have any errors, refer to the wiki page Investigating Enabler Upgrade Issues for assistance

Note: The Head Office server and tills must always on be the same or a greater version to that of the stores. All machines in a branch environment must run the same version of enabler.

How do l manually upgrade the tills (nodes) across the network?

  1. As per the previous details, unzip the upgrade package to a folder on the Head Office or Store Server
  2. On the tills (nodes) close ALL Enabler applications including Nibbler
  3. Open a command prompt and go to the enabler folder. EG: C:\Users\POS> cd\enabler
  4. Enter the following command to run the upgrade
    \\ServerName\magenta\upgrade \\ServerName\magenta\ 
    Note: Ensure you include the '\' on the end
    Note: Replace 'ServerName' with the name or IP Address of your Head Office or Store Server
  5. Press <enter> to start the upgrade
  6. The upgrade should complete with no errors. If you have any errors, refer to the wiki page Investigating Enabler Upgrade Issues for assistance

Auto Upgrades

Note: The Head Office branch MUST be upgraded prior to upgrading stores

An auto upgrade enables an upgrade to perform automatically as a scheduled task. The upgrade pack is held at the Head Office server and copied to the branch prior to the scheduled upgrade time. A single branch, a region or the whole company can be scheduled for an upgrade at the same time.

Note: This guide assumes that the Enabler folder on the Head Office Server and Store Servers has been shared as the share name: enserver. It is also assumed that the store connects to the HO Server via a standard TCP/IP based WAN. For a document that outlines upgrades via Batch File Comms, contact Magenta Support.

Configure the correct upgrade path for all machines in a store

The auto upgrade path differs between Store Servers and Tills and must be configured separately. The store server will copy the auto upgrade pack locally from Head office prior to running the upgrade. The store till will use the upgrade pack copied on the store server.

Complete the details as follows for each machine type:

Store Server Upgrade Path Setup

  1. On the Head Office Server, start Back Office
  2. Select Global Setup
  3. On the left hand side of the screen, ensure the company is selected at the highest level.
  4. On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
  5. When prompted to apply changes, choose "Store Server"
  6. Complete the database paths for all Store servers (this assumes all servers have enabler installed on same drive letter otherwise make changes at each branch level)

Enabler Upgrades EnablerNodesToConfigure.jpg

Enabler Upgrades Figure 3.jpg

HOServerName = the HO Server’s machine name or IP Address

Store Till Upgrade Path Setup

  1. On the Head Office Server, start Back Office
  2. Select Global Setup
  3. On the left hand side of the screen, ensure the branch is selected
  4. On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
  5. When prompted to apply changes, choose "Tills”"
  6. Complete the database paths for all tills

The auto upgrade path differs between Store Servers and Tills and must be configured separately. The store server (master) will copy the auto upgrade pack locally from Head office prior to running the upgrade. The store till (node) will use the upgrade pack copied on the store server.

Enabler Upgrades EnablerNodesToConfigure.jpg

Enabler Upgrades Figure 4.jpg

StoreServerName = the Store Server’s machine name or IP Address

Is the scheduler setup the same for all machines?

It is important that all machines in the store have the same scheduled setup times. End of day (EoD) shuts down any Enabler applications that might be running and resume till restarts them. The upgrade needs to be scheduled so it does not conflict with overnight scheduled processes.

Note: Ideally the upgrade should run overnight after EoD and purge and backup has completed and before the Till resumes. Please refer to The Oracle wiki article on setting up backup on machines

  1. On the HO Server, start Back Office
  2. Select Global Setup
  3. On the left hand side of the screen, ensure the company is selected at the highest level.
  4. On the right hand side of the screen select:
  5. Transaction Processing / Comms → Scheduler Setup → Config
  6. When prompted, choose either 'All', 'Store Server' or 'Tills'
  7. Review the details as required for each machine type:

Enabler Upgrades Figure 5.jpg

Schedule the auto-upgrade

An auto upgrade can be scheduled to run at a predefined date and time. This scheduled time can be set in Global setup on the Head office for a store or regions in advance of the actual day the upgrade is to apply. It can also be scheduled at store level via Local Store Setup. The auto upgrades need to be scheduled for a time to occur where no other maintenance or tasks are scheduled to run. (refer to Configure Scheduler for all machines in a store).

  1. Start Back Office then select 'Global Setup' (or Local Store Setup if scheduling at a store)
  2. Highlight a branch name or region (left hand side of the screen)
  3. Right click the branch or region
  4. Select Upgrade
  5. The system will advise if the upgrade schedule time set previously can be cancelled or changed.
    Enabler Upgrades Figure 8.jpg
  6. Select <enter>/Yes to continue
  7. Key in the upgrade date
  8. Key in the time of the upgrade
  9. Highlight the upgrade package to be applied then select <Enter>/OK
    Enabler Upgrades Figure 9.jpg
  10. Press <enter>/yes to confirm the date/time details
    Enabler Upgrades Figure 10.jpg

Confirm the upgrade has been scheduled

This upgrade schedule information is sent down to the stores via nibble records and can be confirmed by checking the upgrade time is set in the nibble monitor screen. Once the upgrade schedule is applied at the store, the auto upgrade will apply when the scheduled date and time is reached.

  1. Double click the Nibbler icon in the taskbar
  2. The 'Upgrade' light should be highlighed green
  3. Click the upgrade light to display the schedule time details
    Enabler Upgrades Figure 6.jpgEnabler Upgrades Figure 7.jpg

Check the upgrade has applied successfully

There are various methods to ensure all tills have successfully upgraded. Version details are sent to Head Office in the nibbler file so if the nibble files have been sent after the upgrade has applied, the version information will be available to review.

Checking on the Head Office Server

Note: The following check can be done once there has been a successful movement of nibble records from the store to Head office since the upgrade.

These details also apply when checking the version via a store server.

  1. From the Back Office main screen select the 'Configuration' menu
  2. Select 'Version Table' from the menu
  3. Select F6 Till Number
  4. Key in the logical address of a machine you want to check, the current Enabler version number will be displayed
    Enabler Upgrades Figure 11.jpg

Checking in EEE

If configured to export Version Information records in the .hos files, then EEE can be used to check the version of Enabler running on each till.

  1. From the EEE Main Menu, select Location Management
  2. Select Version Control
  3. Tick 'Show only Enabler Version Records' and enter the 'till number' if desired
  4. Click Search, the current Enabler version will be displayed for all tills
    Enabler Upgrades Figure 12.jpg

Checking upgrade event records in Back Office

The auto upgrade process will log an event record for each step of the upgrade for all tills, if there is a final event record that reports no tills found on wrong version, then the upgrade has applied successfully. If there were issues with the upgrade process and it failed to upgrade tills the event records that failed will display in red. Refer to the wiki page Investigating Enabler Upgrade Issues for assistance

Note: The auto upgrade will abort the upgrade process if any tills in branch do not respond to server request to upgrade. Please ensure Nibbler is running on all tills to avoid this from occurring.

  1. From the Back Office main screen select 'Reports' then 'Event Log'
  2. Enter the date, branch and till number to view and click OK
  3. Click on the Auto Upgrade event type
    Enabler Upgrades Figure 13.jpg

Checking upgrade event records in EEE

The EEE event log can also be used to check the Upgrade events.

  1. From the EEE Main Menu, select 'Analysis' → 'Queries' → 'Event Log'
  2. Enter the date, branch and till number to view and click OK
  3. Select 'Auto Upgrade' from the Filter list

See Also:

Investigating Enabler Upgrade Issues

Personal tools