CST BrandsHelpdesk POS ConfigurationPOS Environmental Variables (Travstar.ini)

POS Environmental Variables (Travstar.ini)

This lesson will teach you about the POS environmental data

Once connected to the POS, go to the /cygdrive/c/Program\ Files/fiscal directory

Type nano travstar.ini and press enter.

Example of Travstar.ini

Example of Travstar.ini

Below is a list of variables for the travstar and their explanations:

3DES

This variable tells the POS which encryption method to use with DUKPT pin pads. Permissible values are 0, or 2 where 0 denotes single DES keys and 2 denotes triple DES keys.

Used in functions:

GetPinPadEncrypted: a routine that requests encrypted pin data from a DUKPT (Derived Unique Key Per Transaction) capable pin pad. When defined denotes that DUKPT pinpads should be set to use triple DES encryption.

ABORTPREAUTH

When defined allows a cashier to change a pre-edit / pre-auth / post-auth transaction to an ordinary AUTH transaction when a pre-auth repeatedly fails.

ADS

When defined, will not allow the more than one pump to be registered in a sale where a credit card is used for a tender.

Used in functions:

hose_plu_amount: a routine that registers the fuel sale for a selected dispenser. When defined, will not allow more than one dispenser to be rung during a single sale.

ALCOHOLPURCHRESTRICT

When defined will trigger a check of a temporal restriction database on the MWS when items whose department flags contain an 'A'. If the time of sale falls within a restriction period defined in the table, then the sale is not allowed.

ALLOW_TFT_DELETE

Will allow the cashier to delete a truck fleet transaction. If the environmental variable ALLOW_TFT_DELETE is not present the cashier will NOT be able to delete a truck fleet transaction.

Used in functions:

CDispTftTrans::OnDelete: Truck fleet pending sales display dialog callback function which deletes the selected truck fleet transaction from the CCL database. When defined, deletion of truck fleet transactions is allowed in the pending fleet dialog.

AUTHLEVELDISCOUNT

When defined denotes the per gallon discount given when a post-paid fuel item is found in a sale tendered by a designated card type. If this is not defined, the default is $0.05.

AUTHLIMIT

When defined, denotes the maximum amount for which a truck fleet transaction can be pre-authorized at the fuel desk.

Used in functions:

GetPreEditPrompts: routine that sends a pre-edit request to the CCL for a truck fleet transaction.

AUTOEOD

This will allow the EOD parameter on the “Z Report” to increment the day to the next business day when the “EOD Z Report” button is pressed.

Used in functions:

update_trm_rec: A routine that updates the terminal database records with various sales statistics after each sale completes. If NOT defined, then the official business date of the current reset record is set if this routine is called and no net sales have yet been recorded for the current reset.

zreports: A routine that performs an end of shift / end of day Z operation. If defined it:

calls SetBusinessDay.

if this register is the master pos, makes sure that all other registers have already done their Z process

get_key: Routine that runs the main POS idle loop. In the idle timeout switch case, if defined check to see if the designated time for the EOD process has come, and if so puts up a dialog box reminding the clerk to perform the EOD Z process.

end_of_day: A routine to send reset and log file to the MWS. If defined, then the local EOD database is updated here.

BACKUPXMLIP

When defined denotes the IP address of the backup xml receipt database server. The backup server commonly runs on the same linux machine as the manager workstation suite.

BAILEYCLEAR

When defined suppresses display of customer financial information in customer selection dialog boxes and customer status display on the main screen. In addition, when defined will not allow the cashier to "master clear" the register at the register screen.

Used in functions:

CCustSelect::OnSelchangelbLIST: Callback function in the customer selection dialog that displays a single customer's file content when that record is selected in a list box. When BAILEYCLEAR is defined, the customer's account balance information is suppressed.

GUIDisplayCust: a routine that displays customer data on the main register data window after a customer has been selected. See entry for CCustSelect::OnSelchangelbLIST for details

my_clear_register: A routine that will clear all register status variables. If BAILEYCLEAR is defined, this routine displays "This function is Restricted." and returns without executing further.

BATCHONEOD

Changed EOD button to run Gas report, CC Batch, along with Z Variable without this EOD Z runs normal.

Used in functions:

zreports: A routine that performs an end of shift / end of day Z operation. When defined, for the master pos only, a credit card batch is also run at EOD Z time.

BCREADER

When defined allows the used of a serial port interface for the magstripe reader instead of a keyboard wedge interface.

Used in functions:

dopos: A routine that houses the main application loop. When defined, enables using a serial port mag stripe reader. This reader defaults to COM6.

BDATETIME

BDATETIME=235500 will contain the time in HHMMSS format (military time) when the POS unit will wake up and set the business date for the current reset if no sales have been previously rung up.

Used in functions:

set_environment: A routine that is called during initialization to read in the contents of the travstar.ini file. When defined contains the time of day in HHMM format (24 hour time) when the register will reset the business date in the terminal record.

BGMT

When defined, denotes that the geographic location of the POS is east of Greenwich England. This information is used to determine world time zone information needed to submit time stamps to the BP EPS in login messages.

Used in functions:

GetTimeZone: A routine that sets the timezone variable used with logging onto the BP EPS. When defined, denotes that the geographic location of the POS is east of zero degrees longitude. This information is used to determine world time zone information needed to submit time stamps to the BP EPS in login messages.

BYPASSFFS

When defined causes the truck fleet receipt look up dialog to access a postgreSQL server on the MWS for truck fleet receipt data.

CARWASH_DISCOUNT

When defined as two characters ('1'<=tier<='2')('1'<=level<='4') and a carwash is sold as part of a fuel preauthorization, the designed dispenser will be set to the defined price level and tier.

CASH_DISCOUNT_TIER

Specifies the tier and level to be authorized for a cash sale. The above parameter will set the dispenser to tier 1 level 1. The parameter for tier must be either 1 or 2. The parameter for level must be 1-4. If the parameters are not specified the system will default to tier 1 level 1.

Used in functions:

GetGasDiscount: Routine that determines the PPU fuel discount in truck fleet transactions. When defined, the routine returns a zero dollar amount since the discount is to be determined by price tier on of the dispensed product.

tft_authorize: Routine that authorizes a dispenser for an specified amount. When defined, its contents consists of a two character string that specifies the price tier (1st character) and price level (2nd character) to be used for this transaction.

CASHCARDS

This will define which cards get the cash discount specified in the cashdiscount variable. Default = GepcBWSe$txrfjuOKIYFCXpU

Used in functions:

get_gas_discount: routine that determines a PPU discount for truck fleet transactions. When defined, contains a list of truck fleet card types that are eligible to receive the discount.

GetGasDiscount: See get_gas_discount.

CASHDISCOUNT

When defined, denotes the cash discount amount to be applied to fuel ppu if a truck fleet credit card has been used to purchase said fuel. Two place decimal point inferred if none in the string.

Used in functions:

CashDiscountAmount: Routine that determines the PPU fuel discount in truck fleet transactions. When defined, contains the text representation of the discount amount.

CASHDISCOUNTDEPT

Used in function:

update_gas_discount_dept: routine that records the PPU fuel discount amount given in a truck fleet transaction. When defined, contains the department ID of the department used in the foregoing sentence.

CBC

Used in functions:

do_reports: Routine that executes designated 'X' or the 'Z' report. When defined, prints the "Change Back Report" for dispensers that use cash acceptors on the Z tape.

CCISO

Used in functions:

dopos: A routine that houses the main application loop. When defined, causes creation of the Credit card table if it doesn't exist

CCLIP

Used in functions:

GUIDisplayGenStatus: Routine that outputs all status information onto the main status display are of the main screen. When defined, determines the color of the NTWK: status string heading.

set_server_port: Routine that initializes communications between the LSC, CCL, and POS. When defined, contsins the TCP/IP address of the computer upon which running the CCL and causes a port setup to be done for the CCL.

dopos: A routine that houses the main application loop. When defined, causes initialization of the encryption key manager for use in secure transaction communications with the CCL.

CCLPORT

Used in functions:

GUIDisplayGenStatus: Routine that outputs all status information onto the main status display are of the main screen. When defined, determines whether or not to display the CCL status ICON text.

CCL_online: Routine that determines whether or not the POS is online with the CCL. If not defined, this routine returns false.

set_server_port: Routine that initializes communications between the LSC, CCL, and POS. If not defined, a separate port for the CCL is not setup.

CCOPEN

When defined, the cash drawer pops only for payments on account.

Used in functions:

end_sale: A routine that finishes a sale following a successful tender that satisfies the total amount due on that sale. When defined, causes the cash drawer to open if the following are true:

cash has been tendered for the sale.

this was a truck fleet transaction and there is cash advance money due the driver.

there is change of any kind due the customer.

Otherwise, the cash drawer opens at the end of every transaction, regardless of tender circumstances.

CDCC

When defined, denotes the amount of a com data credit card use surcharge. Decimal point is NOT assumed.

Used in function:

cd_surcharge: Routine that returns an amount to be used as a surcharge when a network tender is processed through Comdata. When defined, contains the string value of the surcharge amount.

CHECKFUELDISCOUNT

When defined causes truck fleet transactions paid by check to receive cash discounted fuel pricing.

