Void Report Plugin

Last edited: December 15, 2003 08:19 AM

The Void Report plugin an extra report that can be run from within Manager. (See Programming Plugins for more information.) This report shows voids by employee or reason as well as the item voided and the total dollar amounts. In order to collect this information, this report is also a shell for use with TouchPRO.

This report is configurable from Manager. Select “Configure Extra Reports” from the File menu and then select “Void Report” from the list box. This screen will appear showing current void reasons and the current report sort priority.

[img:3gjb00cn]http://www.possupport.net/dealer/kbase/images/voidrp1.gif[/img:3gjb00cn]

Use this screen to define the void reasons and to set the report sort priority to be used when running the void report. To define a void reason, select the desired Void reason number and then select the MODIFY button. This action will bring up the following screen:

[img:3gjb00cn]http://www.possupport.net/dealer/kbase/images/voidrp2.gif[/img:3gjb00cn]

Type a description for the void reason and select the OK button to save your changes. The defined void reasons will be displayed for selection in TouchPRO each time a void is performed. Here is an example of what the user will see when performing a void in TouchPRO:

[img:3gjb00cn]http://www.possupport.net/dealer/kbase/images/voidrp3.gif[/img:3gjb00cn]

They will be able to choose from the defined void reasons or touch the Cancel button to abort the void.
Sample Reports

                              ** Void Report **

                              (Sorted by employee)

                Report Printed on: Tue, Aug 12, 1997    9:28am

            Report For: Mon, Aug 04, 1997

---

> Tue, Aug 12, 1997

              Employee Name:

        ITEM VOIDED      AMOUNT CHECK      SERVER                  REASON

---

    2 Fetzer Cabernet      5.50    0                      This is a test

    1 Filet Mignon        14.99    0                      This is a test

    2 Fetzer Cabernet      5.50    17 Perry, Brad          Test number 2

---

    Totals:        3    25.99

              Employee Name: Perry, Brad

        ITEM VOIDED      AMOUNT CHECK      SERVER                  REASON

---

    1 Filet Mignon        14.99    0 Perry, Brad          This is a test

    2 Fetzer Cabernet      5.50    12 Morris, Tim          Test number 2

    2 Fetzer Cabernet      5.50    0 Perry, Brad          Test number 2

---

    Totals:        3    25.99

(Program: VoidRP  Version: 6.06)

                              ** Void Report **

                              (Sorted by reason)

                Report Printed on: Tue, Aug 12, 1997    9:29am

            Report For: Mon, Aug 04, 1997

---

> Tue, Aug 12, 1997

                    Void Reason:  1 – This is a test

        ITEM VOIDED      AMOUNT CHECK      SERVER                EMPLOYEE

---

    2 Fetzer Cabernet      5.50    0                      Perry, Brad

    1 Filet Mignon        14.99    0                      Perry, Brad

    1 Filet Mignon        14.99    0 Perry, Brad          Morris, Tim

---

    Totals:        3    35.48

                    Void Reason:  2 – Test number 2

        ITEM VOIDED      AMOUNT CHECK      SERVER                EMPLOYEE

---

    2 Fetzer Cabernet      5.50    0 Perry, Brad          Morris, Tim

    2 Fetzer Cabernet      5.50    12 Morris, Tim          Morris, Tim

    2 Fetzer Cabernet      5.50    17 Perry, Brad          Perry, Brad

---

    Totals:        3    16.50

(Program: VoidRP  Version: 6.06)

Installation

Create a directory called Plugins on the same drive as Manager was found. If Manager was found on C: then the directory should be created on the C: drive.

Place the program files in this directory. The necessary files are:

    * VoidRP.EXE – the program executable
    * VoidRP.RES – the resource file
    * VoidRP.PID – the program definition file

The “Code” range will be: 5101 – 5199, where the last two digits will indicate the reason, corresponding to the reason database.

You can download VoidRP from our version 6.xx download section.

Technical Notes

The stylist must insert the proper code to implement the information collection shell within TouchPRO.The shell should be run right before the void item instruction is issued in EditNET. The shell will return a value in the “status” variable to indicate success of storing the extra data, so that the stylist can avoid doing a void if necessary (i.e. the shell did not run properly). The shell will collect a reason and store the detailed information about the void in the journal file for that day specifically for voids. The reasons will be structured as follows:

Each reason will consist of a code number and a alpha description up to 20 characters long. The reasons will be definable through the configuration of the plugin (in Manager). Up to 99 reasons will be supported. The reason database will be kept in a separate file and only the code stored in the journal.

The shell will store the following information in the journal file:

    Reason code 2 bytes
    Employee ID (performed void) 2 bytes
    Server ID 2 bytes
    PLU voided 2 bytes
    Amount of PLU 4 bytes
    Check # 2 bytes

Journal file format:

    Code Amount1 Amount2 Data1 Data2
    ? ?  Amount of PLU voided Employee ID/Server ID PLU# Check #

To create the voidrp shell:

[img:3gjb00cn]http://www.possupport.net/dealer/kbase/images/voidrp4.gif[/img:3gjb00cn]

NOTE the high/low variables, preserve screen, store variables, swap to XMS/EMS/VMS and get variables options.  If the /voidchk command line switch is used, the Store Check PLU List must be checked also.

The syntax for the Command Line should be:

        voidrp /shell {/voidchk}{/reason=xx}

    *      /shell – required to tell utility it is posting a void, not creating a report.
    *      /voidchk – causes all items on check to be posted as voids, as opposed to just the highlighted item.
    *      /reason=xx – posts reason number xx instead of opening a window to prompt the user for a reason.

Next implement the shell before the ‘Void’ instruction.

Example chain:

Status = 0

Shell to: VoidRP

IF Status ~0

  Void Item

End IF

For more detailed information about the workings of a plugin, please refer to Programming Plugins.
Revisions
8/11/97 Version 6.00

  1. Initial Release

08/27/97 Version 6.01

  1. Fixed bug in report by employee. Would show server name instead of employee name.
  2. Added check for valid reasons in shell portion. If no reasons are defined, will show error window and close shell.
  3. Added command line switch /voidchk. Will be used in conjunction with proper styling to void an entire check, applying one reason to all plus on the check. To create this shell, follow the standard instructions and also turn on ‘Store Check PLU List’ option.
  4. Fixed bug that would cause incorrect name to be displayed on report for both servers and employees. Caused by not doing ARRAY SCAN EmpID!

12/09/98 Version 6.02

  1. Y2K compliant.

05/03/99 Version 6.03

  1. Initializes the mouse now. This fixes the problem with Elo touch monitors.

5/28/99 Version 6.04

  1. The SlowScroll Environment variable wasn’t working properly and has been fixed.
  2. A New command line is available. /Reason=# will allow the reason to be predetermined by the calling application and skip the touch screen selection.

2/28/2000 Version 6.05  (dh)

  1. Added support for the new Secret Global Option in TouchPRO: ‘Roll Journal dates forward after NDH’.

4/25/2000 Version 6.06 (dh)

  1. Oops, the feature #1 in 6.05 didn’t actually work. Now it does, really!

11/29/2001  rw

  1. Documented the syntax for the Command Line when run as a Touchnet shell.
  2. Removed the PID section and replaced with a link to the KBase document for plugins.