EnablerWiki - User contributions [en]

EEPOS:Index

2017-01-25T04:16:50Z

Brant: /* EEPOS Related Articles */

== EEPOS Related Articles ==

[[EEPOS:_Hardware/Software_Specifications|Hardware/Software Specifications]]

[[EEPOS:Enabler_to_EEPOS_-_Configuration_Conversion|Enabler to EEPOS - Configuration Conversion]]

[[EEPOS:Installation_-_Standard_Installation|Installation - Standard Installation]]

[[EEPOS:Update_Process|Update Process]]

[[EEPOS:Purge_Parameters|Purge Parameters]]

[[Investigating_POS_Service_Issues|Investigating POS Service Issues]]

[[EEPOS:System_Database_Recovery|System Database Recovery]]

EEPOS:System Database Recovery

2017-01-25T04:15:14Z

Brant: Created page with "POS has been modified to implement a nightly backup of the EEPOS database, and select system databases (master, msdb, model), performed by the POS Service. POS will keep 2 n..."

POS has been modified to implement a nightly backup of the EEPOS database, and select system databases (master, msdb, model), performed by the POS Service. 
POS will keep 2 nights worth of backups (located in C:\Program Files (x86)\Magenta Retail\EEPOS\Support\SystemDBFiles), and will remove any additional backups on the completion of the latest backup (ensuring each till will have a minimum of 2 days worth of backups).

This has been implemented to ease recovery in the instance of a corrupted SQL Server installation, which can occur due to I/O issues on the machine (e.g. disk issues, power loss during operations being performed on a database).

The file size of the system database backups will be minimal, however the EEPOS database backup file size is dependant on the content in the database. There is a limitation of 10GB on the file size of the database, which means that the maximum backup file size should be close to this size.

Additionally, we have implemented a once-off copy of the system database files (master.mdf, msdb.mdf, model.mdf, mastlog.ldf, msdblog.ldf, modellog.ldf) to the POS directory during the installer. 
This process utilises a script (SysDbRecovery.cmd) located in the main EEPOS directory (e.g. C:\Program Files (x86)\Magenta Retail\EEPOS) which can be used separate from the installer if required.

This script performs the following:
* BACKUPPARAMS - Records required parameters for the backup, restore and recovery processes, and outputs the parameters to params.cmd. This is automatically referenced by each of these processed.
* BACKUP - Performs a file copy of the system database files to C:\Program Files (x86)\Magenta Retail\EEPOS\Support\SystemDBFiles.
* RESTORE - Performs a copy of the backed up copies of the system databases, and then restores the latest backups of the system databases (created by the POS Service)
* RECOVER - Regenerates the system databases from scratch, and then restores the latest backups of the system databases (created by the POS Service). If the backups do not exist, only the regenerate of the system databases will be performed

Running the file without any parameters will display the paramaters and their meanings:

<pre>Usage: SysDbRecovery <command> [instance-name (default=MAGENTAPOS, use . for default instance)]

where <command> is:

BACKUP - make initial backup copies of system databases
BACKUPPARAMS - just record required backup parameters
RESTORE - restore backed up copies of system databases, then restore latest SQL backups
RECOVER - regenerate system databases, then restore latest SQL backups</pre>

For the instance name parameter noted above, three options are available:
* Parameter not provided - the script will assume the instance name for the SQL Server is MAGENTAPOS (the default instance name installed during a EEPOS installation)
* Parameter provided as "." - the script will run the required operation on a local SQL Server Default Instance.
* Parameter provided as an instance name - the script will run the required operation on the specified SQL Server Named Instance.

Further details of what is performed for each option is noted below:

----

'''BACKUP'''
* Turn off the SQL Server
* Copy the system database MDF and LDF files to C:\Program Files (x86)\Magenta Retail\EEPOS\Support\SystemDBFiles
* Restart SQL Server
* Restart the POS Service (may throw an error if the POS Service is not yet installed, this is an acceptable error)

----

'''BACKUPPARAMS'''
* Create the parameters required for this script to run (storing the parameters in params.cmd)

----

'''RESTORE'''
* Check for the existence of the backup MDF/LDF files
** If any of the files are missing, the script will not continue
* Check for the existence of the backup files created from the POS Service scheduled task
** If any of the files are missing, the script will not continue
* The script will then prompt the user to continue or cancel
* Once the user confirms to continue, the script will
** Turn off the SQL Server
** Copy the system database MDF and LDF files to their SQL Server data path
** Restart SQL Server
** Perform the restore of the databases
** Restart the POS Service (may throw an error if the POS Service is not yet installed, this is an acceptable error)

----

'''RECOVER'''
* Check for the existence of the backup files performed from the POS Service scheduled task
** If the script is unable to find them, it will display a warning noting that the default system databases will be generated, but no backups will be restored
* The script will then prompt the user to continue or cancel
* Once the user confirms to continue, the script will
* Turn off the SQL Server
* Regenerate the system databases
* Restart SQL Server
* Perform the restore of the databases from the backups
* Restart the POS Service (may throw an error if the POS Service is not yet installed, this is an acceptable error)

----

EEPOS:Installation - Standard Installation

2016-12-22T01:41:31Z

Brant: /* Enabling Linked Server Encryption - OPTIONAL */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Enabling Linked Server Encryption - OPTIONAL ===
'''''This option will only benefit EEPOS Installations of versions 1.86 and above.'''''

'''''This is an optional step and EEE/EEPOS will function without this enabled.'''''

# Provision a certificate. A valid certificate signed by a reputable Certificate Authority is recommended.
# Configure any non-server clients to trust the certificate's root signing authority. See [http://support.microsoft.com/default.aspx?scid=kb;en-us;316898 How to enable SSL encryption for an instance of SQL Server by using Microsoft Management Console].
# During installation of EEPOS, tick the option to “Enable linked server encryption” on the store server installation.

Contact Magenta Support if you have any questions regarding this step.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceEEE2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceStoreServer2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Replication Connectivity Testing ===
Press the Test button to ensure that a connection can be made to the database.