COINSTAR

Enables CoinStar processes and functionality.

COINSTAR_VOIDNOHOST

When defined allows voiding of coinstar products without contact with the coinstar host.

DELETEDAYS

Number of day to keep deleted file specified in the DELFILEPATTERMS variable.

Used in functions:

DeleteTempFiles: Routine that periodically deletes out of data temporary files from the register hard disk drive. When defined, denotes the maximum age in days a file must attain before the file is deleted.

DELFILEPATTERNS

DELFILEPATTERNS=*.vdf,Bbatch.*,CA*.sav,EFS*.res,ej*.*,ejrl*.*,fl*.*,gaslog.*,gasrpt.*,*.itm,pmedia*.*,pttotals.*,*.prn,rcmedia.*,*.comm = Patterns of files to remove out of the POS,. Use with DELETEDAYS variable.

Used in functions:

DeleteTempFiles: Routine that periodically deletes out of data temporary files from the register hard disk drive. When defined, contains a comma separated list of regular expression style file masks to be used to search for temporary files subject to deletion.

DELI_REGISTER

This Keeps the electronic journals and end of day information from going to the back.

Used in functions:

set_parms: Routine that sets certain global status variables upon initialization of the POS. When defined, sets the DeliRegister parameter to true. Used in functions:

check_retrans: Routine that re-transmits "sce files" to the MWS during a Z if necessary. When defined, this routine aborts and does not run.

end_of_day: Routine that sends an end of day log file and reset to the MWS. When defined, this routine aborts and does not run.

end_sale: A routine that finishes a sale following a successful tender that satisfies the total amount due on that sale. When defined, this routine does not send the temporary electronic journal file to the MWS.

DOFLEETDATA

When defined, denotes special customer lookup by name of TA fleet customers that are using TA Access Cards, but do not allow their drivers to carry the cards. Lookup is accomplished by entering part or all of a customer name in the company name field of the truck fleet dialog, and subsequently pressing the <ENTER> button. A special version of our customer lookup dialog is displayed and the customer is selected from there. In addition to this, the returned record has a list of fields that must be completed for the selected customer. The truck fleet dialog then displays only those fields, hiding all unneeded fields from the cashier. This effect can be canceled by touching the dispenser display area. The environmental variable DOFLEETDATA has been changed to indicate the lookup mode for Fleet Data. When DOFLEETDATA is set to 1 the system will always look on the MWS for Fleet Data. When using the Fleet Data file as a positive check file the system will always go to the MWS to determine if a customer can cash a check. When DOFLEETDATA is set to 2 the system will always look at the purchase policy file on the Master Point of Sale except when doing a lookup for check verification. When the TA environmental variable is present the mode is set to always look at the Purchase Policy file for Fleet Data. When the TA environmental variable is present always use the Purchase Policy file. The Fleet Data file on the MWS is always accessed for Positive Check Cashing information

Used in functions:

CTftmain::OnInitDialog: A routine that initializes the new truck fleet transaction dialog. When defined, causes the dialog to display only fields flagged in a purchase policy record.

CTftmain::OnStatic22: Routine that does a customer lookup when the enter key is pressed in the company edit field in the new truck fleet transaction dialog. When defined, determines whether the dialog will use the cust.dat file or the purchase policy file for displaying customer files.

DOINGRETALIX

When defined denotes that PILOT LOYALTY cards are processed through a Retalix LPE device instead of NBS

DROP_AMOUNT

Used to notify the cashier to drop specified amount when the drawer limit is exceeded. If the DROP_AMOUNT environmental variable is not set the current drop message is displayed to the cashier

Used in functions:

DisplayDropMessage: Routine that displays a message to the cashier to make a safe drop when cash in drawer has exceeded the maximum limit set up for the site. When defined, denotes the amount of the requested safe drop displayed to the cashier.

EJRLLOGTHREAD

When defined, instructs the POS to handle electronic journal processing in a thread.

EMP_DISC

When defined, is used to set which discount table entry is an employee discount. When matching a discount taken table entry, causes an employee signature line to be printed on the receipt. This is a modification added for TA. A file named empdisc.txt needs to be on the POS Register and what ever is in this file is what is printed on the receipt.

Used in functions:

calc_disc: Routine that calculates a discount amount for an item that is being registered. When defined, denotes an index into the regular discount table.

ENABLESVCSTATS

When defined turns on writing stored value card activation and reload statistics to a database on the MWS.

EXTENDED_EJRL

Used in functions:

send_log: Routine that sends all unsent electronic journal log records contained in current resets electronic journal file. When defined, denotes that such records should be sent in blocks of 20 records at a time, rather than individually.

FAKEPUMPS

FAKEPUMPS=1,2,3,4,5,6,7,8 contains a comma separated list of pump numbers to allow Comdata to set up low end Omnidesq with fake pumps. This take effect ONLY if there is no fuel screen setup. If there is a fuel screen, this doesn't work.

Used in functions:

AuthPumps::OnInitDialog: Routine that initializes the authorize dispensers dialog. When defined, aborts displaying the dialog since there are no actual dispensers to authorize.

DisplayCompleteHoses::OnInitDialog: Routine that initializes the dispensers completed dialog. When defined, aborts display of the dialog since there are no actual dispensers to display.

DisplayPumping::OnInitDialog: Routine that initializes the dispenser pumping in progress dialog. When defined, aborts display of the dialog since there are no actual dispensers to display.

CMainFrame::OnCreateClient: Routine that initializes the main POS screen window. When defined, runs code to allow Comdata to set up low end Omnidesq with fake pumps. This take effect ONLY if there is no fuel screen setup.If there is a fuel screen defined, this doesn't work.

CMainFrame::OnKeyDown: Routine that reacts to screen touches in the receipt, dataline, status and main display areas. When defined, and the main display area has been touched (change to fuel screen functionality) this prevents a change to the non-extant fuel screen.

display_hose_status: Routine that displays hose status on dispenser buttons and for selected dispenser in the main display window data area. When defined, this function is aborted and does not run.

GasAnimationThread: Routine that animates the images on dispenser buttons when that dispenser is calling or is completed. When defined, this thread aborts and does not run.

InitTouchScreen: Routine that initializes the keyboard thread. When defined, suppresses setting up the gasbank keypres array.

get_sale_data: Routine retrieves the sale data structure from the LSC. When defined, this routine aborts and does not run.

shift_meters_rpt: Routine that pulls the dispensers meters file from the LSC and prints a report. When defined, this routine aborts and does not run.

meters_rpt: See shift_meters_report above.

FORCE_CASHIER_CLOCK

When defined, forces a cashier who is not clocked in to do so before being allowed to logon to a register. This modification added for TA.

Used in functions:

cashier: A routine that logs cashiers on and off the register. When defined, will not allow a cashier logon unless his corresponding employee record indicates that he has clocked in on the time clock.

FORCE_DROP

FORCE_DROP=nn,aaa.aa where: nn is the number of warnings before forcing the cashier to drop. aaa.aa is the amount to display in the force drop message Example, set FORCE_DROP=10,200.00 Force a drop after informing the cashier ten times to drop two hundred dollars.

Used in functions:

DrawerLimitOK: Routine that checks cash in drawer and returns true if the amount is less than max limit. When defined, contains two data fields, delimited by a comma. The first field is an integer specifying the maximum number of times to warn the cashier to make a safe drop. The second field specifies the minimum amount for which to prompt the cashier to drop.

FORCE_PRICES

Used in functions:

ok_to_load_prices: Routine that checks all dispenser status before allowing a download of prices to the LSC and hence to the dispensers. When defined, forces a fuel price download to the LSC even when other wise would not be allowed.

FORCE_PRINT

When defined, will force a receipt to print when one would not otherwise print. Used in conjunction with forcing a credit card voucher to print.

Used in functions:

force_print: Routine that returns status of FORCE_PRINT: returns true if defined, and false if not defined. When defined, forces a receipt print when receipt printing is turned off. Used for credit card invoices

FORCEAGE

When defined, will force an acceptance of any value entered into the “age” dialog that is presented when a restricted product (ALCOLHOL OR TOBACCO) is sold.

Used in functions:

force_age: Routine that returns status of FORCEAGE: returns true if defined and false if not defined. When defined, allows the cashier to bypass age verification on age restricted products.

FORCEEOD

Effective as of version 09.01.00: Forces an EOD Z if none has been performed prior to 0045 each day.

FPCS

When defined forces pre edit inquiry to CCL for non-truck fleet use of fiscal proprietary cards.

FPCSFQDN

When defined specifies the IP address and path to the FPCS server. Example: 192.168.5.11/fpcs.cgi/fpcs

FPCSMERCHANTCHAIN

When defined specifies the merchant for whom FPCS processing will be performed. Example: cft/store0001

FPCSPORT

When defined denotes the TCP/IP port number used when connecting to the FPCS server.

FRACTIONALQUANT

When defined, allows entry of a fractional quantity for an item. As an addendum, if ANY parameter is entered for the quantity function it will be set to a quantity of ONE.

Used in function:

set_cursal: Routine that sets all the values of the current item in a sale for recording into possale.

GASLOG

ANY OF “0123” When defined, this sets the “mode” of the gaslog report printed at Z time on the master POS: The values are defined as follows: 0) No report, 1) summary, 2) outside sales, 3) detail.

