Enabler Internal Comms

From EnablerWiki

Jump to: navigation, search

Created: 31 August 2009. Last Reviewed: 31 August 2009

Setting Up Enabler for Internal Comms


Automatically move Nibbler messages to Enabler Head Office and .hos files to EEE.


Requires Enabler v4.41 or greater


The following settings are for store servers only and should be set up under Global configuration in Enabler Head Office.


NOTE: Prior to modifying the Enabler configurations, Windows Folder Shares need to be set up on the Head Office server/s with permissions set on the shares for the standard user account that stores servers will be logged in as.


Once set up, the shares should be tested from a store to ensure that the user has full/read/write/delete/modify/etc rights to the shares.


EEE Server: The data import and export folders need to be shared at the Company level. EG, if the folder structure is \eeedata\production\import and \eeedata\production\export, then the ‘production’ folder should be shared, with full share authority and full directory permissions given to the Enabler user account.


Enabler Server: The standard user account that stores servers will be logged in as will need access to the \enabler\comms\frombr, \enabler\comms\tobr, and \enabler\comms\upgpack directories on the Enabler Head Office server. The directories themselves can be shared, or just the \enabler\comms or \enabler folder, with full share authority and full directory permissions given to the store servers’ Enabler user account.

A commonly used scenario is to share the Enabler folder on the Head Office Server using the sharename ‘enserver’.


Nibbler Message Communications

Previously any nibbler messages being transferred upstream or downstream from Head Office had to be transferred via batch files. With the copy to/from network path options in the Communications Setup screen, the batch files are no longer required and this transfer functionality will be handled by Nibbler.

These check boxes allow nibbler messages to be copied directly from the HO server to the local directory path and vice versa.


Transaction Processing/Comms  Communications


Upstream inbound Path (Nibbler messages coming from the Enabler HO Server)

  • Copy from network path
    • Path e.g. [/\\HOservername\enserver\comms\tobr\%25laddr \\HOservername\enserver\comms\tobr\%laddr]

Upstream outbound path (Nibbler messages destined for the Enabler HO Server)

  • Copy to network path
    • Path e.g. [/\\HOservername\enserver\comms\frombr\%25laddr \\HOservername\enserver\comms\frombr\%laddr]

NOTE: The ‘%laddr’ wildcard can be used in place of the branches logical address, and simplifies the setup of each branch using Internal Comms. Nibbler will automatically replace the %laddr with the first 4 digits of the logical address, and use the related from to copy to and read from


Eg. For a store server with logical address 010201, the files will be read from [/\\HOservername\enserver\comms\tobr\0102 \\HOservername\enserver\comms\tobr\0102] and files will be copied to [/\\HOservername\enserver\comms\frombr\0102 \\HOservername\enserver\comms\frombr\0102]

Enabler Internal Comms Figure 1.jpg


Specify the paths for receiving and sending messages in the Path edit box. Once the messages are sent or received they will be deleted from the respective source directories. The above example paths are based on the enabler folder having a share name of enserver.

Nibbler files transferred from a Store Server to the Head Office can include the *.xxx, *.zip and isl-inv.dat files. Nibbler files transferred from the Head Office to a Store Server include the *.xxx, *.zip and *.bld files.


When the Copy from Network Path option in the Communication Setup screen is on, Nibbler will search for and process maintenance files from Head Office once every 10 seconds or so.

If Nibbler is unable to copy or delete the maintenance files from the network path it will appear as a red icon in the system tray. Nibbler must be shut down and restarted after any permission or network problems have been addressed.


Host Interface Setup

The system can be configured to allow copying of files to and from the EEE import/output folders This does away with the need to run ftpagent scripts to copy the files if you are on the same WAN.


There are two sets of options on the Host Interface Setup screen Export page. These options allow:

  1. The HOS file to be moved to another folder (usually the EEE import folder) after it has been created. The HOS file is then renamed from *.hos to *.imp, to trigger EEE import of the file.
  2. Acknowledgements generated by EEE to be copied to the local Acknowledgements In path prior to running an acknowledgment import. These acknowledgments are then renamed from AAZ to ACZ so that Nibbler will process them.

Transaction Processing/Comms  Host Interface  Export File Options