[[File:ReplicationConnectivityTesting.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following process needs to be run at EEE to migrate Enabler Seed Values for use in EEPOS.

'''This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.'''

Log into EEE and navigate to '''Location Management → Branch'''.

Select the appropriate branch and click '''Initialise EE POS Seed Values''', and confirm the prompt.

[[File:InitialiseEEPOSSeedValues.png|400px]]

[[File:InitialiseEEPOSSeedValues2.png|400px]]

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Installation - Standard Installation

2016-12-22T01:41:06Z

Brant: /* Preparing EEE */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Enabling Linked Server Encryption - OPTIONAL ===
'''''This option will only benefit EEPOS Installations of versions 1.86 and above.'''''

'''''This is an optional step and EEE/EEPOS will function without this enabled.'''''

# Provision a certificate. A valid certificate signed by a reputable Certificate Authority is recommended.
# Configure any non-server clients to trust the certificate's root signing authority. See [http://support.microsoft.com/default.aspx?scid=kb;en-us;316898 How to enable SSL encryption for an instance of SQL Server by using Microsoft Management Console].
# During installation of EEPOS, tick the option to “Enable linked server encryption” on the store server installation.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceEEE2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceStoreServer2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Replication Connectivity Testing ===
Press the Test button to ensure that a connection can be made to the database.

[[File:ReplicationConnectivityTesting.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following process needs to be run at EEE to migrate Enabler Seed Values for use in EEPOS.

'''This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.'''

Log into EEE and navigate to '''Location Management → Branch'''.

Select the appropriate branch and click '''Initialise EE POS Seed Values''', and confirm the prompt.

[[File:InitialiseEEPOSSeedValues.png|400px]]

[[File:InitialiseEEPOSSeedValues2.png|400px]]

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Installation - Standard Installation

2016-12-22T01:33:34Z

Brant: /* Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceEEE2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceStoreServer2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Replication Connectivity Testing ===
Press the Test button to ensure that a connection can be made to the database.

[[File:ReplicationConnectivityTesting.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following process needs to be run at EEE to migrate Enabler Seed Values for use in EEPOS.

'''This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.'''

Log into EEE and navigate to '''Location Management → Branch'''.

Select the appropriate branch and click '''Initialise EE POS Seed Values''', and confirm the prompt.

[[File:InitialiseEEPOSSeedValues.png|400px]]

[[File:InitialiseEEPOSSeedValues2.png|400px]]

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

File:InitialiseEEPOSSeedValues2.png

2016-12-22T01:33:15Z

Brant:

File:InitialiseEEPOSSeedValues.png

2016-12-22T01:33:05Z

Brant:

EEPOS:Installation - Standard Installation

2016-12-22T01:14:12Z

Brant: /* Step 9 - Test Distributed Transaction Coordinator */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceEEE2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceStoreServer2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Replication Connectivity Testing ===
Press the Test button to ensure that a connection can be made to the database.

[[File:ReplicationConnectivityTesting.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

File:ReplicationConnectivityTesting.png

2016-12-22T01:14:05Z

Brant:

EEPOS:Installation - Standard Installation

2016-12-22T01:12:33Z

Brant: /* Replication Source: Store Server */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceEEE2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceStoreServer2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

File:SelectReplicationSourceStoreServer2.png

2016-12-22T01:11:18Z

Brant:

EEPOS:Installation - Standard Installation

2016-12-22T01:02:59Z

Brant: /* Replication Source: EEE */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceEEE2.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

File:SelectReplicationSourceEEE2.png

2016-12-22T01:02:32Z

Brant:

EEPOS:Installation - Standard Installation

2016-12-22T01:00:15Z

Brant: /* Replication Source: EEE */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceEEE.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Installation - Standard Installation

2016-12-22T00:59:57Z

Brant: /* Replication Source: EEE */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Installation - Standard Installation

2016-12-22T00:59:45Z

Brant: /* Replication Source: EEE */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

[[File:SelectReplicationSourceEEE.png|400px]]

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

File:SelectReplicationSourceEEE.png

2016-12-22T00:57:38Z

Brant: uploaded a new version of "File:SelectReplicationSourceEEE.png"

EEPOS:Installation - Standard Installation

2016-12-22T00:56:12Z

Brant: /* Replication Source: EEE */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

The '''Hidden Site Key''' is an encrypted key (unique per client) used in processes within EEE and EEPOS to increase security. This key must be specified and must match the key stored in EEE.

EEPOS utilises linked servers to communicate between store servers and tills, and between store servers and EEE. If you wish for these connections to be encrypted, select '''Enable linked server encryption'''.

'''The Hidden Site Key and Enable linked server encryption options are only available for versions 1.86 or higher.'''

[[File:SelectReplicationSourceEEE.png|400px]]

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Installation - Standard Installation

2016-12-22T00:48:38Z

Brant: /* Configure Windows Firewall */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*This Distributed Transaction Coordinator exceptions only need to be added if the EEPOS version being installed is earlier than 1.86.
**The Distributed Transaction Coordinator (on the EEE Server and on the till)
*** MSDTC.exe
*** TCP Port 135
*** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 135 (port 135 - only if EEPOS version being installed is earlier than 1.86)
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceEEE.png|400px]]

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Installation - Standard Installation

2016-12-22T00:45:52Z

Brant: /* Configure the Distributed Transaction Co-ordinator (MSDTC) */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===

'''This section only applies to EEPOS versions earlier than 1.86. If your installer version is 1.86 or higher, this step can be skipped.'''

# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*The Distributed Transaction Coordinator (on the EEE Server and on the till)
** MSDTC.exe
** TCP Port 135
** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 1103, 135
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceEEE.png|400px]]

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Index

2016-12-22T00:44:43Z

Brant:

Investigating POS Service Issues

2016-12-22T00:44:01Z

Brant:

==Pos Service Statuses==
Click the POS Service light to expand it and obtain the specific message.

Red:
* POS Service is stopped – “POS Service stopped”
Yellow:
* POS Service is in the process of starting – “POS Service starting”
* POS Service is in the process of stopping – “POS Service stopping”
Orange:
* No connection to local EEPOS database – “No connection to database”
* No connection to store server – “No connection to store server”
* No connection to replication source – “No connection to replication source”
* Store Server is updating – “Store Server update in progress”
* EEE is updating – “EEE update in progress”
Green:
* POS Service is running – “POS Service Running”

== POS Service issues ==
If the POS Service light is orange, review the table below to determine the potential cause/resolution
{| class="prettytable"
|
|-
| '''Status'''
| '''Potential cause'''
| '''Solution'''

|-
| ''No connection to database''
| SQL Server Service is not running
| Start the SQL Server (MAGENTAPOS) Service

|-
|
| EEPOS database is not accessible
| Ensure EEPOS database is in a valid state. If EEPOS database is inaccessible or in an error state, contact Magenta Support.

|-
| ''No connection to store server''
| Store server is offline or inaccessible
| Ensure the store server is online and accessible

|-
|
| Network connectivity issues
| See Network checks section below

|-
| ''No connection to replication source''
| Replication source is offline or inaccessible
| Ensure the replication source is online and accessible

|-
|
| Network connectivity issues
| See Network checks section below

|-
| ''Store Server update in progress''
| Store server is updating
| Ensure store server has completed updating. If update has already completed, status will automatically reset after an hour.

|-
| ''EEE update in progress''
| EEE is updating
| Ensure EEE has completed updating. If update has already completed, status will automatically reset after an hour.

|}

==Network checks==
* Reboot the machine. Temporary network issues are commonly resolved through a simple reboot.
* If the till is a store server:
** Check that the EEE database server is able to resolve the correct IP address of the EEPOS till by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping TILL01”)
** Check that the EEPOS till is able to resolve the correct IP address of the EEE database server by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping EEESERVER01”)
* If the till is not a store server:
** Check that the till is able to resolve correct IP address of the store server by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping STORESERVER01”)
** Check that the store server is able to resolve correct IP address of the till by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping TILL01”)
* Ensure the network profile is set to the correct profile (Network and Sharing Centre)
** Most companies have policies set to apply to a private/domain profile, and a network issue has caused the profile to change to a different profile.
** [[File:networkprofile.png|border|650px]]
* Check the POS Service log (located in C:\ProgramData\MagentaPOS\C-Program Files (x86)-Magenta Retail-EEPOS) for any errors.

'''Please note, the following DTC checks are only applicable to versions of POS earlier than 1.86.'''

* If any errors relate to DTC/MSDTC (try each step below, restarting the POS Service between each change and reviewing the POS Service):
** Restart the Distributed Transaction Coordinator, or start it if it is not running.
** Reboot the machine.
** If the error relates to “MSDTC is unavailable”, in Command Prompt (elevated), run “msdtc -resetlog“. This will clear out the DTC log.
** If the error relates to “MSDTC is unavailable”, and the reboot/resetlog did not resolve the issue, uninstall and reinstall DTC (note that this will require another reboot after DTC has been reinstalled).
*** In Command Prompt (elevated), run “msdtc -uninstall“.
*** In Command Prompt (elevated), run “msdtc -install“

* If the above did not resolve the issue, check Event Viewer for DTC related errors, and resolve.

Contact Magenta Support if you are still unable to resolve the issue.

Investigating POS Service Issues

2016-09-26T04:13:43Z

Brant:

==Pos Service Statuses==
Click the POS Service light to expand it and obtain the specific message.

Red:
* POS Service is stopped – “POS Service stopped”
Yellow:
* POS Service is in the process of starting – “POS Service starting”
* POS Service is in the process of stopping – “POS Service stopping”
Orange:
* No connection to local EEPOS database – “No connection to database”
* No connection to store server – “No connection to store server”
* No connection to replication source – “No connection to replication source”
* Store Server is updating – “Store Server update in progress”
* EEE is updating – “EEE update in progress”
Green:
* POS Service is running – “POS Service Running”

== POS Service issues ==
If the POS Service light is orange, review the table below to determine the potential cause/resolution
{| class="prettytable"
|
|-
| '''Status'''
| '''Potential cause'''
| '''Solution'''

|-
| ''No connection to database''
| SQL Server Service is not running
| Start the SQL Server (MAGENTAPOS) Service

|-
|
| EEPOS database is not accessible
| Ensure EEPOS database is in a valid state. If EEPOS database is inaccessible or in an error state, contact Magenta Support.

|-
| ''No connection to store server''
| Store server is offline or inaccessible
| Ensure the store server is online and accessible

|-
|
| Network connectivity issues
| See Network checks section below

|-
| ''No connection to replication source''
| Replication source is offline or inaccessible
| Ensure the replication source is online and accessible

|-
|
| Network connectivity issues
| See Network checks section below

|-
| ''Store Server update in progress''
| Store server is updating
| Ensure store server has completed updating. If update has already completed, status will automatically reset after an hour.

|-
| ''EEE update in progress''
| EEE is updating
| Ensure EEE has completed updating. If update has already completed, status will automatically reset after an hour.

|}

==Network checks==
* Reboot the machine. Temporary network issues are commonly resolved through a simple reboot.
* If the till is a store server:
** Check that the EEE database server is able to resolve the correct IP address of the EEPOS till by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping TILL01”)
** Check that the EEPOS till is able to resolve the correct IP address of the EEE database server by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping EEESERVER01”)
* If the till is not a store server:
** Check that the till is able to resolve correct IP address of the store server by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping STORESERVER01”)
** Check that the store server is able to resolve correct IP address of the till by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping TILL01”)
* Ensure the network profile is set to the correct profile (Network and Sharing Centre)
** Most companies have policies set to apply to a private/domain profile, and a network issue has caused the profile to change to a different profile.
** [[File:networkprofile.png|border|650px]]
* Check the POS Service log (located in C:\ProgramData\MagentaPOS\C-Program Files (x86)-Magenta Retail-EEPOS) for any errors.
* If any errors relate to DTC/MSDTC (try each step below, restarting the POS Service between each change and reviewing the POS Service):
** Restart the Distributed Transaction Coordinator, or start it if it is not running.
** Reboot the machine.
** If the error relates to “MSDTC is unavailable”, in Command Prompt (elevated), run “msdtc -resetlog“. This will clear out the DTC log.
** If the error relates to “MSDTC is unavailable”, and the reboot/resetlog did not resolve the issue, uninstall and reinstall DTC (note that this will require another reboot after DTC has been reinstalled).
*** In Command Prompt (elevated), run “msdtc -uninstall“.
*** In Command Prompt (elevated), run “msdtc -install“
* If the above did not resolve the issue, check Event Viewer for DTC related errors, and resolve.

Contact Magenta Support if you are still unable to resolve the issue.

Investigating POS Service Issues

2016-09-26T03:41:57Z

Brant: Created page with "==Pos Service Statuses== Click the POS Service light to expand it and obtain the specific message. Red</spa..."

==Pos Service Statuses==
Click the POS Service light to expand it and obtain the specific message.

Red:
* POS Service is stopped – “POS Service stopped”
Yellow:
* POS Service is in the process of starting – “POS Service starting”
* POS Service is in the process of stopping – “POS Service stopping”
Orange:
* No connection to local EEPOS database – “No connection to database”
* No connection to store server – “No connection to store server”
* No connection to replication source – “No connection to replication source”
* Store Server is updating – “Store Server update in progress”
* EEE is updating – “EEE update in progress”
Green:
* POS Service is running – “POS Service Running”