Used in functions:

gaslog_mode: Routine that returns status of GASLOG: The values are defined as follows: 0) No report, 1) summary, 2) outside sales, 3) detail.

GETPREPAYFUELTYPE

Used in functions:

hose_prepay: Routine that pre-authorizes a dispenser for a designated amount, and registers that amount to a pre-pay department. When defined, the cashier is prompted to choose a fuel product from a list in a dialog box.

pr_prepay: Routine that prints the pre-pay receipt. When defined, the designated product is used to retrieve a fuel product description from the GASPROD file on the LSC.

HEXDUMPFILE

When defined and containing a filename, its incoming data packets from the LSC will be hex dumped to pch.dat.

HOUSEKEEPINGINTERVAL

HOUSEKEEPING_INTERVAL=43200 - This example would check the log file size every 12 hours and renames the Poslog.dat to Poslog.save once it gets close to or above the 20MB limit set in this example.

Used in functions:

HouseKeeping: routine to clean up the poslog.dat file from time to time.

HUSKYFLEET

Used in functions:

FindCTSRCustomer: Routine that uses a card pan to find a FDIS customer in the comdata database. When defined, provides a Fleet number to be used in conjunction with a Husky Fleet customer account number to build a credit card pan. When not defined, default value used is "000182"

IBM

When defined, this denotes that an IBM SurePos is in use by the system, and that special handling for the magstripe reader is in use. This was done because IBM magstripe readers insert a carriage return character between tracks one and two, causing our software to prematurely exit a card swipe dialog box. Used in functions:

CCreditCardScan::OnChangeEdit1: Routine that is called whenever the edit box in the input credit card dialog sees a change to its content. When defined, the routine checks for the letter 'E' in the incoming data (which indicates a bad card scan from an IBM supplied MSR.)

CGetData::OnChangeData: SEE CCreditCardScan::OnChangeEdit1

interrogate_drawer_sensor: routine that sends a message to the printer to get the status of the cash drawer sensor, and returns that status to the caller. When defined as a '2' the routine knows it is interrogating an IBM cash drawer.

IFSFVER

Used in functions:

CBPBatchProcess::HandleReconciliation: Routine in BP batch interface dialog that handles doing a batch with reconciliation. When defined, determines the IFSF XML version number to use in formatting XML messages to the EPS.

CBPBatchProcess::HandleOffline: Routine in the BP batch interface dialog that does offline operations. When defined, determines the IFSF XML version number to use in formatting XML messages to the EPS.

CBPDiagnosis::OnOK: Routine in the BP diagnosis dialog that executes the designated operation. When defined, determines the IFSF XML version number to use in formatting XML messages to the EPS.

BuildLogin: Routine that constructs a login message data object. When defined, determines the IFSF XML version number to use in formatting XML messages to the EPS.

BuildLogoff: Routine that constructs a logoff message data object. When defined, determines the IFSF XML version number to use in formatting XML messages to the EPS.

DoBPCardReaderStatus: Routine that sends a card reader status change request to the EPS. When defined, determines the IFSF XML version number to use in formatting XML messages to the EPS.

BuildDataRequest: Routine to build a data request message to send to BP EPS. When defined, determines the IFSF XML version number to use in formatting XML messages to the EPS.

HandleBPRebootReportage: Routine that sends a message when the register restarts after an abnormal shutdown (thereby constituting a "reboot").

INACTIVITY_INTERVAL

Time limit before the Cashier is logged out automatically. Max value is 15 minutes (INACTIVITY_INTERVAL=15).

INDIANDIESELSALESTAX

Used to implement a special diesel fuel sales tax for selling locations in the state of Indiana.

JOENTERPRISES

When defined, causes the “ACCEPT” caption on the ACCEPT button in the truck fleet dialog to display the string “PRE ACCEPT”. This is used only in conjunction with JO Enterprises installations.

Used in functions:

CTftmain::OnDrawItem: Routine that renders owner drawn buttons in the new truck fleet transaction dialog. When defined, Replaces the “Accept” button on the truck fleet transaction with a button labeled “Pre-Accept”. Function of the button does not change.

KEYLOG

Used in functions:

get_key: Routine that runs the main POS idle loop. When defined, donotes that all buttons pressed will be logged to poslog.dat

KEYOPTIMEOUT

Used in functions:

AESKeyManager::KeyOp: Routine that performs a requested encryption key operation. When defined, Sets the timeout on encryption key communications operations.

KITCHEN_EJECT_SIZE

When defined, denotes the number of lines ejected from a kitchen printer after the receipt has been printed.

Used in functions:

set_environment: A routine that is called during initialization to read in the contents of the travstar.ini file. When defined, sets the number of lines of paper ejected from the kitchen printer after a receipt has been printed.

KITCHPRNTNAME

When defined, and a parallel kitchen printer is used, this denotes its defined name in the WIN2000 operating system.

Used in functions:

FindKitchenPrinter: Routine that finds the windows printer used to print kitchen receipts. When defined, contains the name of a windows printer used as the kitchen printer for deli registers.

KYBDLOGDAT

Used in functions:

ReportKey: Routine that reports keystrokes to the poslog.dat file and the named output file. When defined, denotes the name of an additional output file for logged keystrokes.

LOCAL_AUTH

This will cause proprietary fleet cards to post to House Accounts in the MWS2.

Used in functions:

do_bailey_fleet: Routine called to handle processing proprietary Bailey cards. When defined, does the credit processing through the local customer file rather than submitting the request to the CCL.

do_aloha_fleet: Routine to handle processing proprietary Aloha cards. When defined, does the credit processing through the local customer file rather than submitting the request to the CCL.

do_flynns_fleet: Routine called to handle processing proprietary Flynns cards. hen defined, does the credit processing through the local customer file rather than submitting the request to the CCL.

update_outside_fleet: Routine that logs outside proprietary card transactions to the MWS. When not defined, this routine aborts and does not run.

LONGRECEIPT

When defined, all network tendered sales will print "long receipts" (all sales items present on both the customer and merchant receipts). This is an extension of receipt printing logic that was originally done for URC. If URC is defined, it is not necessary to define "LONGRECEIPT" to see "long receipt" printing occur for network tendered sales.

LOTTERYCREDIT

When defined, This allows sales containing Lottery products to be tendered with Credit Cards.

Used in functions:

do_ctender: routine that processes vetting the details of a network tender against various qualifying criteria. When defined, if any portion of the current transaction is for lottery products, then the tender is rejected.

tender: Routine that handles network sale tenders. When defined in conjuction with the BP environmental variable, if any portion of the current transaction is for lottery products, then the tender is rejected.

LOTTERYDEPT

This denotes a the department used with lottery products.

Used in functions:

process_plu: A routine that processes the registration of an item. When defined, denotes the department ID of department used to register lottery item purchases. If the current item's department ID matches, then the amount charged for the item is added to a sale environment variable to designate the total amount of the sale attributable to lottery products.

deptlookup: A routine that processes the registration of an open department sale item. When defined, denotes the department ID of department used to register lottery item purchases. If the current item's department ID matches, then the amount charged for the item is added to a sale environment variable to designate the total amount of the sale attributable to lottery products.

LPEIP

When defined denotes the IP address of a Retalix LPE device on the local network.

LPEPORT

When defined denotes the PORT upon which to connect to a Retalix LPE device on the local network for sending transaction messages.

LPETIMEOUT

When defined denotes the timeout used when attempting to connect to a Retalix LPE device on the local network.

MAINXMLIP

When defined designates the primary xml receipt data server IP address. If this value is NOT defined, then no attempt to contact the transport service routine will be made.

MANAGER_PASSWD

When set the manager must enter their cashier code followed by their password. For instance they would enter 1231234 when their cashier code is 123 and their password is 1234. This setting ignores the Managers password set in the POS Setup!

Used in functions:

manager_ovr: Routine that sets manager overide status if proper ID is provided. When defined, forces entry of a cashier ID and password in order to be granted manager override authority. The resulting found cashier record is checked for the presence of the manager authority flag and the m_overide variable is set accordingly.

MANUALFALLBACKCARDS

MANUALFALLBACKCARDS When defined contains a list of card types designating what credit cards will be submitted for fall back processing when an approval has been manutally entered by a cashier. Default list is: AMVDYWGFEZ

MANUALFUEL

MANUALFUEL=700 = will set the manual fuel plu to begin at 700 instead of the standard fuel plu which starts at 100. Plu's for each fuel must be setup the same as the items normally setup starting at 100.The truck fleet receipt will show nn** where nn is the dispenser number for manually entered fuel.

Used in functions:

convert_unrung_fuel: routine to ring up truck fleet transactions that were started at the fuel desk but never rung up.

MANUALTFT

When defined, this turns on the manual fuel feature of the truck fleet dialog. Furthermore, if defined as “GALLONS”, it allows the user to enter gallons pumped and the ppu for the fuel selected, and the box then calculates the total dollar amount of the fuel sale. If defined as “DOLLARS”, it allows the user to enter the total dollar amount of the sale and the fuel ppu and it then calculates the resulting volume of fuel pumped.

Used in functions:

