ESCAPE Polling with StoreGazer
The following steps are designed for a 3-day rollout process (to include testing), but can easily be shortened by eliminating the testing steps (3 and 5).
Note: the following instructions are for ACE systems. To work on other applications (Supermarket/GSA/Specialty/Chain Drug), ESCTXACE in step 1b needs to be replaced by ESCHBILD (in both Rule 201 and Rule 202).
1. Setup a flag file to indicate ESCTRANS is ready to be retrieved
a. Create the file EDJGAZER:ESCREADY. The contents can be left blank.
b. Modify the EDJGAZER:EVNTFILE.DAT to include the following rules. (If Rules 201 and 202 are in use, change them to any unused value)
# When ESCTXACE ends (W620), copy the ESCREADY file into position [Rule = 201] Message = W620 Ascii Data = ESCTXACE Action ID = 201 # Between 12:00am and 12:15am, remove the ESCREADY file if it still exists [Rule = 202] Message = W620 Ascii Data = ESCTXACE Frequency = 0 Start Time = 0000 Stop Time = 0015 Action ID = 202
c. Modify the EDJGAZER:ACTNFILE.DAT to include the following actions.
(If Actions 201 and 202 are in use, change them to any unused value. You will also need to change the Action IDs (not the Rule #s) in the EVNTFILE as well.
# Copy the ESCREADY file from EDJGAZER to EJ to indicate ESCTRANS is ready to be retrieved [Action = 201] Type = Run Program NodeID = %m Background = False Program Name = ADX_SPGM:COPY.286 Parameters = edjgazer:escready ej:escready # Delete the ESCREADY file from EJ in preparation for ESCTRANS processing [Action = 202] Type = Delete File NodeID = %m Program Name = C:\EJ\ESCREADY
d. Allow 15 minutes for StoreGazer to detect the changes to the EVNTFILE and ACTNFILE. No application or system restart is required.
2. Create a StoreGazer job to retrieve the ESCTRANS files from the controller.
a. In the StoreGazer Client, open Multistore, switch to the Multiple Steps tab and click Create Job.
b. Give the job a name and description relating to “ESCTRANS Polling”
c. On the steps tab, create three new steps, as described below:
i. Step 1: Verify ESCREADY is present.
Request Type: File Information
Filename: EJ:ESCREADY
Other options: Leave both the Keyed File and Checkum boxes unchecked
On Success: Continue to Next Step
On Failure: Quit Job with Error
Retries: 3, 10 minutes between each attempt
ii. Step 2: Transfer ESCTRANS
Request Type: File Transfer
4690 File: C:\EJ\ESCTRANS
Local File: C:\EJ\%s%m%d.%y
Options: Delete source files after successful transfer should be checked
Other options: Configure the FTP/SFTP operation with the appropriate authentication details
On Success: Continue to Next Step
On Failure: Quit Job with Error
Retries: 3, 10 minutes between each attempt
Note: Ensure the C:\EJ\ (or whatever path you use in the Local File) exists on both your StoreGazer Client and the StoreGazer Server systems.
iii. Step 3: Delete ESCREADY
Request Type: Delete File
Filename: C:\EJ\ESCREADY
On Success: Quit Job with Success
On Failure: Quit Job with Error
Retries: 0
3. Test the job to ensure it is built properly and works as expected.
a. Allow the 4690 process to run overnight.
b. Verify the EJ:ESCREADY file exists on the 4690 after ESCTXACE completes (not time-sensitive)
c. Run the job manually (from Multistore) against a controller.
i. It is recommended to perform this step on the StoreGazer Server machine.
ii. YES, make sure the Client is also installed on the Server!
d. Verify the ESCTRANS file is retrieved (the file will be in the C:\EJ\ folder and contain the store number and date in the filename)
e. Verify the EJ:ESCREADY and EJ:ESCTRANS files are deleted from the 4690
4. Schedule the job to run automatically each night
a. Note: scheduled jobs are performed on the StoreGazer Server. The Client must be installed on the Server system for jobs to be executed.
b. In the StoreGazer Client, open Multistore, switch to the Multiple Steps tab, select the job and click Edit Job.
c. On the Schedules tab, create a new schedule
d. Set the schedule to run daily at a time after the ESCTXACE process finishes (15 minutes after ESCTXACE is scheduled to start should be sufficient)
e. Specify a test set of controllers to schedule the job on. Make sure the steps in Section 1 have been performed on all the test controllers.
5. Test the schedule to ensure it works as expected.
a. Allow the 4690 process to run overnight.
b. Verify the files on your StoreGazer SERVER system in the C:\EJ\ folder. There should be a file for each store in the test group.
c. Run a Multistore File Information query against EJ:ESC* to ensure the ESCTRANS and ESCREADY files were removed from the test systems.
6. Go Live!
a. Modify the Job and edit the schedule to run against all of your stores
b. If you are dealing with multiple timezones, you can setup a different polling time for each group, or run them all after the last store has run the ESCTXACE process.
i. The scheduled time is relative to the Server, not the 4690, so if you have an East Coast server and 4690s in the Pacific timezone that run at 2:00am, you’ll need to schedule the polling no earlier than5:15am.
ii. If you’d like to setup multiple schedules to handle each timezone independently, let me know. We can assist with that.
7. Integrate with JAM/ESCAPE
a. If JAM is already configured to process the C:\EJ\ folder, then the files should be integrating automatically.
b. If not, we can choose ONE the following options:
i. Modify Step 2 of the job to put the files into the directory that JAM is processing (changing the Local File from C:\EJ\… to the configured JAM directory)
ii. Modify JAM configuration to process the C:\EJ\ folder
iii. (Not Recommended, but possible) Create another process to move the files from C:\EJ\ to the JAM processing directory after the transfers have completed.
c. Once JAM processes the files, they should be immediately available in ESCAPE.