== POS Service issues ==
If the POS Service light is orange, review the table below to determine the potential cause/resolution
{| class="prettytable"
|
|-
| '''Status'''
| '''Potential cause'''
| '''Solution'''

|-
| ''No connection to database''
| SQL Server Service is not running
| Start the SQL Server (MAGENTAPOS) Service

|-
|
| EEPOS database is not accessible
| Ensure EEPOS database is in a valid state. If EEPOS database is inaccessible or in an error state, contact Magenta Support.

|-
| ''No connection to store server''
| Store server is offline or inaccessible
| Ensure the store server is online and accessible

|-
|
| Network connectivity issues
| See Network checks section below

|-
| ''No connection to replication source''
| Replication source is offline or inaccessible
| Ensure the replication source is online and accessible

|-
|
| Network connectivity issues
| See Network checks section below

|-
| ''Store Server update in progress''
| Store server is updating
| Ensure store server has completed updating. If update has already completed, status will automatically reset after an hour.

|-
| ''EEE update in progress''
| EEE is updating
| Ensure EEE has completed updating. If update has already completed, status will automatically reset after an hour.

|}

==Network checks==
* Reboot the machine. Temporary network issues are commonly resolved through a simple reboot.
* If the till is a store server:
** Check that the EEE database server is able to resolve the correct IP address of the EEPOS till by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping TILL01”)
** Check that the EEPOS till is able to resolve the correct IP address of the EEE database server by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping EEESERVER01”)
* If the till affected is not a store server:
** Check that the till is able to resolve correct IP address of the store server by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping STORESERVER01”)
** Check that the store server is able to resolve correct IP address of the till by performing a ping using the hostname
*** In Command Prompt, type “ping <hostname>” and press enter (e.g. “ping TILL01”)
* Ensure the network profile is set to the correct profile (Network and Sharing Centre)
** Most companies have policies set to apply to a private/domain profile, and a network issue has caused the profile to change to a different profile.
** [[File:networkprofile.png|border|650px]]
* Check the POS Service log (located in C:\ProgramData\MagentaPOS\C-Program Files (x86)-Magenta Retail-EEPOS) for any errors.
* If any errors relate to DTC/MSDTC (try each step below, restarting the POS Service between each change and reviewing the POS Service):
** Restart the Distributed Transaction Coordinator, or start it if it is not running.
** Reboot the machine.
** If the error relates to “MSDTC is unavailable”, in Command Prompt (elevated), run “msdtc -resetlog“. This will clear out the DTC log.
** If the error relates to “MSDTC is unavailable”, and the reboot/resetlog did not resolve the issue, uninstall and reinstall DTC (note that this will require another reboot after DTC has been reinstalled).
*** In Command Prompt (elevated), run “msdtc -uninstall“.
*** In Command Prompt (elevated), run “msdtc -install“
* If the above did not resolve the issue, check Event Viewer for DTC related errors, and resolve.

Contact Magenta Support if you are still unable to resolve the issue.

File:Networkprofile.png

2016-09-26T02:52:33Z

Brant:

EEPOS:Installation - Standard Installation

2016-05-09T02:02:20Z

Brant:

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===
# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*The Distributed Transaction Coordinator (on the EEE Server and on the till)
** MSDTC.exe
** TCP Port 135
** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 1103, 135
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created in EEE, ensure the configurations are correct and proceed to the "Setting up till(s) in EEE" section.''

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a tillcode that has already been created in EEE, ensure the configurations are correct and proceed to the "Installation Wizard" section. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceEEE.png|400px]]

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Installation - Standard Installation

2016-05-09T01:27:50Z

Brant: /* Setting up till(s) in EEE */

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===
# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*The Distributed Transaction Coordinator (on the EEE Server and on the till)
** MSDTC.exe
** TCP Port 135
** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 1103, 135
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created, this section can be skipped.''

Ensure the "Exclude this branch from data exports" flag is not set, otherwise the branch will be flagged as offline.

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a till that has already been created, this section can be skipped. ''

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

'''Note:''' Please ensure the till is flagged as "Is Enabler Enterprise POS till" after the till has finished trading on its final day in Enabler.

If the till has traded in Enabler, please ensure that the procedure in the "Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS" section is completed after trading is completed on the last day of trading in Enabler, and before trading starts on EEPOS.

Please ensure EEPOS is closed and reopened on each machine after the procedure has been run for each till, to ensure the seed values are obtained from their replication source.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceEEE.png|400px]]

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Installation - Standard Installation

2016-05-05T00:48:58Z

Brant:

The following article will provide basic instructions for a standard installation of EEPOS. For more detailed instruction documentation, please contact [mailto:support@magentaretail.com.au Magenta Support]).

== Hardware/Software Specifications ==

Please refer to [http://theoracle.magentaretail.com.au/EEPOS:_Hardware/Software_Specifications EEPOS Hardware and Software Specifications] page

== Preparing EEE ==
'''NOTE''': With the exception of the till specific settings, and the setting up of the branch/tills, the following instructions will need to be run once on the initial setup of EEPOS with EEE.

=== Configure the Distributed Transaction Co-ordinator (MSDTC) ===
# On the EEE database server, set the Distributed Transaction Coordinator service to set the Start-up type to Automatic
# Control Panel > Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator > Right Click “Local DTC” and click properties. Click the security tab.
# Enable the following options:
## Network DTC Access > Allow Remote Clients
##Transaction Manager Communication > Allow Inbound, Allow Outbound, No Authentication Required
# Click OK.
# Restart the MSDTC Service (if not already prompted to).

=== Configure Windows Firewall ===
The following exceptions will need to be created/enabled within your Firewall:
*The Distributed Transaction Coordinator (on the EEE Server and on the till)
** MSDTC.exe
** TCP Port 135
** UDP Port 137.
* Query Server Port (if not already configured)
'''If not created by the installer, the following exceptions will need to be created/enabled:'''
* The POS Service application (POSService.exe) (Till only)
* SQL Server
** The installed SQL Server instance application (i.e. C:\ProgramFiles\MicrosoftSqlServer\MSSQL11.MAGENTAPOS\Binn\SqlServr.exe)
** TCP Ports:
*** 1433, 1103, 135
** UDP Port:
*** 1434

'''NOTE''': Please ensure the firewall exceptions are enabled on the correct profile (Domain/Private or Public).

=== EEE Configurations ===
# Open Tools Configurator. Select the correct profile, and enable “This EEE Instance has Enabler Enterprise POS stores". Click Save, and close the configurator.
# Restart EEE Dataloader.
# Log into EEE. Navigate to Utilities > Configuration > Company Preferences.
# Enable the “Has Enabler Enterprise POS stores”. Click Save.
# If tills are already setup, and will be reused, ensure they have been configured as a EEPOS till. (Location Management > POS Till Maintenance > select till and click Edit > “Is Enabler Enterprise POS till?”). Otherwise, set up your tills with this option enabled.

=== Setting up the branch in EEE ===
''If you are reusing a branch that has already been created, this section can be skipped.''

Ensure the "Exclude this branch from data exports" flag is not set, otherwise the branch will be flagged as offline.

# A new store should be initially created in EEE from Location Management -> Branch. When creating a new branch in EEE, the Logical Address and Directory must be the same, and must be unique. All Mandatory fields are marked with a <nowiki>*</nowiki>.
# Review and apply the relevant options (such as Maintain Costs/Prices/Min Max) for the branch.
# If the EEPOS machines are not being setup at the same time as the branch being created, you should turn on the flag "Exclude this branch from data exports" to flag the branch as offline. Please ensure this flag is turned off once the EEPOS machines are set up.
# After clicking on SAVE to create the branch, you are then prompted whether to clone Prices, Costs, Branch Purge Parameters and Min/Max from another branch. You also have the option of skipping the cloning process. To clone Prices, Costs, Branch Purge Parameters and Min/Max settings from another branch, enter a branch code beside the relevant options, then press OK to proceed with the cloning. If data is not cloned using this process, you must populate at least costs and prices from another method, otherwise products will have no prices or costs associated with them at the store. If this option is skipped, the screen can be accessed at a later time from the '''Pricing -> Clone Prices, Costs, Min Max Levels, etc''' menu.

# If the option "Exclude this branch from data exports" was not ticked, you will be prompted to set the last export date for stores. The branch will not be enabled for replication until you have successfully completed this screen.

=== Setting up till(s) in EEE ===
''If you are reusing a till that has already been created, this section can be skipped. ''

Please ensure the till is not flagged as offline.

Please ensure the till is flagged as "Is Enabler Enterprise POS till" after the till has finished trading on its final day in Enabler.

If the till has traded in Enabler, please ensure that the procedure in the "Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS" section is completed after trading is completed on the last day of trading in Enabler, and before trading starts on EEPOS.

Please ensure EEPOS is closed and reopened on each machine after the procedure has been run for each till, to ensure the seed values are obtained from their replication source.

# A new till should be initially created in EEE from Location Management -> POS Till Maintenance. All Mandatory fields are marked with an *.
# Specify the appropriate options (Till Code, Till Number, Branch Code etc). Ensure the till is flagged as "Is Enabler Enterprise POS till" and is not flagged as offline.
# Click Save.

== Installation Wizard ==
=== Step 1 - Select Installation Type ===
Start the EEPOS Installation Wizard. Select the installation Type:
(This article describes the “Install & Configure” option)
* Install only, without configuration
* '''Install & Configure'''
* Master Image install for store server
* Master Image install for till

[[File:SelectInstallationType.png|450px]]

=== Step 2 - Enter Branch and Till Code ===
Enter the Branch and Till Codes. These must be registered in the EEE database before starting the installation.

[[File:EnterBranchAndTillCode.png|450px]]

=== Step 3 - User group ===
If your computer is not on a domain, use the default setting. If the installer fails to create the local user group, you will need to create the group manually.
NOTE: If the installer detects that the machine is on a domain, it will provide an option to have the POS user group placed on the domain. If you select this option, you need to ensure that the EEPOSUsers group is created before progressing with the installation.

[[File:UserGroup.png|450px]]

=== Step 4 - Where will the POS Database be stored? ===

If the SQL Database Engine has not already been installed, ‘tick’ the Install SQL Server option. Ensure the collation of the SQL Server is the same as your EEE SQL Server collation.
Leave all other options at their default values.

[[File:WhereWillThePOSDatabaseBeStored.png|450px]]

=== Step 5 - Enter the POS Database Name ===
Use the default setting. The database name is typically ‘EEPOS’, and does not need to be changed in a normal installation.

[[File:EnterThePOSDatabaseName.png|450px]]

=== Step 6 - Select Replication Source ===
The Replication Source screen allows the Replication source to be either EEE (if you are installing EEPOS as a Store Server) or Store Server (if you are installing EEPOS as a till).

==== Replication Source: EEE ====
Specify the "Replication Source SQL Server Instance Name" to your EEE Database Server Instance Name (or just the server name if the EEE database is installed on the default instance of SQL Server).

Specify the "Replication Source Database Name" as your EEE Database name.

Ensure "This machine is a store server?" is checked, and accept the defaults for the Store Server Machine Name (name of current machine - autopopulated) and Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceEEE.png|400px]]