CTftmain::OnInitDialog: A routine that initializes the new truck fleet transaction dialog. When defined causes the manual fuel and manual reefer buttons to appear in the dialog.

CManualTFFuel::OnInitDialog: Routine that initializes the manual fuel entry dialog box. When defined, denotes whether fuel gallons or fuel dollar pumped will be entered in the dialog.

CManualTFFuel::OnKillfocusPrice: Routine that re-calculates either the gallons or dollars designated in the dialog. When defined, designates recalculation of the gallons or dollars set in the dialog.

MASTER_POS_IP

IP address of the master pos. This is used by all other POS and OPT units so that they can communicate with the fiscal file server.

Used in functions:

CCTSRPicker::OnInitDialog: Routine that initializes a dialog box used for selecting CTSR customer records. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

CDeliSelect::OnInitDialog: Routine that initializes a dialog box used to select deli transaction for sale resumption. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

CDispTftTrans::OnInitDialog: Routine that initializes the truck stop transaction selection dialog (commonly referred to as "pending fleet". When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

CDispTftTrans::HandleDirectBill: Routine that handles opening and reading direct bill transaction files for the purpose of submitting them for processing when necessary. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

CFleetData::OnInitDialog: Routine that initializes a dialog for picking out FDIS fleet customers. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

close_print80: Routine to close the 80 column printer when printing of a truck fleet transaction completes. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

GetBaileyOdometer: Routine to retrieve from the pinpad.dat file an indicator of whether or not to prompt for odometer. Default return is to NOT ask for odometer. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

CQueryTFReceipt::OnOK: Routine that handles retrieving a selected receipt file from the master pos for printing. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

CQueryTFReceipt::OnSearch: Routine that submits a search message to the ffserver on the master pos. hen defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

ProcessCTSRSingle: Routine processes a single CTSR transaction. function is called after a successful transaction is processed by local_approval and is found to have a direct bill component. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

TFReceiptThread: Routine to send truck fleet receipts to master pos. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

SaveTFTransactionData: outine that preserves truck fleet transaction data in a "void data file" for use in electronic voiding of the transaction if desired. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

CVoidTrans::OnOK: Routine that handles retrieving and voiding a transaction selecting in the void truck fleet transaction dialog box. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

CVoidTrans::OnInitDialog: Routine that initializes the void truck fleet transaction dialog box. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

GetTFTCAuth: Routine to retrieve the saved TF cauth structure from the master pos when a postauth of a TF transaction is done from a register. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

transmit_sale_total: Routine to send sale data for a deli register sale to the master pos ffserver. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

load_sale_info: Routine to retrieve sale data from a completed deli register sale from the master pos. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

LoadOffRoadTaxes: Routine loads off road tax file for non masterpos registers. When defined, contains the IP address of the master pos which is then used to connect to the ffserver on the master pos.

MASTERPOS

When defined, denotes that this register is the “master” POS.

Used in functions:

CCTSRPicker::OnInitDialog: Routine that initializes a dialog box used for selecting CTSR customer records. When NOT defined, the routine retrieves the listing of void data from the master pos. Otherwise, the files are read directly from the hard disk drive.

CDispTftTrans::OnInitDialog: Routine that initializes the truck stop transaction selection dialog (commonly referred to as "pending fleet". When NOT defined, causes a search for CTSR transaction files on the master pos for inclusion in the display; otherwise the search on the local hard drive.

CDispTftTrans::HandleDirectBill: Routine that handles opening and reading direct bill transaction files for the purpose of submitting them for processing when necessary. When NOT defined, retrieves a CTSR transaction file from the master pos for processing; otherwise the file is retrieved from the local hard disk drive.

GUIDisplayGenStatus: Routine that outputs all status information onto the main status display are of the main screen. When defined, displays ffserver online status.

close_print80: Routine to close the 80 column printer when printing of a truck fleet transaction completes. When not defined sends the newly created truck fleet transaction receipt file to the master pos.

GetBaileyOdometer: Routine to retrieve from the pinpad.dat file an indicator of whether or not to prompt for odometer. Default return is to NOT ask for odometer. When not defined, retrieves the file from the master pos.

CQueryTFReceipt::OnOK: Routine that handles retrieving a selected receipt file from the master pos for printing. When not defined, the file is retrieved from the master pos, otherwise, it is read from the local hard disk drive.

ProcessCTSRSingle: Routine processes a single CTSR transaction. function is called after a successful transaction is processed by local_approval and is found to have a direct bill component. When not defined, the resulting void data file is sent to the master pos. Otherwise, it is simply written to the local hard disk drive.

DeleteTempFiles: Routine that periodically deletes out of data temporary files from the register hard disk drive. When defined, handles deleting print file data from the receipt lookup database as well as the file itself.

TFReceiptThread: Routine to send truck fleet receipts to master pos. When defined, this routine is aborted.

CTravStarApp::InitInstance: Routine that initializes the POS application. When not defined, the application opens and then closes the purchpol database. This causes that file to update itself with the latest records from the master pos.

SaveTFTransactionData: Routine that preserves truck fleet transaction data in a "void data file" for use in electronic voiding of the transaction if desired. When not defined, the "void data file" is transmitted to the master pos via the ffserver.

GetTFTCAuth: Routine to retrieve the saved TF cauth structure from the master pos when a postauth of a TF transaction is done from a register. When defined, the file is read from the local hard disk drive instead of being retrieved from the master pos.

transmit_sale_total: Routine to send sale data for a deli register sale to the master pos ffserver. When defined, the file is written directly to the local hard disk drive. (It is unlikely that the master pos would be designated as a deli register.)

load_sale_info: Routine to retrieve sale data from a completed deli register sale from the master pos. When defined, the file is merely read directly from the local hard disk drive. (It is unlikely that the master pos would be designated as a deli register.)

ReprintBatch: Routine to reprint the credit card batch for a specified reset. When NOT defined, the routine is aborted.

zreports: A routine that performs an end of shift / end of day Z operation. When defined

in conjunction with CITGONETWORK, an end of shift report is sent to the CCL.

in conjunction with CITGONETWORK, a PDL refresh request is sent to the CCL.

in conjunction with CTSR, updated CTSR database files are retrieved from the CTSR server.

do_reports: Routine that executes designated 'X' or the 'Z' report. When defined,

in conjunction with LITTLE_AMERICA does a gas end of shift

processes outside fuel end of day.

processes truck fleet fuel reports

UpdateEODInformation: Routine to update the end of day database. When NOT defined, writes a copy of that data to the master pos.

LoadEODDef: Routine to load end-of-day database into memory. When defined, loads eod data for all other registers on the local LAN.

CheckOtherRegisters: Routine that checks eod status of all other registers on the LAN. If NOT defined, this routine aborts.

meters_rpt: Routine that pulls the dispensers meters file from the LSC and prints a report. When NOT defined, aborts this routine.

get_key: Routine that runs the main POS idle loop. When:

NOT defined, sweeps up untransmitted truck fleet receipt files and sends them to the master pos.

defined, prints smart fuel and alpha crind receipts.

gas_cmd: A routine that displays a menu of commands related to fuel dispensation. When defined:

allows the master pos to send a set time command to the LSC.

allows the master pos to send new pricing data to the LSC.

allows the master pos to send new executable code and re-start the LSC (new code must be on a floppy disk in the A: drive)

allows the master pos to send new configuration files to the LSC. (gasdata,gasprod,gasparm,gasblend,gasprice)

dopos: A routine that houses the main application loop. When defined:

the msater pos retrieves CTSR data files from comdata at start up.

the master pos sends off-road diesel tax data to the CCL at start up.

the master pos writes off-road diesel tax data to the hard disk drive so that it may be accessed by OPT units at start up.

the master pos sends a heartbeat message to the ffserver at start up.

chk_comm: A routine that handles background communications messages from the MWS. When defined, allows a command from the MWS to reset the system time on the LSC.

snd_media: A routine called during Z processing that sends all media end-of-day records to the MWS. When defined, also sends media records from the OPT, smartfuel, and alpha crind units.

upload_map_data: Routine that performs a network tender batch operation on the CCL. When defind, if the LITTLE_AMERICA envvar is also defined, forces an outside credit card batch to also be performed.

settle_batch: A routine that sends a command to the CCL to settle credit card batches. When defined, forces the upload of all batch print files from the CCL.

do_fuel_prices: A routine that puts up a fuel price change dialog. When not defined, puts up an error message: "Function not available" and aborts.

dos_gas_online: A routine that checks to see if the LSC is online by sending a LINKSTATUS packet to the LSC. When defined, if it has not yet been sent, sends a MASTERPOS packet to the LSC to inform it that it is the master pos. This only happens at startup, or if the LSC has gone offline.

DoLinkStatus: A routine to send a LINKSTATUS packet to the LSC. When defined, if it has not yet been sent, sends a MASTERPOS packet to the LSC to inform it that it is the master pos. This only happens at startup, or if the LSC has gone offline.

ServerThread: A routine that runs as a thread to manage response messages from the LSC and CCL. When defined:

When defined, if it has not yet been sent, sends a MASTERPOS packet to the LSC to inform it that it is the master pos. This only happens at startup, or if the LSC has gone offline.

CCL_online: Routine that determines whether or not the POS is online with the CCL. When defined, also sends a heart beat message to FFS.

MAX_SVC_AMOUNT

Dollar Amount (500.00) has been implemented to put a cap on both SVC activation and recharge.

Used in functions:

check_svc_max: A routine to see if an amount is less than the maximum amount that may be assigned to a SVC as an initialization or re-charge. When defined, denotes the maximum amount that be used, else any amount is acceptable.

StoredValueCard: A routine that deals with various stored value card operations. When defined, denotes the maximum amount that be used, else any amount is acceptable.

MAXCASHBACK

Used in functions:

do_ctender: routine that processes vetting the details of a network tender against various qualifying criteria. When defined, denotes the maximum amount of cash that may be given back dujring a debit transaction.

MAXCBCAMOUNT

Used in functions:

ChangeBackCode: A routine that gets the Amount associated with the Change Back Code. Return 0.00 if not valid. When defined, provides sanity check limit for a cash acceptor refund to a user set limit or 999.99 if not set.

MAXLOGSIZE

MAXLOGSIZE=20971520 - This example would be for 20MB limit (1024 x 1024) x 20. This represents the maximum size that the poslog.dat file attains before it is moved to poslog.save and a new file begins.

Used in functions:

HouseKeeping: routine that cleans up the poslog.dat file from time to time.

MAXPPU

Used to define the maximum fuel price / unit.

Used in functions:

CGasPrice::OnInitDialog: A routine that initializes the gas price change dialog. When defined, denotes the maximum PPU that may be set for any grade of fuel, else a maximum of 5.00 is assumed.

MEMDEBUG

When defined will cause POS out debug messages when ShutdownApplication runs as the register is shut down.

METROSPLASH

When defined, enables processing of MetroSplash FuelLinks loyalty cards. Definition MUST contain a valid UUID for the site. UUID numbers are assigned by MetroSplash.

MINDEBITAMOUNT

Used to define the minimum debit transaction that will be processed without adding a cash back amount.

MINPPU

Used to define the minimum fuel price / unit.

Used in functions:

CGasPrice::OnInitDialog: A routine that initializes the gas price change dialog. When defined, denotes the minimum PPU that may be set for any grade of fuel, else a miniimum of 1.00 is assumed.

MSDEBUG

When defined causes all Metrosplash request and reply XML to be hex-dumped to pch.dat

MSFQDN

Used to define the fully qualified domain name for connecting to the metrosplash web server for processing of FuelLinks cards.

Used in function:

MSSendRequest: A routine that sends a fully formed XML request message to the metrosplash web server, and returns an xmlDocPtr containing the parsed reply.

MSNO_POINTS_AWARD

When defined, prevents awarding FuelLinks points at all, and prevents prompting for a MetroSplash card in tender routines when there is no fuel associated with the sale.

MSPATH

Used to define the data path when submitting FuelLinks cards for processing to the metrosplash web server.

Used in function:

MSSendRequest: A routine that sends a fully formed XML request message to the metrosplash web server, and returns an xmlDocPtr containing the parsed reply.

MSPORT

Used to define the port for connecting to the metrosplash web server for processing of FuelLinks cards.

Used in function:

MSSendRequest: A routine that sends a fully formed XML request message to the metrosplash web server, and returns an xmlDocPtr containing the parsed reply.

MSRESTALCOHOL

When defined, reporting of alcoholic beverage purchases to MetroSplash will contain the default department designation of "480" regardless of how dgroup.dat is set up.

MSRESTTOBACCO

When defined, reporting of tobacco purchases to MetroSplash will contain the default department designation of "410" regardless of how dgroup.dat is set up.

MWSMSGTIMEOUT

Used in functions:

sndreq: A routine that sends a request to the MWS. When defined, denotes the length of time (in milliseconds) before a request times out. This was institued to deal with sites whose LAN latency varies greatly.

MXDEVICEPORT

When defined contains the communications port to be used by the Mx860 POP device. For example MXDEVICEPORT=COM9 would appear in the travstar.ini file.

NEWPLUDEPT

When defined, this denotes the department number to be used when a cashier sets up a new plu at the register. If this is not defined, the system defaults to “888” as the department number for newly setup plus.

Used in functions:

do_openplu: A routine that allows the cashier to set up a new PLU when an item is scanned and is not found in the PLU file. When defined, denotes a department ID to which to assign the new PLU. If not found, this defaults to "888".

NO_DRAWER_SENSOR

When defined, causes the drawer_open function to return a false value, thus preventing the “cannot operate with drawer open” message from appearing when there is no drawer sensor to be read. Since our default operation mode for cash drawers precludes sensors, this should be set if the customer sets the “operate with drawer open” flag to false.

Used in functions:

drawer_open: A routine that returns true if the cash drawer sensor indicates that it is open. When defined, causes this routine to always return false.

NO_EMAIL

Used in functions:

ServerThread: A routine that runs as a thread to manage response messages from the LSC and CCL. When defined, causes error messages arriving from the LSC or CCL to written to poslog.dat instead of putting up a dialog box containing a listing of such messages for review by the cashier.

NOANIMATION

When set, this turns off the gas key status image animation.

Used in functions:

PosButton::setgas: Routine sets current dispenser states. When defined, animation of dispenser state images are not animated when the designated dispenser is calling or complete.

NOBANKCARDPREEDIT

When defined, bank cards will not be allowed for truck fleet pre-edit/pre-auth transactions.

NOCASHLOGOUT

When defined, overrides cashier inactivity logout feature, for SINCLAIR selling locations. Added to 09.01.01-33A

NOCDMC

The NOCDMC variable will tell the POS to always treat the Comdata Master Card as a standard Master Card.

Used in functions:

set_comdata_fleet_mastercardtype: a routine that sets the card type for a Comdata Fleet Master card to 'M' for master card when defined. If not defined, then if there is a tender defined with a description that starts with "COMDATA" then, the card type assigned to a Comdat Fleet Master will be 'c' which results in that card being processed directly by Comdata instead of another FEP such as Buypass or ADS.

NOCLERKAUTH

When defined allows a blind authorization of a dispenser.

Used in functions:

authorize: a routine that performs a non-pre-authorized authorization of a dispenser without a clerk logged on.

NOCRINDS

When defined, the master pos will NOT try to retrieve $cmedia.dat from the CCL for processing.

NODEBITPREEDIT

When defined, debit cards will not be allowed in truck fleet pre-edit transactions

NOEODOFFLINE

If the register is offline and a cashier tries to “Z” the register, the system will display a message and not allow the EOD to proceed.

Used in functions:

zreports: Entry point routine for running a Z report. When defined, aborts routine if the MWS is not on line when invoked.

NOERRORPRINT

When defined, prevents a “failed” truck fleet receipt from printing when a post auth fails.

Used in functions:

resume_cc_susp: Routine that is called when a network tender authorization request reply comes in from the CCL. When defined, prevents printing of 80 column "Failed transaction receipt" when a truck fleet transaction tender is rejected.

NOFILLUP

Used to avoid auto pump auth requested by FMI, but not TA. Added to 09.01.01-18A

NOFINANCIALADVICERECEIPT

Used in functions:

reprint_creceipt: A routine that prints a receipt file. When defined, prevents printing a financial advice receipt

NOFUELPRODAUTHREST

When defined causes the POS to always send fuel authorization commands using the smaller structure size.

NOLOG_TFT

When defined, this denotes that a truck fleet transaction is NOT to be logged into the electronic journal. Default (undefined) behavior is that the truck fleet data IS logged into the electronic journal.

Used in functions:

print_tft: Routine that prints an 80 column truck fleet transaction receipt. When defined, prevents logging of the truck fleet data used to generate the receipt.

NOMETERS

Used in functions:

do_reports: Routine that executes designated 'X' or the 'Z' report. When defined, precludes printing of a fuel meters report when an EOD Z is executed.

DoTruckFleetReports: Routine called during an EOD Z that reports on truck fleet transaction data. When defined, precludes printing of a fuel meters report.

NOMXSTVC

When defined prevents use of an Mx860 device for scanning STV cards for activation or reload.

NONBANKCARDS

When defined contains a list of card types which will be added to the standard list used by the function VerifyBankCardISO when deciding what cards should be encrypted and/or obfuscated. Adding a card type to this list will insure that card data from that type of card WILL NOT BE ENCRYPTED AND/OR OBFUCATED.

NOPREAUTHRECEIPT

Used in functions:

reprint_creceipt: A routine that prints a receipt file. When defined, prevents printing a fuel pre-authorization receipt.

NOREEFERSALESTAX

When defined, prevents assessing sales tax on discounted off road diesel fuel (typically reefer fuel). In addition, it is incumbent upon setup personnel to insure that the PLU which accounts for the discounts and is linked to the diesel fuel PLU be NON-TAXABLE for this to work properly.

NOT_DOING_FUEL

When defined, will prevent the master POS from doing any outside fuel accounting.

Used in functions:

do_reports: Routine that executes designated 'X' or the 'Z' report. When defined, precludes running all fuel related end of day functions.

NOTF

When defined, the master POS will not do any truck fleet fuel reporting.

Used in functions:

DoTruckFleetReports: Routine called during an EOD Z that reports on truck fleet transaction data. When defined, no truck fleet fuel sales reporting is done at EOD Z time.

NOTFVOUCHER

Used in functions:

pr_voucher: A routine that formats a credit card voucher when a sale is tendered to a network tender. When defined, prevents printing of a small credit card voucher when truck fleet transactions are tendered.

end_sale: A routine that finishes a sale following a successful tender that satisfies the total amount due on that sale. When defined, prevents printing of a small credit card voucher when truck fleet transactions are tendered.

BPPrVoucher: See pr_voucher above.

NOTRUCKLOYALTY

When defined, prevents prompting for a loyalty card when the TF dialog is "RUNG" out. Does NOT inhibit processing a loyalty card if one was entered into the TF dialog.

NOUPDATEGAS

When defined, this prevents the saving of fuel information from the sitecontroller at gas EOS.

Used in functions:

save_gas: Routine that saves gas data in isam file. When defined, this function aborts and does not run.

NOVOYAGERPIN

Will not print driver id on receipts for Voyager cards if in INI file.

Used in functions:

pr_fleet_data: routine to print parameters entered by driver from the pin pad on receipts.

NOXOUT

Used in functions:

XoutBankCard: Routine that truncates bank card pans. When defined, card pans are not truncated.

OFFROADDISCOUNT

When defined causes the MPOS to process off road discounted and sales taxed reefer fuel.

Used in functions:

print_PT_media: Routine that prints and logs media data from the SFT and OPT terminals

ONSCREENKEYBOARD

Used in functions:

GUIDoNumpad: Routine that displays a numeric keyboard on the screen. When defined, displays a full alpha-numeric keyboard.

GetXD: Routine that displays a dialog box to get an expiration date. When defined, displays a full alpha-numeric keyboard.

GetData: Routine that displays a generic dialog box, getting data input from cashier if necessary. When defined, displays a full alpha-numeric keyboard.

GetCardData: Routine that gets a credit card number via magstripe. When manual entry is detected, and this is defined, a full alpha-numberic keyboard is displayed.

OSGAS

When defined, denotes the starting plu number for outside (CRIND) gas sales.

Used in functions:

set_osgas_plu: Routine that returns a PLU number into which to register outside fuel sales. When defined, denotes that PLU number. Defaults to "0000000110" .

OUTSIDE_EOD

Used in functions:

do_reports: Routine that executes designated 'X' or the 'Z' report. When defined, a fuel end-of-day procedure is run on the master pos at Z time.

PERMITMAXLENGTH

When defined, denotes the maximum length of a weight permit number entered for a sales tax exemption discount.

PERMITTAXDISCOUNT

When defined, denotes the per gallon discount given on diesel fuel to eligible truckers when a weight permit number is entered by the trucker in the truck fleet dialog. Amount calculation will assume three decimal places if no decimal is found in defintion.

PETCANFLEET

Used in functions:

FindCTSRCustomer: Routine that uses a card pan to find a FDIS customer in the comdata database. When defined, provides a Fleet number to be used in conjunction with a Petro-Canada Fleet customer account number to build a credit card pan. Default value is "000178".

PETRO_LOYALTY

Used in functions:

CTftmain::OnRingsale: Callback Routine in the new truck fleet transaction dialog that is run when the "RING" button is pressed. When defined, precludes Schneider drivers from using loyalty cards at PETRO sites.

PIOCATS

Used in functions:

paidout: Routine to allow the cashier to pay a vend out of the cash drawer. When defined, present a list of pio categories that will be inserted into the reference field included in the piolog entries.

paidin: Routine to allow cashier to receive payments from vendors into the cashier drawer. When defined, present a list of pio categories that will be inserted into the reference field included in the piolog entries.

PLAYSOUND

When defined, denotes that wave files will be played through the POS sound card to denote a pump that is calling or complete. Default behavior is beeps played through the POS speaker, which often has inadequate volume.

Used in functions:

CallProc: Routine that plays a sound when a dispenser status indicates that it is calling, or has gone complete and needs payment. When defined, the POS will play special sound files instead of using the standard Windows beep sound.

PLRETAILERNAME

When defined denotes the PILOT loyalty Retailer Name used when interfacing with a Retalix LPE device on the local network.

PLSTORENAME

When defined denotes the PILOT loyalty Store Name used when interfacing with a Retalix LPE device on the local network.

PLWATCHDOGDELAY

When defined denotes the time interval in milliseconds between watch dog messages sent to a Retalix LPE device on the local network.

PLWATCHDOGPORT

When defined denotes the port upon which to connect to a Retalix LPE device for sending and receiving watchdog messages.

PLWATCHDOGTIMEOUT

When defined denotes timeout in milliseconds for watch dog send and receive messages to a Retalix LPE device on the local network.

POINTSVALUE

Used in functions:

SetLoyaltyInformation: A routine that formats loyalty points data for a transaction. When defined, this contains (For Points to Partners loyalty program) a points value multiplier value used to determine the total points to award for items purchased in the transaction.

POLETYPE

When defined, denotes a pole configuration using a serial cable connection between the POS and the pole display, in which a second serial cable connects the pole display to the pole printer.

POPID

Used in various BP functions to populate the point-of-purchase device ID value in message XML sent to the BP EPS.

POSIP

When defined, denotes the IP address of a LINUX site controller.

Used in functions:

authorize: Routine that authorizes a dispenser for a specified amount. When defined and the parameter for the button was AUTHALL, all dispensers will be authorized for an unlimited amount.

set_server_port: Routine that initializes communications between the LSC, and POS. When defined, contsins the TCP/IP address of the computer upon which running the LSC and causes a port setup to be done for the LSC.

POSPORT

When defined, denotes the TCP/IP port number of the Linux sitecontroller.

Used in functions:

set_server_port: Routine that initializes communications between the LSC, and POS. When defined, contains the TCP/IP port number upon which running the LSC and causes a port object setup to be done for the LSC.

PP

When defined, denotes pin pad type in use. Two pin pad types are supported: D = DUKPT and M = MASTERSESSION

Used in functions:

pp_type: Routine that returns the type of pinpad in use. When defined, designates the pinpad type in use. Defaults to 'D' for DUKPT (Derived Unique Key Per Transaction).

PRE_EDIT

When defined denotes that the fuel desk portion of the POS is doing pre-edit, pre-auth, post-auth type transactions.

Used in functions:

CTftmain::OnQuit: callback routine for the "ACCEPT" button in the truck fleet dialog.

CTftmain::OnInitDialog: truck fleet dialog initialization routine.

CTftmain::GetMedia: callback routien for the "PYMNT TYPE" button.

CTftmain::OnSetfocusCompany: callback routine for the company edit box on the truck fleet dialog

CTftmain::DoData: routine that populates all edit boxes in the truck fleet dialog.

my_fleet_data: entry point for display of the truck fleet dialog.

CTftmain::OnSetfocusDispensers: routine that displays all edits if this list box gains focus (is clicked on).

CTravStarApp::InitInstance: application initialization routine for the entire POS program.

PREAUTH

Used in functions:

PrepayThread: A routine that processes fuel prepay completions. When defined denotes that this site does fuel preauth transactions from the POS handles pre-authorization financial advice receipts.

local_cauth: Routine that does low level formatting of a credit authorization request for the CCL. When defined, the routine checks to make sure a split tender is not occuring for a fuel pre-authorization.

host_udcauth: Routine that sends dispenser authorization requests to the LSC. When defined, does special formatting to indicate that the authorization requested is for a network tendered pre-authorization.

do_ctender: routine that processes vetting the details of a network tender against various qualifying criteria. When defined, the routine checks to make sure a split tender is not occuring for a fuel pre-authorization.

hose_prepay: Routine that pre-authorizes a dispenser for a designated amount, and registers that amount to a pre-pay department. When defined, denotes a default amount to use when prepaying a dispenser if no amount is entered at the keyboard by the cashier.

PREAUTHVOUCHERTEXTFILE

Used in functions:

pr_voucher: A routine that formats a credit card voucher when a sale is tendered to a network tender. When defined denotes the name of a text file containing verbage to be printed on a fuel pre-authorization voucher upon completion of the transaction.

PREPAY_DEPT

When defined, this denotes the department number to be used for fuel prepays in place of the department listed in the prepay key definition.

Used in functions:

BuildEvalArray: Routine that builds an array of sale items to be sent to BP EPS when a fuel preauthorization card request is indicated. When defined, contains the department code to which fuel prepays are registered.

HandleRestrictionCodes: Routine that evaluates a BP fuel preauthorization request reply for restricted items in the sale. When defined, contains the department code to which fuel prepays are registered.

BPUpdateDept: BP version of update_dept. When defined, contains the department code to which fuel prepays are registered.

pricecng: Routine that sets a flag so that the price entered at the keyboard is used on the next itme registered. When defined, cntains the department code to which fuel prepays are registered, an compares that to the department ID of this next registered item. If they match the price change is not allowed.

hose_prepay: Routine that pre-authorizes a dispenser for a designated amount, and registers that amount to a pre-pay department. When defined Contains the department code to which fuel prepays are registered.

convert_prepay: Routine that takes sale data from a completed sale, and registers the dollars and gallons to the appropriate department and plu numbers. When defined contains the department code to which fuel prepays are registered.

PREPAY_PLU

When defined, this denotes the prepay fuel base plu number, in place of the plu number listed in the prepay key definition.

Used in functions:

FuelUPCCode: Routine used in BP fuel preauthorization card payment requests that returns a UPC code to use for prepaid fuel registration. When defined contains the plu code to which fuel prepays are registered.

BuildFASaleArray: Routine used in BP fuel financial advice message. When defined contains the plu code to which fuel prepays are registered.

hose_prepay: Routine that pre-authorizes a dispenser for a designated amount, and registers that amount to a pre-pay department. When defined contains the plu code to which fuel prepays are registered.

convert_prepay: Routine that takes sale data from a completed sale, and registers the dollars and gallons to the appropriate department and plu numbers. When defined contains the plu code to which fuel prepays are registered.

convert_prepay: Routine that takes sale data from a completed sale, and registers the dollars and gallons to the appropriate department and plu numbers. When defined contains the plu code to which fuel prepays are registered.

update_prepay: Routine to convert sales in the prepay department to correct gas item. When defined Contains the plu code to which fuel prepays are registered.

PRINTCANCELEDSALE

When defined, all receipts resulting from running the cancel sale routine will print regardless of normal receipt printing preferences.

PRINTDELAY

When defined, this denotes a delay in milliseconds in the print routine for the serial receipt printer. This is necessary only when a pole display is between the serial port and the printer to prevent printer overflow errors when the pole display continues to send its buffer contents to the printer after the printer has raised DTR upon a full buffer. The usual value for this is 1750 milliseconds.

Used in functions:

BPPrintAsciiFile: BP version of print_ascii_file. When defined contains a delay factor in milliseconds to delay each print packet when there is a pole display between the printer and the serial port.

print_ascii_file: Routine that prints the contents of a file specified by its formal parameter. When defined contains a delay factor in milliseconds to delay each print packet when there is a pole display between the printer and the serial port.

pr_voucher: A routine that formats a credit card voucher when a sale is tendered to a network tender. When defined contains a delay factor in milliseconds to delay each print packet when there is a pole display between the printer and the serial port.

PRINTMMSAVING

Print out mixmatch saving for each item based on whether not an envvar called "PRINTMMSAVING" or "TA" is defined.

PTPNAME

Used in functions:

PrintLoyaltyData: Routine that prints loyalty data on a loyalty receipt. When defined contains the local jobber name to be printed on Points To Partners receipts

SetPTPData: Routine that formats loyalty data for Points To Partners loyalty transactions. When defined contains the local jobber name to be printed on PTP receipts

SetPTPCancelData: Routine that cancels a Points to Partners loyalty card. When defined contains the local jobber name to be printed on PTP receipts

SetPTPRedeem: Routine that sets up loyalty data for a Points to Partners redemption transaction. When defined contains the local jobber name to be printed on PTP receipts

SetLoyaltyRedeem: Processes data from a loyalty redemption reply message. When defined contains the local jobber name to be printed on PTP receipts

SetLoyaltyTransfer: Processes data from a loyalty points transfer transaction. When defined contains the local jobber name to be printed on PTP receipts

QPMONEY

When defined causes all truck fleet check redemptions (except for Comdata Express Checks) to be shown as a tender labeled #MONEY.

Used in functions:

resume_cc_susp: Routine that is called when a network tender authorization request reply comes in from the CCL. When defined, a Qwik Check submission is taken as a tender for the current sale.

RECEIPTCUTLINES

Used in functions:

cut_epson_receipt: Routine that directs the 30 column receipt printer to cut the paper. When defined, denotes the number of blank lines to eject at the end of a 30 column receipt.

RECEIPTPRINTERNAME

When defined, denotes the name of a USB based Epson TM-88IV receipt printer set up as a printer under windows. If this name is not defined here, then the POS defaults to "FiscalReceipt" as the receipt printer name. THIS DOES NOT APPLY TO SERIALLY INTERFACED PRINTERS.

REEFER

When defined, this character is inserted into the reefer variable in the truck fleet data structure and denotes whether reefer fuel is sales taxable.

Used in functions:

dopos: A routine that houses the main application loop. When defined, will contain an 'O' or a 'T'. 'O' denotes that reefer fuel will be treated as “off road” for tax purposes. 'T' denotes that reefer fuel will be taxed as tractor fuel is taxed. In this routine, when defined causes the pos to load offroad tax data from a file broadcast by the master pos.

reefer_type: Routine that returns a character defining as what type of fuel reefer fuel is to be sold. When defined, will contain an 'O' or a 'T'. 'O' denotes that reefer fuel will be treated as “off road” for tax purposes. 'T' denotes that reefer fuel will be taxed as tractor fuel is taxed. Default type is 'R'.

RESTARTFILE

When defined will cause POS to exit with an exit code of -3 when a Z is run.

RESTRICTEDBANKS

Used in functions:

checkBankRestriction: Routine that restricts access to various screens of keys. When defined, contains a comma separated list of When defined contains a comma separated list of screen key banks that cannot be entered by the cashier unless manager override authority is turned on.

RESTRICTSUBTOTALDISCOUNT

When defined disallows sub total discounts if ANY real plu item has the "disable discount keys" flag set in its record.

RESTRICTVIEWALLTFT

When defined, prevents viewing of truck fleet transactions that originate at an OPT, SFT, or alpha-crind dispenser and are locked in the pending fleet display on the POS.

RETAILLOYALTY

Used in functions:

end_sale: A routine that finishes a sale following a successful tender that satisfies the total amount due on that sale. When defined denotes that non truck fleet loyalty cards are to be procesed.

ROOMTIMEOUT

When defined, denotes the number of milliseconds to wait on a LITTLEAMERICA room charge inquiry to the MWS. Used at Little America Hotels only.

Used in functions:

room_charge: Routine that handles charging transactions to a particular hotel room (used by Sinclari Little America Hotels only). When defined contains the timeout interval for Little America room folio communications.

SDOFFROADTAX

Used in functions:

ring_tft_fuel: A routine that rings up fuel dollars and gallons from truck fleet transaction data. When defined denotes that federal road tax is not subtracted from fuel PPU prior to calculating sales tax for off road diesel fuel.

up_totals: Routine that updates the sale totals, calculate new tax, and display totals. When defined denotes that federal road tax is not subtracted from fuel PPU prior to calculating sales tax for off road diesel fuel.

process_plu: A routine that processes the registration of an item. When defined denotes that federal road tax is not subtracted from fuel PPU prior to calculating sales tax for off road diesel fuel.

SIGNATURECAPTURE

When defined, enables signature capture on POS systems running Mx860 units.

SIGPRINTFLOORAMT

When defined denotes an amount at which or below a signature line does not print on a credit card voucher. Version specific; to wit, 09.01.01-D36N or later.

SMARTFUEL

Used in functions:

log_PT_transaction_detail: Routine that logs outside payment terminal sales data to the MWS at EOD time. When defined, this routine upon failure to retrieve the $mdetail.dat file from the CCL displays a dialog box informing the operator that this operation has failed.

get_key: Routine that runs the main POS idle loop. When defined in conjunction with MASTERPOS sweeps and prints receipts generated by the LSC when transactions complete on smart fuel terminals.

STDEBUG

When defined turns on extensive message logging in the LSC/CCL communications thread. Version specific; to wit, 09.01.02-D08B or later.

STOPCHECKTEND

When defined, displays a dialog box requiring cashier acknowledgment of check approval messages. Utltimately, regardless of the content of the aproval message (good or bad) the cashier decides whether to take the check.

Used in functions:

bad_check: Routine to vet a check submitted to tender a sale. When defined, displays a dialog box requiring cashier acknowledgment of check approval messages. Utltimately, regardless of the content of the aproval message (good or bad) the cashier decides whether to take the check.

SVCDEPT

Used in functions:

CBPActivateSTVC::OnInitDialog: Routine that initializes the BP STVC dialog. When defined, specifies the the department code into which sales of stored value card activations and recharges are stored.

DoBPStoredValueCard: Routine that handles processing STVC during BP tendered transactions. When defined, specifies the the department code into which sales of stored value card activations and recharges are stored.

end_sale: A routine that finishes a sale following a successful tender that satisfies the total amount due on that sale. When defined, and an amount was spent on STVC, then the activation dialog is displayed.

check_svc_max: A routine to see if an amount is less than the maximum amount that may be assigned to a SVC as an initialization or re-charge. When defined, specifies the the department code into which sales of stored value card activations and recharges are stored.

deptlookup: A routine that processes the registration of an open department sale item. When defined, denotes the department ID of department used to register lottery item purchases. When defined, specifies the the department code into which sales of stored value card activations and recharges are stored.

StoredValueCard: A routine that deals with various stored value card operations. When defined and no money was spent on STVC, this routine aborts.

rvoid: Routine that voids the last item registered in a sale. When defined, and the department code of the voided item matches the contents of this variable, then the amount sold into the item is deducted from the sale environment variable se.SVCAmnt. When that amount reaches zero, then no STVC activity occurs at the end of the sale.

SWEEPRKC

When defined, does a periodic sweep for RKC transactions that failed due to comm errors.

Used in functions:

CTravStarApp::InitInstance: Routine that initializes the POS application. When defined, does a periodic sweep for RKC transactions that failed due to comm errors. When found (each failed transaction is stored in a file named <5 digit receipt number left padded with zeros>.frq) the POS attempts to resend the transaction to the RKC server. If this resend is successful, the file is deleted. If not, it remains to be re-tried again at the next sweep.

TAX_BUYDOWN

When defined, this points to a previously setup plu that is designated as a “negative”, non-taxed PLU. This is used in conjunction with Bosselman's cigarette buydowns where full tax is charged on the amount of the cigarettes bought and then this PLU is linked to the bought down PLU so that the ultimate price is reduced, but tax is charged on what would have been the full price of the cigarettes had there been no buydown at all.

Used in functions:

tax_buydown: Routine that returns a PLU to be used as the linked buydown PLU into which to register a negative amount when a tobacco purchase is "bought down". When defined, contains the PLU number. Default undefined behavior is to not register this into a PLU.

TAXDETAIL

Print the tax detail on the receipt.

Used in functions:

pr_totals: Routine that prints totals on receipts. When defined, all four jurisdictions contained in a tax table are printed, rather than a total of them.

TCHEKSHIFTSETTLE

This will cause Tcheck to settle by shift rather than day.

Used in functions:

do_tft_settlement: Routine that performs truck fleet transaction tender media settlement. When defined in conjuction with URC allows for doing TCHEK shift settlements wherein the cashier enters the settlement data and settlement begin and end times.

TCHFLEETMASTERCARD

When defined, allows the POS to recognize Flying 'J' Fleet Mastercards. When not defined, these cards are rejected with an "Card not found" message.

Used in functions:

credit_card_type: Routine that assigns card types to various credit and debit cards.

TENDASSIGN

When defined specifies the name of the card type to tender assignment table. When the POS finds this variable it will open the file designated by the variable, and use its content to set up a table of card types for each tender number. The POS will then use this table to assign network approved cards to specific tenders. In other words, there will no more absolute tender names that will designate a credit card. Using this method, multiple cards can be assigned to a single tender.

TFAUTHREDUCTION

When defined denotes an amount by which truck fleet dispenser authorizations will be reduced in order to prevent over pumping.

TFCARDS

When defined, contains a string consisting of truck fleet card types that get a cash advance in conjunction with a truck fleet sale.

Used in functions:

SetTFCards: Routine that sets a global variable containing the list of truck fleet cards that get a cash advance in conjunction with a truck fleet sale. When defined, contains a string consisting of truck fleet card types.

TFT_RESERVE_ON

When defined, denotes that the truck fleet dispenser reservation system is turned on in the sitecontroller. This results in defined dispensers being automatically authorize and reserved for a given tft transaction. Further, when the fuel dispenser is hung up and that same dispenser is designated as the reefer dispenser, then the sitecontroller automatically authorizes that dispenser.

Used in functions:

CDispTftTrans::OnDelete: Truck fleet pending sales display dialog callback function which deletes the selected truck fleet transaction from the CCL database. When defined, if the dispenser was reserved for the selected transaction, the dispenser is released.

GUIDisplayHoseStatus: Routine that displays dispenser status, both on pump buttons and in the status area of the main window. When defined, the reserved status is shown in the status display in the data area.

authorize: Routine that authorizeds a dispenser for an amount specified by the cashier. When defined, the designed dispenser reserve status is checked, and the authorization fails if it is reserved.

de_auth: Routine that de-authorizes a dispenser that had been previously authorized. When defined, the designated dispenser reserve status is check and the de-authorization fails if it is reserved.

hose_plu_amount: a routine that registers the fuel sale for a selected dispenser. When defined, checks the reserved status of the designated dispenser. Registration fails if the dispenser is reserved.

release_disp_to_tft: Routine that cashes out the designated dispenser, writing its sale data into the truck fleet data structure. Routine called from the RING SALE option of the truck fleet dialog. When defined, the reservation status of the dispenser is checked and if it is not reserved for the current transaction, then the RING SALE fails.

CTftmain::OnReleasedisp: Routine that releases a dispenser reserved for the current transaction. When defined, the reserve status of the desginated dispenser is check, and if it is not reserved for the current transaction, then the release fails.

TFT_VERTICAL_INDENT

When defined, denotes the number of lines ejected from the 80 column printer for a truck fleet receipt.

Used in functions:

do_vertical_indent: Routine does a vertical indention at the beginning of an 80 column truck fleet receipt. When defined, contains the number of lines to advance 80 column paper before beginning printout of a truck fleet fuel receipt.

TFT2BP

When defined, all truck fleet credit card authorization requests will be directed to the BP VIPER first. Otherwise, all truck fleet credit card authorizations will go to the CCL.

TLS

When defined, causes an electronic underground fuel tank montior report to print at Z time.

Used in functions:

meters_rpt: Routine that pulls the dispensers meters file from the LSC and prints a report. When defined causes the routine to pull an electronic underground fuel tank monitoring report and print it.

TRANSCARDDISCOVER

When defined, allows the POS to recognize Transcard Discover cards. When not defined, these cards are rejected with an "Card not found" message.

Used in functions:

credit_card_type: Routine that assigns card type designators to credit and loyalty cards.

TYEARS

When defined, denotes the minimum age allowed to buy tobacco products. This is used when the minimum age for tobacco products is different from that of alcohol.

Used in functions:

id_ok: Routine that checks the age of a customer purchasing age restricted merchandise. When defined, designates the minimum age at which tobacco may be purchased.

UNRUNGFUEL

When defined, causes a list of all truck fleet transactions where the fuel has been released (dispenser hung up) but not registered by the cashier.

Used in functions:

convert_unrung_fuel: Routine run before a Z has been performed to ring up all fuel that was released in truck fleet transaction, but not rung up by the cashier. When not defined, this routine does not run.

UPCPREPENDDIGITS

When defined, prepends sufficient zero digits to fill out a upc code for a lookup. This happens contextually with regard to the length of upc codes being processed by the register. In the case of 12 digit bar codes, no check digits are calculated.

Used in functions:

fix_upc: a routine that prepares UPC codes for use in looking up an item.

USBCHECKREADER

When defined, denotes the simulated comm port used by the USB based MICR check scanner.

USBSCANNAME

When defined contains the device name of the USB bar code scanner in use. Only one currently supported is "Symbol". This is case sensitive.

USEPDL

When defined, the POS will attempt to use a PDL file in relation to network tender processing.

VERIFYCLOCK

Verifies the clock in / out status on the MWS.

Used in functions:

get_empl: Routine that gets in an employee record from the MWS and clocks that employee in or out according to the type variable passed into the routine. When defined verifies that the clock operation attempted is appropriate (eg no clock out if not clocked in first).

VRIP

When defined, contains the TCP/IP addressing to be used for when connecting to a video surveillance system.

Used in functions:

InitVRPort: Routine that initializes the TCP/IP connection to a security video recorder. When defined, this initialization is attempted using the content as the TCP/IP address for the port. Once initialized, receipt text is output to this port for overlay onto the video.

VRPORT

When defined, contains the TCP/IP port to be used for when connecting to a video surveillance system.

Used in functions:

InitVRPort: Routine that initializes the TCP/IP connection to a security video recorder. When defined denotes the TPC/IP port upon which to connect to the video recorder unit

XMLPORT

When defined denotes the port on which to contact the TA xml receipt database server.

XMLTRANSURL

(i.e. /storerecWeb/storeTransactionServlet) Added to 09.01.00-09

XOUT

When defined, causes “X” characters to be printed for the first 12 digits of a credit card number, to mask the number.

Used in functions:

XoutMedia: Routine to obfuscate a card pan string. When defined, all but the last four digits of a card pan are obscured with 'X' characters.

pr_mediaid: Routine to print a card pan on a voucher receipt. When defined, all but the last for digits of the card pan are obscured with 'X' characters.

fix_media: Routine to remove all but the card pan from credit card track data. When defined, all but the last for digits of the card pan are obscured with 'X' characters.

XOUTZ

When defined, causes "X" characters to be printed for the first 12 digits of a credit card number on a Z Report, to mask the number.

XPCHECK

XPCHECK_PLU=nnnnnnnnnn Where: nnnnnnnnnn is the PLU number to be used for Express Check. Secify an item for the sale of an Express Check. If this environmental variable is not set it will default to item 0000002000.

Used in functions:

DoExpressCheck: routine to register an Express Check for reporting purposes only.

XPCHECK_PLU

nnnnnnnnnnnn, where "nnnnnnnnnnnn" is the PLU number to be used for Express Check. Specify an item for the sale of an Express Check. If this environmental variable is not set it will default to item 000000002000.

ZIPCODE

When defined will cause the POS to prompt for a zip code whenever a credit card is tendered. This is is mutually exclusive with CITGONETWORK and RBSLYNK.

Used in functions:

do_ctender: routine that processes vetting the details of a network tender against various qualifying criteria. When defined, contains a list of card types for which the POS will always prompt for zipcodes. This variable is always mutually exclusive with CITGONETWORK. Zip code verifications under CITGONETWORK occur as specified in the Citgo PDL.

0 Comments

Add your comment

E-Mail me when someone replies to this comment