Host log path

  • Copy to network path
    • Path e.g. [/\\HOServername\eeedata\import\%25laddr \\HOServername\eeedata\import\%laddr]

Acknowledgment path

  • Copy from network path
    • Path e.g. [/\\HOServername\eeedata\export\%25laddr \\HOServername\eeedata\export\%laddr]

Enabler Internal Comms Figure 2.jpg


Transaction Processing/Comms  Host Interface  Import


Acknowledgment path

  • Copy to network path
    • Path e.g. [/\\HOServername\eeedata\import\%25laddr \\HOServername\eeedata\import\%laddr]

The copy to network options on the Host Interface Setup screen Import tab allow acknowledgements generated by Enabler to be copied to the EEE import path after they have been generated. These acknowledgments are then renamed from *.ack to *.imp.


NOTE: The Host Import/Export network paths can also accept the %laddr token as part of the path so files can be imported directly over the network


Enabler Internal Comms Figure 3.jpg


In each case, the files are copied to a temp file in the new folder, and file sizes compared to ensure that they have copied successfully. The files are then renamed to their final file name ready for importing. Once complete, the source files are deleted. If files cannot be copied due to network issues, file already exists etc, it remains in the source path, and the copy is attempted again on the next run.


It is important to note that when entering in the path in one of these options, you can use the token %laddr to specify the tills <RRBB> portion of its logical address. i.e in the example above, the path for the HOS file copy is:

[/\\HOServername\eeedata\import\%25laddr \\HOServername\eeedata\import\%laddr]

When performing the copy, Enabler will expand this path to be:

[/\\HOServername\eeedata\import\0102 \\HOServername\eeedata\import\0102]- with 0102 coming from the logical address for this till.


Version Control Setup

The ability to perform auto upgrades is made simpler with the option to copy the upgrade pack over the network. Using version control setup as per below, store servers can download the upgrade pack from the HO server to their local drive

The auto upgrade pack can be copied locally over the network prior to being extracted. The “upgrade package path” entered is where the auto upgrade pack is placed at Head Office. The below example path has the enabler folder shared as enserver.


The “copy upgrade pack to “path is dependent on the flag “copy upgrade pack before extracting” once flagged the path can be entered where the upgrade pack will be copied to on the store server before extraction.

Transaction Processing/Comms >Version Control Setup

Upgrade package path

  • Copy upgrade pack before extracting

Enabler Internal Comms Figure 4.jpg


To alleviate stores all trying to download the upgrade package at the same time as each other (placing excessive drain in the available bandwidth,) some changes have been made to the upgrade scheduling process. When you are scheduling upgrades, be it for a branch, a region, a company etc, Enabler generates an upgrade instruction that is sent to all the required store servers and it contains details of the upgrade and the date/time it is to be applied. This upgrade instruction now contains an additional date/time to signify when the server should download the upgrade package, in preparation for the upgrade. This is done with some smarts in that that we stagger the download date/time for all the branches.


This is done by calculating the available window between now and the upgrade date/time in seconds, taking off an hour + 5% from this window to allow for inconveniences, and then using the number of branches being scheduled to calculate a download interval. This interval is then incremented and added to the upgrade instruction for each store. Nibbler at the store will write the download time to winsuite.ini

[TimedEvents]

UpgDwnldDate=28-08-2007

UpgDwnldTime=11:30

UpgDwnldRun=0

and it can be seen by clicking on the upgrade light on the nibbler screen which shows this informational popup.

Enabler Internal Comms Figure 5.jpg

Nibbler will act upon this instruction when due and download the upgrade package. In the event the scheduled download is missed, the upgrade package is downloaded at the time of the upgrade being applied.


Further, if the upgrade is scheduled to occur within the next hour, no download date/time is generated, the upgrade packages is downloaded at the time of upgrading.


To accommodate differing time zones the Branch Details screen now allows a GMT offset to be entered, and stores with the highest GMT offset will be scheduled to download the package first.

Enabler Internal Comms Figure 6.jpg

This setting can also be imported via the “kC” record.


Generic Masterfile Interface – Branch Maintenance (kC) Record – New Field

18 GMT OffsetN-3,0

Personal tools