==== Replication Source: Store Server====

Specify the "Replication Source SQL Server Instance Name" to your Store Servers instance name (default is MACHINENAME\MAGENTAPOS)

Specify the "Replication Source Database Name" as your Store Servers EEPOS Database name (default is EEPOS).

The Store Server Machine Name will be auto-populated with the machine name obtained from the "Replication Source SQL Server Instance Name" field.

Accept the default for the Store Server .Net Remoting Port (8080).

[[File:SelectReplicationSourceStoreServer.png|400px]]

=== Step 7 - Install screen ===
Confirm the settings and press the Install button.

[[File:InstallScreen.png|450px]]

=== Step 8 - Installation Complete ===
Check the installation Log and then press Next once installation has completed.

[[File:InstallationComplete.png|450px]]

=== Step 9 - Test Distributed Transaction Coordinator ===
Press the Test button to ensure that a connection can be made to the database.

[[File:TestDistributedTransactionCoordinator.png|450px]]

=== Step 10 - Update Software Version ===
'''''This is an optional step. To proceed without updating, click Next.'''''

Once the installation is complete, you will be able to update to the latest version available. Press the Check Version button.

If no updates are available, you will be notified that the latest version is already installed. No earlier versions will be available.

To proceed with the upgrade, press the Start Upgrade button. The updating process may take some time. You will be notified of the progress during the update.

[[File:UpdateSoftwareVersion.png|450px]]

=== Step 11 - Master Table Replication ===
At the completion of the process, continue the Wizard and complete Master Table Replication if/when requested.

[[File:MasterTableReplication.png|450px]]

=== Step 12 – MANUAL STEP - Migrate Enabler Seed Values for use in EEPOS ===
'''MUST BE RUN IF BRANCH/TILL IS BEING REUSED FROM ENABLER'''

If the branch/till used during the installation already existed, and is being reused from an Enabler till, the following procedure needs to be run in the EEE database to migrate Enabler Seed Values for use in EEPOS.
This must only be run AFTER all tills in the Enabler environment have finished trading on their last day of trade.

'''NOTE: Replace the @prmCustPrefix value with the configured customer prefix (if required), otherwise use null as the value'''

'''''exec usp_MigrateEnablerSeedValues @till = '<tillcode>', @branch ='<branchcode>', @prmCustPrefix = null'''''

Once the procedure has been run, when EEPOS starts up it will retrieve the newly populated seed values from EEE.

=== Step 13 - Run EEPOS ===
At the completion of the installation, the installer will ask if you wish to run the application. Click yes.

Once EEPOS has opened, you will be prompted to license the application.

After you had completed licensing, you can login to EEPOS using your EEE credentials.

EEPOS:Installation - Standard Installation

2016-05-04T23:46:36Z

Brant: /* Installation Wizard */

EEPOS:Index

2016-02-21T22:04:05Z

Brant: Created page with "== EEPOS Related Articles == Hardware/Software Specifications [[EEPOS:Enabler_to_EEPOS_-_Configuration_Conversion|Enabler to EEPOS -..."

EEPOS:Purge Parameters

2016-02-19T00:45:31Z

Brant: /* EEPOS - Purge Parameters */

== EEPOS - Purge Parameters ==

This option is located in the EEPOS Config screen, located in EEE under '''Utilities → Configuration → Enabler Enterprise POS → Configuration → System → Purge Parameters'''.

This allows configurations to be set on how long data is kept in the EEPOS databases, before being purged.

By default, the configurations populated with preset values (as seen in the screenshot below).

[[Image:EEPOS_PurgeParameters.png|800px|link=]]

EEPOS:Purge Parameters

2016-02-19T00:45:06Z

Brant: /* EEPOS - Purge Parameters */

== EEPOS - Purge Parameters ==

This option is located in the EEPOS Config screen, located in EEE under Utilities → Configuration → Enabler Enterprise POS → Configuration → System → Purge Paraneters.

This allows configurations to be set on how long data is kept in the EEPOS databases, before being purged.

By default, the configurations populated with preset values (as seen in the screenshot below).

[[Image:EEPOS_PurgeParameters.png|800px|link=]]

EEPOS:Purge Parameters

2016-02-19T00:44:53Z

Brant: Created page with "== EEPOS - Purge Parameters == This option is located in the EEPOS Config screen, located in EEE under Utilities → Configuration → Enabler Enterprise POS → Config..."

== EEPOS - Purge Parameters ==

This option is located in the EEPOS Config screen, located in EEE under Utilities → Configuration → Enabler Enterprise POS → Configuration → System → Purge Paraneters.

This allows configurations to be set on how long data is kept in the EEPOS databases, before being purged. By default, the configurations populated with preset values (as seen in the screenshot below).

[[Image:EEPOS_PurgeParameters.png|800px|link=]]

File:EEPOS PurgeParameters.png

2016-02-19T00:44:45Z

Brant:

Enabler Upgrades

2016-02-18T22:44:37Z

Brant: /* Is the scheduler setup the same for all machines? */

===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: [http://www.magentaretail.com.au www.magentaretail.com.au] and select Support then Downloads.

[[Image:Enabler_Upgrades_Figure_1_New.jpg|400px|link=http://www.magentaretail.com.au/downloads/]]

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|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|Manual Upgrades]] section for further details

'''Note:''' If you are looking for a specific version of Enabler other than the latest release, please contact [mailto:support@magentaretail.com.au 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?===
#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'.
#Close ALL Enabler applications including Nibbler
#Open a command prompt and go to the Enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command and press Enter to run the upgrade
#:<pre>c:\magenta\upgrade c:\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#The following screen will be displayed:
#:[[Image:Enabler_Upgrades_Figure_2.jpg|400px|link=]]
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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?===
#As per the previous details, unzip the upgrade package to a folder on the Head Office or Store Server
#On the tills (nodes) close ALL Enabler applications including Nibbler
#Open a command prompt and go to the enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command to run the upgrade
#:<pre>\\ServerName\magenta\upgrade \\ServerName\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#:'''Note:''' Replace 'ServerName' with the name or IP Address of your Head Office or Store Server
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the company is selected at the highest level.
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Store Server"
#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)
[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_3.jpg|400px|link=]]

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

====Store Till Upgrade Path Setup====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the branch is selected
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Tills”"
#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.

[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_4.jpg|400px|link=]]

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 [[Enabler_Backup_and_Restore|The Oracle wiki article]] on setting up backup on machines

#On the HO Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the company is selected at the highest level.
#On the right hand side of the screen select:
#Transaction Processing / Comms → Scheduler Setup → Config
#When prompted, choose either 'All', 'Store Server' or 'Tills'
#Review the details as required for each machine type:
#:
[[Image:Enabler_Upgrades_Figure_5.jpg|400px|link=]]

===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|Configure Scheduler for all machines in a store]]).

#Start Back Office then select 'Global Setup' (or Local Store Setup if scheduling at a store)
#Highlight a branch name or region (left hand side of the screen)
#Right click the branch or region
#Select Upgrade
#The system will advise if the upgrade schedule time set previously can be cancelled or changed.
#:[[Image:Enabler_Upgrades_Figure_8.jpg|400px|link=]]
#Select <enter>/Yes to continue
#Key in the upgrade date
#Key in the time of the upgrade
#Highlight the upgrade package to be applied then select <Enter>/OK
#:[[Image:Enabler_Upgrades_Figure_9.jpg|400px|link=]]
#Press <enter>/yes to confirm the date/time details
#:[[Image:Enabler_Upgrades_Figure_10.jpg|400px|link=]]

===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.

#Double click the Nibbler icon in the taskbar
#The 'Upgrade' light should be highlighed green
#Click the upgrade light to display the schedule time details
#:
#:[[Image:Enabler_Upgrades_Figure_6.jpg|400px|link=]][[Image:Enabler_Upgrades_Figure_7.jpg|400px|link=]]

==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.
#From the Back Office main screen select the 'Configuration' menu
#Select 'Version Table' from the menu
#Select F6 Till Number
#Key in the logical address of a machine you want to check, the current Enabler version number will be displayed
#:[[Image:Enabler_Upgrades_Figure_11.jpg|400px|link=]]

===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.
#From the EEE Main Menu, select Location Management
#Select Version Control
#Tick 'Show only Enabler Version Records' and enter the 'till number' if desired
#Click Search, the current Enabler version will be displayed for all tills
#:[[Image:Enabler_Upgrades_Figure_12.jpg|400px|link=]]

===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|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.

#From the Back Office main screen select 'Reports' then 'Event Log'
#Enter the date, branch and till number to view and click OK
#Click on the Auto Upgrade event type
#:[[Image:Enabler_Upgrades_Figure_13.jpg|400px|link=]]

===Checking upgrade event records in EEE===
The EEE event log can also be used to check the Upgrade events.
#From the EEE Main Menu, select 'Analysis' → 'Queries' → 'Event Log'
#Enter the date, branch and till number to view and click OK
#Select 'Auto Upgrade' from the Filter list

==See Also:==
[[Investigating Enabler Upgrade Issues|Investigating Enabler Upgrade Issues]]

Enabler Upgrades

2016-02-18T22:43:10Z

Brant: /* Is the scheduler setup the same for all machines? */

===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: [http://www.magentaretail.com.au www.magentaretail.com.au] and select Support then Downloads.

[[Image:Enabler_Upgrades_Figure_1_New.jpg|400px|link=http://www.magentaretail.com.au/downloads/]]

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|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|Manual Upgrades]] section for further details

'''Note:''' If you are looking for a specific version of Enabler other than the latest release, please contact [mailto:support@magentaretail.com.au 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?===
#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'.
#Close ALL Enabler applications including Nibbler
#Open a command prompt and go to the Enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command and press Enter to run the upgrade
#:<pre>c:\magenta\upgrade c:\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#The following screen will be displayed:
#:[[Image:Enabler_Upgrades_Figure_2.jpg|400px|link=]]
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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?===
#As per the previous details, unzip the upgrade package to a folder on the Head Office or Store Server
#On the tills (nodes) close ALL Enabler applications including Nibbler
#Open a command prompt and go to the enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command to run the upgrade
#:<pre>\\ServerName\magenta\upgrade \\ServerName\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#:'''Note:''' Replace 'ServerName' with the name or IP Address of your Head Office or Store Server
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the company is selected at the highest level.
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Store Server"
#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)
[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_3.jpg|400px|link=]]

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

====Store Till Upgrade Path Setup====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the branch is selected
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Tills”"
#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.

[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_4.jpg|400px|link=]]

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 [[Enabler_Backup_and_Restore|The Oracle wiki article]] on setting up backup on machines

#On the HO Server, start Back Office
#Select Global Setup
#On the right hand side of the screen select:
#Transaction Processing / Comms → Scheduler Setup → Config
#When prompted, choose either 'Store Server' or 'Tills'
#Complete the details as required for each machine type:
#:
[[Image:Enabler_Upgrades_Figure_5.jpg|400px|link=]]

===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|Configure Scheduler for all machines in a store]]).

#Start Back Office then select 'Global Setup' (or Local Store Setup if scheduling at a store)
#Highlight a branch name or region (left hand side of the screen)
#Right click the branch or region
#Select Upgrade
#The system will advise if the upgrade schedule time set previously can be cancelled or changed.
#:[[Image:Enabler_Upgrades_Figure_8.jpg|400px|link=]]
#Select <enter>/Yes to continue
#Key in the upgrade date
#Key in the time of the upgrade
#Highlight the upgrade package to be applied then select <Enter>/OK
#:[[Image:Enabler_Upgrades_Figure_9.jpg|400px|link=]]
#Press <enter>/yes to confirm the date/time details
#:[[Image:Enabler_Upgrades_Figure_10.jpg|400px|link=]]

===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.

#Double click the Nibbler icon in the taskbar
#The 'Upgrade' light should be highlighed green
#Click the upgrade light to display the schedule time details
#:
#:[[Image:Enabler_Upgrades_Figure_6.jpg|400px|link=]][[Image:Enabler_Upgrades_Figure_7.jpg|400px|link=]]

==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.
#From the Back Office main screen select the 'Configuration' menu
#Select 'Version Table' from the menu
#Select F6 Till Number
#Key in the logical address of a machine you want to check, the current Enabler version number will be displayed
#:[[Image:Enabler_Upgrades_Figure_11.jpg|400px|link=]]

===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.
#From the EEE Main Menu, select Location Management
#Select Version Control
#Tick 'Show only Enabler Version Records' and enter the 'till number' if desired
#Click Search, the current Enabler version will be displayed for all tills
#:[[Image:Enabler_Upgrades_Figure_12.jpg|400px|link=]]

===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|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.

#From the Back Office main screen select 'Reports' then 'Event Log'
#Enter the date, branch and till number to view and click OK
#Click on the Auto Upgrade event type
#:[[Image:Enabler_Upgrades_Figure_13.jpg|400px|link=]]

===Checking upgrade event records in EEE===
The EEE event log can also be used to check the Upgrade events.
#From the EEE Main Menu, select 'Analysis' → 'Queries' → 'Event Log'
#Enter the date, branch and till number to view and click OK
#Select 'Auto Upgrade' from the Filter list

==See Also:==
[[Investigating Enabler Upgrade Issues|Investigating Enabler Upgrade Issues]]

Enabler Upgrades

2016-02-18T22:42:43Z

Brant: /* Is the scheduler setup the same for all machines? */

===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: [http://www.magentaretail.com.au www.magentaretail.com.au] and select Support then Downloads.

[[Image:Enabler_Upgrades_Figure_1_New.jpg|400px|link=http://www.magentaretail.com.au/downloads/]]

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|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|Manual Upgrades]] section for further details

'''Note:''' If you are looking for a specific version of Enabler other than the latest release, please contact [mailto:support@magentaretail.com.au 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?===
#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'.
#Close ALL Enabler applications including Nibbler
#Open a command prompt and go to the Enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command and press Enter to run the upgrade
#:<pre>c:\magenta\upgrade c:\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#The following screen will be displayed:
#:[[Image:Enabler_Upgrades_Figure_2.jpg|400px|link=]]
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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?===
#As per the previous details, unzip the upgrade package to a folder on the Head Office or Store Server
#On the tills (nodes) close ALL Enabler applications including Nibbler
#Open a command prompt and go to the enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command to run the upgrade
#:<pre>\\ServerName\magenta\upgrade \\ServerName\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#:'''Note:''' Replace 'ServerName' with the name or IP Address of your Head Office or Store Server
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the company is selected at the highest level.
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Store Server"
#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)
[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_3.jpg|400px|link=]]

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

====Store Till Upgrade Path Setup====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the branch is selected
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Tills”"
#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.

[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_4.jpg|400px|link=]]

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 [[#Enabler_Backup_and_Restore|The Oracle wiki article]] on setting up backup on machines

#On the HO Server, start Back Office
#Select Global Setup
#On the right hand side of the screen select:
#Transaction Processing / Comms → Scheduler Setup → Config
#When prompted, choose either 'Store Server' or 'Tills'
#Complete the details as required for each machine type:
#:
[[Image:Enabler_Upgrades_Figure_5.jpg|400px|link=]]

===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|Configure Scheduler for all machines in a store]]).

#Start Back Office then select 'Global Setup' (or Local Store Setup if scheduling at a store)
#Highlight a branch name or region (left hand side of the screen)
#Right click the branch or region
#Select Upgrade
#The system will advise if the upgrade schedule time set previously can be cancelled or changed.
#:[[Image:Enabler_Upgrades_Figure_8.jpg|400px|link=]]
#Select <enter>/Yes to continue
#Key in the upgrade date
#Key in the time of the upgrade
#Highlight the upgrade package to be applied then select <Enter>/OK
#:[[Image:Enabler_Upgrades_Figure_9.jpg|400px|link=]]
#Press <enter>/yes to confirm the date/time details
#:[[Image:Enabler_Upgrades_Figure_10.jpg|400px|link=]]

===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.

#Double click the Nibbler icon in the taskbar
#The 'Upgrade' light should be highlighed green
#Click the upgrade light to display the schedule time details
#:
#:[[Image:Enabler_Upgrades_Figure_6.jpg|400px|link=]][[Image:Enabler_Upgrades_Figure_7.jpg|400px|link=]]

==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.
#From the Back Office main screen select the 'Configuration' menu
#Select 'Version Table' from the menu
#Select F6 Till Number
#Key in the logical address of a machine you want to check, the current Enabler version number will be displayed
#:[[Image:Enabler_Upgrades_Figure_11.jpg|400px|link=]]

===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.
#From the EEE Main Menu, select Location Management
#Select Version Control
#Tick 'Show only Enabler Version Records' and enter the 'till number' if desired
#Click Search, the current Enabler version will be displayed for all tills
#:[[Image:Enabler_Upgrades_Figure_12.jpg|400px|link=]]

===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|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.

#From the Back Office main screen select 'Reports' then 'Event Log'
#Enter the date, branch and till number to view and click OK
#Click on the Auto Upgrade event type
#:[[Image:Enabler_Upgrades_Figure_13.jpg|400px|link=]]

===Checking upgrade event records in EEE===
The EEE event log can also be used to check the Upgrade events.
#From the EEE Main Menu, select 'Analysis' → 'Queries' → 'Event Log'
#Enter the date, branch and till number to view and click OK
#Select 'Auto Upgrade' from the Filter list

==See Also:==
[[Investigating Enabler Upgrade Issues|Investigating Enabler Upgrade Issues]]

Enabler Upgrades

2016-02-18T22:40:33Z

Brant: /* Is the scheduler setup the same for all machines? */

===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: [http://www.magentaretail.com.au www.magentaretail.com.au] and select Support then Downloads.

[[Image:Enabler_Upgrades_Figure_1_New.jpg|400px|link=http://www.magentaretail.com.au/downloads/]]

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|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|Manual Upgrades]] section for further details

'''Note:''' If you are looking for a specific version of Enabler other than the latest release, please contact [mailto:support@magentaretail.com.au 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?===
#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'.
#Close ALL Enabler applications including Nibbler
#Open a command prompt and go to the Enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command and press Enter to run the upgrade
#:<pre>c:\magenta\upgrade c:\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#The following screen will be displayed:
#:[[Image:Enabler_Upgrades_Figure_2.jpg|400px|link=]]
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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?===
#As per the previous details, unzip the upgrade package to a folder on the Head Office or Store Server
#On the tills (nodes) close ALL Enabler applications including Nibbler
#Open a command prompt and go to the enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command to run the upgrade
#:<pre>\\ServerName\magenta\upgrade \\ServerName\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#:'''Note:''' Replace 'ServerName' with the name or IP Address of your Head Office or Store Server
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the company is selected at the highest level.
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Store Server"
#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)
[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_3.jpg|400px|link=]]

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

====Store Till Upgrade Path Setup====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the branch is selected
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Tills”"
#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.

[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_4.jpg|400px|link=]]

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 [[#Enabler Backup and Restore|The Oracle wiki article]] on setting up backup on machines

#On the HO Server, start Back Office
#Select Global Setup
#On the right hand side of the screen select:
#Transaction Processing / Comms → Scheduler Setup → Config
#When prompted, choose either 'Store Server' or 'Tills'
#Complete the details as required for each machine type:
#:
[[Image:Enabler_Upgrades_Figure_5.jpg|400px|link=]]

===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|Configure Scheduler for all machines in a store]]).

#Start Back Office then select 'Global Setup' (or Local Store Setup if scheduling at a store)
#Highlight a branch name or region (left hand side of the screen)
#Right click the branch or region
#Select Upgrade
#The system will advise if the upgrade schedule time set previously can be cancelled or changed.
#:[[Image:Enabler_Upgrades_Figure_8.jpg|400px|link=]]
#Select <enter>/Yes to continue
#Key in the upgrade date
#Key in the time of the upgrade
#Highlight the upgrade package to be applied then select <Enter>/OK
#:[[Image:Enabler_Upgrades_Figure_9.jpg|400px|link=]]
#Press <enter>/yes to confirm the date/time details
#:[[Image:Enabler_Upgrades_Figure_10.jpg|400px|link=]]

===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.

#Double click the Nibbler icon in the taskbar
#The 'Upgrade' light should be highlighed green
#Click the upgrade light to display the schedule time details
#:
#:[[Image:Enabler_Upgrades_Figure_6.jpg|400px|link=]][[Image:Enabler_Upgrades_Figure_7.jpg|400px|link=]]

==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.
#From the Back Office main screen select the 'Configuration' menu
#Select 'Version Table' from the menu
#Select F6 Till Number
#Key in the logical address of a machine you want to check, the current Enabler version number will be displayed
#:[[Image:Enabler_Upgrades_Figure_11.jpg|400px|link=]]

===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.
#From the EEE Main Menu, select Location Management
#Select Version Control
#Tick 'Show only Enabler Version Records' and enter the 'till number' if desired
#Click Search, the current Enabler version will be displayed for all tills
#:[[Image:Enabler_Upgrades_Figure_12.jpg|400px|link=]]

===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|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.

#From the Back Office main screen select 'Reports' then 'Event Log'
#Enter the date, branch and till number to view and click OK
#Click on the Auto Upgrade event type
#:[[Image:Enabler_Upgrades_Figure_13.jpg|400px|link=]]

===Checking upgrade event records in EEE===
The EEE event log can also be used to check the Upgrade events.
#From the EEE Main Menu, select 'Analysis' → 'Queries' → 'Event Log'
#Enter the date, branch and till number to view and click OK
#Select 'Auto Upgrade' from the Filter list

==See Also:==
[[Investigating Enabler Upgrade Issues|Investigating Enabler Upgrade Issues]]

Enabler Upgrades

2016-02-18T22:40:06Z

Brant: /* Configure Scheduler for all machines in a store */

===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: [http://www.magentaretail.com.au www.magentaretail.com.au] and select Support then Downloads.

[[Image:Enabler_Upgrades_Figure_1_New.jpg|400px|link=http://www.magentaretail.com.au/downloads/]]

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|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|Manual Upgrades]] section for further details

'''Note:''' If you are looking for a specific version of Enabler other than the latest release, please contact [mailto:support@magentaretail.com.au 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?===
#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'.
#Close ALL Enabler applications including Nibbler
#Open a command prompt and go to the Enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command and press Enter to run the upgrade
#:<pre>c:\magenta\upgrade c:\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#The following screen will be displayed:
#:[[Image:Enabler_Upgrades_Figure_2.jpg|400px|link=]]
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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?===
#As per the previous details, unzip the upgrade package to a folder on the Head Office or Store Server
#On the tills (nodes) close ALL Enabler applications including Nibbler
#Open a command prompt and go to the enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command to run the upgrade
#:<pre>\\ServerName\magenta\upgrade \\ServerName\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#:'''Note:''' Replace 'ServerName' with the name or IP Address of your Head Office or Store Server
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the company is selected at the highest level.
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Store Server"
#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)
[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_3.jpg|400px|link=]]

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

====Store Till Upgrade Path Setup====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the branch is selected
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Tills”"
#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.

[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_4.jpg|400px|link=]]

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 [[#Enabler_Backup_and_Restore|The Oracle wiki article]] on setting up backup on machines

#On the HO Server, start Back Office
#Select Global Setup
#On the right hand side of the screen select:
#Transaction Processing / Comms → Scheduler Setup → Config
#When prompted, choose either 'Store Server' or 'Tills'
#Complete the details as required for each machine type:
#:
[[Image:Enabler_Upgrades_Figure_5.jpg|400px|link=]]

===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|Configure Scheduler for all machines in a store]]).

#Start Back Office then select 'Global Setup' (or Local Store Setup if scheduling at a store)
#Highlight a branch name or region (left hand side of the screen)
#Right click the branch or region
#Select Upgrade
#The system will advise if the upgrade schedule time set previously can be cancelled or changed.
#:[[Image:Enabler_Upgrades_Figure_8.jpg|400px|link=]]
#Select <enter>/Yes to continue
#Key in the upgrade date
#Key in the time of the upgrade
#Highlight the upgrade package to be applied then select <Enter>/OK
#:[[Image:Enabler_Upgrades_Figure_9.jpg|400px|link=]]
#Press <enter>/yes to confirm the date/time details
#:[[Image:Enabler_Upgrades_Figure_10.jpg|400px|link=]]

===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.

#Double click the Nibbler icon in the taskbar
#The 'Upgrade' light should be highlighed green
#Click the upgrade light to display the schedule time details
#:
#:[[Image:Enabler_Upgrades_Figure_6.jpg|400px|link=]][[Image:Enabler_Upgrades_Figure_7.jpg|400px|link=]]

==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.
#From the Back Office main screen select the 'Configuration' menu
#Select 'Version Table' from the menu
#Select F6 Till Number
#Key in the logical address of a machine you want to check, the current Enabler version number will be displayed
#:[[Image:Enabler_Upgrades_Figure_11.jpg|400px|link=]]

===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.
#From the EEE Main Menu, select Location Management
#Select Version Control
#Tick 'Show only Enabler Version Records' and enter the 'till number' if desired
#Click Search, the current Enabler version will be displayed for all tills
#:[[Image:Enabler_Upgrades_Figure_12.jpg|400px|link=]]

===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|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.

#From the Back Office main screen select 'Reports' then 'Event Log'
#Enter the date, branch and till number to view and click OK
#Click on the Auto Upgrade event type
#:[[Image:Enabler_Upgrades_Figure_13.jpg|400px|link=]]

===Checking upgrade event records in EEE===
The EEE event log can also be used to check the Upgrade events.
#From the EEE Main Menu, select 'Analysis' → 'Queries' → 'Event Log'
#Enter the date, branch and till number to view and click OK
#Select 'Auto Upgrade' from the Filter list

==See Also:==
[[Investigating Enabler Upgrade Issues|Investigating Enabler Upgrade Issues]]

Enabler Upgrades

2016-02-18T22:33:55Z

Brant: /* Downloading upgrade packs from the web site */

===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: [http://www.magentaretail.com.au www.magentaretail.com.au] and select Support then Downloads.

[[Image:Enabler_Upgrades_Figure_1_New.jpg|400px|link=http://www.magentaretail.com.au/downloads/]]

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|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|Manual Upgrades]] section for further details

'''Note:''' If you are looking for a specific version of Enabler other than the latest release, please contact [mailto:support@magentaretail.com.au 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?===
#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'.
#Close ALL Enabler applications including Nibbler
#Open a command prompt and go to the Enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command and press Enter to run the upgrade
#:<pre>c:\magenta\upgrade c:\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#The following screen will be displayed:
#:[[Image:Enabler_Upgrades_Figure_2.jpg|400px|link=]]
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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?===
#As per the previous details, unzip the upgrade package to a folder on the Head Office or Store Server
#On the tills (nodes) close ALL Enabler applications including Nibbler
#Open a command prompt and go to the enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command to run the upgrade
#:<pre>\\ServerName\magenta\upgrade \\ServerName\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#:'''Note:''' Replace 'ServerName' with the name or IP Address of your Head Office or Store Server
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the company is selected at the highest level.
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Store Server"
#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)
[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_3.jpg|400px|link=]]

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

====Store Till Upgrade Path Setup====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the branch is selected
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Tills”"
#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.

[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_4.jpg|400px|link=]]

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

===Configure Scheduler for all machines in a store===
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:''' It is important that the upgrade is scheduled to occur between EOD and Resume Till times. Nibbler is required to be running on all tills flagged as online for auto upgrade to successfully proceed.

#On the HO Server, start Back Office
#Select Global Setup
#On the right hand side of the screen select:
#Transaction Processing / Comms → Scheduler Setup → Config
#When prompted, choose either 'Store Server' or 'Tills'
#Complete the details as required for each machine type:
#:
[[Image:Enabler_Upgrades_Figure_5.jpg|400px|link=]]

===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|Configure Scheduler for all machines in a store]]).

#Start Back Office then select 'Global Setup' (or Local Store Setup if scheduling at a store)
#Highlight a branch name or region (left hand side of the screen)
#Right click the branch or region
#Select Upgrade
#The system will advise if the upgrade schedule time set previously can be cancelled or changed.
#:[[Image:Enabler_Upgrades_Figure_8.jpg|400px|link=]]
#Select <enter>/Yes to continue
#Key in the upgrade date
#Key in the time of the upgrade
#Highlight the upgrade package to be applied then select <Enter>/OK
#:[[Image:Enabler_Upgrades_Figure_9.jpg|400px|link=]]
#Press <enter>/yes to confirm the date/time details
#:[[Image:Enabler_Upgrades_Figure_10.jpg|400px|link=]]

===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.

#Double click the Nibbler icon in the taskbar
#The 'Upgrade' light should be highlighed green
#Click the upgrade light to display the schedule time details
#:
#:[[Image:Enabler_Upgrades_Figure_6.jpg|400px|link=]][[Image:Enabler_Upgrades_Figure_7.jpg|400px|link=]]

==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.
#From the Back Office main screen select the 'Configuration' menu
#Select 'Version Table' from the menu
#Select F6 Till Number
#Key in the logical address of a machine you want to check, the current Enabler version number will be displayed
#:[[Image:Enabler_Upgrades_Figure_11.jpg|400px|link=]]

===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.
#From the EEE Main Menu, select Location Management
#Select Version Control
#Tick 'Show only Enabler Version Records' and enter the 'till number' if desired
#Click Search, the current Enabler version will be displayed for all tills
#:[[Image:Enabler_Upgrades_Figure_12.jpg|400px|link=]]

===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|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.

#From the Back Office main screen select 'Reports' then 'Event Log'
#Enter the date, branch and till number to view and click OK
#Click on the Auto Upgrade event type
#:[[Image:Enabler_Upgrades_Figure_13.jpg|400px|link=]]

===Checking upgrade event records in EEE===
The EEE event log can also be used to check the Upgrade events.
#From the EEE Main Menu, select 'Analysis' → 'Queries' → 'Event Log'
#Enter the date, branch and till number to view and click OK
#Select 'Auto Upgrade' from the Filter list

==See Also:==
[[Investigating Enabler Upgrade Issues|Investigating Enabler Upgrade Issues]]

EEPOS:Update Process

2016-02-18T22:26:15Z

Brant: /* Updating EEPOS to a new version */

== Updating EEPOS to a new version ==

''' WE RECOMMEND APPLYING NEW UPDATES IN THE FOLLOWING PROCEDURE'''

#'''Apply to Test Till(s) and test thoroughly for a week.'''
#'''Apply to 1 store for a few days.'''
#'''Apply to 2 more stores for a few days.'''
#'''Apply to all remaining stores.'''

'''This recommendation is made to ensure that if any issues occur, the effect can be minimalised.'''

=== Pre-setup checklist ===

#Ensure company is configured as having Enabler Enterprise POS stores
##In EEE, navigate to Utilities → Configuration → Company Preferences.
##Scroll to the bottom of the screen, and confirm that the “has Enabler Enterprise POS stores” is ticked. If it is not, tick it and save.
#Ensure that the Till(s) are configured as an Enabler Enterprise POS Till.
##In EEE, navigate to Location Management → POS Till Maintenance)
##Select the till and click Edit.
##Confirm that the tick box is checked for “Is Enabler Enterprise POS Till?”.
##Save and check the next till for that branch.
#Ensure that the Magenta Web Service URL is correctly configured.
##In EEE, navigate to Utilities → Configuration → Configuration Settings.
##Click the “Licensed Plugins” tab.
##Ensure the Magenta Web Service URL is http://licensing.magentaretail.com.au/MagentaWebService

'''Note:''' Ensure that EEE Server and all tills to be updated are online and running. The update will push through to the store server first, and then to any other tills.

Ensure store servers have replicated from EEE Server at least once.
=== Updating EEPOS ===
#Log into EEE.
#Navigate to Utilities → Configuration → Enabler Enterprise POS → Update Scheduling.
#Click “Check for new updates” and wait for it to process. A message beside the button will read “Checking for new updates…”. This will disappear once it has processed.
#Select the version you will be updating to by clicking the row, then click “Download”. Once the “Downloaded” status changes to “Yes”, click “Schedules”.
#Find your store and tick it. By default, the time and date will be the current date and time, but you can set the update to happen at some point in the future. Select the date and time for your update to run, and click Save.
#Go to the main menu and go to Utilities → Data Interchange → Store Replication Status.
#Check that the store you are updating is at the top of the screen, and if not, select it by clicking the F4 button and selecting it.
#Scroll through the list and tick the following: EEEPOSUpdate, EEEPOSUpdateDependency and EEEPOSUpdateSchedule. Tick Replicate Immediately at the bottom of the screen, and click Commit Changes. Wait for the status columns beside these 3 rows to signify “Replication Succeeded”.
#Wait for the time that you have scheduled for the updates, and check that these tills have updated to the new version by checking the Menu bar at the top of the EEPOS screen.
#During the update, EEPOS will close and a DOS Prompt window will appear on the screen. Please do not close this window. If EEPOS is closed when the update time ticks over, EEPOS will update in the background, and will not allow EEPOS to open until it is completed.

'''Note:''' The tills will not upgrade while a transaction is in progress. If it gets to the time of the update and a transaction is in progress, an alert will pop up on the screen, telling the operator that after the current transaction, the till will update. 

The store server will always update first, and then any remaining tills, so there will always be at least one till available for trade.

'''If you encounter any issues, please contact [mailto:support@magentaretail.com.au Magenta Support].'''

[[Image:EEPOS_CheckForNewUpdates.png|800px|link=]]

[[Image:EEPOS_UpdateSchedules.png|800px|link=]]

[[Image:EEPOS_Schedule_SelectStores.png|800px|link=]]

[[Image:EEPOS_ReplicationScreen.png|800px|link=]]

[[Image:EEPOS_ReplicationStatusKey.png|200px|link=]]

''Versions in image may not be the latest versions available.''

EEPOS:Update Process

2016-02-18T22:25:46Z

Brant: Created page with "== Updating EEPOS to a new version == ''' WE RECOMMEND APPLYING NEW UPDATES IN THE FOLLOWING PROCEDURE''' #'''Apply to Test Till(s) and test thoroughly for a week.''' #'''Apply..."

== Updating EEPOS to a new version ==

''' WE RECOMMEND APPLYING NEW UPDATES IN THE FOLLOWING PROCEDURE'''

#'''Apply to Test Till(s) and test thoroughly for a week.'''
#'''Apply to 1 store for a few days.'''
#'''Apply to 2 more stores for a few days.'''
#'''Apply to all remaining stores.'''

'''This recommendation is made to ensure that if any issues occur, the effect can be minimalised.'''

'''Note:''' Ensure that EEE Server and all tills to be updated are online and running. The update will push through to the store server first, and then to any other tills.

Ensure store servers have replicated from EEE Server at least once.

=== Pre-setup checklist ===

#Ensure company is configured as having Enabler Enterprise POS stores
##In EEE, navigate to Utilities → Configuration → Company Preferences.
##Scroll to the bottom of the screen, and confirm that the “has Enabler Enterprise POS stores” is ticked. If it is not, tick it and save.
#Ensure that the Till(s) are configured as an Enabler Enterprise POS Till.
##In EEE, navigate to Location Management → POS Till Maintenance)
##Select the till and click Edit.
##Confirm that the tick box is checked for “Is Enabler Enterprise POS Till?”.
##Save and check the next till for that branch.
#Ensure that the Magenta Web Service URL is correctly configured.
##In EEE, navigate to Utilities → Configuration → Configuration Settings.
##Click the “Licensed Plugins” tab.
##Ensure the Magenta Web Service URL is http://licensing.magentaretail.com.au/MagentaWebService

=== Updating EEPOS ===
#Log into EEE.
#Navigate to Utilities → Configuration → Enabler Enterprise POS → Update Scheduling.
#Click “Check for new updates” and wait for it to process. A message beside the button will read “Checking for new updates…”. This will disappear once it has processed.
#Select the version you will be updating to by clicking the row, then click “Download”. Once the “Downloaded” status changes to “Yes”, click “Schedules”.
#Find your store and tick it. By default, the time and date will be the current date and time, but you can set the update to happen at some point in the future. Select the date and time for your update to run, and click Save.
#Go to the main menu and go to Utilities → Data Interchange → Store Replication Status.
#Check that the store you are updating is at the top of the screen, and if not, select it by clicking the F4 button and selecting it.
#Scroll through the list and tick the following: EEEPOSUpdate, EEEPOSUpdateDependency and EEEPOSUpdateSchedule. Tick Replicate Immediately at the bottom of the screen, and click Commit Changes. Wait for the status columns beside these 3 rows to signify “Replication Succeeded”.
#Wait for the time that you have scheduled for the updates, and check that these tills have updated to the new version by checking the Menu bar at the top of the EEPOS screen.
#During the update, EEPOS will close and a DOS Prompt window will appear on the screen. Please do not close this window. If EEPOS is closed when the update time ticks over, EEPOS will update in the background, and will not allow EEPOS to open until it is completed.

'''Note:''' The tills will not upgrade while a transaction is in progress. If it gets to the time of the update and a transaction is in progress, an alert will pop up on the screen, telling the operator that after the current transaction, the till will update. 

The store server will always update first, and then any remaining tills, so there will always be at least one till available for trade.

'''If you encounter any issues, please contact [mailto:support@magentaretail.com.au Magenta Support].'''

[[Image:EEPOS_CheckForNewUpdates.png|800px|link=]]

[[Image:EEPOS_UpdateSchedules.png|800px|link=]]

[[Image:EEPOS_Schedule_SelectStores.png|800px|link=]]

[[Image:EEPOS_ReplicationScreen.png|800px|link=]]

[[Image:EEPOS_ReplicationStatusKey.png|200px|link=]]

''Versions in image may not be the latest versions available.''

File:EEPOS UpdateSchedules.png

2016-02-18T22:19:00Z

Brant: uploaded a new version of "File:EEPOS UpdateSchedules.png"

File:EEPOS ReplicationScreen.png

2016-02-18T22:18:59Z

Brant:

File:EEPOS ReplicationStatusKey.png

2016-02-18T22:18:59Z

Brant:

File:EEPOS Schedule SelectStores.png

2016-02-18T22:06:58Z

Brant:

File:EEPOS UpdateSchedules.png

2016-02-18T22:04:06Z

Brant:

File:EEPOS CheckForNewUpdates.png

2016-02-18T22:03:58Z

Brant:

Enabler Upgrades

2016-02-18T05:51:29Z

Brant: /* Store Till Upgrade Path Setup */

===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: [http://www.magentaretail.com.au www.magentaretail.com.au] and select Support then Downloads.

[[Image:Enabler_Upgrades_Figure_1_New.jpg|400px|link=http://www.magentaretail.com.au/downloads/]]

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.

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 tills in the branch during upgrade process. Refer to the [[#Auto Upgrades|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’s being run on. Refer to the [[#Manual Upgrades|Manual Upgrades]] section for further details

'''Note:''' If you are looking for a specific version of Enabler other than the latest release, please contact [mailto:support@magentaretail.com.au 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?===
#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'.
#Close ALL Enabler applications including Nibbler
#Open a command prompt and go to the Enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command and press Enter to run the upgrade
#:<pre>c:\magenta\upgrade c:\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#The following screen will be displayed:
#:[[Image:Enabler_Upgrades_Figure_2.jpg|400px|link=]]
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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?===
#As per the previous details, unzip the upgrade package to a folder on the Head Office or Store Server
#On the tills (nodes) close ALL Enabler applications including Nibbler
#Open a command prompt and go to the enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command to run the upgrade
#:<pre>\\ServerName\magenta\upgrade \\ServerName\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#:'''Note:''' Replace 'ServerName' with the name or IP Address of your Head Office or Store Server
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the company is selected at the highest level.
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Store Server"
#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)
[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_3.jpg|400px|link=]]

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

====Store Till Upgrade Path Setup====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the branch is selected
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Tills”"
#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.

[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_4.jpg|400px|link=]]

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

===Configure Scheduler for all machines in a store===
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:''' It is important that the upgrade is scheduled to occur between EOD and Resume Till times. Nibbler is required to be running on all tills flagged as online for auto upgrade to successfully proceed.

#On the HO Server, start Back Office
#Select Global Setup
#On the right hand side of the screen select:
#Transaction Processing / Comms → Scheduler Setup → Config
#When prompted, choose either 'Store Server' or 'Tills'
#Complete the details as required for each machine type:
#:
[[Image:Enabler_Upgrades_Figure_5.jpg|400px|link=]]

===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|Configure Scheduler for all machines in a store]]).

#Start Back Office then select 'Global Setup' (or Local Store Setup if scheduling at a store)
#Highlight a branch name or region (left hand side of the screen)
#Right click the branch or region
#Select Upgrade
#The system will advise if the upgrade schedule time set previously can be cancelled or changed.
#:[[Image:Enabler_Upgrades_Figure_8.jpg|400px|link=]]
#Select <enter>/Yes to continue
#Key in the upgrade date
#Key in the time of the upgrade
#Highlight the upgrade package to be applied then select <Enter>/OK
#:[[Image:Enabler_Upgrades_Figure_9.jpg|400px|link=]]
#Press <enter>/yes to confirm the date/time details
#:[[Image:Enabler_Upgrades_Figure_10.jpg|400px|link=]]

===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.

#Double click the Nibbler icon in the taskbar
#The 'Upgrade' light should be highlighed green
#Click the upgrade light to display the schedule time details
#:
#:[[Image:Enabler_Upgrades_Figure_6.jpg|400px|link=]][[Image:Enabler_Upgrades_Figure_7.jpg|400px|link=]]

==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.
#From the Back Office main screen select the 'Configuration' menu
#Select 'Version Table' from the menu
#Select F6 Till Number
#Key in the logical address of a machine you want to check, the current Enabler version number will be displayed
#:[[Image:Enabler_Upgrades_Figure_11.jpg|400px|link=]]

===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.
#From the EEE Main Menu, select Location Management
#Select Version Control
#Tick 'Show only Enabler Version Records' and enter the 'till number' if desired
#Click Search, the current Enabler version will be displayed for all tills
#:[[Image:Enabler_Upgrades_Figure_12.jpg|400px|link=]]

===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|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.

#From the Back Office main screen select 'Reports' then 'Event Log'
#Enter the date, branch and till number to view and click OK
#Click on the Auto Upgrade event type
#:[[Image:Enabler_Upgrades_Figure_13.jpg|400px|link=]]

===Checking upgrade event records in EEE===
The EEE event log can also be used to check the Upgrade events.
#From the EEE Main Menu, select 'Analysis' → 'Queries' → 'Event Log'
#Enter the date, branch and till number to view and click OK
#Select 'Auto Upgrade' from the Filter list

==See Also:==
[[Investigating Enabler Upgrade Issues|Investigating Enabler Upgrade Issues]]

Enabler Upgrades

2016-02-18T05:50:26Z

Brant: /* Store Server Upgrade Path Setup */

===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: [http://www.magentaretail.com.au www.magentaretail.com.au] and select Support then Downloads.

[[Image:Enabler_Upgrades_Figure_1_New.jpg|400px|link=http://www.magentaretail.com.au/downloads/]]

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.

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 tills in the branch during upgrade process. Refer to the [[#Auto Upgrades|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’s being run on. Refer to the [[#Manual Upgrades|Manual Upgrades]] section for further details

'''Note:''' If you are looking for a specific version of Enabler other than the latest release, please contact [mailto:support@magentaretail.com.au 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?===
#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'.
#Close ALL Enabler applications including Nibbler
#Open a command prompt and go to the Enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command and press Enter to run the upgrade
#:<pre>c:\magenta\upgrade c:\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#The following screen will be displayed:
#:[[Image:Enabler_Upgrades_Figure_2.jpg|400px|link=]]
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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?===
#As per the previous details, unzip the upgrade package to a folder on the Head Office or Store Server
#On the tills (nodes) close ALL Enabler applications including Nibbler
#Open a command prompt and go to the enabler folder. EG: <code>C:\Users\POS> cd\enabler</code>
#Enter the following command to run the upgrade
#:<pre>\\ServerName\magenta\upgrade \\ServerName\magenta\ </pre>
#:'''Note:''' Ensure you include the '\' on the end
#:'''Note:''' Replace 'ServerName' with the name or IP Address of your Head Office or Store Server
#Press <enter> to start the upgrade
#The upgrade should complete with no errors. If you have any errors, refer to the wiki page [[Investigating Enabler Upgrade Issues|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====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the company is selected at the highest level.
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Store Server"
#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)
[[Image:Enabler_Upgrades_EnablerNodesToConfigure.jpg|400px|link=]]

[[Image:Enabler_Upgrades_Figure_3.jpg|400px|link=]]

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

====Store Till Upgrade Path Setup====
#On the Head Office Server, start Back Office
#Select Global Setup
#On the left hand side of the screen, ensure the branch is selected
#On the right hand side of the screen select: Transaction Processing/Comms → Version Control Setup → Config
#When prompted to apply changes, choose "Tills”"
#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.

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

[[Image:Enabler_Upgrades_Figure_4.jpg|400px|link=]]

===Configure Scheduler for all machines in a store===
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:''' It is important that the upgrade is scheduled to occur between EOD and Resume Till times. Nibbler is required to be running on all tills flagged as online for auto upgrade to successfully proceed.

#On the HO Server, start Back Office
#Select Global Setup
#On the right hand side of the screen select:
#Transaction Processing / Comms → Scheduler Setup → Config
#When prompted, choose either 'Store Server' or 'Tills'
#Complete the details as required for each machine type:
#:
[[Image:Enabler_Upgrades_Figure_5.jpg|400px|link=]]

===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|Configure Scheduler for all machines in a store]]).

#Start Back Office then select 'Global Setup' (or Local Store Setup if scheduling at a store)
#Highlight a branch name or region (left hand side of the screen)
#Right click the branch or region
#Select Upgrade
#The system will advise if the upgrade schedule time set previously can be cancelled or changed.
#:[[Image:Enabler_Upgrades_Figure_8.jpg|400px|link=]]
#Select <enter>/Yes to continue
#Key in the upgrade date
#Key in the time of the upgrade
#Highlight the upgrade package to be applied then select <Enter>/OK
#:[[Image:Enabler_Upgrades_Figure_9.jpg|400px|link=]]
#Press <enter>/yes to confirm the date/time details
#:[[Image:Enabler_Upgrades_Figure_10.jpg|400px|link=]]

===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.

#Double click the Nibbler icon in the taskbar
#The 'Upgrade' light should be highlighed green
#Click the upgrade light to display the schedule time details
#:
#:[[Image:Enabler_Upgrades_Figure_6.jpg|400px|link=]][[Image:Enabler_Upgrades_Figure_7.jpg|400px|link=]]

==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.
#From the Back Office main screen select the 'Configuration' menu
#Select 'Version Table' from the menu
#Select F6 Till Number
#Key in the logical address of a machine you want to check, the current Enabler version number will be displayed
#:[[Image:Enabler_Upgrades_Figure_11.jpg|400px|link=]]

===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.
#From the EEE Main Menu, select Location Management
#Select Version Control
#Tick 'Show only Enabler Version Records' and enter the 'till number' if desired
#Click Search, the current Enabler version will be displayed for all tills
#:[[Image:Enabler_Upgrades_Figure_12.jpg|400px|link=]]

===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|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.

#From the Back Office main screen select 'Reports' then 'Event Log'
#Enter the date, branch and till number to view and click OK
#Click on the Auto Upgrade event type
#:[[Image:Enabler_Upgrades_Figure_13.jpg|400px|link=]]

===Checking upgrade event records in EEE===
The EEE event log can also be used to check the Upgrade events.
#From the EEE Main Menu, select 'Analysis' → 'Queries' → 'Event Log'
#Enter the date, branch and till number to view and click OK
#Select 'Auto Upgrade' from the Filter list

==See Also:==
[[Investigating Enabler Upgrade Issues|Investigating Enabler Upgrade Issues]]