ProtoBase User's Guide1).pdfProtoBase Administrator User Guide - Version 4.3.002 - Introduction...

ProtoBase

AdministratorVersion 4.3.002

User Guide

Southern DataComm, Inc.

ProtoBase Administrator User Guide - Version 4.3.002

Southern DataComm, Inc. 08/2000Proprietary & Confidential

ProtoBase Administrator User Guide

COPYRIGHT

Copyright 2000 Southern DataComm, Incorporated. All rights reserved. No partof this publication may be reproduced or distributed without the prior consent ofSouthern DataComm, Incorporated, 10700 76th Court, Largo, Florida 33777.

DISCLAIMER

Southern DataComm, Incorporated provides this publication "as is" without warrantyof any kind, either express or implied. This publication could include technicalinaccuracies or typographical errors. Changes are periodically made to theinformation herein; these changes will be incorporated in new editions of thepublication. Southern DataComm, Incorporated may make improvements and/orchanges in the products(s) and/or program(s) described in this publication at anytime.

TRADEMARKS

ProtoBase and SofTrans are registered trademarks of Southern DataComm,Incorporated. All other brand and product names are trademarks or registeredtrademarks of their respective companies.

RELATED DOCUMENTS

The following documents are related to this document:

ProtoBase User GuidesSofTrans Transaction Processor GuideProtoBase Technical Reference GuideProtoBase Integration GuidePbAdmin Error Messages Addendum

Edition Date Version

First Release 08/2000 4.3.002



Table of Contents

I. Introduction...................................................................................................................... 1Purpose.......................................................................................................................... 3How to Use this Guide.................................................................................................. 4Conventions ................................................................................................................... 6

Product Overview.............................................................................................................. 9Administrator Setup and ProtoBase Configuration.................................................11Settlement ....................................................................................................................12Field Data Validation..................................................................................................13Transaction Maintenance...........................................................................................13Database Maintenance..............................................................................................14Reporting......................................................................................................................14Transaction History .....................................................................................................15Troubleshooting and Help ..........................................................................................15ProtoBase Administrator Front End (PBFE) ...........................................................16

II. PbAdmin Integration....................................................................................................18ProtoBase Administrator Front End (PBFE) ...........................................................18

ProtoBase American Express Utility.....................................................................18PBFE Functions ......................................................................................................19Incremental Authorization.......................................................................................19Authorization Reversal............................................................................................20

Validation of Data by PbAdmin.................................................................................21Transaction Types (Valid for PbAdmin)....................................................................21

Table of Transaction Types....................................................................................21Required Input Fields by Transaction Type..........................................................25Suggested Input Fields by Industry Type ..............................................................26

Output Fields................................................................................................................27Input Fields...................................................................................................................29Integrating PbAdmin for Specific Processing Situations........................................36

Incremental Authorization and Authorization Reversal........................................36AVS ..........................................................................................................................38Prior-Authorized Sale .............................................................................................38Voids and Returns...................................................................................................38Settlement ................................................................................................................39Gateways .................................................................................................................40Auto Close ...............................................................................................................40Multiple Locations ...................................................................................................40Real Time Transactions..........................................................................................40Transaction Qualifier Field (115)...........................................................................40Force Field (12) for Forced Authorizations ..........................................................41User Defined Field (11)..........................................................................................41Time Out Reversal...................................................................................................41Printer Setup............................................................................................................41


08/2000 Southern DataComm, Inc.Proprietary & Confidential

Card Number Validations.......................................................................................42Transaction Inquiry (Tran Type 22)........................................................................42

How to Generate Reports Outside of PbAdmin.......................................................43PBADREP, the PbAdmin Report Generator .......................................................43How to Call the Report Generator (PBADREP) ..................................................44How to Set up the Input File....................................................................................45Table of Input File Fields ........................................................................................46Output File that is Generated.................................................................................49

How to Use the Optional File Server Gateway.........................................................51III. Installing PbAdmin......................................................................................................55

Installation of PbAdmin for DOS/LAN, OS/2 ............................................................56System Requirements (DOS/LAN, OS/2) ............................................................57First Time Installation of PbAdmin (DOS/LAN, OS/2).........................................58Upgrade of PbAdmin (DOS/LAN, OS/2)..............................................................60

Installation of PbAdmin for UNIX................................................................................63System Requirements ............................................................................................64First-Time Installation of PbAdmin for UNIX .........................................................65First-Time Installation of PbAdmin for UNIX (cont.) .............................................66Upgrade of PbAdmin for UNIX ..............................................................................68

Setting Up PbAdmin.......................................................................................................72Setup Screens/ Instructions........................................................................................73

Global INI File Screen.............................................................................................73ProtoBase Administrator User Login Screen......................................................74ProtoBase Administrator Locations Screen........................................................75Location Information Screen..................................................................................76User Security Screen..............................................................................................78Reports Security Screen........................................................................................80

Configuring ProtoBase...................................................................................................82Automatic Configuration - Overview..........................................................................82Manual Configuration - Overview...............................................................................82Backing up the DB Directory .....................................................................................83Automatic Configuration of ProtoBase.....................................................................83

How to Know if You Are Ready to Configure Automatically................................83Steps to Automatically Configure ..........................................................................84Activating the New Values (Run Configuration) ...................................................85

Manual Configuration of ProtoBase..........................................................................87Processors...............................................................................................................90Terminals..................................................................................................................93Credit Card Tables .................................................................................................96Devices ..................................................................................................................100Run Configuration..................................................................................................102Print Configuration ................................................................................................106

Running Test Transactions Using PBFE....................................................................107How to Run Test Transactions Using PBFE ..........................................................107



IV. PbAdmin Technical Reference Guide...................................................................111Global and Local INI File Screens ...........................................................................112Location Information Screen....................................................................................116User Security Screen................................................................................................124Reports Security Screen..........................................................................................127Processor Edit Screen.............................................................................................130Terminal Edit Screen................................................................................................134Edit Credit Card Table Screen................................................................................136

Add/Edit Credit Cards Screen ............................................................................137Device Edit Screen...................................................................................................142Environment Settings Screen..................................................................................148Select/View/Edit Transactions Screen (Main Screen)..........................................149

Add Transaction [F3] – .........................................................................................152Search for Transaction [F4]..................................................................................156Transaction Detail [F6] .........................................................................................157Select/Deselect Transactions [F8/F9] ................................................................159Industry Detail Screens.........................................................................................161

PbAdmin Reports......................................................................................................177Cashier (Server) Summary Report......................................................................178Cashier (Server) Detail Report............................................................................180Cashier Extended Detail Report - Retail............................................................182Server Extended Detail Report - Restaurant......................................................184Cashier Extended Detail Report -Lodging.........................................................186Cashier Extended Detail Report - Rental Car....................................................188Cashier Extended Detail Report - Direct Marketing .........................................190Terminal Summary Report ...................................................................................192Terminal Detail Report..........................................................................................194Terminal Extended Detail Reports ......................................................................196Deposit Status Report ..........................................................................................197Authorization Date & Time Report ......................................................................198Incremental Authorization Report.........................................................................199Card Type Summary Report ................................................................................200Card Type Detail Report ......................................................................................202Merchant Key Summary Report...........................................................................204Merchant Key Detail Report.................................................................................206Server Tip Report (Restaurant Only) ...................................................................208Administrator Configuration Report ....................................................................211

Transaction History Search......................................................................................213Transaction Log.........................................................................................................215Administrator Log......................................................................................................219PbAdmin File and Program Descriptions ..............................................................220

V. How to Use PbAdmin...............................................................................................230How to Start PbAdmin..............................................................................................231User Log In Screen...................................................................................................231How to Exit PbAdmin................................................................................................233Select/Edit Transactions ..........................................................................................234


08/2000 Southern DataComm, Inc.Proprietary & Confidential

Select/View/Edit Transactions Screen (Main Screen)......................................235Select Display Mode [Shift]+[F4].........................................................................236Select/Deselect Transactions [F8] and [F9].......................................................238Search for Transaction [F4]..................................................................................240View/Modify Transaction Detail [F6]...................................................................242Toggle Status [Shift]+[F6].....................................................................................246Add Transaction [F3] - Add New Detail Transaction Screen...........................247Add Transaction [F3] - Add New Detail Transaction Screen (cont.) ...............248

Reports.......................................................................................................................249How to Generate a Report ...................................................................................250Report Descriptions ..............................................................................................252

Deposit Transactions (Settlement)..........................................................................257When You Perform the Settlement ......................................................................258Multi-Merchant Settlement....................................................................................259When Settlement is Complete .............................................................................260

View Deposit Log (Settlement Log)........................................................................262American Express Status Check ........................................................................263Viewing the Deposit (Settlement) Log................................................................264

Transaction History Menu.........................................................................................265Transaction History Search..................................................................................266View History Transactions Screen......................................................................267Search for Transaction [F4]..................................................................................269View Transaction Detail [F6]................................................................................271Select/Deselect Transactions [F8] and [F9].......................................................273Reverse and Copy to Main Database [F5].........................................................275Copy to Main Database [Shift]+[F6]....................................................................276Deposit Date and Time Report ...........................................................................277Various History Reports .......................................................................................277

Database Management Menu.................................................................................278Modify Transaction Status....................................................................................279Purge Old Authorizations......................................................................................281Check Settlement Information..............................................................................282Fix Settlement Information....................................................................................283Rebuild Transaction Database............................................................................284Purge Transaction Database...............................................................................286Rebuild History File ...............................................................................................287Purge History Files................................................................................................288View Log ................................................................................................................289Purge Log ..............................................................................................................292

VI. PbAdmin Troubleshooting ......................................................................................294Issues to Consider Prior to Calling SDC Client Services.....................................294Error Messages/Solutions........................................................................................304Other PbAdmin Errors/Solutions .............................................................................309



GLOSSARY

INDEX

ProtoBase Administrator User Guide - Version 4.3.002 - Introduction


ProtoBase


User Guide

I. Introduction


Southern DataComm, Inc. 08/2000 1Proprietary & Confidential

Introduction The ProtoBase Administrator (also called “PbAdmin” or“the Administrator”) is a screen-based, data baseapplication that stores approved transactions and, whenappropriate, automatically tracks compliance data duringelectronic payment processing. It is an add-on productand intermediate interface to ProtoBase, the SDCcommunications utility that integrates into a point-of-sale(POS) system. ProtoBase provides the link between thethird-party transaction processor and the merchant at thepoint-of-sale (see Figure I-1).

NOTE: For detailed information on how to useProtoBase, please refer to the ProtoBaseUser Guide for your operating system.

POS System

ProtoBase

SofTrans SofTrans SofTrans SofTrans

AMEXAuth/

Settlement

CheckProcessor

Third-PartyTransactionProcessor

PbAdmin and

ScreenInterface

DataBase

DataBase

Figure I - 1


2 08/2000 Southern DataComm, Inc.Proprietary & Confidential

Introduction(cont.)

PbAdmin provides detailed data validation beforetransactions reach the third-party transaction processor. Itstores data for several transaction and payment types,including credit cards, debit cards, and checks. Itsupports Address Verification with each transaction, ifAddress Verification is applicable to the particularprocessor.

Transaction maintenance is easy using PbAdmin. Thissystem enables the merchant to edit or delete transactionsprior to settlement. The merchant can also choose whichtransactions to settle by category. The categories includeterminal, date, cashier (server), and card type.

PbAdmin provides comprehensive reporting capabilities,including detailed and summary industry reports withvarious sorts. The Administrator also provides systemsetup, configuration reports, and audit logs that can beused for troubleshooting problems.



Purpose This document provides the necessary information tosuccessfully use the ProtoBase Administrator. Itdescribes field definitions and functions for each screen.

To set up the Administrator, we provide integration,installation, and configuration information. Additionally,this user guide shows industry-specific screens and reportexamples.

We also provide troubleshooting techniques, including acomplete set of error messages for reference purposes.

Solution!

PbAdmin

Installation Integration Configuration

Reports Screens Troubleshooting

POS System

PbAdmin w/ProtoBase

SofTrans SofTrans SofTrans SofTrans

Laser printer

ModemsTape or diskettedrive

PbAdminReports

Figure I -2



How to Use thisGuide

This section documents the various tabbed sections ofthis user guide, giving a brief overview. It also details theconventions of this user guide, describing how it wasdesigned to help you use the ProtoBase Administratoreffectively.

Introduction • Gives a brief overview of the ProtoBase Administrator

• Explains the reason for this user guide

• Summarizes the various sections and documentconventions

• Describes the main attributes of the ProtoBaseAdministrator system, including a general discussionof the capabilities of PbAdmin

Integration • Describes PBFE, the PbAdmin front end program

• Lists the transaction types and input/output fields

• Explains how PbAdmin handles specific transactiontypes and processing situations

Installation andSetup

• How to determine minimum system requirements

• How to install for the first time or as an upgrade

• How to set the various environment variables

• How to start and set up the basic information onPbAdmin, including location and user security data

• How to configure ProtoBase using the ProtoBaseConfiguration group of screens

Installation andSetup QuickReference

Provides a summary of the steps to install and setup theProtoBase Administrator



PbAdminTechnicalReference

Describes the technical information of PbAdmin,including:

• Description of every screen field• Report descriptions and samples• Transaction (PBFE) log• PbAdmin file and program descriptions

How to UsePbAdmin

Describes how to perform the various day-to-day functionsof PbAdmin from the end-user point-of-view, including:

• How to Select and Edit Transactions

• How to Add Transactions

• How to Search for a Transaction

• How to Generate and View Reports

• How to Deposit Transactions (How to PerformSettlement)

• How to View the Deposit Log

• How to Search and View Transaction History

• How to Perform Database Clean-up

Troubleshooting Provides troubleshooting techniques, including a list of allerror messages and recommended solutions.

Glossary Contains ProtoBase and payment service industry terms.

NOTE: At the end of this user guide, we providean index to give you an easy way to findPbAdmin topics quickly.



Conventions This user guide employs many conventions to help youuse this product.

Important Points Notes are identified by the word NOTE in bold type.Important information follows this break in the flow of text.A different font style is used for readability.

NOTE: Please read all important points in thisguide. The information given will helpyou avoid integration problems.

OperatingSystems andPlatforms

Operating system naming conventions vary. UNIXfilenames are case sensitive, but do not require the .EXEextension for executables. DOS, OS/2 and WindowsNT/95 require the .EXE extension for executables, but arenot case sensitive. The requirements, conventions, andinstructions may vary for each operating system.

Executable programs for DOS, OS/2 and Windows NT/95have one of the following extensions: EXE, COM, BAT,CMD. For this guide, program names may or may notinclude an extension. For example, PBFE.EXE or PBFErefer to the same program.

NOTE: Please be aware of your specific operatingsystem requirements. This guide doesnot attempt to cover every possibility forevery operating system.

File Names To enable readability:

For DOS, OS/2, and Windows, file names are capitalizedwhen referenced.

For UNIX, file names are displayed in their correct case.

If the operating system is not referenced, file names arecapitalized when referenced.



Parameters When the parameter is specified, the word indicating theparameter is italicized and, if optional, placed in brackets.

Example:

PBFE -iInputFile [-oOutputFile]

Keystrokes Keystrokes are in bold font and usually capitalized. Thekeys are enclosed in brackets and combination keystrokes are divided by a plus sign (+).

Example:

press [ENTER]; press [CTRL]+[BREAK]press [F2] to view a list of valid values

For UNIX systems, the [ESC] key has to be pressedtwice, due to the way the operating system interprets theescape key.

Field Names Data is passed between the POS software andProtoBase, PbAdmin, or it’s other utilities (or add-onproducts) via files. The data information is in the format:field number, data. The comma separates the fieldnumber from the data.

When the fields are referenced by name, they are followedby the word “field” and their associated field number, ifapplicable.

Example:

Reference Number (field 007)



ProtoBaseTransactionTypes

One of the fields passed to ProtoBase is the type oftransaction being performed. Transaction types includethe transaction name and a uniquely associated numberas shown in the following examples:

Authorization Only (01)Prior-Authorized Sale (07)Return (09)

Examples Examples usually follow a line of text just like the examplebelow.

Terminal=TERM1

Steps of aProcess

Steps are numbered if there is more than one instructionas shown below.

1. Select the Select/Edit Transactions option fromthe Main Menu.

2. Use the arrow keys to move to the transaction youwant to select.

3. Press the space bar to mark the transaction asselected.

OtherDocumentation

Other User Guide references and tabbed sectionreferences are bolded and italicized as shown in thefollowing example:

For detailed information on how to useProtoBase, please refer to the ProtoBaseUser Guide for your operating system.



ProductOverview

The ProtoBase Administrator is a text-based, electronicpayments database software interface. It is an add-on toProtoBase, the data communications utility created bySouthern DataComm, Inc. It contains settlement,reporting, field data validation, transaction history, andmaintenance functions beyond what is provided in aProtoBase-only distribution.

You navigate various menus and screens using the arrow,tab, enter, and function keys. You choose menu optionsby selecting the highlighted letter of the option or using thearrow and enter keys. Choice lists are available for fieldsthat have a specific set of values for entry.

NOTE: Online help is available throughoutPbAdmin by pressing the [F1] key.

When you log in to PbAdmin, the Main Menu appears asshown below:

Main Menu

The above menu shows the primary groups of screensand functions contained in the ProtoBase Administrator.



ProductOverview(cont.)

This section summarizes the various features of PbAdmin,separated into several categories. For each category, welist the submenus (or any separate utility programs) youwould generally use from the Main Menu to access thefeatures listed.

The following categories are included in this overview:

• Administrator setup and ProtoBase configuration• Settlement• Field data validation• Transaction maintenance• Database maintenance• Reporting• Transaction history• Troubleshooting and help• ProtoBase Administrator front end (PBFE)



AdministratorSetup andProtoBaseConfiguration

You can maintain merchant locations, users, ProtoBaseconfiguration, and general system attributes throughPbAdmin. The Administrator Setup Menu from the MainMenu allows users to maintain this information.

Some of the PbAdmin features related to setup andconfiguration are as follows:

• Enables configuration of Global and Local INI FileSetup, Location, User Security, Printer Setup, andProtoBase (transaction processors, terminals,payment types, and communication devices).

• Supports multiple merchant locations in oneapplication (e.g., one location for hotel/front desk,and one for hotel/restaurant).

• For terminal capture processing, allowsauthorization through one processor and settlementthrough another.

• Includes security with multiple user access levels.Each user/login can be configured with differentaccess permissions. It supports master logincapabilities, allowing one or more users to monitoractivity at all locations.

• Provides full access to ProtoBase configurationusing a screen interface. You configure ProtoBasethrough easy-to-use screen prompts instead ofediting a text file.

• Provides a modem pick list. Just pick your modembrand from the list and PbAdmin automaticallysupplies the initialization data. The user canmodify the default initialization data.

• Enables viewing of environment settings to helpdiagnose problems.



Settlement PbAdmin provides various functions related to thesettlement of transactions. The three primary settlement-related options from the Main Menu are as follows:

• Select/Edit Transactions• Deposit Transactions• View Deposit Log

Some of the PbAdmin features related to settlement areas follows:

• Enables inquiry and selection of transactions to besettled.

• Allows deletion of transactions prior to settlement.

• Supports settlement for both terminal and hostcapture processors; also supports real timetransactions.

• For terminal capture processing, allows user tochoose which transactions to settle by terminal,date, cashier (server), and card type.

• Settles all transactions selected for deposit for allprocessors.

• Performs Incremental Authorizations (type 75) orAuthorization Reversals (type 76) as requiredautomatically.

• Provides multi-merchant settlement capability, inwhich multiple Terminal IDs can be identified andsettled in a single batch using a Settlement Group.This feature is applicable to those transactionprocessors that accept multi-merchant settlement.



Field DataValidation

PbAdmin provides validation of field data in the input filethat is passed to the POS system for processingtransactions. This validation occurs prior to sending thedata to the third-party transaction processor. This reducesthe amount of invalid data being passed to the processorand stored in the database.

When a transaction is built and processed throughPbAdmin, it verifies the validity of each field and itscontents as found in the input file. If a discrepancy exists,PbAdmin indicates the error and allows you to edit thetransaction prior to communicating with the processor.

The merchant benefits in that it does not get charged forauthorization transactions that contain errors; PbAdmincatches these errors before they are sent.

TransactionMaintenance

Through PbAdmin, you can view and maintaintransactions. To accomplish this, access the Select/EditTransactions option from the Main Menu.

Some of the PbAdmin features related to transactionmaintenance are as follows:

• Add, modify, or delete individual or groups oftransactions.

• Allow manual entry or modification of transactions.



DatabaseMaintenance

You can also view and purge history files and various logs.To accomplish this, access the Database Managementoption from the Main Menu. Some of the PbAdminfeatures related to database maintenance are as follows:

• Ability to select a group of transactions and movethem from history back to the main database(working status) or from the main database tohistory. This can be used to correct problems withsettlement.

• Delete old authorizations that have expired.

• Rebuild the entire transaction database. Thisfunction is useful when the database may havebeen corrupted.

• Rebuild or delete history files as of a specific date.These functions are useful when particular historyfiles may have been corrupted or memoryconstraints require a purge.

• View or delete PbAdmin logs. Deleting the logsshould be done periodically to free up space onyour hard disk.

Reporting PbAdmin provides various reporting capabilities. You canproduce and view the various reports through both theReports Menu option and the Transaction History optionfrom the Main Menu. Some of the PbAdmin reportingfeatures are as follows:

• Generate, view, and print all available reports.

• Choose from summary, detailed and extendedindustry data on most reports.

• Sort by cashier, terminal, card type, and merchantkey within each location.

• Generate Deposit Status report for overview ofsettled batches.

• Report on authorization statistics.



TransactionHistory

You can inquire into transaction history for a specificmonth through PbAdmin. To accomplish this, you canaccess the Transaction History Menu option from the MainMenu.

Some of the PbAdmin features related to transactionhistory are as follows:

• View and search for particular transactions inhistory for chargeback research.

• Generate history reports for a particular month,including either all batches or a specific batch.

Troubleshootingand Help

PbAdmin provides various troubleshooting and helpfunctions. These can be accessed using several menuoptions and function keys.

Some of the troubleshooting and help features ofPbAdmin are as follows:

• The function key [F1] for help. The [F1] keyprovides brief descriptions and hints concerningthe field, menu option, error messages, or whateverportion of a screen the cursor resides.

• Detailed informational and error messages thatdisplay at the bottom of the screen.

• Setup information available under the AdministratorSetup option from the Main Menu.

• System log information available from the ViewLog screen under the Database Managementoption from the Main Menu. Three log options areavailable which record major activities: thePbAdmin front end (Transaction), PbAdmin(Administrator), and settlement (Settlement).These logs can be used to troubleshoot certainproblems.



ProtoBaseAdministratorFront End (PBFE)

The ProtoBase Administrator uses a front end module,PBFE, which verifies that the fields being passed in theinput file to the POS system meet specific requirements infield length and content. This depends on the particulartransaction type and industry being processed. Thisgreatly reduces the amount of invalid data being passedto the transaction processor.

Your POS system must call PBFE, the ProtoBaseAdministrator front end module. When your POS systemcalls PBFE, it in turn calls ProtoBase. ProtoBase theninvokes PB, the transaction builder. PB parses and buildsthe third-party transaction processor messages based onthe input file used to communicate between ProtoBaseand the transaction processor.

ProtoBase Administrator User Guide - Version 4.3.002 – Integration


ProtoBase


User Guide

II. Integration



PbAdminIntegration

This section provides the information you need tosuccessfully integrate the ProtoBase Administrator(PbAdmin) into your POS system.

NOTE: You must first integrate ProtoBase intoyour POS system prior to integratingPbAdmin. Please refer to the ProtoBaseIntegration Guide for more information.

PbAdmin is a screen-based, data base application thatstores approved transactions and tracks compliance data.It is an add-on product and intermediate interface toProtoBase, the SDC communications utility that integratesinto a point-of-sale (POS) system. ProtoBase providesthe link between the third-party transaction processor andthe merchant at the point-of-sale.

PbAdmin provides a simpler means of integration thateases the burden of the POS system having to verify andstore much of the transaction data processed by theirmerchants.

PbAdmin integration includes in-depth validation and errorchecking of the following:

• Field lengths• Data types• Transaction types• Required fields

ProtoBaseAdministratorFront End (PBFE)

ProtoBaseAmericanExpress Utility

Your POS system must call PBFE, the ProtoBaseAdministrator front end module. When your POS systemcalls PBFE, it in turn calls ProtoBase. ProtoBase theninvokes PB, the transaction builder. PB parses and buildsthe third-party transaction processor messages based onthe input file used to communicate between ProtoBaseand the transaction processor.

If you have also integrated the ProtoBase AmericanExpress Utility, your POS system should route AmericanExpress transactions through PBFE also.



PBFE Functions

IncrementalAuthorization

PBFE parses the transaction data to be stored in thePbAdmin main database (see Figure II-1 on the nextpage).

This program also verifies that the fields being passed inthe input file meet specific requirements in field length andcontent. This depends on the particular transaction typeand industry being processed. This greatly reduces theamount of invalid data being passed to the transactionprocessor.

PBFE stores data for Authorizations, Voids, Sales, Prior-Authorized Sales, Returns, and real-time transactions. Itstores Address Verification Service (AVS) data for eachtransaction and provides support for this if the third-partytransaction processor supports AVS. PBFE automaticallytracks and computes required CPS/PS2000 data.

The Incremental Authorization transaction enablesmerchants to add to the total authorized amount. This maybe needed for compliance when the total authorizedamount is less than the Prior-Authorized Sale amount bymore than the industry-specific tolerance.

To handle this situation, PBFE can be integrated one oftwo ways:

1. When a Prior-Authorized Sale is processed, PBFEwill check the total amount authorized. If the totalamount authorized is less than the Prior-AuthorizedSale amount by more than the industry-specifictolerance, PBFE will return an error.

2. When a Prior-Authorized Sale is processed, PBFEwill check the total amount authorized. If the totalamount authorized is less than the Prior-AuthorizedSale amount by more than the industry-specifictolerance, the system will automatically process anIncremental Authorization for the difference.



AuthorizationReversal

The Authorization Reversal transaction enables merchantsto reverse from the total authorized amount. This may beneeded to be in compliance when the total authorizedamount is greater than the Prior-Authorized Sale amountby more than the industry-specific tolerance.

If the transaction processor supports an AuthorizationReversal, PbAdmin issues an Authorization Reversaltransaction at settlement time when the total amountauthorized is greater than the Prior-Authorized Sale bymore than the tolerance. It does the same for anytransactions that have been voided.

Integration Diagram - PbAdmin

Third-PartyTransactionProcessor

PbAdmin

PBFE

ProtoBase withSofTrans

DataBase

PB

Point-of-Sale System Integrated with

PbAdmin and ProtoBaseScreenInterface

Figure II -1



Validation of Databy PbAdmin

PbAdmin provides validation of field data in the input filethat is passed to the POS system for processingtransactions. This validation occurs prior to sending thedata to the third-party transaction processor. This reducesthe amount of invalid data being passed to the processorand stored in the database.

PbAdmin uses the file VALID.DAT to verify the validity ofeach field and its contents as found in the input file.VALID.DAT contains a list of fields and their attributes thatare required for each transaction type.

When a transaction is built and processed throughPbAdmin, a data validation check is made against thedata for those fields and the transaction type as defined inVALID.DAT. If a discrepancy exists, PbAdmin indicatesthe fields in error and rejects the transaction. This enablesyou to correct the error.

TransactionTypes (Valid forPbAdmin)

The following table lists the transaction types and relevantinformation for the transactions that are valid for PbAdmin.

Table of Transaction Types

TransactionType

AccountAuthorizationStatus

Stored in PbAdmindatabase?

Can/Cannot beSettled(Deposited withtransactionprocessor)?

AuthorizationOnly (1)

Authorizes cardaccount for theamount specified

Transaction stored inPbAdmin database oradded to existingAuthorization for the sametransaction

Cannot be settled

Sale (2) Authorizesaccount for theamount specified

Transaction stored inPbAdmin database as:-Prior-Auth Sale (07) forterminal capture-Sale (02) for host capture

Can be settled



TransactionType




Prior-AuthorizedSale (7)

Card must havebeen previouslyauthorized -however, if notpreviouslyauthorized, mayauthorize ifconfigured to doso

Adds a sale that hasalready been authorizedto the PbAdmindatabase

Can be settled

Return (9) No authorizationneeded

Adds a return to thePbAdmin database

Can be settled

Void Sale (11) Voids a saletransaction thathas not beenpreviouslysettled

Changes the status of asale or prior-authorizedsale transaction in thePbAdmin database toVOIDED

Usually notsettled, but maybe included inbatch uploaddepending onprocessor

Void Return(17)

No authorizationneeded

Changes the status of acredit card returntransaction in thePbAdmin database toVOIDED

Cannot besettled



TransactionType




CheckAuthorization(20); or Sale(02) withTransactionQualifier (field115) equal to020

Check verificationor guaranteeperformed todetermine risk ofcustomer

Transaction stored inPbAdmin database forreporting purposes

Cannot besettled; moved tohistoryautomatically

TransactionInquiry (22)

No authorizationneeded

Not stored in database;appears in TransactionLog only

Cannot besettled

IncrementalAuthorization1

(75)

Performsauthorization ona previouslyauthorized cardaccount for anadditionalamount

Transaction stored inPbAdmin database;reflected in the totalauthorized amount

Cannot besettled

AuthorizationReversal 2 (76)

Performsreversal onprevious cardaccountauthorization fora specificamount

Transaction is not storedin PbAdmin database;reflected in the totalauthorized amount

Cannot besettled

1 Transaction types (1) and (75) are very similar. They are treated as such by PbAdmin product. A

transaction type (75) is handled internally by PbAdmin. If a transaction type (1) is used and the systemdiscovers a previous authorization for that credit card account, PbAdmin automatically changes the transactiontype to 75. If the transaction type (75) is not supported by the processor, PbAdmin automatically changes it backto a 1 and resubmits the transaction.

2 The PbAdmin system does Authorization Reversals automatically instead of having to enter thetransaction type (76).



TransactionType




Working KeyUpdate (77)

Not applicable Not stored - Result oftransaction is returned tocalling program

Cannot besettled

Close ofOpenTransaction(89)

Closes an opentransaction andallows update ofthe amount, tips,and extraamount

Transaction stored inPbAdmin database forreporting purposes only

Can be settled

RemoveOpenTransaction(90)

Deletes alloutstandingauthorizationsassociated witha specific card

Deletes a specificauthorization record fromthe database

Cannot besettled

NOTE: Settlement is performed through theDeposit Transactions option from theMain Menu. The settlement transactionitself is done through PbAdmin. ThePbAdmin front-end (PBFE) does notperform the settlement transaction.

Each transaction requires a specific set of input fields andreturns a defined set of output fields regardless of third-party transaction processor.



Required InputFields byTransaction Type

The following table lists the minimum fields required byPbAdmin in the input file for each valid transaction type.We provide a more detailed list of fields later in thissection. For a detailed description of each field, pleaserefer to the ProtoBase Technical Reference Guide.

Transaction Type Input FieldsAuthorization Only (1) 2, 3, 105, 109

Sale (2) 2, 3, 105, 106, 109

Prior-Authorized Sale (7) 2, 3, 105, 106, 109

Return (9) 2, 3, 105, 106, 109

Void Sale (11) 2, 3, 7, 105, 106, 109

Void Return (17) 2, 3, 7, 105, 106, 109

Check Authorization (20) 2, 105, 106, 109

Transaction Inquiry (22) 3, 7, 105, 106, 109

Incremental Authorization (75) 2, 3, 105, 109

Authorization Reversal (76) 2, 3, 105, 109

Working Key Update (77) None required

Close of Open Transaction (89) 2, 3, 7, 105, 106, 109

Remove Open Transaction (90) 2, 3, 7, 105, 106, 109



Suggested InputFields by IndustryType

The following table lists the industry-specific fields thatshould be included in the input file to comply with currentregulations for electronic card processing.

Industry Type Input Fields

Restaurant (002) 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 212,213

Lodging/Front Desk(003)

300, 301, 302, 303, 304, 305, 306, 307, 309, 310, 311, 312,313

Retail (004) 71, 400, 401, 406, 407, 408, 409, 410, 411, 412, 413, 414,415, 416

Rental Car (005) 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511,512, 513, 514, 515, 516, 517, 519, 520, 521

Direct Marketing(007)

711, 712, 713, 714, 715, 716, 717, 718, 719, 720, 721, 722

Lodging/Restaurant(003/002)

300, 301, 305, 308, 200, 201, 202, 203, 204, 205, 206, 207,208, 209, 210, 212, 213

Lodging/Retail(003/004)

300, 301, 305, 308, 400, 401, 406, 407, 408, 409, 410, 411,412, 413, 414, 415, 416

Generic (999) None available

NOTE: Lodging/Retail may be set up as eitherLodging/Retail or Retail. Similarly,Lodging/Restaurant may be set up aseither Lodging/Restaurant orRestaurant. How this is set up dependson the industry classification assigned byAmerican Express or the hotel’s third-party transaction processor.



Output Fields The output fields returned for each transaction include:

• All fields passed as input fields• Field 1003 (ProtoBase response code)• Field 1010 (ProtoBase response message)

Output Field Names and Attributes

1003 ProtoBase Response Code Numeric 4

1004 Host Response Message Alpha numeric 80

1009 Host Response Code Alpha numeric 10

1010 ProtoBase Response Message Alpha numeric 30

1011 Host Reference Number(Used by Host Processor)

Alpha numeric 8

1015 AVS Result Code Alpha numeric 8



Output Fields(cont.)

In addition to the output fields on the previous page, otherconditions determine which output fields will be passeddepending on the response code returned.

TransactionType

If PbAdmin responsecode (Field 1003) = 0,these additional fields

are returned:

If PbAdmin responsecode = 60, this

additional field isreturned:

1 6 1004

2 6, 7, 1011 1004

7 7, 1011 1004

9 7, 1011 1004

11 1004

17 1004

20 6 1004

22 N/A

75 6 1004

76 1004

77 1004

89 1004

90 1004

NOTE: If the ProtoBase response code (Field1003) is not a 0 or 60, you should displaythe Host response text returned in Field1004.



Input Fields The following are the fields available for use withPbAdmin. Shaded fields are stored and maintainedwithin PbAdmin, but are not required; however, they will beaccepted and processed by PbAdmin if supplied.

Input Field Names and Attributes

FieldNumber

Field Name Data Type Size/Format

1 Transaction Type Numeric 2

2 Transaction Amount Decimal Amount 99999.99

3 Account Number/Track Alpha Numeric 120

4 Expiration Date Numeric MMYY

6 Authorization Number Alpha Numeric 6

7 Reference Number Alpha Numeric 12

9 Batch Number Numeric 8

11 User Defined Field Alpha Numeric 80

12 Force Flag Numeric 1

13 Override System Transaction Date Numeric MMDDYY

14 Override System Transaction Time Numeric HHMMSS

15 PS2000 Data Alpha Numeric 23

16 PS2000 Amount Decimal Amount 9999.99

18 Debit PIN Number Alpha Numeric 16

25 Business Date Date MMDDYY

32 Transaction Date Date MMDDYY

33 Transaction Time Time HHMMSS

34 CPS PSI Indicator Alpha Numeric 1

35 CPS Transaction Code Alpha Numeric 4

36 CPS Transaction ID Alpha Numeric 15

37 CPS Authorizer Alpha Numeric 1

38 Reason Code Alpha Numeric 2

39 POS Entry Mode Alpha Numeric 4

40 CVC Error Indicator Alpha Numeric 1



FieldNumber


41 Magnetic Stripe Quality Indicator Alpha Numeric 1

42 Authentication Code Alpha Numeric 6

70 Customer Code Alpha Numeric 17

71 Tax 1 Included Numeric 1

72 Tax 1 Amount Decimal Amount 999.99





100 X Display Coordinate Numeric 2

101 Y Display Coordinate Numeric 2

105 ProtoBase Files Path Alpha Numeric 80

106 Settlement Path Alpha Numeric 80

107 Settlement Report Path Alpha Numeric 80

108 Settlement History Path Alpha Numeric 80

109 Terminal ID Alpha Numeric 8

110 Cashier ID Alpha Numeric 7

112 Processor ID Numeric 3

115 Transaction Qualifier Numeric 3

118 Reversal ID Numeric 1

125 Retrieval Reference Number Numeric 8

126 Acquiring ICA Alpha Numeric 2

127 Authorization Characteristic Indicator Alpha Numeric 1

128 Original Authorization Amount Numeric 9

129 Preferred Customer Indicator Alpha Numeric 1

130 Total Authorized Amount Numeric 9

131 Total Number of Incrementals Numeric 2

132 Authorization Reversal Sent Numeric 1



Restaurant

FieldNumber


200 Charge Description Numeric 2

201 Tip 1 Amount Decimal Amount 9999.99

202 Tip 2 Amount Decimal Amount 9999.99

203 Server 1 Number Numeric 8

204 Server 2 Number Numeric 8

205 Ticket Number Numeric 6

206 Tax Amount Decimal Amount 999.99

207 Food Amount3 Decimal Amount 99999.99

208 Beverage Amount Decimal Amount 9999.99

209 Table Number Numeric 3

210 Tip 1 Description Alpha Numeric “TIP”

211 Adjusted Tip Amount Decimal Amount 99.99

212 ROC Number Alpha Numeric 10

213 Food Description Alpha Numeric “FOOD”,“FOOD/BEV”,“BEVERAGE”

214 Beverage Description Alpha Numeric “BEVERAGE”“DRINKS”

215 Tip 2 DescriptionAlpha Numeric

“TIP”

216 Number of Guests Numeric 2

3 Food Amount - Any amount 10,000 or greater will be changed to 9999.99 due to processor limitations



Lodging

FieldNumber


300 Charge Description4 Numeric 2

301 Folio Number Numeric 8

302 Room Rate5 Decimal Amount 9999.99

303 Checkin Date Date MMDDYY

304 Checkout Date Date MMDDYY

305 Program Code Numeric 2

306 Tax Amount Decimal Amount 999.99

307 Length of Stay6 Numeric 4

308 Ticket Number/ROC Number Numeric 10

309 Operator/Server ID Numeric 6

310 Room Number Alpha Numeric 4

311 Extra Charges Decimal Amount 999.99

312 Extra Charges Reason7 Numeric 6

313 Guest Name Alpha Numeric 26

4 Charge Description values - 00=Health Spa, 01=Lodging, 02=Food/Beverage, 03=Gift Shop, 04=BeautySalon, 05=Convention Fees, 06=Tennis/Pro Shop, 07=Golf/Pro-Shop, 08=Unassigned, 09=Unassigned5 Room Rate - Any amount 1,000 or greater will be changed to 999.99 due to processor limitations6 Length of Stay - Any amount 100 or greater will be changed to 99 due to processor limitations7 Extra Reason Codes: 0-None, 2-Restaurant, 3-Gift Shop, 4-MiniBar, 5-Telephone, 6-Other, 7-Laundry(Up to six individual reason codes can be entered in the same field)



Retail

FieldNumber


400 Item Code Numeric 2

401 Invoice Number Numeric 6

406 Item 1 Text Alpha Numeric 40





411 Retail Terms Numeric 4

412 Item Code 1 Numeric 4





Rental Car

500 Vehicle ID Number Numeric 8

501 Adjustment Amount Decimal Amount 999.99

502 Rental Date Date MMDDYY

503 Rental Time Time HHMMSS

504 Rental City Alpha Numeric 18

505 Rental State Alpha Numeric 2

506 Return Date Date MMDDYY

507 Return Time Time HHMMSS

508 Return City Alpha Numeric 18`

509 Return State Alpha Numeric 2

510 Renter Name Alpha Numeric 26

511 Rental Agreement Number Alpha Numeric 9

512 Days Rented Numeric 2



FieldNumber


513 Promotion Code Numeric 4

514 Certificate Number Alpha Numeric 14

515 Reserve City Alpha Numeric 18

516 Reserve State Alpha Numeric 2

517 Tax Amount Numeric 999.99


519 Program Indicator Alpha Numeric 2

520 Return Location ID Alpha Numeric 10

521 Extra Charges8 Numeric 6

Address Verification

700 Zip Code Numeric 9

701 Street Address Alpha Numeric 20

702 First Name Alpha Numeric 15

703 Last Name Alpha Numeric 20

704 House Number Alpha Numeric 6

705 Street Name Alpha Numeric 20

706 Apartment Number Alpha Numeric 6

707 City Alpha Numeric 20

708 State Alpha Numeric 2

Direct Marketing

711 Shipping Date Date MMDDYY


713 Clearing Sequence Count Numeric 2

714 Clearing Sequence Number Numeric 2

715 Order Number Numeric 10

716 Ship to Zip Code Numeric 5-9

8 Extra Charges reason code: 0-None, 1-Gas, 2-Extra Mileage, 3-Late Return, 4-One way service, 5-Parking Violation




FieldNumber




720 Item 1 Code Numeric 4



Checks

900 MICR Number Alpha Numeric 40

901 Driver’s License Number Alpha Numeric 50

902 Check Number Numeric 6

903 Alpha Numeric State Code Alpha Numeric 2

904 Numeric State Code Numeric 2

905 Date of Birth Date MMDDYY

906 Check Type Numeric 3

907 MICR Entry Mode Numeric 1

908 Driver’s License Entry Mode Numeric 1

909 Manager Override Alpha Numeric 1

910 Zip Code Numeric 5-9

911 Phone Number Numeric 10

912 ABA Number Numeric 9

913 Alternate Identification Indicator Numeric 2

914 Alternate Identification Alpha Numeric 80

Gateways

8000 Remote Program to Run (PBFE.EXE) Alpha Numeric 40

NOTE: Detailed descriptions of all of these fields are available in theProtoBase Technical Reference Guide. Many of thesefields correspond to PbAdmin screen fields. We describe thescreen fields in detail in the PbAdmin Technical Referencesection.



IntegratingPbAdmin forSpecificProcessingSituations

Before integrating PbAdmin into your POS system, youneed to know how PbAdmin handles various transactiontypes (such as Authorization maintenance, Prior-Authorization, and Settlement) and other processingsituations.

In this section, we describe the integration considerationsfor specific transactions and other processing options.

IncrementalAuthorization andAuthorizationReversal

PbAdmin can be set up to run Incremental Authorizationsand Authorization Reversals as required.

If the difference between the original and finalauthorization amount is greater than the AuthorizationTolerance percentage, PbAdmin can automaticallyprocess the appropriate Incremental Authorization orAuthorization Reversal. The Authorization Tolerancepercentage is set in the Authorization Tolerance Valuefield (on the Location Information screen).

NOTE: If Auth Tolerance Value is set to 100%, itdisables checking for both IncrementalAuthorization and AuthorizationReversals. PbAdmin does not create oneof these transactions automatically inthis case. Therefore, incrementals andreversals must be handled by theintegrator to maintain CPS compliance.

If a transaction is manually edited making the difference inthe original and final amount more than the tolerance, anIncremental Authorization or Authorization Reversal isautomatically run prior to settlement as required.

Incremental Auths and Auth Reversals are both reflected inthe total amount authorized field (130) of the transaction.CPS field data is automatically maintained by PbAdminand does not need to be passed by the POS system forthese transactions.



IncrementalAuthorization

Processing for Incremental Authorizations depends onhow the Auto Authorize Difference field is set in theLocation Information screen for that location:

• If set to Yes, when a Prior Auth is run and theamount is greater than the total authorized amountby more than the Auth Tolerance percentage,PbAdmin will automatically create an IncrementalAuth.

• If set to No, the user will get an error message“-116 Final Amt Too Large” if the amount isgreater than the total authorized amount by morethan the Auth Tolerance percentage.

If two Authorization Only (type 01) transactions are run withthe same Reference Number, PbAdmin converts thesecond Auth Only into an Incremental Authorizationautomatically, if required.

If an Incremental Authorization (type 75) is run without anAuthorization Only to reference, it changes the IncrementalAuthorization to an Authorization Only.

AuthorizationReversal

If the total amount authorized exceeds the amount to besettled by an amount larger than the Tolerancepercentage, PbAdmin automatically does an AuthorizationReversal (type 76) at settlement.

If a void is done, at settlement an Auth Reversaltransaction is generated automatically to reverse theexisting authorization.

If the user wants to run an Auth Reversal manually, this canbe done by running an Authorization Reversal (type 76)manually through ProtoBase.



AVS AVS data is supported and the AVS result code in theoutput is stored for the particular transaction. The AVSinformation may be viewed from the Select/View/EditTransactions screen by pressing [F6] (to view a particulartransaction) and then [Shift]+[F3]. For the DirectMarketing industry, AVS information also appears on thetransaction detail screen.

Prior-AuthorizedSale

PbAdmin matches a Prior-Authorized Sale (type 07)transaction to an existing Authorization Only transaction byReference Number, Account Number, and Location.

If a Prior-Auth Sale is entered manually without an AuthOnly to reference, an Auth Only is automatically generatedat settlement time.

If a Prior-Auth Sale is processed with an authorizationnumber but does not have a matching authorization, thetransaction will be treated as a forced authorization andaccepted.

For the lodging industry, if one card is used for check inand another card is used for check out and the hotelcustomer wants to cancel the first card’s purchase, thiscan be done. However, the new card must be authorizedwith an Auth Only transaction. The original Auth Only willremain unless it is removed by running a Remove OpenTransaction (type 90), or purged using the DatabaseManagement menu option.

NOTE: PbAdmin will not reverse authorizationsfor any authorizations that are purged.

Voids andReturns

The Void Sale or Void Return transactions replace theexisting Sale, Prior-Auth Sale, or Return.

A Return transaction creates a new record in the maindatabase.



Settlement The Settlement or Deposit transaction must be run withinPbAdmin using the Deposit Transaction option from theMain Menu. This transaction cannot be run throughPBFE using a Settlement transaction (type 13).

A ProtoBase “batch file” is created by PbAdmin only atsettlement time. Transactions are not stored in a batchfile, but in the PbAdmin database.

Settlement information is locked in and cannot bemodified at the time the Prior-Auth Sale is run. Errors insettlement information may be corrected to match thecurrent configuration using the Fix SettlementInformation option on the Database Management menu.



Gateways If using a ProtoBase Gateway product, you must includean entry of PBFE.EXE in Field 8000 (Remote Program toRun). This lets the Gateway know to run PBFE, thePbAdmin Front End program.

Auto Close SDC does NOT recommend our clients integrate with anauto-close feature. The “Auto-Close” is offered by somehost capture transaction processors to automatically settlethe batch file at a specified time each day, without sendinga Batch Settlement/Close request. Using PbAdmin withauto-close will cause transactions to be moved to historywithout ever dialing out.

MultipleLocations

Integrators have to consider whether the user will havemultiple locations or one location. Each terminal is tied toa specific location. A particular merchant key may beused by one or more locations.

If the end user will be authorizing with one transactionprocessor and settling with a different transactionprocessor, separate terminals must be set up.

Real TimeTransactions

PbAdmin moves real-time transactions (i.e., PIN-paddebit card or check authorization) to the PbAdmin historydatabase directly; no dialing out occurs for thesetransactions. Offline transactions without the use of a PINpad are treated like credit transactions.

TransactionQualifier Field(115)

PbAdmin accepts three values for theTransaction Qualifierfield (115). These values are as follows:

010 = Credit020 = Check030 = Debit

To run a transaction using one of these qualifiers, the inputfile would be run as a Sale transaction (type 02) with theappropriate value in Field 115.



Force Field (12)for ForcedAuthorizations

If a manual authorization is done and the user wants thistransaction in the database, they can run an authorizationwith the Force Field (12) set to 1. This will not dial out, butwill put the transaction in the database.

User DefinedField (11)

The User Defined field (11) can be used to pass anyspecial data needed with the transaction. If this field ispassed in the input file, it is returned in the output file aspresented for all transactions.

Time OutReversal

A communication error may occur when an Authorization,Sale, or Prior-Auth Sale is attempted. It may be uncertainif the transaction was received by the transactionprocessor. In this case, PbAdmin automatically runs atime-out reversal transaction, or retries the transaction.

PbAdmin will retry the transaction as many times asallowed by the transaction processor. If, after exhaustingthe number of attempts PbAdmin still cannot process thetransaction, it will be returned to the POS with the originalerror message.

Printer Setup Printer setup records are provided in PbAdmin fordifferent report formats, as follows:

PortraitLandscape17 cps/20 cps line printer

These settings determine the number of characters perline when printing reports.



Card NumberValidations

A common practice in the lodging industry is for users torun an initial authorization for $1.00 to validate the accountnumber. If, at some point, they expect to actually swipe thecard, it is recommended that the $1.00 authorization bedone at a terminal different than the one used to processthe transaction with the cardholder present. The terminalused should be set to go to a different location to avoidconflict with inactive transactions.

TransactionInquiry (TranType 22)

The Transaction Inquiry transaction is unique to users ofPbAdmin. This transaction can be used to inquire aboutthe status of a transaction in the PbAdmin database. Thiswould be used when an error occurs that prevents anoutput response file from being received. In this case, thetransaction status is uncertain. The Transaction Inquirycan be run on this transaction to determine the currentstatus of the transaction.

This transaction does not dial out. It returns CPS data inits response and a report on the current status.ProtoBase does not need to be running for this transactionto function.



How to GenerateReports Outsideof PbAdmin

PBADREP, thePbAdmin ReportGenerator

This section describes the information you need to runreports outside of PbAdmin. This integration optionenables your POS system to call the report generatorprogram, PBADREP, directly, rather than having PbAdmincall it.

PBADREP, the PbAdmin report generator, uses an inputfile that specifies the type of report (in Field 1) and thecriteria to generate it. Within the PbAdmin menus, thisinput file is generated automatically when you select anyreport option (e.g., from the Reports Menu or from theTransaction History Menu).

However, you may want to generate reports outsidePbAdmin and have your POS system call PBADREPdirectly. This will offer your POS system more flexibility forPbAdmin report generation.

The input file for PBADREP may be created as you needit. If the same report will be run multiple times, you maywant to set up a batch file to use the same input fieldvalues every time.

To have your POS system call PBADREP, you must setup an input file first. We describe how to do this on thenext page.

PBADREP generates the report and places its text in thedirectory path and filename specified in Field 107 of theinput file. We describe the reports themselves in moredetail in the PbAdmin Technical Reference section.

Reports are page numbered and printed according to thelength and width specified. However, the user must setthe printer mode prior to printing. No printer codes areinserted into the report. Reports are blank line padded tothe proper page length.



PBADREP, thePbAdmin ReportGenerator(cont.)

How to Call theReport Generator(PBADREP)

In addition to the actual report, an output file is alsogenerated when PBADREP is run. It contains responsecodes, dollar amounts, and item counts. If you want, youmay parse this output file to verify the report has beengenerated successfully.

NOTE: PBADREP will exit with a non-zero value ifany errors are present. The program errorcode may then be reviewed.

To call the report generator, use the following format:

pbadrep -iinput.in [-ooutput.out]

input.in is the input filename and output.out is theoptional output filename. If the output filename is notspecified, the default output filename is the input filenamewith a .out extension.

You must set up an input file for PBADREP to use. Wedescribe the entries you can make in this file below.



How to Set up theInput File

The input file to be used by PBADREP must contain avertical series of field numbers and corresponding values,separated by a comma. The number to the left of eachcomma indicates the field number. The value to the rightof each comma indicates the value for this field.Comments are entered to the right of asterisks.

The following is a sample input file transaction:

1,1 * Terminal report105,.\106,.\107,.\report.rpt * Report text file110,3 * Pre-settlement111,X * Selected records112,steve’s front desk * Location name115,D *Standard detail/totals

Using the above input file, PBADREP will generate a pre-settlement Terminal report called report.rpt containingselected records from the location named “steve’s frontdesk”.



Table of Input FileFields

The table below describes the fields that may be includedin the input file used by PBADREP. The table shows thefield number, name, description, values and whether thefield is required.

NOTE: Not all combinations of values will workfor PBADREP. You must be aware of thelimitations of certain reports. Forexample, Card Type and Merchant Keyreports (values 8 and 9 in Field 1) do notoffer the industry detail option (value F inField 115). For more information on thereports, please refer to the PbAdminTechnical Reference section.

Input File Format Used for PBADREP

FieldNumber

Field Name Required? Description

1 Report Type Yes The type of report to be generated.

1 = Terminal Report

2 = Cashier Report

3 = Auth Date-Time Report

4 = Tip Report (Restaurant Only)

5 = Deposit Date and Time Report

6 = Deposit Error Report

7 = Incremental Auth Report

8 = Card Report

9 = Merchant Key Report

100 Width of Page No The width of the report page.

80 = Portrait (Default)

137 = Epson 17 cpi

160 = Epson 20 cpi

177 = Landscape

101 Length of Page No The length of the report page.

60 = All print modes



Input File Format Used for PBADREP (cont.)

FieldNumber


105 ProtoBase FilesDirectory Path

Yes The directory path for the ProtoBasefiles. The minimum entry is .\ (non-UNIX) or ./ (UNIX). These are the filesin PBPATH.

106 PbAdmin DatabaseDirectory Path

Yes The directory path for the PbAdmindatabases. The minimum entry is .\(non-UNIX) or ./ (UNIX). These are thefiles in PBDBPATH.

107 Report DirectoryPath and Filename

Yes The directory path and filename for thereport generated from the PBADREPprogram. The minimum entry is.\report.rpt or ./report.rpt (wherereport.rpt is the report filename).

110 Report SelectionCriteria

Yes Defines the type of records to beselected for the report.

1 = All records

2 = Selected Records

3 = Pre-settlement

If this value is 2 or 3, Field 111 is alsorequired.

111 Report SelectionCriteria (Additional)

No if Field 110= 1

Yes if Field110 = 2 or 3

The transaction status flags to beincluded on the report. Transactionswith any of these flags on theSelect/View/Edit Transactions screen(or History Transaction screen) will beincluded on the report. Enter this valueas a string with no separators.

! = Transaction in errorA = AuthorizingH = Host captureI = In progress (currently being settled)M = Move to History pendingP = Pending with American ExpressR = Real time transactionS = SettledU = Host capture pendingV = Void or Void ReturnX = Selected records

XUR is the recommended setting.



Input File Format Used for PBADREP (cont.)

FieldNumber


112 Location Name Yes The location name from which theserecords are to be selected for thereport. This value must match exactlyto the actual name of the location. Use“ALL” for all locations.

113 Exclude Characters No The transaction status flags to beexcluded from the report. Transactionswith any of these flags on theSelect/View/Edit Transactions screen(or History Transaction screen) will beexcluded from the report. Enter thisvalue as a string with no separators.

The values are the same as for Field111.

IA is the recommended setting.

114 Batch Number forHistory Reports

No The batch number to report. Applicableonly for history reports.

115 Detail Type Yes Defines the type of records to be selectedfor the report. Each of these values maynot be applicable to all report types foundin Field 1.

T = Totals only (Applicable to all reporttypes)

D = Standard detail and totals (Applicableto all report types except 5 and 7)

F = Full industry detail and totals(Applicable to report types 1 and 2only)

116 Sort Order No Describes the numeric or alphabeticorder that records will be grouped onthe report.

A = Ascending order (low to high)

D = Descending order (high to low)

117 History Month andYear

Applicableand requiredfor historyreports only

The month and year of the history toinclude on the report. Required forhistory reports.



Input File Format for PBADREP (cont.)

FieldNumber


9998 Deposit Status Text No Text to be displayed on report regardingtransaction deposit status. User-defined.

9999 Report Header Text No Text to be displayed on the report asthe report header. User-defined.

Output File that isGenerated

The following table describes the fields that may begenerated in the output file from PBADREP. This file maybe parsed and used to determine that reports havegenerated successfully. The table shows the field number,field name, and description.

NOTE: This output file is not the report textoutput; the actual report text is placedunder the directory and filename definedin Field 107.

Output File Generated from PBADREP

FieldNumber

Field Name Description

1003 Error Code The error code from PBADREP other than database-related errors. If the report is generated correctly, thisfield equals 0.

1009 Database ErrorCode

The error code from PBADREP related to a databaseproblem. If the report is generated correctly, this fieldequals 0.

1010 Error Text The verbose error from PBADREP. If the report isgenerated correctly, this field equals“ACKNOWLEDGED”.

1020 Net Credit DollarAmount

Total dollar amount for all credit transactions on thisreport.

1021 Net Debit DollarAmount

Total dollar amount for all debit transactions on thisreport.



Output File Generated from PBADREP (cont.)

FieldNumber

Field Name Description

1022 Net Check DollarAmount

Total dollar amount for all check transactions on thisreport.

1030 Net Credit Count Total count of all credit transactions on this report.

1031 Net Debit Count Total count of all debit transactions on this report.

1032 Net Check Count Total count of all check transactions on this report.



How to Use theOptional FileServer Gateway

This section describes how to setup PbAdmin to use theProtoBase File Server Gateway. This integration optionenables the merchant to perform settlement or othertransactions from systems that cannot work togetherdirectly, such as using ProtoBase Windows NT (i.e., 32-bit) from a 16-bit DOS machine, an OS/2 machine, and aremote 32-bit Windows machine. See Figure II-2 for anexample.

SystemRequirements

To use the ProtoBase File Server Gateway in themerchant’s system, the following requirements must bemet:

• The local computers that will be runningsettlement must have the ProtoBase directorymapped to it. This allows the local program tohave access to the databases on the networkserver.

• The operating system of the POS must supportshared file systems (for example, Novell,LANtastic, Microsoft Networks, and UNIX NFS).

NetworkServer

ProtoBase Windows NT, File Server Gateway, and Global PbAdmin with Global INI File

POS SystemWorkstations

16-Bit DOS,Local

PbAdmin withLocal INI

OS/2, Local

PbAdmin withLocal INI

Remote 32-BitWindows, LocalPbAdmin with

Local INI

Transaction Processor

Figure II-2



How to SetupPbAdmin to Usethe Gateway

To setup PbAdmin to use the File Server Gateway, theGlobal INI file must already be set up on the networkmachine running ProtoBase. Refer to theInstallation/Setup section for more information. Afterthis is setup, you must perform the following steps:

• Install PbAdmin on at least one local computer.We describe installation procedures in theInstallation/Setup section.

• Setup a Local INI file on the local computer. Youdo this using the Local INI File screen. Wedescribe this screen in detail in the PbAdminTechnical Reference section.

• Install the ProtoBase File Server Gatewaysoftware on the network machine, if not alreadyinstalled. For information on Gateways, refer tothe ProtoBase Gateway documentation.

• Enter the file dropoff path for the Gatewaysoftware in the Optional Gateway File Path fieldon the Local INI File Screen on the localcomputer. This is not the path where theGateway software resides; it is the path wherefiles are to be picked up by the Gateway forprocessing. We describe this screen field indetail in the PbAdmin Technical Referencesection.



When PbAdmin isSetup with theGateway

When you set up the ProtoBase File Server Gateway, allPbAdmin reports and settlement will run through theGateway.

To have PBFE process transactions through the Gateway,you must have a specific entry for Field 8000 in alltransaction input files. This entry must consist of 8000,followed by the fully-qualified path where PBFE resides(e.g., 8000,c:/pb/pbamin/PBFE.EXE).

For reports using PBADREP, you must include a similarentry (e.g., 8000,c:/pb/pbadmin/PBADREP.EXE)in theinput file used by PBADREP.

ProtoBase Administrator User Guide - Version 4.3.002 – Installation/Setup


ProtoBase


User Guide

III. Installation/Setup



InstallingPbAdmin

To install the ProtoBase Administrator system, you mustinstall all of the following components:

• ProtoBase and applicable SofTrans modules• Any ancillary Southern DataComm products you

are using, including the American Express DirectSettlement Utility and ProtoBase Gateways

• The ProtoBase Front End program (PBFE)• The ProtoBase Administrator (PbAdmin)

All of these parts must be installed and working correctly inorder for the entire system to work properly.

NOTE: If you are installing PbAdmin on amachine that already has ProtoBase, youshould already have the necessaryProtoBase software and SofTrans moduleon your system (Minimum ProtoBaseversion 4.76).

If you are installing ProtoBase andPbAdmin for the first time, you shouldinstall ProtoBase and the SofTransmodules and perform testing prior toinstalling PbAdmin. Refer to theProtoBase User Guide for instructionson how to install ProtoBase and theSofTrans modules.

PbAdmin installation differs depending on the particularoperating system and whether it is an upgrade or a first-time installation. We separate the installation instructionsinto the following:

• DOS/LAN, OS/2 (First-time)• DOS/LAN, OS/2 (Upgrade)• UNIX-based (First time)• UNIX-based (Upgrade)

We discuss how to install PbAdmin for DOS/LAN andOS/2 beginning on the next page. To install PbAdmin forUNIX, proceed to this topic on page 55 of this section.



Installation ofPbAdmin forDOS/LAN, OS/2

This section details the procedure for installing theProtoBase Administrator for the first-time or as anupgrade on non-UNIX based operating systems(DOS/LAN, OS/2). For installation of PbAdmin for UNIX-based operating systems, please refer to the appropriateinstructions on page 55 of this section.

NOTE: If a Technical Bulletin accompanied yoursoftware, please consult it for any specialinstallation or upgrade requirements.

The installation CD contains four files: PKUNZIP.EXE,PBADMIN.ZIP, PBFE.ZIP, and INSTALL.BAT.



SystemRequirements(DOS/LAN, OS/2)

Prior to installing PbAdmin for non-UNIX-based systems,verify that your customer’s operating system meets thefollowing minimum requirements:

• Minimum 10 MB of free hard disk space forinstallation and basic operation.

• Minimum 386 mother board (Pentium highlyrecommended).

• Minimum 8 MB RAM; however, 16 MB or moreRAM is highly recommended.

• Additional hard disk space is needed to storehistory files and databases which can becomelarge in size.

• Set FILES=50 (at a minimum) in your configuration.

• Must load the SHARE executable (DOS and OS/2only).

• Minimum 550K for largest executable program size(Type mem at the command line to check this).



First TimeInstallation ofPbAdmin(DOS/LAN, OS/2)

Below, we detail the steps for installing PbAdmin for thefirst time on a non-UNIX system. If you are upgradingPbAdmin for non-UNIX, please refer to these proceduresbeginning on page 60.

NOTE: PbAdmin should be installed inthe ProtoBase directory, eitherdirectly or within a PbAdmindirectory within the ProtoBasedirectory. You can also install itas a separate directory on thesame level as ProtoBase; however,SDC recommends that you installit in the ProtoBase directory.

Complete the following steps:

1. Change to the directory where PbAdmin will beinstalled.

2. Insert the PbAdmin medium into the appropriate driveand change to that drive.

3. Run the installation script, INSTALL.BAT, by typing thefollowing at the command prompt:

install [full path to ProtoBase directory] [full pathto PbAdmin directory] /d [ENTER]

E.g., install c:\pb c:\pb\ /d [ENTER]

INSTALL.BAT performs the following for you:

• Uncompresses the distribution files• Creates subdirectories DB, DBHIST, and API• Creates Global and Local INI files• Installs the new PbAdmin files• Copies the default user location database files

to the proper directory

The /d argument causes the test location and userfiles, PBADLOCA.DAT, PBADLOCA.IDX,PBFLOOR.DAT, PBFLXREF.DAT,



First TimeInstallation ofPbAdmin(DOS/LAN,, OS/2)(cont.)

PBADUSER.DAT, and PBADUSER.IDX, to becopied to the DB directory from the DB/DEFAULTdirectory. DB is one of the subdirectories underPBADMIN automatically created when you ran theinstall program.

4. Change back to the main PbAdmin directory.

5. For OS/2 systems only, a session of PBSHELL.EXEshould be started on the machine which is runningProtoBase. You should include the command start /npbshell in your startup script.

PbAdmin is delivered with one default location (TESTLOCATION) and one default login ID and password.

Both the login ID and password are pbadmin (all lowercase letters since it is case-sensitive).

You are ready to begin setting up and configuringPbAdmin. Please refer to the topic Setting Up PbAdminon page 72 of this section.



Upgrade ofPbAdmin(DOS/LAN, OS/2)

Below, we detail the steps for upgrading PbAdmin on anon-UNIX system. If you are installing PbAdmin for thefirst time, please refer to these procedures beginning onpage 58.

NOTE 1: Do not upgrade from a version ofPbAdmin earlier than 4.3.001. Pleasecontact SDC Client Services for help.

NOTE 2: Follow these instructions if you haveinstalled PbAdmin in a separate PbAdmindirectory under the main ProtoBasedirectory. If you have installed PbAdmindirectly into the root ProtoBase directory,contact our Client Services Departmenttoll free at 1-877-SDC-1799 for assistance.Please have your customer accountnumber available.


1. Backup all existing PbAdmin files on the currentPbAdmin directory for precautionary purposes.

2. Change to the PbAdmin directory.

3. If your existing version is 4.1, type DBEXPORT fromthe command prompt to export your databases fromthe existing version. You will run a script later that willimport them back into the new version of PbAdmin.Be sure to save all *.EXP files.

4. If your existing version is 4.2 or higher, typeDBEXPORT -a –h from the command prompt toexport your databases (including history) from theexisting version. You will run a script later that willimport them back into the new version of PbAdmin.Be sure to save all *.EXP files.



Upgrade ofPbAdmin(DOS/LAN, OS/2)(cont.)

The following command line arguments are availablefor DBEXPORT for version 4.2 or higher:

-a = Export all databases except history-h = Export all of history database-h (MMYY) = Export history database for two-digit monthand year specified-m = Export main database-p = Export packet database-l = Export location database-u = Export user database-d [char] = Export character delimiter (“|”, the pipesymbol, is the default character)-? = Displays this menu of options

5. Insert the PbAdmin installation medium into theappropriate drive and change to that drive.

6. Verify you have backed up the existing database filesand check for the *.EXP files. Then, delete the existingdatabase files (the .DAT and .IDX files forPBADLOCA, PBADUSER, PBADMAIN, andPBPACKET; and, from version 4.1, GENSETUP.DATin the DB directory; and, from version 4.3.002,PBFLOOR.DAT and PBFLXREF.DAT; and all .DATand .IDX files in the DBHIST directory).

7. Run the install script, INSTALL.BAT, by typing thefollowing at the command prompt:

install [full path to ProtoBase directory] [full pathto PbAdmin directory] [ENTER]

E.g., install c:\pb c:\pb\pbadmin [ENTER]

INSTALL.BAT performs the following for you:

• Uncompresses the distribution files• Updates the Global and Local INI files• Deletes the old version of PbAdmin• Installs the new PbAdmin files

NOTE: Do not use the /d option in the abovecommand line as it will overwrite yourexisting databases.



Upgrade ofPbAdmin(DOS/LAN, OS/2)(cont.)

8. Change back to the main PbAdmin directory. Thentype DBIMPORT -a -h from the command prompt toimport the exported databases into the new version.

9. Copy PBCONFIG.LST from the DB directory to theProtoBase directory. Rename this file toPBCONFIG.CFG.

10. Run the upgrade configuration utility, READCFG, toread in your existing PBCONFIG.CFG information.Please refer to page 82 for details.

11. For OS/2 systems only, a session of PBSHELL.EXEshould be started on the machine which is runningProtoBase. You should include the command start /npbshell in your startup script.

PbAdmin should be setup with the same locationinformation as before the upgrade. To make edits to yoursetup, refer to the Setting Up PbAdmin topic on page 72.

You must run configuration to initialize the upgrade.Please refer to the topic Configuring ProtoBase on page82 of this section.



Installation ofPbAdmin forUNIX

This section details the procedure for installing theProtoBase Administrator for the first time or as anupgrade on UNIX-based operating systems Forinstallation of PbAdmin for non-UNIX operating systems(DOS/LAN or OS/2), please refer to the appropriateinstructions on page 56 of this section.

NOTE: If a Technical Bulletin accompanied yoursoftware, please consult it for any specialinstallation or upgrade requirements.

A CD is provided with your distribution and may containsoftware for several SDC products. It includes one of twoPbAdmin files: 43001.tar or 43002.tar.

These files are contained in a CD directory structureillustrated below. The file name that you will specify forinstallation represents the version of PbAdmin that you arerunning.

Abbreviations for the Operating SystemsOperating System AbbreviationAIX AIX322, AIX41, AIX43DG/UX DGUX411, DGUX43

HP UX HP1020, HP1010, HP11Motorola M68K, M88KQNX QNX424VMS VMS71Red Hat Linux REDHAT52SCO OpenServer SCO322, SCO325SCO UnixWare UWARE21, UWARE71Sequent SEQUENTSolaris SOL26, SPARC26, SOL8, SPARC8

PBADMIN43001.TAR

43002.TAR

ROOT/

<Operating System>



SystemRequirements(UNIX)

Prior to installing PbAdmin for UNIX-based systems, verifythat your customer’s operating system meets the followingminimum requirements:

• Minimum 10 MB of free hard disk space forinstallation and basic operation.

• 90% or less used disk space on the installationfiles system.

• Additional hard disk space as needed to storehistory files and databases which can becomelarge in size.

• Computer terminal or emulator that is compatiblewith one of the following types:

• Wyse 50• VT 100/220/320• IBM 3151• VT 100• ANSI

Other compatible terminals may be available. Pleasecontact SDC Client Services for more information.



First-TimeInstallation ofPbAdmin forUNIX

Below, we detail the steps for installing PbAdmin for thefirst time on a UNIX system. If you are upgradingPbAdmin, please refer to these procedures beginning onpage 68.

NOTE: PbAdmin should be installed in theProtoBase directory, either directly orwithin a PbAdmin directory within theProtoBase directory. You can also installit as a separate directory on the samelevel as ProtoBase; however, SDCrecommends that you install it in theProtoBase directory.

To properly install PbAdmin, complete the following :

1. Create two directories. One is a temporary installationdirectory; call it temp or a similar name. The other willbe the main PbAdmin directory; call it pbadmin orsimilar. You will use the temporary directory to untarthe files from the CD. You will use the other as yourpermanent main PbAdmin directory.

2. Change to the temporary directory you have created. If this is a SCO operating system, type: /bin/ksh

For LINUX or QNX, set the environmental path variableto the current directory:

export PATH=$PATH:.

3. Insert the distribution CD and untar the files from theCD to the temporary directory by typing the following:

For Motorola 68/88:

Example: Typetar xovf /<mount point>/M68K/pbadmin/43002.tar[ENTER]where <mount point> is the name you designatedwhen mounting the CD-drive.

For all others:

Example: Typetar xvf /<mount point>/<current operating systemabbreviation>/pbadmin/43002.tar [ENTER]where <mount point> is the name you designatedwhen mounting the CD-drive.



First-TimeInstallation ofPbAdmin forUNIX (cont.)

4. The following files are uncompressed:disk1.taz, disk2.taz, install.scr

5. Install PbAdmin by typing the following at the commandprompt:

chmod 777 install.scr [ENTER]chmod 777 compress [ENTER]install.scr [full path to ProtoBase directory] [fullpath to PbAdmin directory] /d [ENTER]

e.g., install.scr /pb/pbadmin /d [ENTER]

install.scr performs the following for you:

• Untars the file on the temporary directory• Creates the pb and pbadmin subdirectories• Copies test location files to the appropriate

directories• Creates Global and Local INI files• Installs the new PbAdmin files• Changes all file permissions for user, group, and

access

The /d argument causes the test location and userfiles, PBADLOCA.DAT, PBADLOCA.IDX,PBADUSER.DAT, and PBADUSER.IDX, to becopied to the DB directory from the DB/DEFAULTdirectory. DB is one of the subdirectories underPBADMIN automatically created when you ran theinstall program.

6. Set VVTERMCAP=path to PbAdmindirectory/DB/vvtermcap.

For example:

VVTERMCAP=/pbadmin/DB/vvtermcap; exportVVTERMCAP



First-TimeInstallation ofPbAdmin forUNIX (cont.)

7. Set VVTERM=terminal emulation (this is optional andshould only be set if the TERM is not compatible withthe terminals described earlier).

For example:

VVTERM=wyse50; export VVTERM

8. If this is a SCO operating system, type: exit

PbAdmin is delivered with one default location (TESTLOCATION) and one default login ID and password. Boththe login ID and password are pbadmin (all lower caseletters since it is case-sensitive).

You are ready to begin setting up and configuringPbAdmin. Please refer to the topic Setting Up PbAdminon page 72.



Upgrade ofPbAdmin forUNIX

Below, we detail the steps for installing PbAdmin as anupgrade on a UNIX system. If you are installing PbAdminfor the first time, please refer to these proceduresbeginning on page 65.

NOTE 1: Do not upgrade from a version ofPbAdmin earlier than 4.3.001. Pleasecontact SDC Client Services forassistance.

NOTE 2:Follow these instructions if you haveinstalled PbAdmin in a separate PbAdmindirectory under the main ProtoBasedirectory. If you have installed PbAdmindirectly into the root ProtoBase directory,contact our Client Services Departmenttoll free at 1-877-SDC-1799 forassistance. Please have your customeraccount number available.


1. Backup all existing PbAdmin files on this directory forsecurity purposes. Create a temporary installationdirectory; call it temp or a similar name. You shouldalready have a main PbAdmin directory calledpbadmin or similar. You will use the temporarydirectory to untar the files from the CD.

If this is a SCO operating system, type: /bin/ksh

2. If your existing PbAdmin version is 4.1, change to themain PbAdmin directory. Type dbexport from thecommand prompt to export your databases from theexisting version. You will run a script later that willimport them back into the new version of PbAdmin.Be sure to save all *.EXP files.



Upgrade ofPbAdmin forUNIX(cont.)

3. If your existing PbAdmin version is 4.2 or higher,change to the main PbAdmin directory. Typedbexport -a -h from the command prompt to exportyour databases from the existing version. You will runa script later that will import them back into the newversion of PbAdmin. Be sure to save all *.EXP files.

The following command line arguments are availablefor dbexport for version 4.2 or higher:

-a = Export all databases except history-h = Export all of history database-h (MMYY) = Export history database for two-digit monthand year specified-m = Export main database-p = Export packet database-l = Export location database-u = Export user database-d [char] = Export character delimiter (“|”, the pipesymbol, is the default character)-? = Displays this menu of options

4. Change to the temporary directory you have created.

Insert the PbAdmin CD and untar the files from the CDto the temporary directory. (Refer to page 63 for theCD directory structure.) Type the following:

For Motorola 68/88:

Example: Typetar xovf /<mount point>/M68K/pbadmin/43002.tar[ENTER]where <mount point> is the name you designated whenmounting the CD-drive.

For all others:

Example: Typetar xvf /<mount point>/<current operating systemabbreviation>/pbadmin/43002.tar [ENTER]where <mount point> is the name you designated whenmounting the CD-drive.




5. Run the upgrade script, upgrade.scr, by typing thefollowing at the command prompt:

upgrade.scr [full path to ProtoBase directory] [fullpath to PbAdmin directory] [ENTER]

e.g., upgrade.scr /pb/pbadmin [ENTER]

upgrade.scr performs the following for you:

• Untars the file on the temporary directory• Updates the Global and Local INI files• Deletes the old version of PbAdmin• Installs the new PbAdmin files• Changes all file permissions for user, group, and

access• Imports the exported data files (except history)

6. Change back to the main PbAdmin directory. Thentype dbimport -h from the command prompt to importthe exported history databases into the new version.

7. Copy pbconfig.lst from the DB directory to theProtoBase directory. Rename this file topbconfig.cfg.

8. Run the upgrade configuration utility, readcfg, to readin your existing pbconfig.cfg information. Pleaserefer to page 82 for details.

9. Set VVTERMCAP=path to PbAdmindirectory/DB/vvtermcap.

For example:

VVTERMCAP=/pbadmin/DB/vvtermcap; exportVVTERMCAP




10. Set VVTERM=terminal emulation (this is optional andshould only be set if the TERM is not compatible withthe terminals described earlier).

For example:

VVTERM=wyse50; export VVTERM

11. If this is a SCO operating system, type: exit

PbAdmin should be setup with the same locationinformation as before the upgrade. To make edits to yoursetup, refer to the next topic, Setting Up PbAdmin, onpage 72.

You must run configuration to initialize the upgrade.Please refer to the topic Configuring ProtoBase on page82 of this section.



Setting UpPbAdmin

After you have completed the installation of the ProtoBaseAdministrator, you can begin setting up PbAdmin for use.This step involves configuring various aspects of PbAdminand ProtoBase to work with your operating systemproperly.

NOTE: If you are upgrading PbAdmin and haveimported existing databases, you maywant to use this section to edit yoursetup information.

This section explains how to set up the following:

• Global and Local INI files• Merchant locations• User security• Reports security

Figure III-1 outlines the general areas to set up.

PbAdmin Set-up

INIFiles

MerchantLocations

ReportsSecurity

UserSecurity

PbAdminReports

Directory Paths

Figure III-1



Setup Screens/Instructions

After PbAdmin installation, use the PBADDLOC utility toaccess the Global INI File screen. This screen reads inthe global directory paths you set and allows you to makeany corrections. It also creates a default Local INI Filewhich contains paths to the Global INI File. For adescription of the Local INI File screen, please refer to thePbAdmin Technical Reference section.

Global INI FileScreen

To access the Global INI File screen, change to thePbAdmin directory. From the command prompt, typepbaddloc [ENTER]. The Global INI File screen appearsas shown below. It indicates “New” if being accessed forthe first time.

You should verify the accuracy of the information on thisscreen. Make any changes where appropriate. Press[F1] for a description of each field. For a detaileddescription of every field on this screen, refer to thePbAdmin Technical Reference section.

Global INI File Screen

Press the [F10] key to save changes; then press [ESC] tocontinue setup. This exits you out of the Global INI Filescreen and takes you into the ProtoBase AdministratorUser Log In screen.



ProtoBaseAdministratorUser LoginScreen

The ProtoBase Administrator User Login screen enablesyou to log into the ProtoBase Administrator system.

Log in using pbadmin as the Login ID and pbadmin asthe Password. Both of these must be entered with alllower case letters.

When you log in, the next screen, the Locations screen,lists all of the locations currently setup in the system.

User Login Screen



ProtoBaseAdministratorLocations Screen

The ProtoBase Administrator Locations screen enablesyou to view a list of all established locations. These canbe different individual merchant locations, or separatePOS stations within one merchant location. When you firstinstall PbAdmin, one default location, “Test Location”, isautomatically established. The default location is set upas a master location.

Locations Screen

To choose an existing location to modify, highlight thelocation and press [ENTER]. If you are installing for thefirst time, the only location established is called TESTLOCATION.

To enter a new location, press [F3].



LocationInformationScreen

You access the Location Information screen automaticallywhen you select one of the locations listed on the previousLocations list screen, or when you press [F3] to enter anew location. This screen also can be accessed fromPbAdmin through the Administrator Setup option from theMain Menu.

Use this screen to set up details about a particularlocation that is using PbAdmin. You may modify existinglocations or add new ones using this screen.

For a detailed description of every field on this screen,refer to the PbAdmin Technical Reference section.

The Location Information screen appears as shown below.

Location Information Screen



LocationInformationScreen (cont.)

If this was a new location you have just entered, press[F10] to save the new location. PbAdmin willautomatically access the User Security screen. Wedescribe this screen on the next page.

If you have made changes to an existing location, press[F10] to save the changes. The message “Changeshave been saved” appears. You can then press [ESC]to return to PbAdmin.



User SecurityScreen

The User Security screen is accessed automatically whenyou enter a new location from the Location Informationscreen and exit for the first time. This screen also can beaccessed through the Administrator Setup option from theMain Menu.

You should use this screen to make changes to useraccess for this particular location. You can limit aparticular user’s access to various parts of PbAdmin forthis location by indicating No for any of these screenfields. However, the primary user for this location shouldhave all fields set to Yes.


The User Security screen appears as shown below.

User Security Screen



User SecurityScreen (cont.)

If you adding the initial user to a new location, the “Yes/No”fields automatically default to Yes. You can specificallyselect those fields you want to change to No.

If you access the User Security screen from theAdministrator Setup option from the Main Menu, the“Yes/No” fields automatically default to No. You cantoggle all of these fields to Yes by pressing [Shift]+[F3].

NOTE: Enter information in the Login screen fieldcarefully. This becomes the base login forthe location you just added.

Make sure you press [F10] to save any changes you havemade. The message “Changes have been saved”appears.

You can now press [F6] to enter the Reports Securityscreen to set up security for the PbAdmin reports.

NOTE: The Reports Security screen can only beaccessed from the User Security screen.



Reports SecurityScreen

The Reports Security screen is accessed by pressing [F6]from the User Security screen. This screen contains fieldsrepresenting each of the reports available in PbAdmin.You should use this screen to make any changes to useraccess for particular reports. You can limit a particularuser’s access to a report by pressing the space bar totoggle the appropriate screen field to No.


The Reports Security screen appears as shown below.

Reports Security Screen



Reports SecurityScreen (cont.)

If you adding the initial user to a new location, the “Yes/No”fields automatically default to Yes. You can thenspecifically select those report fields you want to changeto No.

If you access the Reports Security screen via the UserSecurity screen from the Administrator Setup option fromthe Main Menu, the “Yes/No” fields automatically default toNo. You can toggle all of these fields to Yes by pressing[Shift]+[F3].

Make the appropriate edits on this screen. Use the spacebar to toggle between Yes and No responses.


Press [ESC] to exit the Reports Security screen. Thisbrings you back to the User Security screen. If you aresatisfied with all changes on the User Security screen,press [ESC] again. This brings you back to theAdministrator Setup menu. Press [ESC] and [F10] to exitback to the command prompt.

You are now ready to configure ProtoBase. We explainhow to do this with the next topic, Configuring ProtoBase.



ConfiguringProtoBase

You have two options for configuring ProtoBase to workwith PbAdmin: automatic configuration and manualconfiguration. We discuss both methods in this section.

NOTE: For OS/2 systems only, start PBSHELLfrom an OS/2 window prior toconfiguring ProtoBase. You shouldinclude the command start /n pbshell inyour startup script.

AutomaticConfiguration -Overview

Automatic configuration may be used if you have anexisting ProtoBase configuration file, PBCONFIG.CFG,that you want to convert to the PbAdmin screen interface.You convert this file to PbAdmin using the executable file,READCFG. We recommend you use this method if youwant to configure several merchant sites using PbAdminthe same way (or very similar) from one file. You can useone version of PBCONFIG.CFG to create multipleconfigurations of ProtoBase in PbAdmin format.

On the next page, we describe this method in detail.

ManualConfiguration -Overview

Manual configuration may be used to configure thetransaction processors, terminals, credit card tables, andcommunication devices right into the ProtoBaseAdministrator using the PbAdmin configuration screeninterface. Although this is a manual process, it is still fairlyquick and efficient. The ProtoBase Configuration optionin PbAdmin, like other menu options, has easy-to-usepop-up lists. You can move the cursor to particular itemsand press [ENTER] to select them.

We describe this configuration method in detail beginningon page 87.



Backing up theDB Directory

We strongly suggest that after you have installed andconfigured PbAdmin, but before actually using PbAdmin,you back up the databases in the DB directory. You cando this by creating a separate directory and saving thefiles on the DB directory to the back-up directory.

The files you need to backup are the .IDX and .DAT filesfor PBADUSER, PBADLOCA, PBADMAIN, andPBPACKET.

Do this as a safety measure against any possibilities ofcorrupted databases.

When you are sure that PbAdmin is running successfully,you can delete the back-up directory.

AutomaticConfiguration ofProtoBase

How to Know ifYou Are Ready toConfigureAutomatically

This section explains how to configure the ProtoBaseAdministrator with a pre-existing ProtoBase configurationfile (PBCONFIG.CFG).

The PBCONFIG.CFG file is a text file that can be editedusing any standard text editor. For information on how toedit this file, please refer to the ProtoBase TechnicalReference Guide.

If your PBCONFIG.CFG file contains entries in theTerminal section starting with *** <PbAdmin>***, then thefile is ready to be automatically configured and “read into”PbAdmin.

If these entries are missing, you will have to manuallyconfigure settlement and backup terminals and terminallocations.

NOTE: Recent versions of PbAdmin 4.1 produce aPBCONFIG.LST file with the above entriesincluded to facilitate the upgrade toPbAdmin 4.2 or higher.



Steps toAutomaticallyConfigure

Complete the following steps to automatically configureProtoBase to work with PbAdmin:

1. Follow the steps outlined in this section to configureyour location information.

2. Change to the PbAdmin subdirectory (according tothe path set in the PBDBPATH environmentvariable).

NOTE: If backup terminals were used in thesetup under the old version ofPbAdmin, delete all backup terminals(ending with “B”) from thePBCONFIG.CFG file prior to reading itin the new version.

3. Type the following from the PbAdmin subdirectory:

readcfg [ENTER]

NOTE: If the location information is notincluded with the terminals in theTerminal section of PBCONFIG.CFG,you must type the location namesurrounded by quotation marks (“ ”)after the readcfg command (for examplereadcfg “hotel location1” [ENTER]).

The READCFG program checks the PBPATH directoryfor an existing PBCONFIG.CFG file. If one is found, itconverts the values in PBCONFIG.CFG into PbAdminformat. It moves that file to PBCONFIG.LST in the DBdirectory (a subdirectory of the PBADMIN directory).PbAdmin is then set up with the information from the pre-existing ProtoBase configuration.



Activating theNew Values (RunConfiguration)

For PbAdmin to use the new configuration values thatcame from running READCFG, you must run ProtoBaseconfiguration.

NOTE: Shut down ProtoBase before runningconfiguration. For DOS/LAN, type pbarb/u [ENTER]. For all other operatingsystems, type pbkill [ENTER].

Use the following instructions to activate the values:

1. Log in to PbAdmin and any location using one ofthe login IDs and passwords you have set up.

2. Select Administrator Setup Menu from the MainMenu.

3. Select ProtoBase Configuration from theAdministrator Setup menu. The following messageappears:

One moment. Loading…

4. Verify the ProtoBase values are correct by viewingthem through the menu options.

• Select Processors and view theprocessors set up. Press [ESC] to exit.

• Select Terminals and view the terminals setup. Press [ESC] to exit.

• Select Credit Card Tables and view thecredit cards set up for specific terminals.Press [ESC] to exit.

• Select Devices to view the communicationdevices set up. Press [ESC] to exit.



Activating theNew Values (RunConfiguration)(cont.)

5. Activate the settings by selecting the RunConfiguration option.

NOTE: After running the configuration, thismessage appears in the report file:

“WARNING: Pbconfig has been forced tonot test version compatibility.”

Disregard this message. These files havebeen checked for version compatibilityalready by PbAdmin by running thePBCHKVER program that is included in aProtoBase distribution.

After you complete the automatic configuration ofProtoBase, you are ready to test the Select/EditTransactions option from the Main Menu. We describehow to do this in the How to Use PbAdmin section.



ManualConfiguration ofProtoBase

If you have not performed an automatic configuration ofProtoBase from a pre-existing configuration, you must setup a ProtoBase configuration before you can runProtoBase with PbAdmin. PbAdmin provides an easy-to-use screen interface to set up your configuration.

To manually configure, complete the following steps:

1. Start PbAdmin. To do this, change to the PbAdmindirectory if you are not already in it. Then, typepbadmin and press [ENTER].

2. Log into the system. Use one of the login IDs andpasswords you have set up. For testing purposes,the built-in login ID is pbadmin and the passwordis pbadmin. Type the appropriate login ID andpassword and press [ENTER]. The Main Menuappears as shown below.

Main Menu



ManualConfiguration ofProtoBase (cont.)

3. From the main menu, select the AdministratorSetup option. The Administrator Setup submenuappears as shown below.

Administrator Setup Menu

NOTE: Earlier in this section, we describe theother options shown on this submenu forsetting up the ProtoBase Administrator.

4. To access the ProtoBase Configuration screeninterface, select the ProtoBase Configurationoption from this submenu.

When selected, the message “One Moment.Loading…” displays while the configuration programloads.



ManualConfiguration ofProtoBase (cont.)

The ProtoBase Configuration submenu appears as shownbelow.

ProtoBase Configuration Menu

The ProtoBase Configuration submenu contains optionsto build and configure the ProtoBase file PBCONFIG.LST.The primary areas to configure are as follows:

• Processors• Terminals• Credit Card Tables• Devices

We describe each of these areas in detail beginning onthe next page.

NOTE: Any changes made during this manualconfiguration process will not take effectuntil you select the Run Configurationoption and the configuration runssuccessfully.



Processors

If One or MoreProcessorsAlreadyConfigured andYou Want to Edit

The Processors portion enables you to configure varioustransaction processor information. This includes primaryand secondary phone numbers, baud rates, data bits, andparity for transaction processors to be used forauthorization and settlement.

To begin this process, select Processors from theProtoBase Configuration submenu.

If you have configured one or more processors already, alist appears showing those processors. We show asample below.

Processor List Screen

You can select the one you want to edit by highlighting itand pressing [ENTER]. The Processor Edit Screenappears with the transaction processor information filledin. We show a sample on page 92.



Processors (cont.)

If No ProcessorsConfigured Yet

If you want to add a new processor, press [F3]. A generic,partially completed Processor Edit Screen appears withdefault values filled in for some fields. A pop-up list ofavailable processors and corresponding SofTrans modulenumbers also appears. We show a sample below.

If you have not configured any processors, a generic,partially completed Processor Edit Screen automaticallyappears with a pop-up list of available processors andSofTrans module numbers (e.g., VisaNet CPS (088) ).We show a sample below.

Processor Edit/Processors Screen

Select a Processor by highlighting it and pressing[ENTER]. The pop-up list disappears. The ProcessorEdit Screen now appears with the Processor you selectedshowing in the Processor Name screen field at the top.



If No ProcessorsConfigured Yet(cont.)

We show a sample of the Processor Edit Screen belowfor VisaNet CPS (088) with the default values alreadyfilled in.

Make the appropriate edits on this screen.


Press [ESC] to exit the Processor Edit Screen. Thisbrings you back to the Processor List screen that lists allof your current processors.

If you are satisfied with all changes, press [ESC] again.This brings you back to the ProtoBase Configurationsubmenu.

To edit a different processor, press [ENTER] on theappropriate processor and complete the edits needed.When finished, press [F10] to save and [ESC] to exit.

You are now ready to configure the Terminals portion ofthe ProtoBase configuration. We explain how to do thison the next page.

Processor Edit Screen



Terminals

If One or MoreTerminals AlreadyConfigured andYou Want to Edit

The Terminals portion of the ProtoBase configurationenables you to configure various terminal names.Terminals may represent individual or associated groupsof POS work stations, electronic cash registers, locations,or PCs. Each terminal entry consists of the valid creditcard (and other payment) types and the third-partytransaction processor(s) through which each type will beauthorized and settled.

One physical terminal may have several terminal ID’s. Forexample, Terminal 1 is configured to accept Visa andMasterCard, Terminal 2 is configured to accept Debitcards, and Terminal 3 is configured to accept checks.Terminals 1, 2, and 3 are one physical terminal, but areconfigured as three separate terminals for reporting andauthorizing purposes.

You link the terminals named here with specific paymenttypes (e.g., credit cards) and processors using the CreditCard Tables option from the ProtoBase Configurationsubmenu. We describe Credit Card Tables on page 96.

To set up or edit your terminals, select Terminals from theProtoBase Configuration submenu.

If you have configured one or more terminals already, aTerminal List screen appears listing the terminals youhave configured. We show a sample below.

Terminal List Screen



Terminals (cont.) You can select the terminal you want to edit by highlightingit and pressing [ENTER]. The Terminal Edit Screenappears showing the location applicable to this terminalname. We show a sample below.

Terminal Edit Screen

If One or MoreTerminals AlreadyConfigured andYou Want to Add aTerminal

If No TerminalsConfigured Yet

Press [F2] to view all of the locations available to be setup with this terminal. If you want to change the terminal’slocation, you may do so here. This screen enables you totie terminals to specific locations that have been set up inthe Location Information screen.

If you want to add a new terminal, press [F3] from theTerminal List screen. A blank Terminal Edit Screenappears showing the location you are logged into. Youcan complete the screen and press [F10] to save.

If you have not configured any terminals, a blank TerminalEdit Screen automatically appears showing the locationyou are logged into.



If You Want toCreate aSettlement Group

A settlement group enables you to settle multiple TerminalIDs in the same batch file. If you want to tie this TerminalID with other Terminal IDs in the same group, type thename of the settlement group here. This should not beused unless the transaction processor supports multi-merchant settlement. Otherwise, leave this field blank.

Making Edits onthis Screen

Make the appropriate edits on this screen, including theTerminal ID field and the Settlement Group field, asapplicable.


Press [ESC] to exit the Terminal Edit Screen. This bringsyou back to the Terminal List screen that lists all of yourcurrent terminals.


If you want to edit a different terminal, press [ENTER] onthe appropriate terminal and complete the edits needed.When you are done, press [F10] to save and [ESC] toexit.

You are now ready to configure the Credit Cards (andother Payment types) portion of the ProtoBaseconfiguration. We explain how to do this beginning on thenext page.



Credit CardTables

If One or MoreCredit CardsAlreadyConfigured andYou Want to Addor Edit

The Credit Card Tables portion of the ProtoBaseconfiguration enables you to assign the various creditcards and other payment types for a specific terminal.Using the Add/Edit functions, you tie the Terminal IDs youhave set up in the Terminal portion to specific paymenttypes with the transaction processors for authorization andsettlement, by card type.

To set up or edit your credit cards and other paymenttypes, select Credit Card Tables from the ProtoBaseConfiguration submenu.

If you have configured one or more credit cards or otherpayment types already, a Terminal List screen appearslisting the terminals tied to those credit cards. We show asample below.




If One or MoreCredit CardsAlreadyConfigured andYou Want to Addor Edit (cont.)

You can select the terminal you want to edit by highlightingit and pressing [ENTER]. The Edit Credit Card Tablescreen appears showing the credit cards and otherpayment types configured. A check mark indicates whichpayment types are selected for that terminal.

Edit Credit Card Table Screen

To select a credit card or other payment type (e.g., check,debit), press the space bar to place a check mark next toeach payment type you want to accept for this terminal. Atotal of 24 card ranges are configurable per terminal.

NOTE: To function properly, checks and debitcards must be setup by themselves onseparate terminals, and not on the sameTerminal ID with credit card types.

To edit the processor and card information tied to apayment type, use the arrow keys to move the cursor nextto that payment type and press [F3]. The Add/Edit CreditCards screen appears. We show a sample and describethe screen on page 137 of this section.



If One or MoreCredit CardsAlreadyConfigured andYou Want to Addor Edit (cont.)

To add a new payment type, move the cursor next to ablank card type and press [F3]. Enter the appropriateprocessor and card information in the Add/Edit CreditCards screen.

Other function key options on the Edit Credit Card Tablescreen are [F1] (help), [F8] (delete this terminal), [F10](save changes), and [ESC] (exit).

If No Credit CardsConfigured Yet

If you have not configured any credit cards or otherpayment types yet, a Terminal List screen appears listingthe available terminals (same as if you have credit cardsconfigured already). We show a sample below.

When you select a terminal, the Edit Credit Card Tablescreen appears as described earlier.

Follow the above instructions for adding new paymenttypes.




Add/Edit CreditCards Screen

You access this screen by pressing [F3] from the EditCredit Card Table screen.

Make the appropriate edits on this screen.

Make sure you press [F10] to save any changes you havemade. This exits you back to the Edit Credit Card Tablescreen. Press [F10] again to save all changes in theCredit Card portion of the ProtoBase Configuration. Themessage “Changes have been saved” appears.

Press [ESC] to exit the Edit Credit Card Table screen.This brings you back to the Terminal List screen that listsall of your current terminals.


If you want to edit a different terminal, press [ENTER] onthe appropriate terminal and complete the edits needed.When you are done, press [F10] to save and [ESC] toexit.

You are now ready to configure the Devices portion of theProtoBase configuration. We explain how to do thisbeginning on the next page.

Add/Edit Credit Cards Screen



Devices

If One or MoreDevices AlreadyConfigured andYou Want to Addor Edit

The Devices portion of the ProtoBase configurationenables you to configure various communication devicesto work with ProtoBase.

To set up or edit your devices, select Devices from theProtoBase Configuration submenu.

If you have configured one or more devices already, aDevice List screen appears listing the devices alreadyconfigured. We show a sample below.

Device List Screen

You can select the device you want to edit by highlighting itand pressing [ENTER]. To add a device, press [F3]. TheDevice Edit Screen appears. We show a sample on thenext page.

If No DevicesConfigured Yet

If you have not configured any devices, a Device EditScreen automatically appears showing particular defaultinformation.



Device Edit Screen Make the appropriate edits on this screen.


Press [ESC] to exit the Device Edit Screen. This bringsyou back to the Device List screen that lists all of yourcurrent devices.


If you want to edit a different device, press [ENTER] onthe appropriate device and complete the edits needed.When you are done, press [F10] to save and [ESC] toexit.

Device Edit Screen

You are now ready to run configuration to include allchanges you have made to all portions of the ProtoBaseConfiguration. We explain how to do this beginning on thenext page.



RunConfiguration

The Run Configuration option on the ProtoBaseConfiguration menu initiates actual reconfiguration ofProtoBase. It includes all edits made to all portions of theProtoBase Configuration (Processors, Terminals, CreditCard Tables, and Devices).

NOTE 1: Shut down ProtoBase before runningconfiguration.

NOTE 2:You must perform the Run Configurationoption whenever you make edits to yourProtoBase configuration.

To run the configuration, select Run Configuration fromthe ProtoBase Configuration submenu as shown below.

ProtoBase Configuration Menu

Upon selection, PbAdmin first checks to see if aPBCONFIG.CFG file already exists.

If the file PBCONFIG.CFG already exists in the ProtoBasedirectory, an overwrite warning displays. If you are unsurewhether you want to delete the existing PBCONFIG.CFGfile, you may exit here and not run the configuration.



Run Configuration(cont.)

If there is no PBCONFIG.CFG found or you continuethrough the overwrite warning, PbAdmin runs theconfiguration. The existing PBCONFIG.CFG file isdeleted, replaced by PBCONFIG.LST. The .LST file is atext version of the information that appears in theProtoBase Configuration screens in PbAdmin.

As the configuration is running, a Status Window screenappears showing the configuration progress. Whencompleted, the Status Window displays the following:

Status Window Screen

Press any key. PbAdmin returns you to the ProtoBaseConfiguration submenu. The message “RestartProtoBase to activate new settings” displays toremind you that you must restart ProtoBase for the newconfiguration settings to take effect.




Press any key again to display the configuration settings.We show a sample below.

Configuration Settings Report


This display shows the basic data elements configured foreach configuration section (Card Types, Terminals,Devices, Processors). For a more detailed configurationlisting, use the Print Configuration option from theProtoBase Configuration submenu. We describe thisoption on page 89.

NOTE: After running the configuration, thismessage appears in the report file:“WARNING: Pbconfig has been forced tonot test version compatibility.”

Disregard this message. These files havebeen checked automatically by PbAdminby running the PBCHKVER program thatcomes with ProtoBase. Please refer to theProtoBase User Guide for moreinformation.




Use the [Page Up] and [Page Down] keys to scrollquickly through this display.

You may print this display by pressing the [F7] (Print) key.

To save this display as a text file, press the [F10] (Saveas) key. PbAdmin prompts you to save as a specificfilename. The default directory path is the DBsubdirectory under your PbAdmin main directory. Thedefault filename is PBADMIN.rpt.

To exit this display, press the [ESC] key.

NOTE: Once PbAdmin has been installed and isrunning, you can no longer run theProtoBase executable PBCONFIG.Instead, all changes to configurationmust be done using the PbAdmin screeninterface.



PrintConfiguration

To print a detailed ProtoBase configuration, select PrintConfiguration from the ProtoBase Configurationsubmenu. We show a sample below.

This is the PBCONFIG.LST file found in the DB directoryunder PBADMIN, in PBCONFIG.CFG format.

Print Configuration Report

This display shows the detailed data elements configuredfor each configuration section (Card Types, Terminals,Devices, Processors).

Use the [Page Up] and [Page Down] keys to scrollquickly through this display.

You may print this display by pressing the [F7] (Print) key.

To save this display as a text file, press the [F10] (Saveas) key. PbAdmin prompts you to save as a specificfilename. The default directory path is the DBsubdirectory under your PbAdmin main directory. Thedefault filename is PBADMIN.rpt.

To exit this display, press the [ESC] key.

You are now ready to run test transactions.



Running TestTransactionsUsing PBFE

When you have completed setting up and configuring theProtoBase Administrator, run several test transactionsthrough PBFE, the ProtoBase front end program forPbAdmin. We describe how to do this below.

How to Run TestTransactionsUsing PBFE

To run test transactions using PBFE, complete thefollowing procedures:

1. Exit out of the ProtoBase Administrator. Use the[ESC] key to exit out of most screens and menus.From the Main Menu, press [F10] or “E” to exit toyour command prompt.

2. Change to the directory that contains PBFE.EXE,the PbAdmin front end executable program. Thismust be located under your main ProtoBasedirectory.

3. Prepare various test transactions. Use a text editorto edit the sample transaction file, PBSALE.IN,included with your ProtoBase distribution.

A transaction is generally transmitted via a text filethat provides the PBFE program the necessaryinformation to run a transaction. It contains avertical series of field numbers and correspondingvalues, separated by a comma. The number to theleft of each comma indicates the field number. Thevalue to the right of each comma indicates thevalue for this field.



How to Run TestTransactionsUsing PBFE(cont.)

The following is a sample Sale transaction:

1,22,1.003,%B4012888888881881^NUMBER/TEST^99121010000019301000000498000000?;4012888888881881=9608101193010498498?6,0000007,43215678105,.\106,.\109,TERM42110,SOMEONE

NOTE: For fields 105 and 106 above, UNIXsystems require a forward slash (/).

In this sample, the first entry (1,2) indicates Field 1(Transaction type) has a value of 2 (indicatingSale). The next entry (2,1.00) indicates Field 2(Transaction amount) has a value of $1.00. For adescription of all fields available, refer to thePbAdmin Technical Reference section.

You can also build other sample input files. Makesure you build several transaction types, applicableto the appropriate industry.

4. Start ProtoBase in demonstration (i.e., non-communicating) mode. This varies per operatingsystem. Type the following from the commandprompt of the main ProtoBase directory:

DOS:

pbarb /mmain /s1 /v /o

Windows NT/95 or OS/2:

start pbdirect . -d

UNIX:

pbdirect . -qd&

For more details on starting ProtoBase, pleaserefer to the ProtoBase User Guide.



How to Run TestTransactionsUsing PBFE(cont.)

5. Run the various test transactions you have built.You may want to build a batch file (such asPBSALE.BAT) that contains more than onetransaction. To run the transaction(s) contained inthe file PBSALE.IN, type the following at thecommand prompt:

pbfe -ipbsale.in [-opbsale.out] [ENTER]

pbsale.in is the name of the input file andpbsale.out is the name of the output file. If you donot enter an output file name,the default name is PBSALE.OUT.

6. View the output file for each of these transactions toverify that the transactions completed successfully.To do this, type TYPE (for DOS, Windows, orOS/2) or CAT (for UNIX) and the output filename atthe command prompt and press [ENTER]. If thetransaction was successful, Field 1010 shouldcontain the message COMPLETE.

7. View the transactions that were successful in theProtoBase Administrator data base. You can dothis by logging into PbAdmin and selectingSelect/Edit Transactions from the Main Menu.The transactions that were successful appear onthe Select/View/Edit Transactions screen. Wedescribe how to use this screen in the section Howto Use PbAdmin.

8. Run some test transactions through the POSsystem to make sure that transactions are beingaccepted and stored in the database.

When you are satisfied that you have set up PbAdmincorrectly, you can begin using PbAdmin to perform itsdaily functions. The How to Use PbAdmin sectiondescribes the functions for the operation and use of theProtoBase Administrator.

ProtoBase Administrator User Guide - Version 4.3.002 - Technical Reference


ProtoBase


User Guide

IV. Technical Reference



PbAdminTechnicalReferenceGuide

The PbAdmin Technical Reference Guide documentsdetailed technical information, including screen fields andfiles/programs, that may be needed by integrators,installers, and end-users of PbAdmin. It does not providestep-by-step instructions on how to install or use thisprogram; however, this information is covered in detail inthe Installation and Setup and How to Use PbAdminsections, respectively.

You may need to use this section to look up technicalinformation related to integration, installation/set-up,troubleshooting, and specific use of PbAdmin.

The following are the technical aspects of PbAdmincovered in this section:

• Description of every screen field

• Report descriptions and samples

• Transaction and Administrator logs

• PbAdmin file and program descriptions



Global and LocalINI File Screens - Field Namesand Descriptions

The following describes the information on the Global INIFile screen and the Local INI File screen. In addition todescribing the screen fields, the Description columnindicates the default values for screen fields, whenapplicable.

To access either screen, choose the Administrator SetupMenu from the Main Menu. Then choose the Global INIFile option (for the global file) or the Local INI File option(for the local file).

Global INI File Screen (PBFE.INI)

Local INI File Screen (PBADMIN.INI)



When You WouldUse the Local INIFile Screen(PBADMIN.INI)

The Local INI File screen corresponds to the filePBADMIN.INI. Use this file to set up a local version ofPbAdmin with different INI settings on a particularcomputer. This screen overrides the values in the GlobalINI File screen. The PBADMIN.INI file also contains thepath to the PBFE.INI file, which is important when thePBFE and PBADMIN directories are different. Programsuse the INI files to locate the PBFE directory.

Description Table The following describes the fields on the Global and LocalINI File screens. For non-UNIX systems, the paths listed inthe following table must include the drive designator (e.g.,C:\).

Global INI and Local INIScreens

Field Name

Description

ProtoBase Path Full path to ProtoBase executable directory. Defaults to the value setin PBPATH during initial setup.

Required for the Global INI screen.

ProtoBase Data Path Full path to ProtoBase data directory. Defaults to the value set inPBPATH during initial setup. This path can be set to allow loading offiles from a faster local drive.

ProtoBase Executables Path Full path to ProtoBase executable directory. Defaults to the value setin PBPATH during initial setup.

PBFE Executables Path Full path to the PBFE executable directory. Defaults to the value setin PBPATH during initial setup.

ProtoBase Administrator Path Full path to the base ProtoBase Administrator directory. Defaults tothe value set in PBDBPATH during initial setup.

This field is required for the Global INI screen.



PBADMIN Executables Path Full path to the base ProtoBase Administrator directory. Defaults tothe value set in PBDBPATH during initial setup. This path can be setto allow loading of files from a faster local drive.

Optional Gateway File Path Full path to the directory where the File Gateway is located. The pathis where the File Server Gateway picks up files if PbAdmin will berequired to use the Gateway during settlement or to run reports. Filesnot transferred through the gateway within 30 seconds would indicatean error in gateway operation. This is only used for specialimplementations of PbAdmin and requires additional software. Set“None” on the Local INI screen to override the Global INI. Refer to theIntegration section for more details about the File Gateway.

Optional Internal File Viewer Defines the viewer program to replace the default viewer. Optional.

Leave blank to use the default viewer.

Set “NONE” on the Local INI screen to override the Global INI.

Optional System Command Path to point to operating system shell command or other commandto be executed from the setup menu. Optional.

Set “NONE” on the Local INI File screen to override the Global INI.

On the Local INI File screen, the next four fields contain the option“Override Global?”. “Yes” indicates that the value should override theGlobal INI file. Defaults to “No”.

Backup Database before Deposit This field determines if a backup of the database files is to be madeprior to settlement. If a backup is made, the copies are stored in theDBHST directory.

Corresponds to the environment variable PBBACKUP.

Post Reversal Delay (seconds) This determines the number of seconds to wait before startingsettlement after the last reversal transaction is run. This allows themultitran timer to hang up the modem before initiating settlement.Default value is 10.

Corresponds to the environment variable PBSETDEL.



Global INI and Local INIScreens

Field Name

Description

Use DOS ProtoBase For OS/2 and Windows NT/95 systems. If set to “Yes”, PbAdmin willcall DOS ProtoBase instead of the native version when using a 32 bitsystem to run transactions or settlement on a DOS installation.

Corresponds to the environment variable PBOS.

Debug Level (0=Off, 4=Max) This field should be set to 0. It should only be set to 4 temporarily fortroubleshooting purposes.

Corresponds to the environment variable DBLEVEL.

Function Keys:

Help=[F1]

Save=[F10]

Exit=[Esc]

Press the [F1] key to display help information for the current field.

Press the [F10] key to save the changes you have made to the screenfields.

Press the [ESC] key to exit the screen. (UNIX users have to press[ESC] twice to exit.)

NOTE: No changes will be saved if you escape out of thisscreen without pressing [F10].



LocationInformationScreen- Field Names andDescriptions

The following describes the information on the LocationInformation screen.

To access this screen, choose the Administrator SetupMenu from the Main Menu. Then choose the LocationInformation option.

Enter the information you want to add or edit.

Location Information Screen

Location Information ScreenField Name

Description

Location Name Name of this location. This can be the name of an individual merchantlocation or separate POS station within one merchant location.

If you are modifying an existing location, the Location Name fieldcannot be edited.

If you are entering a new location, you can enter the new LocationName here. (You can only add or delete locations when logged in asa master user. For more information, refer to the Installation andSetup section.)




Description

AddressCityState/ProvincePhoneZip/Postal

This is the specific address and phone number information for thisparticular location.

Printer Destination Identifies the printer port. For non-UNIX systems, press the [F2] keyfor a choice list. For UNIX systems, the printer destination must beentered manually.

Printer Type Choice list field of base printer type to use when printing. Press the[F2] key for a choice list.

If none of the supported printer types work with your printer, contactSDC Client Services to configure a new printer type.

Printer Locale (For UNIX Systems only) Choose Local for a local printer or Remotefor a remote print server.

Default Select/Edit Display This determines what transactions will display on the Select/View/EditTransactions screen.

Press [F2] for a choice list. Valid values are:

Settlement = Display only settleable transactionsAuth Only = Display only Authorization Only TransactionsAll = Display all transactions (default value)

Banner Setting Indicates whether a banner is to be used for print jobs. Press the [F2]key for a choice list. Valid values are:

No Banner Use Banner

This field displays and is only applicable to UNIX-based systems.




Description

Default Report Mode This determines what transactions to include when generating reportsfrom the current transaction database.


All = Report all transactions

Selected = Report all transactions selected on theSelect/View/Edit Transactions screen

Pre-settle = Report all transactions selected on theSelect/View/Edit Transactions screen, excluding theAuthorization Only transactions

Duplicates Allowed Indicates whether to allow duplicate transactions in the transactiondatabase. PbAdmin considers transactions duplicates if they havethe same reference number, account number, and dollar amount.

No = Does not allow duplicates; enables duplicate checking (default)Yes = Allows duplicates; disables duplicate checking

This field should be set to Yes for testing, and normally No for livetransactions (unless there is a possibility that you will send up validduplicate transactions).

Press the space bar to toggle between No and Yes.

Log File Base Name Filename for the logs created by PbAdmin for this location. Usersmay want a different log filename for each location. However, formulti-merchant settlement, the names must be the same for alllocations. These files are stored in the DB subdirectory. The defaultbase name is PBADMIN. The default log filenames are as follows:

PBADMIN.STL - Settlement logPBADMIN.TRN - PBFE Transaction logPBADMIN.LOG - PbAdmin system log




Description

Settlement Directory Name Name for the subdirectory where settlement files are located. Eachlocation must have a unique settlement directory name toperform settlements at separate locations concurrently.However, for multi-merchant settlement, the names must be thesame for all locations.

Business End-of-Day This is the time of day, in military time, that this location officiallyends its business day. This determines the “business date”, whichaffects the selection and reporting of transactions. The business dateequals the current system date until the time of day reaches this time;the business date then switches to the next day.

For example, the Business End-of-Day time is set to 22:00 (10:00p.m.). The current system date is Tuesday. The “business date”would be considered “Tuesday” from 10:01 p.m. Monday until 10:00p.m. Tuesday. At 10:01 Tuesday, the “business date” switches toWednesday.

If the Business End-of-Day is set prior to noon, the business date willdefault to the actual transaction date.

If you do not want to use the Business End-of-Day option, set thevalue to 00:00.

This screen field does not affect the actual transaction date, whichalways matches the current system date.

Days to Keep Auths This is the minimum number of days Authorization Only transactionsmust be retained before they can be purged. Valid range is from 10 to999 days. The default is 100 days.

You can purge authorizations from the Database Management menu.

Days to Keep Logs Number of days of previous entries to retain in the various logs when apurge is run. The minimum number is 10 days. Any log entries olderthan the number of days shown here will be purged when you selectthat option from the Database Management menu.




Description

Enable Auto Dial Backup Indicates whether to automatically configure ProtoBase to switch toan alternate terminal in the event of a communications failure. This ismainly used for a dial backup if the primary line is a leased line, otherdirect line, or a network connection.

No = Do not create dial backup terminals (default)Yes = Create dial backup terminals

Press the space bar to toggle between No and Yes.

Industry The industry for this location. This entry defines the field required inthe transaction record and specific industry field information.

If this is the base location tied to all locations, choose MASTERLOCATION for the industry.

NOTE: Running a transaction for the Master Location willresult in an error.

If this merchant/location is not tied to a particular industry, chooseGeneric for the industry.

Press [F2] for a choice list. The list includes these options:

GenericRestaurantRetailRental CarLodging/Front DeskLodging/RestaurantLodging/RetailDirect MarketingMASTER LOCATION

Batch Number for Next Batch This is the sequential number identifying the next batch for thislocation. This can be edited from this screen. This always starts at avalue of 1.




Description

Authorization Tolerance (CPS) Percentage a Prior-Authorized Sale transaction (type 07) can varyfrom the corresponding original Authorization Only (type 01) withouteither returning an error or having to run an Incremental Authorization(type 75) or Authorization Reversal (type 76).

If this value is set to 100, PbAdmin will not validate thetolerance on a Prior Authorization.

NOTE: If set to 100, Reversals and Incremental Auths mustbe run manually to comply with CPS regulations.

For the Car Rental and Lodging industries, this field should equal 15.

For the Restaurant industry, this field should equal 20.

For all other industries, this field should equal 0.

Settle American Express Direct Indicates whether this system is using SDC’s American ExpressDirect Settlement Utility to settle American Express transactionsdirectly. This utility enables authorization and settlement directly toAmerican Express, using SofTrans module #40.

No = No, not using American Express utility (default)Yes = Yes, using American Express utility

Press the [SPACE] bar to toggle between values.

Auto Authorize Difference Flag indicating whether PbAdmin automatically initiates anIncremental Authorization (type 75) for the difference between theoriginal authorized amount and final dollar amount of a transaction.Valid values are:

No = Do not initiate Incremental Auth (default)Yes = Initiate Incremental Auth if the difference is greater than the Authorization Tolerance percentage defined in the screen field above





Description

Will Host Auto-Close Batch Applicable to host capture transaction processors only. Indicateswhether a host capture transaction processor is set up toautomatically settle batches that are open at the host (i.e., set up forauto close).

When the Deposit Transactions option is run (described in the How toUse PbAdmin section), this field indicates the following:

No = Settle normally. Transactions will be moved to history after asuccessful settlement. This is the default value.

Yes = Transactions will go directly to history without dialing the host.

NOTE: If this field is set for a non-host processor, or if theprocessor is not set up to auto-clear, the transactionwill move to history, but will not be settled.


American Express Pending Indicates whether an American Express settlement has beenuploaded and is waiting for confirmation. Valid values are:

No = No American Express confirmation is pendingYes = American Express confirmation is pending

This field is normally for display purposes only. However, you can editthis field by pressing [SHIFT]+[F3].

NOTE: To verify the batch has been processed by AmericanExpress, confirmation must be received.

Settlement In Progress Indicates whether a settlement is in progress. Valid values are:

No = No settlement is in progressYes = Settlement is in progress

This field is normally for display purposes only. However, you can editthis field by pressing [SHIFT]+[F3]. This is needed when a settlementdoesn’t terminate normally, and this field still equals Yes. Set back to“No” to re-try the settlement.




Description

Function Keys:

Help=[F1]

Toggle=[Space]

Choices=[F2]

Delete=[F8]

Save=[F10]

Exit=[ESC]


Press the space bar to toggle between No and Yes responses(applicable fields only).

Press the [F2] key to display a list of available choices.

Press the [F8] key on any field to delete the entire location. PbAdminprompts you before the location is deleted. A location cannot bedeleted if transactions are present. If you accidentally press this key,you can press [ESC] to exit the delete function.

NOTE: You must be logged in as a Master User to add ordelete locations.

Press the [F10] key when you are ready to save the changes youhave made to the screen fields.

Press the [ESC] key to exit the screen.



User SecurityScreen- Field Names andDescriptions

The following describes the information on the UserSecurity screen.

To access this screen, choose the Administrator SetupMenu from the Main Menu. Then select the User Securityoption, and choose the appropriate user from the list.

Make the appropriate edits on this screen. Use the spacebar to toggle between Yes and No responses.

User Security Screen

User Security Screen FieldName

Description

Name Single user name or group description of users using this login. Forthe sample location TEST LOCATION, this defaults to pbadmin whenyou first install PbAdmin.

Login Login ID for this name. Maximum number of characters is ten;minimum is one character. For the sample Test Location, this ispbadmin. This field is case sensitive.

Password Password for this Login ID. It can be any combination ofcharacters/numbers. It does not display on the screen during entry.Maximum number of characters is 10, minimum is one character. Forthe sample Test Location, this is pbadmin. This field is casesensitive.




Description

Verify Password entered again to verify it was typed correctly.

Select Transactions:

General

Detail

Modify

Indicates whether user has access to the Select/View/EditTransactions function from the Main Menu.

Indicates whether user has access to the Transaction Detail function[F6] from the Select/View/Edit Transactions screen.

Indicates whether user has access to the Add, Modify, or Deletefunctions from the Select/View/Edit Transactions screen.

Use the space bar to toggle between Yes and No.

Deposit Transactions Indicates whether user has access to the Deposit Transactionsfunction from the Main Menu.


View Deposit Log Indicates whether user has access to the View Deposit Log functionfrom the Main Menu.


DataBase File Mgmnt. Indicates whether user has access to the Database Managementmenu from the Main Menu.


History:

Search

Transfer

Reports

Indicates whether user has access to the Transaction History Searchfunction from the Transaction History Menu (from the Main Menu).

Indicates whether user has the ability to copy transactions fromhistory to the current working database.

Indicates whether user has access to any of the reports on theTransaction History Menu (from the Main Menu).





Description

General Setup Indicates whether user has access to the INI File Setup screen fromthe Administrator Setup Menu (from the Main Menu).


Location Setup Indicates whether user has access to the Location Information screenfrom the Administrator Setup Menu (from the Main Menu).


User Security Indicates whether user has access to the User Security screen fromthe Administrator Setup Menu (from the Main Menu).


Print Configuration Indicates whether user has access to the Print Configuration functionfrom the Administrator Setup Menu (from the Main Menu).


ProtoBase Config. Indicates whether user has access to the ProtoBase Configurationsubmenu from the Administrator Setup Menu (from the Main Menu).


Function Keys:

All Yes=[Shift]+[F3]

Help=[F1]

Rpts=[F6]

Del=[F8]

Save=[F10]

Exit=[ESC]

Press the [Shift] and [F3] keys together. Allows users to togglebetween all of the defaults at once.


Press the [F6] key to enter the Reports Security screen. Wedescribe this screen on the next page.

Press the [F8] key on any field to delete the entire User Login.PbAdmin prompts you before the User is deleted. If you accidentallypress this key, you can press [ESC] to exit the delete function.


Press the [ESC] key to exit the screen. This returns you to theAdministrator Setup menu.



Reports SecurityScreen- Field Names andDescriptions

The following describes the information on the ReportsSecurity screen. We describe how to run the reports in theHow to Use PbAdmin section.

To access this screen, press [F6] from the User Securityscreen.

Reports Security Screen

Report Security Screen FieldName

Description

Cashier Report -

Summary

Detail

Extended

Indicates whether user has access to the Cashier Summary Report.

Indicates whether user has access to the Cashier Detail Report. Thisreport includes the customer’s card number.

Indicates whether user has access to the Cashier Extended Report.This report includes both industry data and card data.


NOTE: For the restaurant industry, the term “Cashier” isreplaced by the term “Server”.




Description

Terminal Report -

Summary

Detail

Extended

Indicates whether user has access to the Terminal Summary Report.

Indicates whether user has access to the Terminal Detail Report. Thisreport includes the customer’s card number.

Indicates whether user has access to the Terminal Extended Report.This report includes industry data and card data.


Card Type Report -

Summary

Detail

Indicates whether user has access to the Card Type SummaryReport.

Indicates whether user has access to the Card Detail Report. Thisreport includes the customer’s card number.


Merch Key Report -

Summary

Detail

Indicates whether user has access to the Merchant Key SummaryReport.

Indicates whether user has access to the Merchant Key Detail Report.This report includes the customer’s card number.


Deposit Status Report Indicates whether user has access to the Deposit Status Report.


Auth Date & Time Report Indicates whether user has access to the Authorization Date & TimeReport.





Description

Incremental Auth Report Indicates whether user has access to the Incremental AuthorizationReport.


Server Tip Report For restaurant locations only. Indicates whether user has access tothe Server Tip Report.


Function Keys:

Help=[F1]

Toggle=[SPACE]

All Yes=[Shift+F3]

Back=[ESC]

Save=[F10]


Press the space bar to toggle between No and Yes responses.

Press [Shift]+[F3] at the same time to change all Yes/No responsesto Yes. This is the easiest way to allow access to all reportingfeatures of PbAdmin to this user.

If you are adding the initial user for a location, all “Yes/No” fields willautomatically default to Yes.

Press the [ESC] key to exit this screen and return back to the UserSecurity screen.




Processor EditScreen- Field Names andDescriptions

The following describes the information on the ProcessorEdit Screen. It indicates the default values for screenfields, when applicable.

To access this screen, choose the Administrator SetupMenu from the Main Menu. Then select the ProtoBaseConfiguration option. Choose the Processors optionand select the appropriate processor.

Processor Edit Screen



Processor Edit Screen FieldName

Description

Processor Name This is the transaction processor and SofTrans module associatedwith this set of screen information.

The name of the processor is abbreviated.

If CPS appears with the name, this SofTrans module is CPS-compliant.

The three-digit number in parenthesis (e.g., 088) indicates theSofTrans module number. Some transaction processors may havemore than one SofTrans module associated with it.

Modem Type The general classification of modem that the merchant is using toconnect to the host computer.

The default value is “Hayes” (for “Hayes Asynchronous”). For DOS-based systems, this is the only valid value. For all other operatingsystems, the other valid value is “Synchronous”.

Authorization Primary The seven fields associated with the Authorization Primary headingdescribe the primary connection made for Authorization-typetransactions. These descriptions are the same for AuthorizationPrimary, Authorization Secondary, Settlement Primary, andSettlement Secondary. Therefore, we describe them only once.

Attempts Number of times ProtoBase will try this phone number beforeattempting the corresponding secondary number or returning an error.A high number in this field may cause extremely long transactiontimes when the host connection is down.

The default value is 1. This field length is one digit.




Description

Baud The rate of speed, in bits-per-second (bps), at which ProtoBase willcommunicate with this transaction processor. This value cannot beset greater than the maximum baud rate of the host computer’sdevice.


0, 300, 1200, 2400, 4800, 9600, 19200, 38400

The default value is 1200.

If the Processor name is Amex Direct Stl (American ExpressSettlement #40), the Baud must equal 9600.

Data Bits The number of data bits required for communication with thistransaction processor. The default value is 7, the most commonvalue. (This is the “7” of “7E1”.)

Press [F2] for a choice list. Valid values are 6, 7, or 8.

American Express requires a value of 8.

Stop Bits The number of stop bits required for communication with thistransaction processor. The default value is 1, the most commonvalue. (This is the “1” of “7E1”.)

Press [F2] for a choice list. Valid values are 1 or 2.


Parity The parity required for communication with this transaction processor.The default value is Even, the most common value. (This is the “E” of“7E1”.)

Press [F2] for a choice list. Valid values are Even, Odd, None, Spac(Space), or Mix (Mixed).

American Express requires a value of None.

Phone No. The phone number used to dial to connect to this transactionprocessor.

NOTE: For UDP/IP or TCP/IP, this is the Internet Protocol(IP) address used to connect to the transactionprocessor.




Description

Login File Filename containing a log-in script for communicating with thetransaction processor. This field is not used by all transactionprocessors. Some processors require a special login procedurebased on geographical location and customer setup. It is part of theSofTrans distribution, if required by the processor. Maximum of 12characters.

Authorization Secondary

(same fields as AuthorizationPrimary)

The seven fields associated with the Authorization Secondary headingdescribe the secondary connection for Authorization-typetransactions. This is considered the “back-up” line for Authorization-type transactions if the primary line does not function properly. (Thisis not the same as the Dial Backup Terminal.)

Settlement Primary


The seven fields associated with the Settlement Primary headingdescribe the primary connection for Settlement-type transactions.

Settlement Secondary


The seven fields associated with the Settlement Secondary headingdescribe the secondary connection for Settlement-type transactions.This is considered the “back-up” line for Settlement-type transactionsif the primary line does not function properly. This is not the same asthe Dial Backup Terminal.

Function Keys:

Help=[F1]

Select=[ENTER]

Choices=[F2]

Delete=[F8]

Save=[F10]

Exit=[ESC]


Press [ENTER] to select the value displayed in the field the cursor ison. You may edit the default value displayed and then press[ENTER].


Press the [F8] key on any field to delete the entire transactionprocessor. PbAdmin prompts you before the processor is deleted. Ifyou accidentally press this key, you can press [ESC] to exit thedelete function.


Press the [ESC] key to exit the screen. This returns you to theProcessor List screen. Pressing [ESC] again gets you back to theProtoBase Configuration submenu.



Terminal EditScreen- Field Names andDescriptions

The following describes the information on the TerminalEdit Screen.

To access this screen, choose the Administrator SetupMenu from the Main Menu. Then select the ProtoBaseConfiguration option. Choose the Terminals option andselect the appropriate terminal.

Terminal Edit Screen

Terminal Edit ScreenField Name

Description

Terminal ID This is the terminal ID or terminal name associated with this location.If an entry already exists here, you cannot edit this entry.

If this is a new terminal, press [F3] from the Terminal List screen andenter the name of the terminal you want to add.

If you want to change the name of the existing Terminal ID, you mustdelete it from this screen by pressing [F8] and enter a new terminalwith the name you want.



Terminal Edit ScreenField Name

Description

Location The name of the location to which this terminal is tied.

Press [F2] for a list of available locations. This field defaults to thecurrent login location.

Settlement Group Optional Settlement Group setting for this terminal. At settlementtime, transactions are normally grouped by merchant key. If thesettlement terminal has a settlement group specified, the settlementgroup will be used in place of the merchant key to group transactionsbeing settled. Multiple terminals may specify the same settlementgroup.

This setting is useful if you require transactions with different merchantkeys to be settled together. The transaction processor you aresettling through also must support multi-merchant settlement.

All terminals with the same settlement group will settle in one largegroup at settlement time, even across locations for mastersettlements.

Function Keys:

Help=[F1]

Choices=[F2]

Delete=[F8]

Save=[F10]

Exit=[ESC]



Press the [F8] key to delete the entire terminal. PbAdmin promptsyou before the terminal is deleted. If you accidentally press this key,you can press [ESC] to exit the delete function.


Press the [ESC] key to exit the screen. This returns you to theTerminal List screen. Press [ESC] again to return to the ProtoBaseConfiguration menu.



Edit Credit CardTable Screen- Fields Namesand Descriptions

The Edit Credit Card Table screen displays a list ofpayment types. A check mark (33 or X) indicates whichpayment types are to be accepted by the specific terminal.

To access this screen, choose the Administrator SetupMenu from the Main Menu. Then select the ProtoBaseConfiguration option. Choose Credit Card Tables andselect the appropriate Terminal.

Edit Credit Card Table Screen

Function Keys:

Help=[F1]

Edit/Add=[F3]

Toggle=[Space]

Save=[F10]

Exit=[ESC]


Press the [F3] key next to a payment type to edit or add information.

Press the space bar to toggle to select or deselect a payment type.


Press the [ESC] key to exit the screen. This returns you to theTerminal List screen. Press [ESC] again to return to the ProtoBaseConfiguration menu.



Add/Edit CreditCards Screen- Field Names andDescriptions

The following describes the information on the Add/EditCredit Cards Screen.

To access this screen, press [F3] from the Edit CreditCard Table screen.

Add/Edit Credit Cards Screen

Add/Edit Credit Cards ScreenField Name

Description




Description

Card Type The two-character abbreviation of the card or other payment type.Press [F2] for a list of choices.

The valid values are:

VI=VISA CB=Carte BlancheMC=MasterCard EN=enRouteDS=Discover DB=DebitAX=American Express PL=Private LabelJC=JCB CK=ChecksDC=Diners Club

NOTE: To function properly, checks and debit cards mustbe setup by themselves on separate terminals, andnot on the same Terminal ID with credit cardtypes.



Add/Edit Credit CardsScreenField Name

Description

Long Name Longer description of the card or other payment type being used.(e.g., VISA, MasterCard)

Low Range The beginning (lowest) Bank Identification Number (BIN) for this cardor payment type. The first six digits of a card number must fallbetween this number and the High Range number.

NOTE: If a particular card type has more than one BINrange, you must make a separate entry for this cardtype for each BIN range.

High Range The ending (highest) Bank Identification Number (BIN) for this card orpayment type. The first six digits of a card number must fall betweenthis number and the Low Range number.

NOTE: If a particular card type has more than one BINrange, you must make a separate entry for this cardtype for each BIN range (e.g., 400001-401000,420001-421000).

PRIMARY Auth Merchant The primary merchant key used for authorizations for this card type.This value is required and must match the merchant key in themerchant file (PBMERC.DAT).

You must press the [F2] key for a list of valid values. These valuesare read from the currently installed PBMERC.DAT file. You canscroll through this list using the arrow keys. Select by pressing[ENTER].

Once selected, the transaction processor name corresponding to thismerchant key appears to the right of this field.

(PRIMARY) Settlement Merchant The primary merchant key used for settlement for this card type. Thisvalue is required and must match the merchant key in the merchantfile (PBMERC.DAT).

Press the [F2] key for a list of valid values. You can scroll throughthis list using the arrow keys. Select by pressing [ENTER].





Description

(PRIMARY) Settlement Terminal The primary Terminal ID used for settlement for this card type. Thisvalue is required and corresponds to the Terminal ID you set up in theTerminals section of the ProtoBase configuration. This corresponds tothe terminal you have selected to view this screen.

Press the [F2] key for a list of the Terminal IDs you have set up.

ALTERNATE Auth Merchant The secondary or backup merchant key used for authorizations forthis card type. This can be used for a dial-up backup line when theprimary line is a leased (direct) line or a network connection.



NOTE: To use this field, you must set the “Enable Auto DialBackup” field to Yes on the Location Informationscreen.

(ALTERNATE) SettlementMerchant

The secondary or backup merchant key used for settlement for thiscard type. This can be used for a dial-up backup line when theprimary line is a leased (direct) line.




(ALTERNATE) Settlement Terminal The secondary or backup Terminal ID used for settlement for this cardtype. This value is required and corresponds to the Terminal ID youset up in the Terminals section of the ProtoBase configuration. Thiscorresponds to the terminal you have selected to view this screen.

Press the [F2] key for a list of the Terminal IDs you have set up.





Description

Authorizer Reference Special code sent to authorizer/depositor to indicate who authorizedthis transaction.

NOTE: Only used for Gensar.

Valid Lengths This is a set of up to three fields indicating how long account numbersmay be for this card type. ProtoBase uses each of these values invalidating the field length of the account number before passing thetransaction on to the processor. A value of 0 indicates no field lengthvalidation is performed.

The valid values (which are the default values) per card type are asfollows:

VISA = 13, 16, 0MasterCard = 16, 0Amex = 15, 0Diners Club = 0Carte Blanche = 0Discover = 16, 0JCB = 15, 16, 0Check = 0Debit = 0

To turn off the account number length validation, enter 0 for all of thesefields.

Function Keys:

Help=[F1]

Choices=[F2]

Delete=[F8]

Save=[F10]

Exit=[ESC]



Press the [F8] key on any field to delete the entire payment type forthis terminal. PbAdmin prompts you before the payment type isdeleted. If you accidentally press this key, you can press [ESC] toexit the delete function.


Press the [ESC] key to exit the screen. This returns you to the EditCredit Card Table screen.



Device EditScreen- Field Names andDescriptions

The following describes the information on the Device EditScreen. In addition to describing the screen fields, theDescription column indicates whether a screen field isapplicable to a specific operating system. It alsoindicates the default values for screen fields, whenapplicable.

To access this screen, choose the Administrator SetupMenu from the Main Menu. Then select the ProtoBaseConfiguration option. Choose Devices and select theappropriate device.

Device Edit Screen

Device Edit ScreenField Name

Description

Comm Port The name of the communications port which connects a modem ordirect line to the transaction processor. This is usually a name suchas “com1” (for DOS, OS/2 and Win NT/95) or “/dev/tty/xxx” (for UNIX).

Network Dest For DOS/LAN users only. The network name of the PC where thecommunications port is located. Corresponds to the<machine name> [/m] for PBARB. This must be the machine nameused to start ProtoBase (for example, “Main”). The default value isblank.




Description

Modem Brand The make and model of the modem. The default value is GenericHayes Compatible.


Choosing a selection from the list automatically sets the modeminitialization string (Init. String) and dial string (Dial String) to thecorrect value. If your modem is not on the list, choose the “GenericHayes Compatible”. Then consult your modem guide for the correctinitialization string and other applicable information.

Modem Type Type of modem attached to the device port.

Press the [F2] key for a list of valid values. ProtoBase only acceptsHayes in this field. This should not be set to synchronous.

Max Baud The maximum rate of speed, in bits-per-second (bps), at whichProtoBase will communicate with this transaction processor using thisdevice. This rate must be greater than or equal to the baud rate setfor Authorization Primary in the Processor Edit screen.


0, 300, 1200, 2400, 4800, 9600, 19200, 38400

The default value is 2400.

If the Processor name is Amex Direct Stl (American ExpressSettlement #40), the Max Baud must equal 9600.

Recovery Interval Number of minutes to pause between each communication attemptbefore trying to reestablish communications with the modem in theevent of an error.

The default value is 0. Leave at 0 unless using a direct or non-switched line.

Max. Queue Maximum number of transactions to queue up on this device beforeswitching to another device. This field is only used if more than onedevice is configured. The default value is 0.

If the processor accepts multiple transactions on a single call, thisvalue should be great enough to prevent unnecessary dialing out.




Description

Line Type Type of communication line connection being made to the transactionprocessor.

Use the space bar to move through each option and select theappropriate line type. Options are:

Dial-Up = Phone dial-up lineNon-Switched = Normal leased lineDirect Dial = Leased line that, at the line level, works like

a dial-upISDN = Integrated System Digital Network lineTCP/IP = Internet protocol lineUDP/IP = Internet protocol line

Direct Processor The transaction processor reserved for a direct line.

Applicable to the Non-Switched, Direct Dial, ISDN, or UDP/TCP LineTypes only.

The next four fields (Baud, Parity, Data Bits, and Stop Bits) are applicable for Direct Processor lines only:

Baud The rate of speed, in bits-per-second (bps), at which ProtoBase willcommunicate with this direct transaction processor. This valuecannot be set greater than the maximum baud rate of the hostcomputer’s device.


0, 300, 1200, 2400, 4800, 9600, 19200, 38400

Applicable to the Non-Switched, Direct Dial, or ISDN Line Types only.




Description

Data Bits The number of data bits required for communication with this directtransaction processor.

Press [F2] for a choice list. Valid values are 6, 7, or 8.



Parity The parity required for communication with this direct transactionprocessor.

Press [F2] for a choice list. Valid values are Even, Odd, None, Spac(Space), and Mix (Mixed).

American Express requires a value of None.

Applicable to the Non-Switched, Direct Dial or ISDN Line Types only.

Stop Bits The number of stop bits required for communication with this directtransaction processor.

Press [F2] for a choice list. Valid values are 1 or 2.


IP Address The Primary and Secondary Internet Protocol address used forcommunication using either TCP/IP or UDP/IP.

This field will be available only if TCP/IP or UDP/IP is selected for LineType.

Dep. IP Address The Primary and Secondary Internet Protocol address used for depositor settlement communication using either TCP/IP or UDP/IP.

This field will be available only if TCP/IP or UDP/IP is selected for LineType.




Description

Init. String String sent to the modem prior to every dial-out attempt.

If you selected a modem from the list given in the “Modem Brand”field, the correct initialization string will automatically be set in thisfield.

The default value is ATE0V0X4S0=0Q0&C1&D2.

Applicable to Dial-Up Line Type only.

This field will not display if TCP/IP or UDP/IP is selected for Line Type.

Dial String String sent to the modem following the initialization string. The defaultvalue is ATDT (Tone dialing). Another common value is ATDP (Pulsedialing).

If you selected a modem from the list given in the “Modem Brand”field, the correct dial string will automatically be set in this field.


This field will not display if TCP/IP or UDP/IP is selected for Line Type.

Hangup String String sent to the modem when communication with the transactionprocessor is complete and it is time to "hang up" the phone line.

If you selected a modem from the list given in the “Modem Brand”field, the correct hangup string will automatically be set in this field.

The default for this string is blank. If the modem does not hang upproperly, use ATH0.

NOTE: If the “&D2” option is set in the InitString, and themodem is attached to a port that supports the dropDTR method of hangup, leave this field blank. “&C1”is very important if the modem doesn’t drop DTR inthis mode.





Description

Reset String String sent to the modem when a modem error occurs. Used toattempt to resolve a modem error. The default for this string is blank.A common value is ATZ.

If you selected a modem from the list given in the “Modem Brand”field, the correct reset string will automatically be set in this field.


Device Data Used by ProtoBase to attach certain data elements to the devicebeing configured. The most common usage of this field is for theAmerican Express initialization string data for the particular modem.Do not use this field unless instructed by SDC personnel.

If you selected a modem from the list given in the “Modem Brand”field, the correct device data will automatically be set in this field.

Function Keys:

Help=[F1]

Select=[ENTER]

Choices=[F2]

Delete=[F8]

Save=[F10]

Exit=[ESC]


Press the [ENTER] key to select the choice displaying for theparticular field (applicable fields only).


Press the [F8] key on any field to delete the entire device data.PbAdmin prompts you before the device data is deleted. If youaccidentally press this key, you can press [ESC] to exit the deletefunction.


Press the [ESC] key to exit the screen. This returns you to theDevice List screen.



EnvironmentSettings Screen

The information displayed on the Environment Settingsscreen describes the current settings for commonPbAdmin system variables. The information is useful ifyou are executing PbAdmin from an external menu andare not sure how the environment has been set up.

This screen also indicates the available memory for DOS,Win NT/95, and OS/2.

To access this screen, choose the Administrator SetupMenu from the Main Menu. Then select the EnvironmentSettings option.

Press the [F1] Help key for a brief description of eachvariable and/or pathway.

Press the [ESC] key to exit the screen. This returns you tothe Administrator Setup menu screen.

Environment Settings Screen (DOS version shown)



Select/View/EditTransactionsScreen (MainScreen)

The Select/View/Edit Transactions screen shows all thetransactions in the database for the currently logged inlocation that have not been settled. This is the mainscreen you will use to view transactions.

To access this screen, choose the Select/EditTransactions option from the Main Menu.

Pressing [SHIFT]+[F3] together from this screen shows alist of additional functions available. We describe [F3],[F6], and [F8]/[F9] in this section. For a detaileddescription of these functions and others ([F4], [Shift]+[F4],and [Shift]+[F6]), refer to the How to Use PbAdminsection.

On the next page, we provide a description of the fields onthis screen.

Select/View/Edit Transactions Screen



Select/View/Edit TransactionsScreen

Field Name

Description

Select This column indicates the current status of this transaction.

A check mark (33 or X) indicates that the transaction is currentlymarked for settlement the next time the Deposit routine is run. It alsoindicates that these are selected transactions to include on thereports (if you run them in “Selected” mode).

Additional indicators display immediately to the right or left of thebrackets ([ ]).

The additional indicators in the Select screen field are:

* = Authorization Only. It cannot be settled in this state.P = Currently pending with American Express for settlement status check. Awaiting user’s view of deposit log to verify this settlement is okay.I = Currently being settled by another process.U = Host capture pending. Already been conveyed to the host processor. (Used only for host capture systems). Use [Shift]+[F6] to toggle to a status of “h”.h = A host pending transaction that has been toggled to allow editing. Use [Shift]+[F6] to toggle to a status of “U”.F = “Forced” Authorization Only (for Voice or other than regular Auth Only).M = Move to History pending.V = Void or Void Return.R = Real Time Transaction (Check, ATM/Debit). It cannot be edited in this status. Use [Shift]+[F6] to toggle to a status of “r”r = Toggled real-time transaction. It can be edited in this status. Use [Shift]+[F6] to toggle to a status of “R”.

Ref Number The 12-digit reference number assigned to this transaction by thePOS package. From this screen, you only see the first eight digits ofthe reference number. To see the full number, press [F6].

Account Number The credit card, debit card, or check information represented by thistransaction. If the transaction is a check authorization and thecustomer’s driver’s license was used for identification, the fieldcontains “DL: <driver’s license info>”. If the transaction is a checkauthorization and the customer’s MICR number was entered, this fieldcontains “MCR: <MICR info>”. This field is 24 digits.

Amount The transaction amount. Field is right justified, space filled.



Select/View/Edit TransactionsScreen

Field Name

Description

Date Date transaction was authorized/added to database. It is inMM/DD/YY format.

Auth # Transaction approval code assigned by the processor.

Terminal Terminal identifier. Represents the terminal through which thistransaction was authorized.

Function Keys:

Help=[F1]

Available Keys=[Shft][F3]

Exit=[ESC]


Press the [Shift]+[F3] keys together to view a menu of additionalfunctions. We describe how to use these functions in detail in theHow to Use PbAdmin section.

The available functions are as follows:

[F3] = Add new transaction[F4] = Transaction search[F6] = Transaction detail[F8] = Select transaction criteria[F9] = Deselect transaction criteria[Shift]+[F4] = Select display mode[Shift]+[F6] = Toggle status[Arrow Up] = Arrow up one transaction[Arrow Down] = Arrow down one transaction[Shift]+[F7] = Moves to top of database[Shift]+[F8] = Moves to bottom of database[Space] = Toggles to select or deselect

Press the [ESC] key to exit the screen. This returns you to the MainMenu screen.



Add Transaction[F3] –Add New DetailTransactionScreen

Below, we describe the fields on the Add New DetailTransaction screen. This screen is accessed from theSelect/View/Edit Transactions screen by pressing [F3]. Inthe description, we also provide the correspondingProtoBase field number.

Add New Detail Transaction Screen

Add New Detail TransactionScreen

Field Name

Description

Reference 12-character alphanumeric reference number assigned to thistransaction by the POS system. (Field 07)

Host Ref Reference number assigned to this transaction by the third-partytransaction processor or acquirer. This field is only used with hostcapture systems. Otherwise, leave blank. (Field 1011)

Terminal Eight-character terminal identifier of authorizing/settling terminal.Press the [F2] key for a list of valid values. (Field 109)




Field Name

Description

Cashier (Server) Seven-character employee identifier of cashier or server performing thetransaction. For the restaurant industry, this field is “Server”; for allother industries, it is “Cashier”. (Field110)

Tran Type 10-character description of type of transaction running. Press the [F2]key to select from a list of valid values. (Field 1)

Account 24-digit account number for this transaction. Data may be enteredthrough a magnetic stripe reader if it meets the following criteria:

· Current cursor is in the first position.· Card reader is attached to keyboard and appears as keyboard

input.· Track 1 data is preceded by a percent (%) sign.· Track 2 data is preceded by a semi-colon (;).· The entire track is read, up to and including the end sentinel,

usually a question (?) mark.

If the account number is entered through a magnetic stripe reader, thisfield is automatically updated and skipped. (Field 3)

Exp. Date The date the account number expires. In MM/YY format.Automatically updated if the card was entered through a magneticstripe reader. You have the ability to enter an expired date, ifnecessary (e.g., when adding a manual Prior Auth). (Field 4)

Card Type Two-character short name identifier for payment type.For example, VI.

(Field 1000)

MKey The deposit merchant key corresponding to the card type as assignedin the ProtoBase configuration for this location.

Card Name Long name identifier for payment type or card association.

For example, VISA.

(Field 1001)

Amount Maximum eight-digit (99999.99) transaction dollar amount. (Field 2)




Field Name

Description

Customer 26-character customer name. Automatically updated if track 1 isprovided in the Account number field. For the lodging industry, this isthe Guest Name (Field 313).

Date Authorization date of this transaction. Date is in MM/DD/YY format.Automatically defaults to the current date if left blank. (Field 32)

The Business Date appears in parenthesis to the right of the Date.

Time Authorization time of this transaction. Time is in HH:MM:SS format.Automatically defaults to the current time if left blank. (Field 33)

Auth # Maximum six-character authorization approval number returned by theprocessor. This field is required for Prior-Auth Sale transactions.(Field 6)

PS2000 Compliance data corresponding to four different ProtoBase fields:

1st field - One-character code identifying the authorizing agency (Field37)2nd field - Maximum 15-character CPS transaction identifier; uniquetracking number assigned by issuing bank (Field 36)3rd field - Maximum four-character CPS validation code; assigned bythe card association (Field 35)4th field - One-character authorization characteristics indicator;identifies the card association authorizing the transaction (Field 34)

Inc. Info Compliance data corresponding to two different ProtoBase fields:

1st field - Maximum eight-digit amount representing the total amountauthorized during the life cycle of this transaction (Field 130)2nd field - Two-digit number representing the total number ofincremental authorizations (Field 131)

CPS Data Compliance data corresponding to four different ProtoBase fields:

1st field - Maximum 15-character CPS chargeback retrieval referencenumber (Field 125)2nd field - Maximum four-character CPS acquiring ICA; identifies theacquiring bank or transaction processor (Field 126)3rd field - One-character CPS miscellaneous data code (Field 127)4th field - One-character CPS preferred customer indicator (Field 129)




Field Name

Description

MERIT Compliance data corresponding to five different ProtoBase fields:

1st field - Two-character MERIT reason code, assigned by sometransaction processors to track why a transaction was rated as it was(Field 38)2nd field - Maximum four-character MERIT POS entry mode, assignedby some transaction processors identifying how the data was entered(Field 39)3rd field - One-character MERIT CVC error indicator, returned by theissuing bank to indicate the result of the CVC check (Field 40)4th field - One-character MERIT magnetic stripe quality indicator (Field41)5th field - Maximum six-character MERIT authentication code,assigned by the issuing bank (Field 42)

(Industry-specific fields listed onright side of screen)

See Industry Detail Screens, page 161 of this section, for descriptionsand examples of transaction screens containing industry specificinformation.

Function Keys:

Help=[F1]

Save=[F10]

Exit=[ESC]



Press the [ESC] key to exit the screen. This returns you to theSelect/View/Edit Transactions screen.



Search forTransaction [F4]

This screen is accessed from the Select/View/EditTransactions screen by pressing [F4]. The left side of thescreen contains the same fields as the Add NewTransaction function [F3], except for the compliancy fields.

The right side of the screen is blank. Entry of industryspecific information is not allowed for this function.

Search Criteria Screen

Search Criteria ScreenField Name

Description

Function Keys:

Help=[F1]

Search=[F4]

Exit=[ESC]


After you enter the search criteria in the appropriate field(s), press the[F4] key to perform the search. A list of transactions which match thesearch criteria will appear. Highlight the appropriate transaction andpress [ENTER] to return to the Select/View/Edit Transactions screen.The transaction you selected will appear at the top of the screen.




Transaction Detail[F6]

The Detail View of Transaction screen is accessed fromthe Select/View/Edit Transactions screen by pressing[F6]. This enables the user to modify or delete transactiondetail. The left side of the screen contains the same fieldsas for the Add New Transaction function [F3].

The right side of the screen contains the industry-specificfields. The sample below is the data for the Lodgingindustry. We describe all of the industry-specific fields,beginning on page 161.

Detail View of Transaction Screen

In order to insure the integrity of the CPS/PS2000information, PbAdmin will not allow you to change certainfields.



Detail View of TransactionScreen

Field Name

Description

Function Keys:

Help=[F1]

Choice List=[F2]

AVS Info=[Shft][F3]

Delete=[F8]

Save=[F10]

Exit=[ESC]



Press the [Shift]+[F3] keys together to modify Address VerificationService information associated with this transaction.

Press the [F8] key on any field to delete the entire transaction data.PbAdmin prompts you before the transaction is deleted. If youaccidentally press this key, you can press [ESC] to exit the deletefunction.





Select/DeselectTransactions[F8/F9]

The Select/Deselect Transaction Criteria screen isaccessed from the Select/View/Edit Transactions screenby pressing [F8] (for select) or [F9] (for deselect). Thisenables the user to select or deselect particular groups oftransactions for settlement based on particular criteria.

Select Transaction Criteria Screen

Select Transaction CriteriaScreen

Field Name

Description

Card Types Select or deselect by specific card types (VI, MC, AX, DS, etc.).Press [F2] for a list of valid card types.

Business Date Select or deselect by the business date the transaction wasprocessed.

Transaction Date Select or deselect by the date the transaction was processed.



Select Transaction CriteriaScreen

Field Name

Description

Terminal Select or deselect, based on a specific terminal ID (defined in Field109). Press [F2] for a list of valid terminals.

Cashier Select or deselect a specific Cashier/Server ID (defined in Field 110).

Function Keys:

Help=[F1]

Accept=[F10]

Exit=[ESC]


Press the [F10] key to have PbAdmin accept the selection criteria youhave entered. To select/deselect all transactions, leave the selectioncriteria blank and press the [F10] key. PbAdmin prompts you beforeit selects or deselects transactions on the Select/View/EditTransactions screen.

After the records have been selected, a window appears showing thetotal number of records that were just selected/deselected.




Industry DetailScreens

This portion of the PbAdmin Technical Referencesection describes the fields for each of the industry-specific detail screens.

To access these screens, press [F6] from theSelect/View/ Edit Transactions screen. The Detail Viewof Transaction screen for your industry displays.

We describe the industry-specific fields that appear on theright side of the Detail View of Transaction screen for thefollowing industries:

• Retail• Lodging Retail• Restaurant• Lodging Restaurant• Lodging/Front Desk• Rental Car• Direct Marketing

The fields that appear on the left side of the screen aredescribed earlier in this section.

Retail - Detail View of Transaction



Lodging/Retail - Detail View of Transaction

Retail and Lodging/RetailTransaction Detail

Field Name

Description

Folio Maximum eight-digit Property Management System folio referencenumber assigned to this transaction. (Field 301)

Applies to Lodging/Retail, but not Retail.

Charge Desc. Description of transaction charges. Press the [F2] key for a list ofvalid values. The valid values are:

Lodging Restaurant Gift Shop Spa Beauty Shp Conv Fees Tennis/Pro Golf/Pro


(Field 300)



Retail and Lodging/RetailTransaction Detail

Field Name

Description

Hotel Code Detailed description of charges. Press the [F2] key for a list of validvalues. The valid values are:

Sale (Sale)Assured NS (Assured No-Show)Adv Depost (Advance Deposit)Delayed Ch (Delayed Charge)Expr Svc (Express Service)Assured Rv (Assured reservation)


(Field 305)

Invoice/ROC Maximum six-digit invoice number or record-of-charge; referencenumber assigned to this transaction. (Field 401)

Item Code Two-digit code assigned to describe what type goods were purchased.This is usually matched up with a text description of the code andforwarded to the card issuer. (Field 400)

Sales Tax Maximum seven-digit (9999.99) amount of sales tax included in thischarge. (Field 72)

Retail Terms Maximum four-digit number identifying special terms or paymentoptions. (Field 411)

Purchase Information (5 lines) Up to five lines describing the purchases for this transaction. Foreach line, a four-digit CODE and maximum 40-characterDESCRIPTION provide the description for each purchased item (Fields412-416 for CODES, 406-410 for DESCRIPTION, which are includedin the Integration section).



Restaurant - Detail View of Transaction

Lodging/Restaurant - Detail View of Transaction



Restaurant andLodging/RestaurantTransaction Detail

Field Name

Description

Folio Maximum eight-digit Property Management System folio referencenumber assigned to this transaction.

Applies to Lodging/Restaurant, but not Restaurant.

(Field 301)




(Field 300)




(Field 305)

Check Maximum six-digit ticket number or record-of-charge; referencenumber assigned to this transaction. (Field 205)




Field Name

Description

Rest Chg Des Description of food purchased. Valid values are:

“FOOD” If food amount reflects food chargesonly

“FOOD-BEV” If food amount includes drinks or if thesoftware is unable to split the values

“BEVERAGE” If amount reflects beverage chargesonly

(Field 200)

Server 1 Maximum eight-digit employee ID of primary server on this ticket.(Field 203)

Server 1 Tip Maximum seven-digit (9999.99) amount of tip included on thistransaction allotted to the primary server. If the amount is greater than9999.99, enter 9999.99. (Field 201)

Tip 1 Descr Description of first tip field. This field should contain “TIP” even if notip 1 is included. (Field 210)

Server 2 Maximum eight-digit employee ID of secondary server on this ticket.(Field 204)

Server 2 Tip Maximum seven-digit (9999.99) amount of tip included on thistransaction allotted to the secondary server. If the amount is greaterthan 9999.99, enter 9999.99. (Field 202)

Tip 2 Descr Description of second tip field. This field should contain “TIP” if tip 2 isincluded. Otherwise, leave it blank. (Field 215)

Food Amount Maximum eight digit (99999.99) dollar amount of transaction used forfood charges. (Field 207)

Food Descr. Maximum ten-character description of the food on this ticket. If theFood Amount field is blank, leave this field blank also. (Field 213)




Field Name

Description

Beverage Amt Maximum eight-digit (99999.99) dollar amount of transaction used fordrink charges. (Field 208)

Bev. Descr. Maximum ten-character description of beverages on this ticket. Validvalues are “DRINKS” or “BEVERAGE”. If the Beverage Amt field isblank, leave this field blank also. (Field 214)

Tax Amount Maximum eight-digit (99999.99) dollar amount of transaction used forsales tax. (Field 206)

Adj. Tip Amt Maximum five-digit (99.99) amount of adjustment, if any, of tip chargesapplied at a later date/time. (Field 211)

Table Number Maximum three-digit identification number of customer’s table. (Field209)

ROC Number Maximum ten-digit record-of-charge number. (Field 212)



Lodging/Front Desk - Detail View of Transaction

Lodging/Front DeskTransaction Detail

Field Name

Description

Folio Maximum eight-digit Property Management System folio referencenumber assigned to this transaction. (Field 301)



(Field 300)




Field Name

Description



(Field 305)

Check-In Date (in MMDDYY format) when customer begins stay at location.(Field 303)

Check-Out Date (in MMDDYY format) when customer ends stay at location.(Field 304)

Room Number Maximum four-character identification of room incurring primarycharges. (Field 310)

Room Rate Maximum six-digit (999.99) per day charge for room. If the rate isgreater than 999.99, enter 999.99. (Field 302)

Tax Amount Maximum eight-digit (99999.99) amount of tax included in transactionamount. (Field 306)

Duration Two-digit length of customer stay, in days. If greater than 99, enter99. (Field 307)

Operator/Svr Maximum six-digit number identifying the employee performing thetransaction. (Field 309)

ROC Number Maximum eight-character record-of-charge number. (Field 308)




Field Name

Description

Extra Charge Maximum seven-digit (9999.99) amount of extra charges included inthe transaction amount field. (Field 311)

X Chg Reason Maximum six-digit reason code(s) for extra charges; enter multiplereasons consecutively (for example, 235).

0 - None2 - Restaurant3 - Gift Shop4 - Minibar5 - Telephone6 - Other7 - Laundry

(Field 312)

Guest Maximum 20-character name of guest. (Field 313)



Rental Car - Detail View of Transaction

Rental CarTransaction Detail

Field Name

Description

Renter Name Maximum 26-character name of person renting the vehicle. (Field510)

Agreement # Maximum nine-digit rental agreement number. (Field 511)

Promo Code Maximum four-digit number or code for any promotional specialsapplied to this transaction. (Field 513)

Certificate Maximum 14-character certificate number applied to this transaction.(Field 514)

Res. City/ST Maximum 18-character city and two-character state where rental carwas reserved. (Fields 515 and 516)




Field Name

Description

Duration Maximum two-digit number of days rental car was rented. (Field 512)

Vehicle # Maximum eight-digit vehicle identification number. (Field 500)

Adjust Amt Maximum eight-digit (9999.99) amount this transaction was adjustedfrom original agreement amount. (Field 501)

Rent Dte/Tme Date (MMDDYY) and time (HHMMSS in military format) the rental carwas picked up. (Fields 502 and 503)

Rent City/ST Maximum 18-character city and two-character state where the rentalcar was picked up. (Fields 504 and 505)

Ret. Dte/Tme Date (MMDDYY) and time (HHMMSS in military format) the rental carwas returned. (Fields 506 and 507)

Ret. City/ST Maximum 18-character city and two-character state where the rentalcar was returned. (Fields 508 and 509)

Tax Amount Maximum seven-digit (9999.99) amount of tax included in theTransaction Amount field. (Field 517)

Charge Desc. Description of the extra charge. Press the [F2] key for a list of validvalues. Valid values are:

No Extra Gas Extra Miles Late Return OneWay Svc Parking Tkt

(Field 518)




Field Name

Description

Prog Ind Two-digit special program code indicator. (Field 519)

Ret. Loc ID Maximum ten-character identification of return location. (Field 520)

Extra Charge Maximum five-digit reason code(s) for extra charges; enter multiplereasons consecutively (for example 235):

0 - None1 - Gas2 - Extra mileage3 - Late return4 - One way service5 - Parking violation

(Field 521)



Direct Marketing - Detail View of Transaction

Direct MarketingTransaction Detail

Field Name

Description

Zip Code Five-digit or nine-digit zip code. This information is used for AVS.(Field 700)

Street Address Maximum 20-character street address. This information is used forAVS. (Field 701)




Field Name

Description

AVS Response The response received after performing an Address VerificationService. Press the [F2] key for a list of choices. Available choicesare:

Exact w/9 Zip Code Exact w/5 Zip Code Match Address Only Match w/9 Zip Only Match w/5 Zip Only No Match AVS Unavailable Retry Ineligible for AVS AVS Not Supported AVS Not Performed AVS Not Performed_ Edit Error

(Field 1015)

Shipping Date Date (MMDDYY) when merchandise was shipped. (Field 711)

Charge Desc. Description of a mail order purchase. Press the [F2] key for a list ofchoices. Choices are:

Non-Mail Order Single Transaction Recurring Transaction Installment Payment Unknown Mail Order

(Field 712)

Clearing Seq Two fields, separated by “of”, indicating the current and total number ofinstallment payments. Used only when the Charge Desc. field equals“Installment Payment”.

1st field - Maximum two-digits; indicates current installment paymentdue (Field 714)2nd field - Maximum two-digits; indicates total number of installmentpayments (Field 713)

Example: 02 of 10 indicates this is the second of ten installmentpayments.




Field Name

Description

Order Number Maximum ten-digit order number used to identify the transaction.

(Field 715)

Ship to Zip Cd Five-digit or nine-digit zip code to which merchandise is to be shippedor delivered.

(Field 716)

Purchase Information (3 lines) Up to three lines describing the purchases for this transaction. Foreach line, a four-digit CODE and maximum 40-characterDESCRIPTION provide the description for each purchased item (Fields720-722 for CODES, 717-719 for DESCRIPTION which are included inthe Integration section.)



PbAdmin Reports This section describes the various reports availablethrough PbAdmin.

The reports provide detailed transaction informationaccording to the sort you choose. The sorts available areCashier, Terminal, Card Type, and Merchant Key. Most ofthese reports can be generated using the Reports Menuoption from the PbAdmin Main Menu. To generate thesereports outside PbAdmin, please refer to the Integrationsection for information.

Each report provides various headings related to specifictransaction detail. Most reports provide totals by cardtype at each sort break (e.g., each cashier), then totals bycard type for all of the particular sort (e.g., all cashiers).Wide format reports provide additional tax and tip totals,depending on industry.

Each detail report provides a Type heading that displaysan abbreviation for the particular transaction type for eachtransaction listed on the report.

The transaction types that may appear under the Typeheading are as follows:

AO = Authorization OnlyAF = Forced AuthorizationSA = SaleMO = Mail OrderPA = Prior-Authorized SaleRE = ReturnVS = Void SaleVR = Void ReturnCK = CheckIA = Incremental AuthorizationAR = Authorization ReversalDS = Debit SaleDR = Debit Return## = A transaction type number that does not correspond to

any of the above transaction types* = This transaction was manually entered

An additional character may appear to the right of this two-character abbreviation. This additional characteroriginates from the third-party transaction processor andusually equals the Authorization Characteristics Indicator(Input Field 34) if one is present.



Cashier (Server)Summary Report

The Cashier Summary Report provides a summary of alltransactions sorted by cashier ID. For the restaurantindustry, this is called the Server Summary Report. Thisreport provides the following:

• Sort by cashier• Totals by card type for each cashier• Totals by card type for all cashiers

It can be generated from the Reports Menu option fromthe PbAdmin Main Menu. We show a report sample onthe next page in wide format.

NOTE: For the restaurant industry, this report isthe Server Summary Report. For allother industries, this is the CashierSummary Report.



Cashier (Server) Summary Report

ProtoBase Administrator Cashier Report Transactions by Cashier for All Records

Printed: 07/21/98 11:23 Page 1

Location: Hotel Location--------------------------------------------------------------------------------------------------------------------------------------------------------

Credit Totals for Cashier: CASHIER

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tax $---------- ------ --------- ------ --------- ------ --------- ------ --------- ---------AMER EXPR 0 0.00 62 15753.38 0 0.00 62 15753.38 0.00MASTERCARD 0 0.00 100 48266.72 0 0.00 100 48266.72 0.00VISA 0 0.00 98 35277.26 0 0.00 98 35277.26 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- --------- 0 0.00 260 99297.36 0 0.00 260 99297.36 0.00==========================================================================================

Credit Totals for All Cashiers in Location: Hotel Location


****** End of Report ******



Cashier (Server)Detail Report

The Cashier Detail Report provides a standard detail listof all transactions, sorted by cashier ID. For the restaurantindustry, this is called the Server Detail Report. Thisreport provides the following:

• Standard transaction detail only (no extendedindustry data)



NOTE: For the restaurant industry, this report isthe Server Detail Report. For all otherindustries, this is the Cashier DetailReport.



Cashier (Server) Detail Report

ProtoBase Administrator Cashier Report Transactions by Cashier for Selected Records with Standard Detail

Printed: 07/21/98 15:27 Page 1

Location: Hotel LocationCashier : CASHIER------------------------------------------------------------------------------------------------------------------------------------------------Ref # Account Exp Type Amount Date Bus. Auth# Terminal-------- ------------------ ----- ---- -------- -------- ----- ------ -------- 1235 373238500012351 08/98 PA 461.70 11/18/97 11/18 2385 HOTEL 1236 373238500012369 01/99 PA 405.00 11/18/97 11/18 2385 HOTEL 1237 373238500012377 03/98 PA 100.00 11/18/97 11/18 2385 HOTEL 1238 373238500012385 11/98 PA 75.00 11/18/97 11/18 2385 HOTEL 1239 373238500012393 02/98 PA 75.00 11/18/97 11/18 2385 HOTEL 1240 373238500012401 02/99 PA 100.00 11/18/97 11/18 2385 HOTEL 1241 373238500012419 12/99 PA 450.00 11/18/97 11/18 2385 HOTEL


Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tax $---------- ------ --------- ------ --------- ------ --------- ------ --------- ---------AMER EXPR 0 0.00 7 1666.70 0 0.00 7 1666.70 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- --------- 0 0.00 7 1666.70 0 0.00 7 1666.70 0.00==========================================================================================






Cashier ExtendedDetail Report -Retail

The Cashier Extended Detail report for Retail provides anextended detail list of all transactions, sorted by cashierID, for the retail industry. This report provides thefollowing:

• Standard transaction detail• Retail-specific detail• Sort by cashier• Totals by card type for each cashier• Totals by card type for all cashiers




Cashier Extended Detail for Retail

ProtoBase Administrator Cashier Report Transactions by Cashier for Selected Records with Retail Industry Detail

Printed: 07/21/98 15:40 Page 1

Location: Retail LocationCashier : CASHIER---------------------------------------------------------------------------------------------------------------------------------------------------------

Ref # Account Exp Type Amount Date Bus. Auth# Terminal Invoice Item Tax Terms Item1 Item2 Item3 Item4 Item5-------- ------------------ ----- ---- -------- -------- ----- ------ -------- ------- ---- -------- ----- ----- ----- ----- ----- ----- 1235 373238500012351 08/98 PA 5 461.70 11/18/97 11/18 DEMO-7 RETAIL 001235 01 054 6532 1236 373238500012369 01/99 PA 5 405.00 11/18/97 11/18 DEMO-7 RETAIL 001236 01 054 6532 1237 373238500012377 03/98 PA 5 100.00 11/18/97 11/18 DEMO-7 RETAIL 001237 01 054 6532 1238 373238500012385 11/98 PA 5 75.00 11/18/97 11/18 DEMO-7 RETAIL 001238 01 054 6532 1239 373238500012393 02/98 PA 5 75.00 11/18/97 11/18 DEMO-7 RETAIL 001239 01 054 6532 1240 373238500012401 02/99 PA 5 100.00 11/18/97 11/18 DEMO-7 RETAIL 001240 01 054 6532 1241 373238500012419 12/99 PA 5 450.00 11/18/97 11/18 DEMO-7 RETAIL 001241 01 054 6532



Credit Totals for All Cashiers in Location: Retail Location




184 08/2000Proprietary & Confidential

Server ExtendedDetail Report -Restaurant

The Server Extended Detail report for Restaurant providesan extended detail list of all transactions, sorted by serverID, for the restaurant industry. This report provides thefollowing:

• Standard transaction detail• Restaurant-specific detail• Sort by server• Totals by card type for each server• Totals by card type for all servers




Server Extended Detail for Restaurant

ProtoBase Administrator Server Report Transactions by Server for Selected Records with Restaurant Industry Detail

Printed: 07/21/98 15:58 Page 1

Location: Restaurant LocationServer : server2---------------------------------------------------------------------------------------------------------------------------------------------------------

Ref # Account Exp Type Amount Date Bus. Auth# Terminal Ch Desc. Tip 1 Tip 2 Emp 1 Emp 2 Ticket # Tax Amt Food Amt Bev AmtTbl Adj. Tip-------- ------------------ ----- ---- -------- -------- ----- ------ -------- -------- -------- -------- -------- -------- -------- -------- -------- ----------- --------- 1220 5454545454545454 09/99 PA* 150.00 07/20/98 07/20 122220 rest2 00 1222 5454545454545454 09/99 PA* 100.00 07/20/98 07/20 122222 rest2 00

Credit Totals for Server: server2

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tip1 $ Tip2 $ Tax $ Food $ Bev $ AdjTip $---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- --------MASTERCARD 0 0.00 2 250.00 0 0.00 2 250.00 0.00 0.00 0.00 0.00 0.00 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------- 0 0.00 2 250.00 0 0.00 2 250.00 0.00 0.00 0.00 0.00 0.00 0.00=======================================================================================================================================

Credit Totals for All Servers in Location: Restaurant Location

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tip1 $ Tip2 $ Tax $ Food $ Bev $ AdjTip $---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- --------MASTERCARD 0 0.00 2 250.00 0 0.00 2 250.00 0.00 0.00 0.00 0.00 0.00 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------- 0 0.00 2 250.00 0 0.00 2 250.00 0.00 0.00 0.00 0.00 0.00 0.00=======================================================================================================================================




Cashier ExtendedDetail Report -Lodging

The Cashier Extended Detail report for Lodging providesan extended detail list of all transactions, sorted by cashierID, for the lodging industry. This report provides thefollowing:

• Standard transaction detail• Lodging-specific detail• Sort by cashier• Totals by card type for each cashier• Totals by card type for all cashiers




Cashier Extended Detail for Lodging

ProtoBase Administrator Cashier Report Transactions by Cashier for Selected Records with Lodging Industry Detail

Printed: 07/21/98 16:10 Page 1

Location: Hotel LocationCashier : CASHIER---------------------------------------------------------------------------------------------------------------------------------------------------------

Ref # Account Exp Type Amount Date Bus. Auth# Terminal Ch. Desc. Folio # Rm Rate Arr Date Dep Date Code Tax Amt. Dur Cashier Rm #-------- ------------------ ----- ---- -------- -------- ----- ------ -------- --------- ---------- -------- -------- -------- ---- -------- --- -------- ---- 1235 373238500012351 08/98 PA 461.70 11/18/97 11/18 2385 HOTEL SPA 000000 1.00 10/28/97 10/29/97 06 0.00 1 002 1236 373238500012369 01/99 PA 405.00 11/18/97 11/18 2385 HOTEL SPA 000000 1.00 10/28/97 10/29/97 06 0.00 1 002 1237 373238500012377 03/98 PA 100.00 11/18/97 11/18 2385 HOTEL SPA 000000 1.00 10/28/97 10/29/97 06 0.00 1 002 1238 373238500012385 11/98 PA 75.00 11/18/97 11/18 2385 HOTEL SPA 000000 1.00 10/28/97 10/29/97 06 0.00 1 002 1239 373238500012393 02/98 PA 75.00 11/18/97 11/18 2385 HOTEL SPA 000000 1.00 10/28/97 10/29/97 06 0.00 1 002 1240 373238500012401 02/99 PA 100.00 11/18/97 11/18 2385 HOTEL SPA 000000 1.00 10/28/97 10/29/97 06 0.00 1 002 1241 373238500012419 12/99 PA 450.00 11/18/97 11/18 2385 HOTEL SPA 000000 1.00 10/28/97 10/29/97 06 0.00 1 002








Cashier ExtendedDetail Report -Rental Car

The Cashier Extended Detail report for Rental Carprovides an extended detail list of all transactions, sortedby cashier ID, for the rental car industry. This reportprovides the following:

• Standard transaction detail• Rental-car-specific detail• Sort by cashier• Totals by card type for each cashier• Totals by card type for all cashiers




Cashier Extended Detail for Rental Car

ProtoBase Administrator Cashier Report Transactions by Cashier for Selected Records with Car Rental Industry Detail

Printed: 07/21/98 16:24 Page 1Location: Car Rental LocationCashier : CASHIER---------------------------------------------------------------------------------------------------------------------------------------------------------

Ref # Account Exp Type Amount Date Bus. Auth# Terminal Rent Name Rent Date Rent Time Rent CitySt Days Rental Agree # Vehicle# Adj.Amt. Tax Amt. PmCd Certificate # Reserve City St Retn Date Retn Time Return CitySt-------- ------------------ ----- ---- -------- -------- ----- ------ -------- ---- -------------- ------------------ ---- --------- --------- ------------------ ---- ----

1235 373238500012351 08/98 PA 461.70 11/18/97 11/18 2385 RENTAL Nikki Moore 10/28/97 13:46:24 CLEARWATER FL 1 732475600 42375600 CLEARWATER FL 10/29/97 06:32:27 CLEARWATER FL

1236 373238500012369 01/99 PA 405.00 11/18/97 11/18 2385 RENTAL Joan Moss 10/28/97 13:46:24 CLEARWATER FL 1 732475600 42375600 CLEARWATER FL 10/29/97 06:32:27 CLEARWATER FL



Credit Totals for All Cashiers in Location: Car Rental Location

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tax $---------- ------ --------- ------ --------- ------ --------- ------ --------- ---------AMER EXPR 0 0.00 2 866.70 0 0.00 2 866.70 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- --------- 0 0.00 2 866.70 0 0.00 2 866.70 0.00==========================================================================================****** End of Report ******



Cashier ExtendedDetail Report -Direct Marketing

The Cashier Extended Detail report for Direct Marketingprovides an extended detail list of all transactions, sortedby cashier ID, for the rental car industry. This reportprovides the following:

• Standard transaction detail• Direct marketing-specific detail• Sort by cashier• Totals by card type for each cashier• Totals by card type for all cashiers




Cashier Extended Detail for Direct Marketing

ProtoBase Administrator Cashier Report Transactions by Cashier for Selected Records with Direct Marketing Industry Detail

Printed: 07/21/98 16:30 Page 1

Location: Direct Marketing LocationCashier : CASHIER----------------------------------------------------------------------------------------------------------------------------------------------------------

Ref # Account Exp Type Amount Date Bus. Auth# Terminal Order Num. AVS Zip Code Billing Address-------- ------------------ ----- ---- -------- -------- ----- ------ -------- ---------- --- --------- -------------------- 1235 373238500012351 08/98 PA 7 461.70 11/18/97 11/18 123456 DIRECT 9978665 0 33764 1236 373238500012369 01/99 PA 7 405.00 11/18/97 11/18 123456 DIRECT 9978665 0 33764


Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $---------- ------ --------- ------ --------- ------ --------- ------ ---------AMER EXPR 0 0.00 2 866.70 0 0.00 2 866.70---------- ------ --------- ------ --------- ------ --------- ------ --------- 0 0.00 2 866.70 0 0.00 2 866.70===============================================================================

Credit Totals for All Cashiers in Location: Direct Marketing Location

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $---------- ------ --------- ------ --------- ------ --------- ------ ---------AMER EXPR 0 0.00 2 866.70 0 0.00 2 866.70---------- ------ --------- ------ --------- ------ --------- ------ --------- 0 0.00 2 866.70 0 0.00 2 866.70===============================================================================




TerminalSummary Report

The Terminal Summary Report provides a summary of alltransactions sorted by terminal ID. This report providesthe following:

• Sort by terminal ID• Totals by card type for each terminal• Totals by card type for all terminals




Terminal Summary Report

ProtoBase Administrator Terminal Report Transactions by Terminal for All Records

Printed: 07/21/98 16:33 Page 1

Location: Hotel Location-----------------------------------------------------------------------------------------------------------------------------------------------------------

Credit Totals for Terminal: HOTEL


Credit Totals for All Terminals in Location: Hotel Location





Terminal DetailReport

The Terminal Detail Report provides a standard detail listof all transactions, sorted by terminal ID. This reportprovides the following:


• Sort by terminal• Totals by card type for each terminal• Totals by card type for all terminals




Terminal Detail Report

ProtoBase Administrator Terminal Report Transactions by Terminal for Selected Records with Standard Detail

Printed: 07/21/98 16:40 Page 1

Location: Hotel LocationTerminal: HOTEL---------------------------------------------------------------------------------------------------------------------------------------------------------

Ref # Account Exp Type Amount Date Bus. Auth# Cashier-------- ------------------ ----- ---- -------- -------- ----- ------ -------- 1235 373238500012351 08/98 PA 461.70 11/18/97 11/18 2385 CASHIER 1236 373238500012369 01/99 PA 405.00 11/18/97 11/18 2385 CASHIER 41533 5209012204153327 07/98 PA 268.66 11/18/97 11/18 9012 CASHIER 556048 5209019955604895 08/99 PA 18.35 11/18/97 11/18 9019 CASHIER

Credit Totals for Terminal: HOTEL

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tax $---------- ------ --------- ------ --------- ------ --------- ------ --------- ---------AMER EXPR 0 0.00 2 866.70 0 0.00 2 866.70 0.00MASTERCARD 0 0.00 2 287.01 0 0.00 2 287.01 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- --------- 0 0.00 4 1153.71 0 0.00 4 1153.71 0.00==========================================================================================

Credit Totals for All Terminals in Location: Hotel Location





TerminalExtended DetailReports

RetailRestaurantLodgingRental CarDirect Marketing

These reports follow the same format as the CashierExtended Detail reports (described beginning on page182), except they are sorted by Terminal ID. They can begenerated from the Reports Menu option from thePbAdmin Main Menu.



Deposit StatusReport

The Deposit Status Report shows the settlement (ordeposit) log. It provides all settlement deposit attempts,both successful and unsuccessful.

This report can be generated from the Reports Menu orfrom the View Deposit Log option from the PbAdminMain Menu. We show a report sample below.

Deposit Status Report

There are no totals for this report, only detail of eachsettlement deposit attempt.



AuthorizationDate & TimeReport

The Authorization Date and Time Report lists transactionssorted by Authorization Date, and within each date, byAuthorization Time. It can be used to determine if old orexpired authorizations exist in the data base. This reportcan be generated from the Reports Menu option from thePbAdmin Main Menu. We show a report sample below.

Authorization Date and Time Report - Detail

Authorization Date and Time Report - Totals



IncrementalAuthorizationReport

The Incremental Authorization Report lists eachtransaction, sorted by Terminal ID. It shows the originaland final authorization amounts. It can be used to reviewthe amount of incremental authorizations that may beneeded for particular transactions.

This report can be generated from the Reports Menuoption from the PbAdmin Main Menu. We show a reportsample below.

Incremental Authorization - Detail

There are no totals for this report.



Card TypeSummary Report

The Card Type Summary Report provides a summary ofall transactions sorted by card type. This includes any“card type” defined in the ProtoBase configuration,including CHECK and DEBIT. This report provides thefollowing:

• Sort by card type, with separate totals for creditsand returns by card type

• Totals by card type• Totals for all card types

This report can be generated from the Reports Menuoption from the PbAdmin Main Menu. We show a reportsample on the next page in wide format.



Card Type Summary Report

ProtoBase Administrator Location Report Transactions by Card Type for Selected RecordsPrinted: 07/21/98 16:54 Page 1Location: Hotel Location--------------------------------------------------------------------------------------------------------------------------------------------------------Credit Totals for Location: Hotel Location AMER EXPR Sales

Transaction Type Count Total Tip---------------- ---------- --------- ---------Sales 4 1041.70 0.00===============================================================================

Net Totals for Location: Hotel Location AMER EXPR

Count Total Tip ---------- --------- ---------Net Totals 4 1041.70 0.00===============================================================================Location: Hotel Location--------------------------------------------------------------------------------------------------------------------------------------------------------Credit Totals for Location: Hotel Location MASTERCARD Sales

Transaction Type Count Total Tip---------------- ---------- --------- ---------Sales 4 574.02 0.00===============================================================================Net Totals for Location: Hotel Location MASTERCARD

Count Total Tip ---------- --------- ---------Net Totals 4 574.02 0.00===============================================================================

Credit Totals for All Card Types in Location: Hotel Location

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tax $---------- ------ --------- ------ --------- ------ --------- ------ --------- ---------AMER EXPR 0 0.00 4 1041.70 0 0.00 4 1041.70 0.00MASTERCARD 0 0.00 4 574.02 0 0.00 4 574.02 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- --------- 0 0.00 8 1615.72 0 0.00 8 1615.72 0.00==========================================================================================****** End of Report ******



Card Type DetailReport

The Card Type Detail Report provides a standard detaillist of all transactions, sorted by card type. This includesany “card type” defined in the ProtoBase configuration,including CHECK and DEBIT. This report provides thefollowing:







Card Type Detail Report

ProtoBase Administrator Location Report Transactions by Card Type for Selected Records with Standard DetailPrinted: 07/21/98 17:04 Page 1

Location: Hotel LocationCard Type: AMER EXPR Sales---------------------------------------------------------------------------------------------------------------------------------------------------------

Card Number Exp Auth Date Bus. Time Total Reference Cashier Tip MKey Processor Type------------------------ ----- ------ -------- ----- ----- --------- --------- ---------- -------- ----- --------------- ----373238500012351 08/98 2385 11/18/97 11/18 14:10 461.70 1235 CASHIER N/A L88 VisaNet CPS PA373238500012369 01/99 2385 11/18/97 11/18 14:10 405.00 1236 CASHIER N/A L88 VisaNet CPS PA

Credit Totals for Location: Hotel Location AMER EXPR Sales

Transaction Type Count Total Tip---------------- ---------- --------- ---------Sales 2 866.70 0.00===============================================================================

Net Totals for Location: Hotel Location AMER EXPR

Count Total Tip ---------- --------- ---------Net Totals 2 866.70 0.00===============================================================================

Credit Totals for All Card Types in Location: Hotel Location





Merchant KeySummary Report

The Merchant Key Summary Report provides a summaryof all transactions sorted by merchant key (ID). This reportprovides the following:

• Sort by merchant key• Totals by card type for each merchant key• Totals by card type for all merchant keys




Merchant Key Summary Report

ProtoBase Administrator Location Report Transactions by Merchant Key for All Records

Printed: 07/21/98 17:07 Page 1

Location: Hotel Location--------------------------------------------------------------------------------------------------------------------------------------------------------

Credit Totals for Merchant Key: L88


Credit Totals for All Merchant Keys in Location: Hotel Location





Merchant KeyDetail Report

The Merchant Key Detail Report provides a standarddetail list of all transactions, sorted by merchant key (ID).This report provides the following:






Merchant Key Detail Report

ProtoBase Administrator Location Report Transactions by Merchant Key for Selected Records with Standard Detail

Printed: 07/21/98 17:12 Page 1

Location: Hotel LocationMerchant Key: L88------------------------------------------------------------------------------------------------------------------------------------------------------------

Card Number Exp Auth Date Bus. Time Total Reference Cashier Tip MKey Processor Type------------------------ ----- ------ -------- ----- ----- --------- ---------- -------- --------- ----- --------------- ----373238500012351 08/98 2385 11/18/97 11/18 14:10 461.70 1235 CASHIER N/A L88 VisaNet CPS PA373238500012369 01/99 2385 11/18/97 11/18 14:10 405.00 1236 CASHIER N/A L88 VisaNet CPS PA5209012204153327 07/98 9012 11/18/97 11/18 13:49 268.66 41533 CASHIER N/A L88 VisaNet CPS PA5209019955604895 10/99 9019 11/18/97 11/18 13:48 18.35 556048 CASHIER N/A L88 VisaNet CPS PA

Credit Totals for Merchant Key: L88


Credit Totals for All Merchant Keys in Location: Hotel Location

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tax $---------- ------ --------- ------ --------- ------ --------- ------ --------- ---------AMER EXPR 0 0.00 2 866.70 0 0.00 2 866.70 0.00MASTERCARD 0 0.00 2 287.01 0 0.00 2 287.01 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- --------- 0 0.00 4 1153.71 0 0.00 4 1153.71 0.00==========================================================================================****** End of Report ******


208 10/99Proprietary & Confidential

Server Tip Report(Restaurant Only)

The Server Tip Report provides tip and credit totals perrestaurant server, and grand totals for all servers.


This is applicable to the restaurant industry only.



Server Tip Report

ProtoBase Administrator Server Report Transaction Summary for Selected Records With Tips

Printed: 08/17/98 11:05 Page 1

Location: Restaurant Location---------------------------------------------------------------------------------------------------------------------------------------------------------

Tip Totals for Server: server3

Tip 1 Tip 2 Net-------- -------- -------- 42.50 22.50 65.00

Credit Totals for Server: server3

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tip1 $ Tip2 $ Tax $ Food $ Bev $ AdjTip $---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- --------VISA 0 0.00 2 250.00 0 0.00 2 250.00 42.50 22.50 0.00 0.00 0.00 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------- 0 0.00 2 250.00 0 0.00 2 250.00 42.50 22.50 0.00 0.00 0.00 0.00=======================================================================================================================================

Tip Totals for All Servers in Location: Restaurant Location

Tip 1 Tip 2 Net-------- -------- -------- 42.50 22.50 65.00

Credit Totals for All Servers in Location: Restaurant Location

Card Type # Auth Auth $ # Sale Sales $ # Ret Return $ # Net Net $ Tip1 $ Tip2 $ Tax $ Food $ Bev $ AdjTip $---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- --------VISA 0 0.00 2 250.00 0 0.00 2 250.00 42.50 22.50 0.00 0.00 0.00 0.00---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------- 0 0.00 2 250.00 0 0.00 2 250.00 42.50 22.50 0.00 0.00 0.00 0.00=======================================================================================================================================****** End of Report ******

ProtoBase Administrator User Guide Version 4.3.002 – Technical Reference


AdministratorConfigurationReport

The Administrator Configuration Report shows allPbAdmin system settings you have set up for this location.This report provides a summary of many of the settings onthe General Setup and Location Information screens.

To generate this report, select the Administrator SetupMenu from the PbAdmin Main Menu. Then select PrintSetup Information. We show a report sample below andon the next page.

Administrator Configuration Report - First Page



Administrator Configuration Report (continued)



TransactionHistory Search

The Transaction History Search is performed from theView History Transactions screen.

To access this screen, select the Transaction HistoryMenu from the Main Menu, then select TransactionHistory Search. This enables the user to search forvarious transactions in a particular month/year for specificcriteria.

View History Transactions Screen

View History TransactionsScreen

Field Name

Description

Select This field indicates the current status of this transaction. This field willbe a check mark (33 or X) or blank. Selected transactions can betransferred back to the current database for another settlementattempt.

Ref Num The 12-digit reference number assigned to this transaction by thePOS package. This screen only shows the first 8 digits of thereference number.



View History TransactionsScreen

Field Name

Description

Account Number The credit card, debit card, or check information represented by thistransaction. If the transaction is a check authorization and thecustomer’s driver’s license was used for identification, the fieldcontains “DL: <driver’s license info>”. If the transaction is a checkauthorization and the customer’s MICR number was entered, this fieldcontains “MCR: <MICR info>”. This field is 24 positions.

Amount The transaction settlement amount. Field is right justified, spacefilled.

Date Date transaction was authorized/added to database. It is inMM/DD/YY format.

Batch # This field displays the last six digits of the batch number.

Terminal Eight position terminal identifier. Represents the terminal to settlethis transaction to. Defaults to the authorized terminal ID.

Function Keys:

Help=[F1]

Available Keys=[Shift]+[F3]

Exit=[ESC]


Press the [Shift]+[F3] keys together to view a menu of additionalfunctions. We describe how to use these functions in detail in theHow to Use PbAdmin section.

The available functions are as follows:

[F4] = Transaction search[F6] = Transaction detail[F8] = Select transaction criteria[F9] = Deselect transaction criteria[F5] = Reverse and copy to Main database[Shift]+[F6] = Copy selected transactions to Main database[Arrow Up] = Arrow up one transaction[Arrow Down] = Arrow down one transaction[Shift]+[F7] = Moves to top of database[Shift]+[F8] = Moves to bottom of database




Transaction Log The Transaction Log keeps track of functions performedby PBFE, the PbAdmin Front End program. It is used fordata recovery and technical support. All fields in this logare separated by a [TAB] character. The table on thefollowing page describes the fields in the Transaction Log.

To access this log, select Database Management fromthe Main Menu. Then choose View Log and selectTransaction.

Below is a sample Transaction Log.

Transaction Log



Transaction Log Entry Layout

LogHeading

Field Name

08/27/97 Date (MMDDYY)

11:29:44 Time (HHMMSS)

USER Username. (“PBFE” if run through PBFE; ”PBADSET” if it is an auto-transactionthrough PBADSET; user’s name if run through PbAdmin)

TYPE Program Source ID (See next page for descriptions of these codes)

ADM PbAdmin Error Code

PB ProtoBase Error Code

EXT Additional data corresponding to the error code

MESSAGE Text Error Message

DATARECORD

The following fields may appear as part of the transaction data record:

Miscellaneous ID Code (Usually identifies the field number an error occurred on)

Transaction Type

Terminal Number

Cashier Number

Location Name

Short Card Type

Reference Number

Account Number

Transaction Amount

Authorization Date

Authorization Time

Expiration Date

Long Card Type

Voided Flag

Host Response Message

Authorization Number

Track Data

Cardholder Name

Validation Code

Transaction ID



Program SourceID CodeDescriptions

The following table lists the program source ID codes thatcorrespond to the “Type” field in the Transaction andAdministrator logs.

Type ID Description

ACL Auto Closed TransactionsAIN Auto IncrementalAPI Get APIARB Auto Reversal backupART Auto RetryARV Auto ReversalAUT Process Auth-onlyBOT Batch open transactionCAL Check account lengthCDB Close databaseCOT Close open transactionCRC Check CRCCRF Check required fieldsFAT Force authorizationFIN Forced Incremental authorizationFPA Forced prior authorizationGBR Get bin recordGLI Get location informationGMI Get Mkey informationHAA Added record to history databaseHDB Modified record in history databaseHDC Created record for history databaseHDD Deleted record from history databaseIDB Initialize databaseINC Incremental authorizationINQ Batch inquiry transactionIVT Init validation tableLDA Added record to location databaseLDB Modified record in location databaseLDC Created record for location databaseLDD Deleted record from location database



Program SourceID Code

Type ID Description

Descriptions MDA Added record to main database(cont.) MDB Modified record in main database

MDC Created record for main databaseMDD Deleted record from main databaseNON None; no records found for this

processor. (Appears in Settlement log.)ODB Open databaseOGS Open general setup databasePAS Process Prior Auth salePCD Parse cardPDA Added record to packet databasePDB Modified record in packet databasePDC Created record for packet databasePDD Deleted record from packet databasePRV Process partial reversalPTN Process transactionRET Process returnROT Remove open transactionRTY RetrySAL Process saleSIP Settlement in progressTIQ Transaction inquiryUDA Added record to user databaseUDB Modified record in user databaseUDC Created record for user databaseUDD Deleted record from user databaseVAF Validate API fieldsVOI Process voidVON Void only (Appears in Settlement log.)WKE Working key exchange



Administrator Log The Administrator Log keeps track of functions performedby individual users in PbAdmin. Some functions that arelogged include logging in, adding/ deleting locations,initiating settlement, and adding/modifying/purgingrecords. This log is used for technical support.

All fields in this log are separated by a [TAB] character.The fields vary depending on the function that is logged.Many of the fields, including TYPE, are the same as theTransaction Log described earlier. The TYPE fieldcorresponds to the Program Source ID, whose values arelisted on the previous two pages.

To access this log, select Database Management fromthe Main Menu. Then choose View Log and selectAdministrator.

Below is a sample Administrator Log.

Administrator Log



PbAdmin File andProgramDescriptions

The first set of tables indicates those directories and filesthat are part of the ProtoBase Administrator installation.The second set of charts indicates the directories and filescreated by the ProtoBase Administrator during normaluse.

NOTES: The .exe extension is not used in UNIXsystems. Use the program name withoutthe extension.

Case sensitive filenames and directorynames under UNIX appear as listed inthe following tables.

This listing does not include filesprovided with or created by ProtoBase orthe AMEX utility, or provided asProtoBase utilities. Also, files used inand created by upgrade procedures arenot listed, as these are unique for eachimplementation. Contact SDC ClientServices if you wish to determine theorigin of a file not listed here. ClientServices may be reached toll free at 1-877-SDC-1799. Please have yourcustomer account number available.



Files and Directories which are provided as part of the PbAdmin installation:

PBFE directory

(This directory is where ProtoBase resides. It is the directory that the PBPATHenvironment variable points to.)

PBFE.EXE Program that enters transactions into the PbAdmin database. Thisprogram is the equivalent of PB.EXE and is used in a similar way.

PBADSET.EXE Program that conducts settlement from within PbAdmin.

PBCP.EXE Shipped with DOS only

Creates a transfer file for users of Control Point software. Used in lieu ofnormal settlement through PbAdmin. Not required by most users.

NOTE: This program must not be executed if not required,since it will delete all settleable transactions from thedatabase and convert them to Control Point formatwithout copying records to history. This may beprevented by creating a dummy offline.dat file (whichwill cause PBCP.EXE to return an error message) ordeleting PBCP.EXE if not required.

PBSHELL.EXE Shipped with OS/2 only

Program used to shell from DOS programs to OS/2 programs from withinPbAdmin.

PBFEDOS.EXE Shipped with OS/2 and WinNT

DOS version of PBFE.



PBADMIN directory

(This directory may be either separate or combined with the PBFE directory. It is thedirectory that the PBDBPATH environment variable points to.)

ADMBUILD.EXE Utility program used to rebuild PbAdmin database indexes in caseswhere index has become corrupted or for upgrades to new versions whichrequire rebuilding of indexes. May also be run to reduce the size of theindexes (especially for the PBADMAIN.IDX file).

This program is also available as a menu option under DatabaseManagement.

ADMPURGE.EXE Utility program used to purge log files.

This program is also available as a menu option under DatabaseManagement.

PBADMIN.EXE Main program allowing users access to features of PbAdmin.

PBADREP.EXE Program used to create reports from within PbAdmin.

PBCFG.EXE Program used to configure ProtoBase from within PbAdmin.

READCFG.EXE Utility program used to read in configuration from an existingPBCONFIG.CFG file (used when upgrading a ProtoBase site toPbAdmin).

DBEXPORT.EXE Utility program used to create field-delimited ASCII copy of all databases(*.EXP). Used in some upgrade procedures and to fix certain databaseproblems.

DBIMPORT.EXE Utility program used to read field-delimited ASCII files into the PbAdmindatabases. User should be sure to remove unwanted transactions from*.EXP files prior to importing, to prevent duplicating transactions.

PBNTSYS.EXE Shipped with WIN NT version only

Program used to shell from DOS executables to WIN NT executablesfrom within PbAdmin. This file should be copied into the PBFE directory.



DB subdirectory (under PBADMIN)

ADMERROR.TXT Error text for errors reported by PbAdmin.

ADMHELP.TXT Help text used for [F1] help feature in PbAdmin.

ADMLIST.TXT Text used for [F2] lists in PbAdmin and other lists used internally.Should not be modified.

CTERROR.TXT Error text for certain database errors reported within PbAdmin.

PBADERRS.TXT Error text for errors reported by PbAdmin.

PRINT.TXT Printer setup information used in non-UNIX versions of PbAdmin andselected on the printer choice menu.

READCFG.TXT List of processors and numbers used by the READCFG.EXE utility. Alsoused by some versions of PBADREP.EXE.

VALID.DAT Compiled list of validation requirements for fields in PBFE input files.

VVTERMCAP Shipped with UNIX versions only.

List of terminal characteristics (similar to termcap file on UNIX systems)used by Vermont Views (screen display library) to determine keystrokeequivalents on UNIX systems.

PROCCPS.TBL Table of processor equivalents between compliant and non-conpliantversion of ProtoBase (PB). Used by READCFG when converting PB 4.7configurations to use PB 4.7.6 if the “Y” option is specified on thecommand line to indicate conversion should occur.

NOTE: This only converts the processor numbers used in thePbAdmin setup files. Conversion of processor numbersin the existing transaction database (if present) ishandled by the conversion utilities provided.

ADMPROC.TXT Processor data for PbAdmin.

PBCFGHLP.TXT Help file for PBCONFIG program.

ADMMODEM.TXT Modem list for PbAdmin.

DEFAULT subdirectory (under DB)

(These files should be copied into the DB directory for NEW installations only. In olderreleases of PbAdmin, these files appeared in the DB subdirectory. These files will also bepresent in the DB directory of PbAdmin once configured.)

PBADLOCA.DAT

PBADLOCA.IDX

Data file for default location database. Contains entry for the “testlocation” location.

PBADUSER.DAT

PBADUSER.IDX

Data file for default user database. Contains entry for the “pbadmin” user.



Files and Directories which are created by PbAdmin during normal use:

DB directory

PBADMAIN.DAT

PBADMAIN.IDX

Main database which contains all transactions viewable in theSelect/View/Edit Transactions screen of PbAdmin.

PBADUSER.DAT

PBADUSER.IDX

User database which contains data entered in the user setup screen ofPBADMIN.EXE.

PBADLOCA.DAT

PBADLOCA.IDX

Location database which contains data entered in the location setupscreen of PBADMIN.EXE.

PBPACKET.DAT

PBPACKET.IDX

Packet database which contains data on certain real-time or hosttransactions such as checks and debit cards.

*.CRD Files containing data on cards accepted by each terminal and usedinternally by PBCFG.EXE.

MKEYLIST.DAT File containing list of merchant keys used internally.

UCOMM.DAT

UPROC.DAT

UTERM.DAT

Files containing data on comm ports, processors and terminals and usedinternally.

*.LOG The PbAdmin log file, usually called PBADMIN.LOG but may change ifdefault log name is changed in location setup. This file keeps track ofactions performed in the PbAdmin program.

*.STL The PbAdmin settlement log, usually called PBADMIN.STL but maychange if default log name is changed in location setup. This file keepstrack of settlements and is the file displayed on the screen aftercompletion of a successful settlement in PbAdmin.



DB directory

*.TRN The PbAdmin transaction log. The default name is PBADMIN.TRN,which can be changed in location setup. This file keeps track oftransactions as they occur.

PBCONFIG.LST The equivalent of PBCONFIG.CFG, created during configuration byPBCFG.EXE.

PBCFG.OUT The output from the last time PBCFG.EXE was run.

COMMLIST.TXT List of comm devices used internally by PBCFG.EXE.

LOCLIST.TXT List of locations used internally by PBCFG.EXE.

MERCLIST.TXT List of merchant keys used internally by PBCFG.EXE.

PROCLIST.TXT List of processors used internally by PBCFG.EXE.

TERMLIST.TXT List of terminals used internally by PBCFG.EXE.

*.RPT Report files are generated as temporary files by PbAdmin when they areviewed on the screen. If you wish to capture a hard copy of a report file,you may copy this temporary file while the report is being viewed onanother terminal / session / window. Reports can also be generated viaAPI files in a manner similar to running ProtoBase. Consult theIntegration section for details.

DBHIST subdirectory (under DB)

PBAD????.DAT

PBAD????.IDX

History databases (where ???? is the date of the history file in MMYYformat).

????????.T?? Temporary files which may be left by earlier versions of ProtoBase.These may safely be deleted as long as ProtoBase is shut down.

OTHER *.DAT

OTHER *.IDX

Backup copies of the PbAdmin databases made at the time of lastsettlement if the PBBACKUP environment variable is set. In event ofcatastrophic loss of data, these may contain valuable backups of theregular databases at time of last settlement.

DEBUG subdirectory

(This directory should be under PBADMIN or PBFE. It is lowercase in UNIX. These filescan be safely deleted if no debug information is required.)

Various temporary files(name varies byoperating system)

This directory contains copies of some or all of the input/output filespassed to ProtoBase by PBFE when DBLEVEL=4 has been set in theenvironment (depending on how the operating system handles temporaryfiles). These files can be useful if unusual errors occur which requireinvestigation of fields passed from PBFE.EXE to PB.EXE.

????????.H?? History files for good settlements which can be useful when trackingdown problems during settlement.

????????.B?? History files for bad settlements which can be useful when tracking downproblems during settlement.



BATCH subdirectory(This directory is used during settlement to store the ProtoBase temporary batch file. It isusually empty unless a settlement is in progress or catastrophic failure occurred duringsettlement. This is the settlement directory specified on the Location Information screen.)

PBmkey.DAT Temporary batch file created during settlement. This represents only thatsubset of records in the database actually being settled. This file isnormally deleted as a routine part of the settlement process. Mkeyrepresents the particular merchant key being settled.

PBEDC.LCK This is a lock file created by ProtoBase during the settlement process. Ifthere was a catastrophic failure during a previous settlement attempt, thisfile may remain in this directory and should be deleted prior to attemptinganother settlement. Presence of this file during settlement will result inunusual settlement error messages.

API/Settlement Directory

(These files are located in the individual settlement directory by location. They can besafely deleted if no debug information is required. These files are the input/output filescreated during the last settlement attempted and can be useful for tracing problems withsettlement or duplicating errors. The ??? in the filename is the merchant key beingsettled (if settling single merchants) or the name of the settlement group (if settlingmultiple merchants). These are produced regardless of debug setting.)

PB???.IN

PB???.OUT

Prior auth and other transactions created by PBADSET.EXE duringsettlement which may be used to re-create the actual batch file usedduring settlement. The output file may be checked for errors whichoccurred at this point in the settlement process.

PBR???.IN

PBR???.OUT

Auth reversal transactions created by PBADSET.EXE during auto-reversal processing. Errors occurring in these files are normally ignored.

PBT???.IN

PBT???.OUT

Host totals transactions created by PBADSET.EXE and passed toPBHSTTOT.EXE file. Errors in these files can lead to an “Out ofBalance” error message when settling.

PBD???.IN

PBD???.OUT

Host details transactions which may be present if the processor supportsthem. These are created by PBADSET.EXE and passed toPBHSTDET.EXE.

PBS???.IN

PBS???.OUT

Settlement transactions created by PBADSET.EXE during settlementwhich may be used to re-create any settlement errors which occurred.The output file may be checked for the actual error message returned byProtoBase when settling, in cases where the settlement log is suspectedof being in error or inaccurate.



PBADMIN / PBFE / other directories

CORE UNIX only.

These files are created when a program suffers a catastrophic failure andcan be quite lengthy. They may safely be deleted if no debug informationis required. Consult SDC Client Services if core files are continuouslyfound for no reason when no programs have crashed, since this mayindicate a problem with a program abnormally terminating.

OFFLINE.DAT DOS only -- for users of the Control Point interface only.

Output file created by the PBCP.EXE utility. This file containssettlement data being passed to the Control Point software. PBCP.EXEwill not run if this file is present, since it assumes that the previoussettlement has not been completed if this file is found.

PBFE.INI This is the global INI file, corresponding to the Global INI File screen.Settings in this file are overridden by settings in the local INI(PBADMIN.INI) file. This file can be modified in PbAdmin, or by using astandard text editor. This file is located in the PBFE directory.

PBADMIN.INI This is the local INI file, corresponding to the Local INI File screen. Thisallows executables to reside on a local drive, without interfering with thesetup of other computers. The settings in this file override settings in theglobal INI (PBFE.INI) file. This file can be modified in PbAdmin, or byusing a standard text editor. This file is located in the directory in whichPbAdmin is running.

*.EXP Export files created by running DBEXPORT.EXE. This contains flat-filerepresentations of the contents of the databases at the time theDBEXPORT utility was run.

Users may consult these files, but no documentation is providedregarding content.

These files appear in the directory where DBEXPORT was run.

These files may safely be deleted, and may be re-created by runningDBEXPORT.EXE.



PBADMIN / PBFE / other directories (cont.)

*.LCK Lock files created by various programs which may be left if a program isrunning or terminates abnormally. If ProtoBase is not running, and noother users are running PbAdmin, lock files may be safely deleted. Lockfiles may appear in many places depending on the program thatgenerated them, but will always be somewhere in the ProtoBasedirectory structure. Consult SDC Client Services if lock files arecontinuously found for no reason when no programs are active; this mayindicate a problem with a program abnormally terminating. ClientServices may be reached toll free at 1-877-SDC-1799. Please have yourcustomer account number available.

*.STE These are debug files created by various programs when run withDBLEVEL=4 set. They are re-created each time the program is run, sozero-length files may be present if the programs have been run withdebug turned off. The information in these files is usually used bydevelopment programmers to help track down problems occurring withinspecific programs.

Users may consult these files, but they are primarily for internal use bySouthern DataComm staff.

These files appear in the directory where the program in question isexecuted.

These files may safely be deleted if no debug information is required.

ProtoBase Administrator User Guide Version 4.3.002 - How to Use PbAdmin


ProtoBase


User Guide

V. How to Use PbAdmin

ProtoBase Administrator User Guide - Version 4.3.002 - How to Use PbAdmin


How to UsePbAdmin

When you finish setting up PbAdmin and running testtransactions, you are ready to begin using PbAdmin. Thissection describes the various day-to-day functions of theProtoBase Administrator. We explain how to perform thefollowing:

• Start and exit PbAdmin

• Select and edit transactions for settlement

• Generate and view various reports

• Run deposit transactions (perform settlement)

• Maintain transaction history

• Perform database management



How to StartPbAdmin

To start PbAdmin, do the following:

1. Verify you are at the command prompt of the mainPbAdmin directory. Change to the PbAdmin maindirectory if needed.

NOTE: This text-based version of PbAdminis a console application and must berun from the command prompt.

2. Type pbadmin [ENTER].

3. Enter a Login ID and Password which you have setup to log in to PbAdmin.

User Log In Screen



When you complete these steps, the Main Menu displays,as shown below:

Main Menu



How to ExitPbAdmin

To exit PbAdmin and return to the command prompt, youhave three options, all from the Main Menu:

• Select Exit Administrator from the Main Menu. Weshow a sample Main Menu below with this optionhighlighted.

or

• Press the [F10] key from the Main Menu.

or

• Press “E” from the Main Menu.

Main Menu



Select/EditTransactions

To select or modify transactions in preparation forsettlement, select the Select/Edit Transactions optionfrom the Main Menu. You can do this by moving the cursorto this selection and pressing [ENTER]. You can also dothis by pressing “S” from the Main Menu.

When you do this, the Select/View/Edit Transactionsscreen appears. We show a sample below.

Select/View/Edit Transactions Screen



Select/View/EditTransactionsScreen (MainScreen)

How to ManuallySelect or DeselectIndividualTransactions forSettlement

The Select/View/Edit Transactions screen shows all thetransactions in the database that have not been settled forthe location currently logged in. For a description of thefields and transaction indicators on this screen, pleaserefer to the PbAdmin Technical Reference section.

Use this screen to select and deselect specifictransactions to indicate they are ready for settlement or tobe included in reports. To select a transaction, positionthe cursor in the Select column for the particulartransaction, then press the [Space] bar. A check mark(33 or X) appears between two brackets to indicate thistransaction is selected. This mark disappears ifdeselected.

Available FunctionKeys

From this screen, you have access to various functions.You can press [Shift]+[F3] for a list of all availablefunctions. The available function key commands are asfollows:

[F1] = Help[F3] = Add new transaction[F4] = Transaction search[F6] = Transaction detail (To view and modify detail)[F8] = Select transaction criteria[F9] = Deselect transaction criteria[Shift]+[F4] = Select display mode[Shift]+[F6] = Toggle status[Arrow Up] = Arrow up one transaction[Arrow Down] = Arrow down one transaction[Shift]+[F7] = Moves to top of database[Shift]+[F8] = Moves to bottom of database[Space] = Toggles to select or deselect[ESC] = Exit the screen; returns to Main Menu

We describe functions [F3], [F4], [F6], [F8]/[F9],[Shift]+[F4], and [Shift]+[F6] in detail in this section.



Select DisplayMode [Shift]+[F4]

Why You WouldUse this Function

How to Perform thisFunction

This function enables you to choose which transactions todisplay on the Select/View/Edit Transactions screen.

Use this function to limit the number of transactionsdisplayed on the Select/View/Edit Transactions screen.For example, you may only want to view the settleabletransactions to determine which ones to select ordeselect.

From the Select/View/Edit Transactions screen, press[Shift]+[F4] to set the mode. A window appears showingthe current Display Level, and the three display modeoptions. We show a sample below.

The display options are as follows:

Settlement = Displays only settleable transactions (i.e.,sales, returns, and prior authorized sales).

Auth Only = Displays only Authorization Onlytransactions (those marked with “*” ).

All = Displays all transactions, regardless ofstatus or type.

NOTE: The default setting for the display modemay be set on the Location Informationscreen.

Select Display Mode Window



Select/DeselectTransactions [F8]and [F9]

Why You WouldUse theseFunctions

How to Initiatethese Functions

This function enables you to select or deselect groups oftransactions, based on specific criteria, to indicate theyare ready to be settled or included in reports.

Use these functions to select or deselect specificgroups of transactions for settlement or reporting.For example, you may want to select only VISAtransactions for a particular terminal or cashier to settle orto include on a report.

To initiate these functions, press [F8] (for select) or [F9](for deselect) from the Select/View/Edit Transactionsscreen. The select screen is the Select TransactionCriteria screen. The deselect screen is the DeselectTransaction Criteria screen. The screen content is thesame for either function. We show a sample below.




How to Perform theSelect or Deselect

Enter any combination of criteria for any of the fivecolumns (Card Type, Business Date, Transaction Date,Terminal ID, or Cashier ID). Up to ten sets of criteria canbe entered for one selection/deselection. If more than onefield is specified per line, only the records matching allfields will be selected/deselected. To select/deselect alltransactions, leave the criteria columns blank.

NOTE 1: If you are only viewing authorization orsettlement transactions, only those willbe selected/deselected.

NOTE 2:When selecting records to be moved ordeleted from the database (when viewingfrom the Database Management screen),make sure you are viewing alltransactions, since these functions willaffect all selected transactions, eventhose not visible on the Select/View/EditTransactions screen.

To accept the criteria and perform the database select ordeselect, press [F10]. PbAdmin prompts you with “Aboutto modify selection status. Are You Sure?” Tocontinue, press the [Space] bar, then [ENTER]. Todiscontinue, press [ESC].

If you continue with the select/deselect, PbAdmin performsthe function and displays the number of records affected.It then exits you back to theSelect/View/Edit Transactions screen.

The transactions selected show a check mark in theSelect column; the transactions unselected do not show acheck mark.

NOTE3: If you wish to double check yourselection, run a cashier, terminal, ormerchant key “Detail” or “ExtendedDetail” report. Choose Selected for therecords to use. For more information,please read about reports later in thissection.





How to Search for aTransaction

How PbAdminPerforms theSearch

This function enables you to search for a transactionbased on any combination of search criteria.

Use this function to research the PbAdmin database andfind a particular transaction or group of transactions. Youmay need to do this for chargebacks, refunds, returns, or ifyou wish to edit a particular transaction.

Press [F4] from the Select/View/Edit Transactions screen.The Search Criteria screen appears. We show a samplebelow.

Enter any combination of criteria on the Search Criteriascreen. To accept the criteria and perform the databasesearch, press the [F4] key again.

PbAdmin starts the search at the top-most record in thedatabase. It compares the search criteria you enteredwith each transaction in the database and displays a list ofmatching transactions from which you may select thedesired record. You will then be returned to the Select/View/Edit Transactions screen with the record you choseat the top of the screen.

Search Criteria Screen



How PbAdminPerforms theSearch (cont.)

Below is a sample of the screen that appears, showing therecords which match the search criteria. If no matchingrecords are found, the message “No Matching RecordsFound” appears. You can modify the data and performanother search.

Matching Search Criteria



View/ModifyTransaction Detail[F6]



This function enables you to view and modify transactiondetail for individual transactions on the Select/View/EditTransactions screen.

You would use this function for the following reasons:

• To view the detail for a particular transaction in thePbAdmin database. This screen displays the basictransaction detail on the left side (such as customer,card, and amount data) and any extended industrydata on the right side of the screen.

• To edit transaction detail, such as adding room

charges, converting an Auth Only transaction to a PriorAuth to be settled, or to correct an error in thedatabase.

• To void a transaction.

From the Select/View/Edit Transactions screen, place thecursor on the transaction you want to view or modify.Press the [F6] key to initiate this function. The Detail Viewof Transaction screen appears for the transaction youselected. We show a sample below. You may modify ordelete the transaction here. To save your edits, press[F10].

NOTE: Transactions marked with “P”, “U”, “I”, or“R” in the Select column of theSelect/View/Edit Transactions screencannot be modified.

Detail View of Transaction Screen




From the Detail View of Transaction screen, you haveaccess to various functions. The function keys display atthe bottom of the screen as follows:

[F1] = Help

Provides help information for each screen field.

[Shift]+[F3] = AVS Info

Displays AVS information that was entered with thetransaction. (This information cannot be edited.) Weshow a sample screen below.

[F8] = Delete

Deletes the transaction from the database.

[F10] = Save

Saves the updated screen.

[ESC] = Exit

Exits the screen and returns to the Select/View/EditTransactions screen.

Detail View of Transaction/Address Verification Info Screen



Toggle Status[Shift]+[F6]


Available StatusCodes for thisFunction

How to Toggle theStatus

This function enables you to change the transaction statuson particular real-time or settleable host capturetransactions.

Use this function to change the status on applicabletransactions on the Select/View/Edit Transactions screen.For example, use this function on a real-time transactionthat you need to edit or deselect by changing the statusfrom “R” to “r”. It is not advisable to edit a transaction thatis real-time or host capture, since the processor alreadyhas this record. This should only be done to correct atransaction to match the record at the host, or to allow atransaction to be deselected so that it does not settle withthe next batch.

This function is available only for those transactions thathave the following transaction status codes on theSelect/View/Edit Transactions screen:

U = Host capture pending. Already conveyed to the host processor during a previous settlement attempt that was unsuccessful. Used only for host capture systems or real time. Use [Shift]+[F6] to toggle to status “h”.

h = Non-pending host capture. Use [Shift]+[F6] to toggle to status “U”. This transaction may be deselected.

R = Real Time Transaction (Check, ATM/Debit). It cannot be edited in this status. Use [Shift]+[F6] to toggle to status “r”.

r = Toggled real-time transaction. It can be edited in this status. Use [Shift]+[F6] to toggle to status “R”. This transaction may be deselected.

NOTE: If you attempt this function on atransaction for which it is not applicable,the message “Not a Realtime or SettleableHost Capture Transaction” appears.

From the Select/View/Edit Transactions screen, place thecursor on a particular transaction that you want to changethe status. Press [Shift]+[F6] to initiate this function forthis transaction. The status code changes as indicated inthe descriptions above.



Add Transaction[F3] - Add NewDetail TransactionScreen

This function adds a transaction to the PbAdmindatabase.


How to Add aTransaction

Use this function to manually enter a transaction. Thisfunction enables you to add a transaction to the PbAdmindatabase without processing it through your point of salesystem.

Press [F3] from the Select/View/Edit Transactions screen.The Add New Detail Transaction screen appears. Weshow a sample below.

Enter all information on the Add New Detail Transactionscreen for each applicable screen field. You can press[ENTER], [Tab], or the down arrow key to have PbAdminaccept the information for each field. For certain fields,you will need to press [F2] for a choice list. Please referto the PbAdmin Technical Reference section fordetailed descriptions of each field.

Add New Detail Transaction Screen



Add Transaction[F3] - Add NewDetail TransactionScreen (cont.)

NOTE: If you enter and save a transactionwithout an authorization number,PbAdmin will respond with the prompt“No Auth Number Entered. AttemptAuthorization?” Toggle No or Yes byusing the space bar.

Choosing No will return you to theSelect/View/Edit Transactions screen tocontinue entering or editing transactions.

Choose Yes to attempt authorization ofthe transaction through PBFE. AWorking…..message will appear whileauthorization is being attempted. Aprocessor response or an error messagewill be returned to the screen whencomplete.

If the authorization is declined or notcompleted, return to the transaction listto delete the transaction or make anyedits and attempt authorization again.



Reports To generate, view, or save any of the transaction reportsavailable through PbAdmin, select the Reports Menuoption from the Main Menu. You can do this by moving thecursor to this selection and pressing [ENTER]. You canalso do this by pressing “R” from the Main Menu.

When you do this, the Reports menu screen appears asshown below.

Reports Menu



How to Generatea Report

PbAdminReports

To generate a report, select the report you want togenerate from the Reports menu screen. Except for theDeposit Status Report (i.e., the Settlement Log), PbAdminprompts you for the type of transactions to be reported.Press [F2] for a choice list. The following choices areavailable:

All All transactions, regardless of status

Selected All transactions selected on theSelect/View/Edit Transactions screen(those with a check mark)

Pre-Settle All transactions selected on theSelect/View/Edit Transactions screenwhich will actually be deposited when asettlement is run

Place the cursor on the type of transactions you want, thenpress [ENTER].

PbAdmin generates the report you have chosen anddisplays it on the screen.

We provide a brief description of each report beginningon the next page. For report samples, please refer to thePbAdmin Technical Reference section.

You can print the report [F7], save the report with aspecific filename [F10], or exit without printing [ESC].

Several reports are available, showing transaction data intwo levels of detail. These levels are:

Standard, which includes the following fields:

Ref # - Reference NumberAccount - Account NumberType - Transaction TypeAmount - Transaction AmountDate - Transaction DateBus. - Business Date for TransactionAuth# - Authorization NumberCashier (Server) - Cashier or Server employee number

Detail, which includes all the fields specific to the industry.



NOTE 1: If you specified an Optional Internal FileViewer on the Global/Local INI Filescreens, this will be run instead of thedefault viewer. With an optional viewer,PbAdmin still enables you to print andsave the report after you view it.

NOTE 2:If you chose a wide (e.g., landscape)format in the Printer Type field on theLocation Information screen, additionaltax and tip totals display, depending onthe industry.



ReportDescriptions

PbAdminReports -Sorted byCashier

ID

Single-location reports are sorted by cashier, terminal,card type, or merchant key. Multi-location reports aresorted by location with overall totals. The following is adescription of each report.

Cashier Summary Report

Provides a summary of all transactions sorted by cashierID. For the restaurant industry, this is called the ServerSummary Report.


Cashier Detail Report

Provides a standard detail list of all transactions, sorted bycashier ID. For the restaurant industry, this is called theServer Detail Report.



Cashier Extended Detail

Provides an extended detail list of all transactions, sortedby cashier ID. For the restaurant industry, this is called theServer Extended Detail report.

• Standard transaction detail• Industry-specific detail• Sort by cashier• Totals by card type for each cashier• Totals by card type for all cashiers



ReportDescriptions(cont.)

PbAdminReports -Sorted byTerminal

ID

Terminal Summary Report

Provides a summary of all transactions sorted by terminalID.


Terminal Detail Report

Provides a standard detail list of all transactions, sorted bycashier ID.



Terminal Extended Detail

Provides an extended detail list of all transactions, sortedby terminal ID.

• Standard transaction detail• Industry-specific detail• Sort by terminal ID• Totals by card type for each terminal• Totals by card type for all terminals




PbAdminReports -Others

Deposit Status Report (Log)

Shows the settlement (or deposit) log. It provides allsettlement deposit attempts, both successful andunsuccessful.

In addition to selecting the Deposit Status Report optionfrom the Reports Menu, this report can also be generatedtwo other ways:

• Select View Deposit Log from the PbAdmin MainMenu, or

• Select Database Management Menu from thePbAdmin Main Menu, select View Log, and thenchoose Settlement.

Authorization Date & Time Report

Lists transactions sorted by Authorization Date, and withineach date, by Authorization Time. Totals are provided foreach date by card type, and then for all dates by card type.

Incremental Authorization Report

Lists transactions by location and terminal, showing theoriginal and total authorization amounts.

Server Tip Report (Restaurant only)

Provides tip and credit totals per restaurant server, andgrand totals for all servers. Applicable to the restaurantindustry only.




PbAdminReports -Sorted by

CardType

Card Type Summary Report

Provides a summary of all transactions sorted by cardtype. This includes any “card type” defined in theProtoBase configuration, including CHECK and DEBIT.



Card Type Detail Report

Provides a standard detail list of all transactions, sorted bycard type. This includes any “card type” defined in theProtoBase configuration, including CHECK and DEBIT.







PbAdminReports -Sorted byMerchantKey (ID)

Merchant Key Summary Report

Provides a summary of all transactions sorted bymerchant key (ID).


Merchant Key Detail Report

Provides a standard detail list of all transactions, sorted bymerchant key (ID).





DepositTransactions(Settlement)

To initiate a settlement transaction, select the DepositSelected option or Deposit All option from the MainMenu.

Deposit Selected deposits only those transactionsselected on the Select/View/Edit Transactions screen.The Status Window displays the total number and totalamount of selected transactions to be settled.

The Deposit All option deposits all transactions from thecurrent (main) database that can be settled. WhenDeposit All is selected, a Status Window appears asshown below.

Deposit Transactions Status Window

Press [ESC] to exit the screen without performing thesettlement.

NOTE: To verify that your settlement and POStotals balance, run a pre-settlementbalance report prior to running thisselection. You can do this by runningany report and choosing “Pre-settle”when the screen prompts you to choosewhich records to use. The totals for theselected transactions are shown at thebottom of the report.




When YouPerform theSettlement

From this screen, you have access to various functions, asfollows:

[F1] = Help

Provides help information

[F8] = Forced Settlement

Used for host capture processors that support a forcedclose of the host batch even if the totals do not match.Use this if you get a “Batch Out of Balance” error andwant to settle anyway.

[F10] = Normal Settlement

Processes a normal settlement, for the total number oftransactions and amount displayed.

[ESC] = Exit

Exits this screen without performing a settlement.

To initiate the settlement procedure, press [F8] or [F10]when the Status Window displays. The actual settlementprocess may take a few minutes to complete; the durationvaries according to several factors, including the numberof transactions and communication method used.

NOTE: You cannot run authorizations whilesettlement is in progress if you do nothave more than one communicationsdevice, or if the transaction processordoes not support this.

During the settlement process, the Status Window mayshow a series of messages indicating the progress of thesettlement.

If you are set up for automatic Incremental Authorizationsand Authorization Reversals, these are also performed atthis time. Please refer to the Integration section for moreinformation.



Multi-MerchantSettlement

You also have the option of settling multiplemerchants/Terminal ID’s in the same settlement batch file.You would use this option normally when the transactionprocessor has the ability to accept a batch file withmultiple merchant ID’s identified. Some processorsrequire this type of processing.

To use this option, be sure you have set up the Terminal IDfor each transaction you have selected using the sameSettlement Group name (defined in the Terminals setup inthe ProtoBase Configuration screens).

In addition, all transaction locations should be set to usethe same Log File Base Name and Settlement DirectoryName (defined in the PbAdmin Location Informationscreen).

To initiate the settlement, you would perform the sameprocedure as for single merchant settlement (i.e., press[F8] or [F10] when the Status Window displays.) Formore detailed information, please refer to Section 12 ofthe ProtoBase Technical Reference Guide.



When Settlementis Complete

Upon completion of settlement, two separate reportsdisplay on the screen, one at a time.

The first report is a settlement report, generated byProtoBase. We show a sample on the next page. Thisreport is automatically saved in the following location:pbadmin\api\settle\location base log name.rpt. wherepbadmin is the main PbAdmin directory path, settle is thesettlement sub-directory name you chose, and locationbase log name.rpt is the default filename defined in theLocation Information screen.

After you exit the first report, the second report displays.This report is the Deposit Status Log (i.e., SettlementLog), generated by PbAdmin. We show a sample on thenext page.

For each report, you can print [F7], save the report with afilename you specify [F10], or exit without printing [ESC].



Settlement Report Generated by ProtoBase

Deposit Status Log (Settlement Log)



View Deposit Log(Settlement Log)

To view the deposit log (also called the Deposit StatusLog or Settlement Log) for the current location’s depositstatuses, select the View Deposit Log option from theMain Menu. This log automatically displays after youperform a settlement (i.e., select the DepositTransactions option from the Main Menu).

You can also perform this report function two other ways:

• Select the Deposit Status Report from the ReportsMenu.

or

• Select Database Management from the Main Menu,choose View Log, then select Settlement.

Depending on whether an American Express settlement iscurrently pending, different screens may appear when youselect the View Deposit Log option. We describe this onthe next page.



AmericanExpress StatusCheck

If you settle with American Express Direct Settlement, andan American Express settlement is currently pending astatus check, a window displays asking if the user wishesto initiate the status check at this time. Toggle the value to“Yes” using the [Space] bar to initiate the check.

A “Working” box displays while the status check isperformed. If the previous settlement was accepted, thereport returned by American Express displays on thescreen. Press the [F7] key to print it or [F10] to save it.

If the settlement was rejected, or was not ready yet, anerror displays and the settlement log updates with theresponse.


From this screen, you have access to various functions, asfollows:

[F1] = Help

Provides help information.

[F7] = Print

Prints the status check report.

[F10] = Continue

Accepts values and continues with the status check.

[ESC] = Exit

Exits the screen without performing the status check.



Viewing theDeposit(Settlement) Log

If there is no American Express settlement pending orwhen the status check completes, the settlement logdisplays on the screen as shown below.

Settlement Log


[F1] = Help

Provides help information based on the display screen.

[F7] = Print

Prints the settlement log.

[F10] = Save As

Saves the report with a filename you specify.

[ESC] = Exit

Exits without saving the report.



TransactionHistory Menu

To research previously settled transactions in history,select the Transaction History Menu option from theMain Menu. The Transaction History submenu appears asshown below.

Transaction History Menu

Using the Transaction History submenu, you can performthe following functions:

• Search for transactions in history• View history transaction detail• Move history transactions to the current working

database• Print various history reports

We discuss these functions in detail in this section.



TransactionHistory Search

Use this selection to view historical data and transferpreviously settled transactions to the current database.Press [ENTER] on the Transaction History Searchoption on the Transaction History menu to initiate a searchof transaction history.

The first screen prompts you for the initial history monthand year to view. Since the Administrator system storesall settled transactions by month, this is necessary as astarting point for your search.

Transaction History Search Screen

Enter a valid month/year combination to view transactionhistory. After you press [F10] to accept the month/yearcombination, the View History Transactions screenappears.

This screen looks similar to the Select/View/EditTransactions screen. It lists all transactions in the historydatabase for the current location by the chosenmonth/year. We show a sample on the next page.



View HistoryTransactionsScreen

The View History Transactions screen shows all thetransactions in the database that have been settledsuccessfully for the location currently logged in. Thecolumn headings are the same as those of theSelect/View/Edit Transactions screen, except the Auth #column is replaced by the six-digit Batch #. For adescription of the fields and transaction indicators on thisscreen, please refer to the description of theSelect/View/Edit Transactions screen in the PbAdminTechnical Reference section.

NOTE: You cannot edit, toggle status, or deletetransactions from this screen.

View History Transactions Screen




From the View History Transactions screen, you haveaccess to various functions. You can press [Shift]+[F3]for a list of all available functions. The available functionkey commands are as follows:

[F1] = Help[F4] = Transaction search[F6] = Transaction detail (View only)[F8] = Select transaction criteria[F9] = Deselect transaction criteria[F5] = Reverse and copy to main database[Shift]+[F6] = Copy selected transaction to main database[Arrow Up] = Arrow up one transaction[Arrow Down] = Arrow down one transaction[Shift]+[F7] = Moves to top of history database[Shift]+[F8] = Moves to bottom of history database[ESC] = Exit the screen; returns to Transaction History menu

We describe functions [F4], [F6], [F8]/[F9], [F5], and[Shift]+[F6] in detail in this section.





How to Search for aTransaction

How PbAdminPerforms theSearch

This function enables you to search history for atransaction based on any combination of search criteria.

Use this function to research the PbAdmin historicaldatabase and find a particular transaction or group oftransactions. You may need to do this for chargebacks,refunds, or returns.

Press [F4] from the View History Transactions screen.The History Search Criteria screen appears. (We show asample below.) Enter any combination of search criteriaand press the [F4] key again. A window displays,prompting you to enter the date range from which tosearch for the history files. Enter a range, then press the[F10] key to begin the search.

PbAdmin searches the range you select. It compares thesearch criteria you entered with each transaction in thedatabase. You are presented with a list of matchingtransactions. You may then select a desired transaction,and you will be returned to the proper history file with therequested transaction on the top of the screen. If amatching record is not found, PbAdmin returns you to theHistory Search Criteria screen. You can modify the dataand perform another search.



History Search Criteria Screen



View TransactionDetail [F6]



This function enables you to view transaction history detail.

Use this function to view the detail for a particulartransaction in the history database. This screen displaysthe standard transaction detail on the left side (such ascustomer, card, and amount data) and any extendedindustry data on the right side of the screen.

From the View History Transactions screen, place thecursor on the transaction you want to view. Press the [F6]key to initiate this function. The Detail View of HistoryTransaction screen appears for the transaction youselected. We show a sample below.

NOTE: You cannot modify history transactions.

Detail View of History Transaction Screen




From the Detail View of History Transaction screen, youhave access to various functions. The function keysdisplay at the bottom of the screen as follows:

[F1] = Help

Provides help information for each screen field.

[Shift]+[F3] = AVS Info

Displays AVS information that was entered with thetransaction. We show a sample screen below.

[F8] = Copy to main

Copies the transaction from the history database to themain database (the one displayed on the Select/View/EditTransactions screen). The message “Are You Sure?”prompts the user to toggle “Yes” before continuing. Thisfunction can also be done by pressing [Shift]+[F6] fromthe View History Transactions screen.

[ESC] = Exit

Exits the screen and returns to the View HistoryTransactions screen.

Detail View of History Transaction/Address Verification Info Screen



Select/DeselectTransactions [F8]and [F9]

Why You WouldUse theseFunctions

How to Initiatethese Functions

This function enables you to select or deselect groups oftransactions in the history database, based on specificcriteria, for reporting or copying to the main database.

Use this function to select or deselect specific groupsof transactions for reporting or to copy to the maindatabase. For example, you may want to select onlyVISA transactions for a particular terminal or cashier to runa report on. Or, you may want to select a transaction froma certain batch to copy to the main database.

To initiate these functions, press [F8] (for select) or [F9](for deselect) from the View History Transactions screen.The select screen is the Select Transaction Criteriascreen. The deselect screen is the Deselect TransactionCriteria screen. The screen content is the same for eitherfunction. We show a sample below.




How to Perform theSelect or Deselect

Enter any combination of criteria for any of the six columns(Card Type, Business Date, Transaction Date, TerminalID, Cashier ID, or Batch Number). Up to ten sets ofcriteria can be entered for one selection/deselection. Toselect/deselect all transactions, leave the criteria columnsblank.

NOTE 1: If you are only viewing authorization orsettlement transactions, only those willbe selected/deselected.

NOTE 2:When selecting records to be moved ordeleted from the database (when viewingfrom the Database Management screen),make sure you are viewing alltransactions, since these functions willaffect all selected transactions, eventhose not visible on the View HistoryTransactions screen.

To accept the criteria and perform the database select ordeselect, press [F10]. PbAdmin prompts you with “Aboutto modify selection status Are You Sure?”. Tocontinue, press the [Space] bar, then [ENTER]. Todiscontinue, press [ESC].

If you continue with the select/deselect, PbAdmin performsthe function and displays the number of records affected.It then exits you back to theView History Transactions screen.

The transactions selected show a check mark in theSelect column; the transactions unselected do not show acheck mark.

NOTE3: If you wish to double check yourselection, run a cashier, terminal, ormerchant key “Detail” or “ExtendedDetail” report. Choose Selected for therecords to use. For more information,please read about reports later in thissection.



Reverse andCopy to MainDatabase [F5]



What PbAdminDoes When YouPerform thisFunction

This function enables you to copy selected transactionsfrom the history database to the main database (the onedisplayed by the Select/View/Edit Transactions screen) asa reversal of the original transaction.

Use this function only for double-deposited batches thatneed to be reversed. Prior to performing this function, youmust select the entire batch that was double-depositedusing the Select function ([F8]) described on page 273.

From the View History Transactions screen, press [F5] toinitiate this function.

PbAdmin prompts you with “About to reverse and copyrecords to main database Are You Sure?”. Tocontinue, press the [Space] bar, then [ENTER]. Todiscontinue, press [ESC].

If you continue with the reverse and copy function,PbAdmin copies all transaction records that you haveselected to the main database. The history database isnot affected by this function.

When the transactions are copied, it changes each Prior-Authorized Sale transaction to a Return transaction andeach Return to a Prior-Authorized Sale. It will copy, but notchange, any transaction type selected other than Prior-Authorized Sales and Returns.

PbAdmin shows the results of this function in a StatusWindow similar to below.

Reverse and Copy to Main Database Status Window



Copy to MainDatabase[Shift]+[F6]




This function enables you to copy selected transactionsfrom the history database to the main database (the onedisplayed by the Select/View/Edit Transactions screen).

This can be used if transactions were inadvertently movedto history without being settled. You can move thesetransactions from history back to the main database tosettle them correctly.

From the View History Transactions screen, press[Shift]+[F6] to initiate this function.

PbAdmin prompts you with “About to copy records tomain database Are You Sure?”. To continue, press the[Space] bar, then [ENTER]. To discontinue, press[ESC].

If you continue with the copy function, PbAdmin copies alltransaction records that you have selected to the maindatabase. The history database is not affected by thisfunction.

PbAdmin shows the results of this function in a StatusWindow similar to below.

Copy to Main Database Status Window



Deposit Date andTime Report

Select this option from the Transaction History Menu togenerate the Deposit Date and Time Report. Whenselected, a message prompts you for the month and yearto include in the report.

When generated, this report lists settlements by date andtime with net totals for each, and the message receivedfrom the transaction processor.

Various HistoryReports

The rest of the options on the Transaction History Menugenerate reports in the same formats as those on theReports submenu. These reports show transaction databy cashier, terminal, card type, and merchant key. Amessage prompts the user for the month and year and thebatch number to include in each history report. To includeall batches, leave the batch number blank.

The reports available are as follows:

• Cashier Summary Report• Cashier Detail Report• Cashier Extended Report

NOTE 1: For the restaurant industry, theword “Cashier” is replaced by“Server”.

• Terminal Summary Report• Terminal Detail Report• Terminal Extended Report

• Card Type Summary Report• Card Type Detail Report

• Merchant Key Summary Report• Merchant Key Detail Report

NOTE 2:For batch numbers that havemultiple merchant keys, PbAdminalso breaks the history report ateach merchant key.



DatabaseManagementMenu

To perform database clean-up, select the DatabaseManagement option from the Main Menu. The DatabaseManagement submenu appears as shown below.

NOTE: The options on this menu shouldonly be performed by a systemadministrator, or only if directed todo so by qualified personnel.

Database Management Menu

Using the Database Management submenu, you canperform the following functions:

• Modify the status of transactions, or delete them ormove them to history.

• Delete old or expired authorizations.• Check settlement data for a transaction, or fix it if

changes have been made to the ProtoBaseconfiguration.

• Rebuild or delete the transaction database.• Rebuild or delete history databases.• View or delete three separate logs.



ModifyTransactionStatus


Use this function to change the transaction status indicatoron particular transactions as viewed on theSelect/View/Edit Transactions screen. It will change everytransaction in the main database that has the indicated“from” status to the indicated “to” status.

Occasionally, errors may occur that leave transactions inan invalid status. This function enables the user to changethat status. For example, if several transactions have notbeen settled, but settlement was attempted and they are“stuck” in progress, you can change these transactionsfrom an “In Progress” to a “Selected” status.

Modify Transaction Status Window




Select the Modify Transaction Status option from theDatabase Management menu.

A Status Window appears, as shown on the previouspage. It indicates the status you want to move “from” and“to”.

The default is from “In Progress” to “Settled”. Press [F2]for a choice list.

The following are the available statuses for both the“move” and “to” selections, including the correspondingstatus code as indicated on the Select/View/EditTransactions screen:

Selected = 3or XPending = PIn Progress = IHost Pending = UReal Time = RMove to History pending = M

Two additional statuses are available for the “to” field only,as follows:

History = Move this transaction to historyBe Deleted = Delete this transaction from database

When you have made your choices for “move” and “to”,press [F10] to accept.

Upon completion, a message appears indicating thenumber of records that changed from the chosen “move”status to the chosen “to” status.



Purge OldAuthorizations




This function deletes all expired authorization transactionsfrom the main database based on the particular locationyou are logged into.

This function cleans up the main database of any expiredauthorizations which were not settled. You define anexpired authorization by the value in the “Days to KeepAuths” on the Location Information screen for this location.

Select the Purge Old Authorizations option from theDatabase Management menu.

PbAdmin prompts you with “Continuing will cause allexpired authorizations to be permanently deleted!Are You Sure?”. To continue, press the [Space] bar,then [ENTER]. To discontinue, press [ESC].

If you continue with the purge function, PbAdmin deletes allAuthorization Only transaction records from the maindatabase that have a transaction date older than the valueindicated in the Days to Keep Auths (on the LocationInformation screen).

NOTE: If you are logged in as a Master User, thepurge settings for the Master Location willoverride the settings for an individuallocation.

PbAdmin shows the results of this function in a messagesimilar to below:

“PBADMAIN OLD AUTHS PURGED: xx Record(s)Deleted”

xx is the number of authorizations that were deleted.



Check SettlementInformation




This option checks for discrepancies between settlementinformation on all transactions, and the current settlementterminal and settlement merchant key configuration.

Use this function to check settlement information beforeyou run settlement. This is necessary if any terminal ormerchant key information has been changed or deleted inthe ProtoBase configuration. You can then use the FixSettlement Information option to fix the “fixable”transactions. We describe the Fix Settlement Informationoption on the next page.

To initiate this function, select Check SettlementInformation from the Database Management menu.

PbAdmin prompts you with “About to check settlementinformation”. To continue, press the [Space] bar, then[ENTER]. To discontinue, press [ESC].

If you continue with this function, PbAdmin checkssettlement information on all transactions against thecurrent terminal and merchant key configuration.

After PbAdmin performs the check, a message displaysat the bottom of the screen. This message indicates thenumber of transactions with the following types ofdiscrepancies:

Fixable Transaction for which information doesnot match the current settlement terminalor settlement merchant key configuration.These can be fixed by the Fix SettlementInformation option.

Bad Mkey or Caused by configuration errors. ABad Range formerly valid card range has been

deleted, or the PBMERC.DAT file haschanged since configuration was run.These discrepancies cannot be fixedautomatically. They must be fixed bymodifying and re-running configuration.



Fix SettlementInformation




This function fixes transactions if there are discrepanciesbetween settlement information for a transaction and thecurrent terminal and merchant key configuration.

Use this function to fix any “fixable” transactions, asindicated by the Check Settlement Information option.

NOTE: If you cannot identify the errors inthe terminal or merchant keyconfiguration, set DBLEVEL=4 andrun the Check SettlementInformation option again. This willgenerate error notifications in thePBADMIN.STE debug file. You mayeither review the file or call SDCClient Services for moreinformation.

To initiate this function, select the Fix SettlementInformation option from the Database Managementmenu. PbAdmin prompts you with the message “Aboutto Attempt to Fix Settlement Information”. Tocontinue, press the [Space] bar, then [ENTER]. Todiscontinue, press [ESC].

If you continue, PbAdmin modifies the information in thetransaction to match the current configuration.

After PbAdmin performs the fix, a message displays at thebottom of the screen, indicating the number of recordsfixed.



RebuildTransactionDatabase


How to Rebuild allPbAdminDatabases withinPbAdmin

How to RebuildVarious DatabasesOutside PbAdmin

This function rebuilds and reindexes the main transactiondatabase file, PBADMAIN.DAT, and its correspondingindex file, PBADMAIN.IDX. These files are located in theDB subdirectory under the main PbAdmin directory.

Occasionally, the index to the database file may becomecorrupted. Use this selection to create new indexes. Youmay want to try this if you are receiving “C-Tree errors”.

Select the Rebuild Transaction Database option fromthe Database Management menu.

PbAdmin prompts you with “About to RebuildTransaction Database Are You Sure?”. To continue,press the [Space] bar, then [ENTER]. To discontinue,press [ESC].

When completed, the message “Rebuild Complete”appears.

It is sometimes necessary to rebuild (reindex) the variousPbAdmin databases outside of PbAdmin from thecommand prompt. To do this, exit out of PbAdmin untilyou get to the main PbAdmin directory (specified in thePBDBPATH environment variable).

The command admbuild enables you to rebuild andreindex separate databases. We describe the optionsyou have with this command on the next page.



How to RebuildVarious DatabasesOutside PbAdmin(cont.)

To rebuild alldatabases

To rebuild historydatabase only

To rebuild thepacket databaseonly

To rebuild the maindatabase only

You have the following command options to use withadmbuild:

admbuild -a

admbuild -h mmyy (where mmyy is the two-digitmonth and year for the history to rebuild - also can bedone using the Rebuild History File option from theDatabase Management menu)

admbuild -p (used for real-time and host capturetransactions)

admbuild -m

When you run any of these options, PbAdmin shows aseries of messages indicating the progress of the rebuild.When completed, you will be returned to the commandprompt.



PurgeTransactionDatabase



This function deletes all records from the maintransaction database for the particular location youare in.

Use this function to delete all records from the maindatabase. For example, you can run this function to cleara database of test transactions prior to going live with aparticular installation. You do not want to use this functionunless you are sure you do not need any of thetransactions in the main database.

If the live database is damaged, you may not want to usethis function. Instead, the PBADMAIN.DAT andPBADMAIN.IDX files should be backed up and deletedoutside of PbAdmin from the command line.

Select the Purge Transaction Database option from theDatabase Management menu.

PbAdmin prompts you with “Continuing will causetransaction database to be permanently deleted! AreYou Sure?” To continue, press the [Space] bar, then[ENTER]. To discontinue, press [ESC].

When completed, a message appears indicating thepurge has been completed.



Rebuild HistoryFile


How to RebuildHistory PbAdminDatabase withinPbAdmin

How to RebuildVarious DatabasesOutside PbAdmin

This function rebuilds and reindexes the history transactiondatabases, PBADmmyy.DAT, and their correspondingindex files, PBADmmyy.IDX (where mmyy is the two-digitmonth and year when these files were moved to history).These files are located under the DBHIST subdirectorywithin the main PbAdmin directory.

Occasionally, the indexes to the history files may becomecorrupted. Use this selection to create new indexes. Youmay want to try this if you are receiving “C-Tree errors”.

Select the Rebuild History Database option from theDatabase Management menu.

Enter a valid month/year combination to view transactionhistory. Press [F10] to accept the month/yearcombination.

PbAdmin prompts you with About to Rebuild SelectedHistory File Are You Sure?”. To continue, press the[Space] bar, then [ENTER]. To discontinue, press[ESC].

When completed, the message “Rebuild Complete”appears.

You can also rebuild the history databases outside ofPbAdmin from the command prompt. To do this, exit outof PbAdmin until you get to the main PbAdmin directory(specified in the PBDBPATH environment variable).Then, type the following:

Admbuild -h mmyy (where mmyy is the two-digitmonth and year for the history to rebuild)



Purge HistoryFiles



This function deletes all transactions from a selectedhistory database.

Use this function when you want to delete historydatabases that you no longer need for research purposes.

Select Purge History Files from the DatabaseManagement menu.

PbAdmin prompts you to enter the month and year of thehistory file to be deleted. Enter the appropriate month andyear, then press [F10] to accept. PbAdmin prompts youwith the message “Continuing will cause selectedhistory database to be permanently deleted!” Tocontinue, press the [Space] bar, then [ENTER]. Todiscontinue, press [ESC].

If you continue, PbAdmin deletes all transactions from thechosen history file. A message appears indicating thepurge has been completed.



View Log


This function enables you to view and print the three logsavailable in PbAdmin. The logs are as follows:

Administrator The main Administrator log. Listsprocess statuses of functions runthrough PbAdmin

Settlement Lists settlement statuses of alldeposits initiated throughPbAdmin

NOTE: The Settlement Log can also be run twoother ways, as follows:

• Select View Deposit Log from the PbAdminMain Menu, or

• Select Reports Menu from the PbAdmin MainMenu, then select Deposit Status Report fromthe Reports Menu

Transaction The main front end log records alltransactions processed byPbAdmin

Use this function for snapshots of different aspects ofPbAdmin processing, including general PbAdminprocesses (Administrator Log), the deposit log(Settlement Log), and transactions processed throughPBFE (Transaction Log).


To view a log, choose the Database Management optionfrom the main menu. Select View Log and choose theappropriate log.

If you get the error “File Too Large for Default Viewer”, youmust use a viewer or editor other than the default viewer toview the log. With an optional viewer, PbAdmin stillenables you to print and save the report after you view it.To switch from the default viewer, edit the Optional InternalFile Viewer field on the Global INI file screen.



Administrator Log

Settlement Log (Deposit Status)

Transaction Log




When you are viewing a log, you have access to variousfunctions. The function keys display at the bottom of thescreen as follows:

[F7] = Print

Prints the log information that is currently being viewed.

[F10] = Save As

Saves the report, allowing the user to specify the file path.

[ESC] = Exit

Exits the View Log selection.



Purge Log




The Purge Log function clears the selected log of alltransactions older than the number of days specified in the“Days to Keep Logs” field on the Location Informationscreen for a selected location.

Use this function to delete old entries from theAdministrator, Settlement, or Transaction logs.

To initiate this function, select Purge Log from theDatabase Management menu. Choose the appropriatelog to purge from the list provided (Administrator,Settlement, or Transaction).

PbAdmin prompts you with: “Continuing will cause allexpired log entries in the (ADMINISTRATOR,SETTLEMENT, or TRANSACTION) log to bepermanently deleted!” To continue, press the [Space]bar, then [ENTER]. To discontinue, press [ESC].

If you continue with the purge function, PbAdmin deletes allrecords from the selected log that have a transaction dateolder than the value indicated in the Days to Keep Logsfield in the Location Information setup.

NOTE: If you are logged in as a Master User, thepurge settings for the Master Location willoverride the settings for an individuallocation.

After the log is purged, the Database Management menudisplays. The following message appears at the bottom ofthe screen:

“(ADMINISTRATOR, SETTLEMENT, ORTRANSACTION ) log file purged: xx Record(s)Deleted”.

xx is the number of records that were deleted.

ProtoBase Administrator User Guide - Version 4.3.002 - Troubleshooting


ProtoBase


User Guide

VI. Troubleshooting



PbAdminTroubleshooting

Issues to ConsiderPrior to CallingSDC ClientServices

In this section, we provide solutions to troubleshootPbAdmin problems. These suggestions should beaddressed prior to calling SDC Client Services. We alsoprovide a complete list of error messages, includingreasons and solutions to each. Client Services may bereached at 1-877-SDC-1799. Please have yourcustomer account number available.

NOTE: If you want to view the PbAdmin databasein a different database application (such asAccess), you may use DBEXPORT to exportit and then import it into the otherdatabase application. It is pipe-delimiteddata with the first line containing headersto identify the data.

1) What version of PbAdmin is it? What version ofProtoBase is it? What operating system andversion is it? What type of network and version isin use? What third-party transaction processor(s)are in use?

a) To indicate a version number, look at the logonscreen for PbAdmin. You can also run pbchkverpbfe in a Unix environment or pbchkver pbfe.exein a DOS or Windows environment.

b) Run pbchkver pb (or pb.exe) to get theProtoBase version number.

c) Type ver [ENTER] at the DOS command line forDOS version. If Windows is involved, look for an“about program manager” menu item on the helpfor the program manager.



Issues toConsider Prior toCalling SDCClient Services(cont.)

d) For UNIX or network versions, look for indicationsof version numbers at bootup or login, or contactyour system administrator for the version you arerunning.

e) Obtain transaction processor information bydetermining the SofTrans module number youhave. SofTrans module numbers may beobtained by examining the Credit Card Tablessetup screens, or by running a copy of the“Print Configuration” printout from theProtoBase Configuration menu, or a copy ofthe PBCONFIG.LST file in the pbadmin\DBsubdirectory.

2) Has this installation been running for a while, or is it anew installation? If running for a while, what, ifanything, has changed recently on either the computer,modem, network, ProtoBase or merchant setup?



Issues to ConsiderPrior to CallingSDC ClientServices(cont.)

3) Is the problem with configuring ProtoBase orPbAdmin, with running authorizations (or certain typesof transactions), or only during settlement? Or is it aproblem getting PbAdmin to run properly (screens orprograms not running or not working correctly)?

4) Configuration problems –

a) Can you get to the screen that shows Processors,Devices, etc?

I) If not, either you are running out of memory, oryou are having problems “shelling out” tosubprograms.

A) If on a DOS system, type mem /c |more[ENTER] at the command prompt and noteavailable memory under 640K (minimumlargest executable program size is 520K).Also for DOS systems, note the value of theCOMSPEC environment variable. On themain ProtoBase directory, type dir /scommand.com [ENTER]. VerifyProtoBase only has access to one correctversion of the file COMMAND.COM.

B) Set the environment variable DBLEVEL=4and reproduce the problem (this can be seton the INI File screen in PbAdmin.) Whenyou do this, exit out of PbAdmin and then login again. Look for the files PBADMIN.STEand PBCFG.STE in the PbAdmin directory,and get copies of them for SDC ClientServices to examine.




II) If on a DOS system and you get an error whentrying to “Run Configuration”, you may have apath name length problem. If you are shown afile with an error message in it, print the file andobtain a copy for SDC Client Services.

A) Make sure that you have mapped a drive onthe network so that the PBADMIN andPBFE directories appear at the root for themapped drive. If not, the command lineused internally by PbAdmin to run theProtoBase configuration may be too long.You will probably have to edit thePBADMIN.INI or PBFE.INI file to changepaths. This can be done in PbAdmin on theINI File screens in the Administrator SetupMenu, or you can edit the files with astandard text editor.

B) For DOS operating systems: If you aregetting an error message in a file on thescreen, then either one of your files are notCPS compliant or you have an error in yourconfiguration, or ProtoBase may still berunning. If you see text such as “hit a keyto continue” followed by an indication thatit is not CPS compliant, you probably havethe DOS environment variable “DIRCMD”set to include a “/p” option. Set DIRCMD=to clear this environment variable and tryagain.

b) Problems getting anything to happen at all –

I) If you get an error message such as “Unable tolocate pbaderr.txt”, your environmentvariables are not set properly. Or, if you havecopied these files from another directory, yourfile may have the incorrect paths in it.




II) If on a DOS system and you get to variouspoints on the screen and suddenly nothinghappens, or you get inconsistent errormessages, you are probably running out ofmemory. At the command prompt, type mem /c| more [ENTER] and note how much low DOSmemory there is (largest available programsize).

c) Problems running READCFG –

I) If you have a previous PbAdmin setup whereyou have copied the PBCONFIG.LST file toPBCONFIG.CFG and are attempting to re-readthe configuration:

A) If you have “Enable Auto Dial Backup” seton, you must delete the definitions forterminals ending in “B” from theconfiguration file prior to runningREADCFG. These are backup terminalswhich will cause confusion if they are read inagain. (This only applies to a PbAdmin 4.1configuration file that does not have backupterminal information.)

B) If you have more than one locationconfigured, terminals will only be read intothe location specified when you runREADCFG from the command line. You willhave to manually move any terminals fromsecondary locations to the proper locationfrom within the PbAdmin setup screens.(This only applies to a PbAdmin 4.1configuration file that does not have backupterminal information.)

C) A maximum of 24 BIN ranges can be read inusing READCFG. Make sure you removeany unnecessary BIN ranges.




d) Problems logging into PbAdmin –

I) If you are installing PbAdmin for the first time,and do not already have PBADLOCA.DAT,PBADLOCA.IDX, PBADUSER.DAT, andPBADUSER.IDX in the PBADMIN\DBdirectory, copy them from the PBADMIN\DB\DEFAULT directory. These files contain thedefault user “pbadmin” with password“pbadmin”, and location “Test Location”, whichmust be present in order for you to add yourown location data.

5) Problems running authorizations or other transactions(not settlement) –

a) Make sure the paths are all correctly set, and thatPBDIRECT (for non-DOS) or PBARB (for DOS)has been started successfully.

b) Make sure that the PBTERM variable is set to aunique value for NetBIOS applications for eachphysical computer. This only applies to DOSsystems.

c) Make sure that the PC running ProtoBase does notuse a screen saver.




d) If you are getting errors from the processor onauthorizations, or errors from ProtoBase (such asinvalid transaction codes), create temporary files anddebug files for SDC Client Services. Set the“DBLEVEL=4” environment variable in the shell wherePBFE is called, or in the INI File. Then run thetransaction in question. If done correctly, there will bea PBFE.STE file with non-zero size in the PBFEdirectory. In addition, there will be temporary files inthe PBFE\DEBUG directory. These are the input filesthat PBFE uses to call PB. Make sure the DEBUGfiles have a current date/time, or delete files in theDEBUG directory prior to running the transaction tomake sure the correct files are captured. In somecases, temporary files may not be created if the erroris occurring prior to calling PB.

e) If the errors are intermittent, try to locate atransaction that the error is occurring on, preferablyrepeatedly. If a transaction that failed once workswhen tried again, it is most likely not a dataproblem. Contact SDC Client Services todetermine which files are needed in this case.Client Services may be reached toll free at 1-877-SDC-1799. Please have your customer accountnumber available.

6) Problems running settlement –

a) Try to narrow the problem down. Some problemsmay be caused by a single bad transaction, or by asingle type of card. Try settling each half of thebatch separately, to help locate a potentially badtransaction. Contact SDC Client Services assoon as possible to resolve the issue, sincedelays will only result in expiredauthorizations and more transactions notbeing settled.

b) Check the Deposit Log to determine if the site hasever successfully settled, or if anything has changedsince the last successful settlement. This includes anybad settlements which may have occurred or newmerchant files. Sometimes a bad batch must becleared at the processor before any more may beattempted.




c) Collect the files in the PBADMIN\API\settlementdirectory for the location in question. These are thetemporary files created during the previoussettlement attempt, and may contain informationthat will help us re-create settlement problems. It isimportant to capture these prior to attemptinganother settlement, since they are cleared prior toeach settlement attempt.

d) If you get “Batch out of Balance” errors, thesecan indicate that one of the settlement programsdid not execute successfully (unless the batch reallyis out of balance). Set “DBLEVEL=4” and attemptthe settlement again. Collect the PBADSET.STEfile and the files in the API directory for use by SDCClient Services.

e) Look at the files that created the error. Check forinvalid expiration dates. These problems usuallyoccur at the beginning of a new month, when cardswhich expired the previous month may still bepresent in the database.

f) Look for invalid transaction amounts (such as $0dollar transactions, or transactions for less than$1.00). These may not be allowed by transactionprocessors, or may cause problems withProtoBase. Remove any such transactions fromthe settlement and try them again.

g) Call the transaction processor to determine if thereis a problem with their settlement system. Also callSDC Client Services to determine if other sitesusing the same processor have been havingproblems. These can indicate problems with theprocessor or with ProtoBase, which may possiblybe corrected with an updated SofTrans set for theprocessor.




h) If you are settling an unusually large batch, or if youare running short of disk space, try reducing thesize of the settlement. Sometimes largesettlements produce unacceptably large temporaryfiles which may fill up your available disk space.They also increase the chance of communicationerrors.

7) Make sure the attributes on files and directories areset up so that PbAdmin can access them. Files shouldnot be read-only. Make sure that if PBFE is executedremotely, that the user it logs in as is configuredproperly.

8) Make sure there are no performance issues on thenetwork, and that the modem is operating properly. Aslow network can cause errors in ProtoBase inter-process communications. Be sure to check networkloading at the time of day problems are noticed. If thenetwork has changed recently, make sure that if yoursetup uses NetBIOS, that proper software “bridges”are in place to allow NetBIOS communicationsbetween hubs on a multi-hub network. Also make surethat network permissions and variables have not beenaltered by the installation of a new network.

9) If nothing seems to work on the network drives, copy allfiles to a local hard-disk and do not connect thecomputer to the network. Change paths in the INI files(this can be done by using a text editor, or throughPbAdmin on the INI File screens). If it works on thelocal drive but not on the network, the network is mostlikely at fault.

10) If a program is crashing (leaving core files inUNIX or raising an exception window inWindows or OS/2), this can be caused bybad data in the PBMERC.DAT file or invaliddata in the transaction. Call SDC ClientServices for assistance toll free at 1-877-SDC-1799. Please have your customeraccount number available.




11) If you get “c-tree” errors such as “c-tree internalerror”, your database may have been corrupted. Thiscan be caused by the computer going down while aprogram is accessing the database. Usually running“admbuild -a” while ProtoBase is shut down will fixthese kind of problems. These errors can also becaused by low available memory in DOS.

12) If you get “file locked” errors, there may be a left-overlock file from a previous program, or someone elsemay be running at the same time you are. In DOS,type dir /s *.lck [ENTER] at the command prompt tofind lock files that may be present. If you know thatnobody else is running PbAdmin, and ProtoBase isshut down, these may be deleted.

NOTE: Not all lock files appear in the sameplace. Some appear in the DBdirectory, the BATCH directory, or thesettlement directory under API orBATCH.

13) If the .DAT file is corrupted and ADMBUILD cannot fixit, you should try to dbexport the database, removethe .DAT and .IDX files, and then dbimport to restorethe file. This may work since dbexport does not try touse indexes when exporting, and recreating the file willcorrect any possible corruption.



Error Messages/Solutions

The following table describes PbAdmin errors that you may encounter. The tablelists the negative error number, message, reason or cause for the error, andcommon solutions. If a positive error message is received, refer to the ErrorMessages Addendum for a description of various ProtoBase response codes anderror messages.

Error # Error Message Reason/Solutions

-1 INTERNAL ERROR For reasons unknown, an error occurred whileattempting to access any of the c-tree databases.Possible reasons:• Insufficient memory• The database is corruptedTry reindexing the databases by using the“admbuild -a” command in the Administratorsubdirectory or increasing memory size.

-2 INVALID DATABASE An invalid database number was given while tryingto process a command. Call SDC Client Servicestoll free at 1-877-SDC-1799.

-3 DATABASE ALREADYEXISTS

An attempt was made to create a database thatalready exists. Call SDC Client Services.

If you have attempted to delete a database, makesure you remove both the .DAT and .IDX files.

-4 DATABASE DOES NOTEXIST

An attempt was made to open a database thatdoes not exist. Probable cause is that the pathson the Global/Local INI File screens were not setup.Log into PbAdmin, go into Administrator Setup->Global/Local INI File screens and save theinformation.Verify paths on the Global/Local INI File screensand the environment variables.

-5 DUPLICATE ERROR A transaction currently being processed orpreviously processed has been received a secondtime. If the duplicate is of a previous transaction,setting the “Duplicates Allowed” flag to “Yes” in theLocation Information screen will allow thistransaction into the database.

-6 FIND FIRST OR LAST An error occurred during a search procedure. CallSDC Client Services toll free at 1-877-SDC-1799.

-7 NO MATCHING RECORDS No matching records were found when at least onewas expected. Verify information. (This may benormal in some cases, when records do not exist.)




-8 RECORD NOT A SUBSET Same as error -7 above.

-9 OUT OF MEMORY The program ran out of memory during processing.Increase available memory or reduce the number oftransactions being processed.

-10 RECORD LOCKED An attempt was made to modify a record that wasalready locked by another process. Retry thetransaction. If that fails, try reindexing the fileusing the Database Management->RebuildDatabase selection in the Administrator System.

-11 DATABASE NOTINITIALIZED

A transaction could not be processed due to aninternal logic error. Call SDC Client Services tollfree at 1-877-SDC-1799.

-12 LOCATION NOT SET UPFOR MERCHANT

The terminal given in field 109 does not referenceback to a valid card number/ merchant key/locationcombination. Log into the Administrator Setup->ProtoBase Configuration area and verify that:• The terminal belongs to the proper location

(Terminals).• The terminal and card type combination is

setup with the proper merchant key (CardTables->Edit).

• The settings were successfully configured withProtoBase (Run Configuration).

-13 UNABLE TO OPEN FILE An attempt was made to open a file that does notexist. Probable cause is that the paths on theGlobal/Local INI File screens were not set up.Log into PbAdmin, go into Administrator Setup->Global/Local INI File screens and save theinformation.Verify paths on the Global/Local INI File screensand the environment variables.Make sure the file MKEYLIST.DAT exists in theDB directory.Verify that all of the files in the DB directory haveread/write permissions set for all users.

-14 PROTOBASE OUTPUTFILE NOT FOUND

ProtoBase did not respond with an output file.Verify paths are set properly on the Global/LocalINI File screens and the environment variables.Verify ProtoBase is currently running.




-15 TRANSACTION NOT YETSUPPORTED

A transaction was received in the input file that isnot currently supported by PbAdmin. Call SDCClient Services.

-16 FINAL AMOUNT TOOLARGE

A prior authorization or close transaction wasreceived whose final amount exceeds thepreviously authorized amount for the matchingreference/card number. Solutions:

Issue an authorization for the difference.OR

Setup the Administrator System toautomatically do so by setting the “AutoAuthorize Difference” flag to “Yes” in LocationInformation.

-17 SETTLEMENT INPROGRESS

Transactions cannot currently be run because asettlement is in progress for this location. Tryagain later. If the problem persists and it isconfirmed that no settlement is actually inprogress, set the “Settlement in Progress” flag to“No” in Location Information.

-18 INVALID DATA IN FIELD The field number listed contains invalid data.Consult the Integration section for validationcriteria.

-19 INVALID LENGTH FORFIELD

The field number listed is either missing orcontains invalid data. Consult the Integrationsection for valid lengths.

-20 ERROR CREATING APIFILE

The ProtoBase file could not be created.Verify paths are correct on the Global/Local INI Filescreens and the environment variables.Verify that directory permissions for all ProtoBaseand Administrator directories are set for read/writefor all.

-21 CANNOT OPEN TABLEFILE

The reversal file PBREVSUP.TXT or history filePBHSTBL.TBL could not be accessed.Verify paths on the Global/Local INI File screensand the environment variables.Verify the files exist in the DB directory.Verify files have read/write permissions for all.

-22 BATCH OUT OFBALANCE

For host capture systems only. The batch totals ofthe Administrator “shadow” file do not match whatthe host processor expects. Extra reconciliationwith the processor should take place.




-23 ERROR MOVING TOHISTORY-BATCH GOOD

An error occurred while moving an approvedsettlement to history. These records will usuallyshow up with a status of “I” on the Select/View/EditTransactions screen.Confirm with the processor that the settlement wasaccepted.If batch was accepted, use the DatabaseManagement->Modify Transaction Status utility tomove the in-progress (I) transactions to history.If batch was not accepted, use the DatabaseManagement->Modify Transaction Status utility tochange all of the in-progress (I) back to selected(X).

-24 ERROR RESETTINGWORKING FLAGS-BATCHBAD

An error occurred while moving an approvedsettlement to history. These records will usuallyshow up with a status of “I” on the Select/View/EditTransactions screen. See above for procedures.

-25 ERROR RESETTINGWORKING FLAGS-BATCHGOOD

An error occurred while moving an approvedsettlement to history. These records will usuallyshow up with a status of “I” on the Select/Edit/ViewTransactions screen. See above for procedures.

-26 FILE NOT FOUND An attempt was made to open a file that does notexist.Verify paths on the Global/Local INI File screensand the environment variables.

-27 RETURN CODE NOTFOUND

An error occurred when trying to access file. CallSDC Client Services.

-28 SHELL PROGRAM NOTRUNNING

An error occurred while attempting to run PbAdminon an OS/2 operating system and the shellprogram has not been started. Start the shellprogram (PBSHELL.EXE).

-29 UNABLE TO CREATECHILD PROCESS

An error occurred while attempting to spawn aprocess. Call SDC Client Services.

-30 FILE LOCKED An attempt was made to access a file that isalready locked by another process. Try againlater, or look for *.LCK files in the subdirectory. Ifmessage continues, call SDC Client Services.

-31 UNABLE TO OPENVALID.DAT

The specified file could not be opened. Checkpermissions, see if the file still exists, or look for*.LCK files.




-32 UNABLE TO OPENREVSUP.TXT


-33 (Not used at this time) (Reserved for future use.)

-34 UNABLE TO OPENPBERROR.TXT


-35 UNABLE TO OPENPBADERRS.TXT


-36 UNABLE TO OPENMKEYLIST.LCK


-37 UNABLE TO OPENMKEYLIST.DAT


-38 UNABLE TO OPENTERM.DAT


-39 MASTER INDUSTRYERROR

A transaction cannot be run through a terminal setto a “Master Industry” location.

-40 DEBIT CODE ERROR A transaction illegal for Debit was attempted withthe Debit qualifier set. This is an integration error.

-41 UNABLE TO OPENPROTOBASE BATCHFILE

A batch file was not successfully created forProtoBase to settle, or PbAdmin could not open abatch file after settlement. Check the batch file orother files in the settlement directory for errors.Call SDC Client Services for assistance.

-42 UNABLE TO OPENPROTOBASE OUTPUTFILE

PbAdmin could not open the output file after atransaction was run through ProtoBase. Thisindicates ProtoBase abnormally terminated withoutreturning an output file. Call SDC Client Servicesfor assistance.

Any numbernot definedin this table

UNDEFINED ERROR An unknown error was encountered. Call SDCClient Services and report the error number.



Other PbAdmin Errors/Solutions

The following table describes error messages that you may encounter in PbAdmin. Thetable lists the message, reason for the error, and common solutions.

Error Message Reason/Solutions

Access Denied! The logged in user does not have security permissions toperform this function.

American Express Pending There is already an American Express settlement pending.This deposit must be cleared either manually or by callingthe processor to check the status via the “View Deposit Log”option. If there is no actual batch pending, change the“American Express Pending” flag to “No” in LocationInformation.

At least two fields must be used At least two fields must be entered to perform a propersearch.

Cannot access settlement file The settlement file could not be accessed. ProtoBase iscurrently settling another batch. Try again later. Make surepermissions for the ProtoBase directory are set forread/write.

Cannot delete Location becausetransactions exist

An attempt has been made to delete a location where activetransactions exist. This is not allowed.

Cannot lock file. Already in use The record is already in use by another process. Thechanges could not be saved. Try again later.

Cannot remove current user. NOTDELETED!

An attempt has been made to remove the logged in user.This is not allowed.

Card type not valid for thislocation

This card type is not set up for the location in question.

Changes have been saved The changes have been successfully saved.

Choice list program not found (Not used)

Comm Director not running During settlement, PbAdmin determines that the ProtoBasecommunications director is not running. Ensure the directoris running.

c-tree Error c-tree encountered a memory error.Increase the largest executable size (available memory).

c-tree Internal Error For unknown reasons, an error occurred while attempting toaccess any of the c-tree databases. Possible reasons:• Insufficient memory• The database is corruptedTry reindexing the databases by using the “admbuild -a”command in the Administrator subdirectory or increasing theavailable memory.



Error MessageReason/Solutions

Delete program not found The program ADMPURGE was not located in the PbAdmindirectory.

Error configuring card types The file MASTER.CRD in the PbAdmin DB directory couldnot be accessed.Verify file paths on the Global/Local INI File screens and theenvironment variables.Verify the directory and file permissions for the DB directoryare set to read/write for all.After running “Run Configuration”, confirm the MASTER.CRDfile exists.

Error configuring modems The file UCOMM.DAT in the PbAdmin DB directory could notbe accessed.Verify file paths on the Global/Local INI File screens and theenvironment variables.Verify the directory and file permissions for the DB directoryare set to read/write for all.After running “Run Configuration”, confirm the UCOMM.DATfile exists.

Error configuring processors The file UPROC.DAT in the PbAdmin DB directory could notbe accessed.Verify file paths on the Global/Local INI File screens and theenvironment variables.Verify the directory and file permissions for the DB directoryare set to read/write for all.After running “Run Configuration”, confirm the UPROC.DATfile exists.

Error configuring terminals The file UTERM.DAT or <TERMINAL>.DAT files in thePbAdmin DB directory could not be accessed.Verify file paths on the Global/Local INI File screens and theenvironment variables.Verify the directory and file permissions for the DB directoryare set to read/write for all.After running “Run Configuration”, confirm the files exist.

Error deleting record The selected record could not be deleted. Possible causes:• Record is already locked by another user. Try again

later.• c-tree encountered a memory error.• The files in the PbAdmin DB directory do not have

read/write permission.

Error during status check An error occurred during the American Express statuscheck. Either no status was available, or some other erroroccurred. Try again later.




Error executing ProtoBaseconfiguration program

The ProtoBase configuration program PBCONFIG could notbe executed. Possible reasons are:• You are running 32 bit ProtoBase with PBOS=DOS or

PBOS=Client.• PBCONFIG is not located in the ProtoBase directory.• The paths on the Global/Local INI File screens or the

environment variables are invalid.• PBCONFIG does not have read/write/execute

permissions set for all.

Error Loading File – Not enoughMemory

The program is running out of memory. In a DOS system,increase available memory (largest executable programsize).

Error purging file An error occurred while attempting to purge records from afile. Make sure that the PbAdmin DB directory and all of itsfiles have read/write permissions set for all.

Error rebuilding index An error occurred attempting to reindex a file. Make surethat the PbAdmin DB directory and all of its files haveread/write permissions set for all.

Error restarting ProtoBase withnew settings

(Not used)

Error saving file NOT SAVED An error occurred while attempting to save a file. Verify filepermissions.

Error setting up choice list The choice list file could not be created and read intomemory. Possible reasons:• Not enough memory on machine.• Choice list file ADMLIST.TXT is missing in the PbAdmin

DB directory.• File paths on the Global/Local INI File screens or

environment variables are incorrect.• All files in the PbAdmin DB directory do not have

read/write permissions set for all.

Possible solutions:• Increase largest executable program size.• Verify file exists in the DB directory.• Verify paths are correct on the Global/Local INI File

screens and the environment variables.• Verify that directory permissions for all ProtoBase and

PbAdmin directories are set for read/write for all.

Error writing to printer Check printer and printer settings.

File list program not found (Not used)

File Saved Successfully Your file was saved. (Not an error.)




File Too Large for Default Viewer File is too large to view with default viewer. Either install anoptional internal viewer, or save/print file when prompted.

History search program not found (Not used)

Insufficient Memory Available Increase largest executable program size.

Invalid account number Possible causes:• The account number is invalid.• The card type is not set up to be accepted by this

terminal.• The card did not pass a MOD 10 check.• The card number contained invalid data.• The length is incorrect.

Re-enter, or check configuration.

Invalid amount entered The dollar amount entered is invalid.Missing decimal point.Too many numbers to add decimal point.Amounts may not be negative.

Invalid expiration date The card is expired or the date entered is not a proper date.

Invalid login. Access denied The permissions set for this user do not allow access to thisselection/function.

Invalid mag stripe info entered The track information does not match between track 1 and2, or card could not be parsed.

Invalid Merchant Key One of two errors has occurred:The merchant key entered does not exist in theProtoBase file PBMERC.DAT.While saving a terminal card table, a blank merchantkey was encountered for a selected “checked” cardrange.

Invalid password. Please reenter The password is incorrect. Remember, password is casesensitive.

Invalid printer parameters in file The PbAdmin file PRINT.TXT contains invalid data, or iscorrupted. Try selecting a different printer.

Invalid printer port The port specified in the Location Information screen cannotbe accessed.

Invalid processor The transaction processor entered is not in the ProtoBasemerchant file PBMERC.DAT. Make sure you have enteredthe transaction processor. Call SDC Client Services.




Invalid Range Entered for Card A card BIN range must have a lower number on the left anda greater number on the right.

Invalid Record -- DuplicatesExisting Entry

The entry you are saving already exists in the database.

Invalid selection The value entered in this field is invalid. Press the [F2] keyto view a list of valid values.

Invalid terminal/locationcombination entered

The terminal selected for this transaction does not belong tothe currently logged in location.

No printer defined No printer type has been defined in Location Information.

No records available for selection PbAdmin cannot find any records of the requested type inthe database.

No settlement pending There is not a settlement currently pending with AmericanExpress, so the status check could not be performed. If thisis incorrect, change the “American Express Pending” flag to“Yes” in Location Information and run again.

Not a Realtime or Settleable HostCapture Transaction

You have tried to toggle the status on a transaction that isnot real-time or host capture. Transaction must have an “h”,“U”, “R”, or “r” to be toggled.

Printer is currently busy Printer has sent back a busy signal; try again later.

Printer is out of paper Printer is offline or out of paper.

Printer is turned off or is offline Printer is offline or not turned on.

Processor setup files not found The ProtoBase setup files PBSET#.DAT and PBMRC#.DATare not currently located in the ProtoBase directory. Pleaseverify. Call SDC Client Services.

ProtoBase Configuration programnot found

The program PBCONFIG was not found in the ProtoBasedirectory: To resolve this problem:• Verify the ProtoBase directories specified in the

Global/Local INI File screens and the environmentvariables are correct.

• Verify that the executable PBCONFIG is located in theProtoBase directory.

• Verify the PBCONFIG program has read/write/executepermissions for all.

ProtoBase is currently running adeposit

The reconfiguration could not be completed becauseProtoBase is currently running a settlement. Try again later.

Record is No Longer Valid A record on the screen has been deleted or changed. Exitand re-enter the Select/View/Edit Transactions screen torefresh the display.




Reference number not found The reference number entered is not located in the currentdatabase.

Report generator not found The program PBADREP was not located in the basePbAdmin directory.

Required Field not Entered – NotSaved

The cursor will be placed on the missing field when themessage is cleared. Please enter a value for this field.

Restart ProtoBase to activatenew settings

Upon successful completion of “Run Configuration”,ProtoBase (PBDIRECT or PBARB) must be shut down andrestarted to activate the updated values.

Sale not Valid—Use Prior Auth Indicates that a Sale transaction has been entered for a non-host processor. Enter as a Prior Authorization transactioninstead.

Selected file not found PbAdmin could not locate a required file. This can alsohappen if you perform a report that generates no data, or ifyour database contains no data. Call SDC Client Services ifyou cannot resolve this problem.

Selection program not found (Not used)

Sorting program not found PBSORT (for non-UNIX) or SORT (for UNIX) could not beexecuted.

Terminal Mkey does not matchtransaction Mkey

The terminal deposit Mkey currently defined does not matchinformation in the transaction. You may attempt to fix thison the Database Management menu.

Terminal not valid for this location The specified terminal is not set up for the current location.Select a valid terminal.

Transaction not found No transaction was found that matched the entered criteria.

Transaction status error - changenot allowed

The status flag indicator of this transaction is set to a valuethat does not allow editing. Status flags that cannot beedited include:>U= = Host Pending>P= = American Express Pending>I= = In progress for Settlement

Transaction type error - changenot allowed

The transaction type/code of this transaction is set to avalue that does not allow editing. Current transaction typesthat cannot be edited are:• Checks• Debit Sale• Debit Return• Debit Void




Unable to access choice list file The choice list file could not be created and read intomemory. Possible reasons:• Not enough memory on machine.• Choice list file ADMLIST.TXT, ADMMODEM.TXT, or

ADMPROC.TXT is missing in the PbAdmin DBdirectory.

• File paths on the Global/Local INI File screens or theenvironment variables are incorrect.

• All files in the PbAdmin DB directory do not haveread/write permissions set for all.

• Exiting ProtoBase and *.lck files still exist.Possible solutions:• Increase largest available executable program size.• Verify file exists in the DB directory.• Verify paths are correct on the Global/Local INI File

screens and the environment variables.• Verify that directory permissions for all ProtoBase and

PbAdmin directories are set for read/write for all.

Unable to access help text file The help text file could not be read into memory. Possiblereasons:• Not enough memory on machine.• Choice list file ADMHELP.TXT, or PBCFGHLP.TXT is

missing in the Administrator System DB directory.• File paths on the Global/Local INI File screens or the

environment variables are incorrect.• All files in the PbAdmin DB directory do not have

read/write permissions set for all.Possible solutions:• Add memory to machine.

• Verify file exists in the DB directory.

• Verify paths are correct on the Global/Local INI Filescreens and the environment variables.

• Verify that directory permissions for all ProtoBase andPbAdmin directories are set for read/write for all.

Unable to access modem file The file UCOMM.DAT in the PbAdmin DB directory could notbe accessed. To resolve this problem:• Verify file paths on the Global/Local INI File screens and

the environment variables.• Verify the directory and file permissions for the DB

directory are set for read/write for all.If running Run Configuration, confirm the UCOMM.DAT fileexists.




Unable to access PBMERC.DAT The ProtoBase setup file PBMERC.DAT cannot beaccessed. To resolve this problem:• Verify ProtoBase paths on the Global/Local INI File

screens and the environment variables• Verify the file PBMERC.DAT exists in the ProtoBase

directory• Verify the file PBMERC.DAT has read/write permissions

set for all

Unable to access printer defs file The PbAdmin file PRINT.TXT was unable to be accessed.To resolve this problem:• Verify paths on the Global/Local INI File screens and the

environment variables• Verify the file PRINT.TXT exists in the PbAdmin DB

directory• Verify the file PRINT.TXT has read/write permissions for

all

Unable to access processor file The file UPROC.DAT in the PbAdmin DB directory could notbe accessed. To resolve this problem:• Verify file paths on the Global/Local INI File screens and

the environment variables• Verify the directory and file permissions for the DB

directory are set for read/write for all• If running Run Configuration, confirm the UPROC.DAT

file exists

Unable to access report file The report file could not be accessed. No records werefound to generate the report.

Unable to access selection list The processor, terminal, or device list could not be built.Verify the PbAdmin DB directory has read/write permissionsset.

Unable to access terminal file The file UTERM.DAT or <TERMINAL>.DAT files in thePbAdmin DB directory could not be accessed. To resolvethis problem:• Verify file paths on the Global/Local INI File screens and

the environment variables• Verify the directory and file permissions for the DB

directory are set for read/write for all• If running Run Configuration, confirm the files exist

Unable to build selection list The processor, terminal, or device list could not be built.Verify the PbAdmin DB directory has read/write permissionsset.




Unable to change directory An unsuccessful attempt was made to change to a specificdirectory. To resolve this problem:• Verify the ProtoBase directories specified on the

Global/Local INI File screens and the environmentvariables

• Verify the ProtoBase directory has read/write accessset for all

Unable to change industrybecause unsettled records exist

An attempt has been made to change the location industrycode while unsettled transactions are still in the currentworking database. Settle or remove existing settleabletransactions.

Unable to execute Editorcommand

Unable to execute the optional internal viewer program.Check path on the Global/Local INI File screens.

Unable to execute READCFGprogram

(Not used)

Unable to execute settlementprogram PBADSET

The settlement program PBADSET could not be executed.Possible reasons:• PBADSET is not located in the ProtoBase directory• The paths on the Global/Local INI File screens or the

environment variables are invalid• PBADSET does not have read/write/execute

permissions set for this user

Unable to execute Systemcommand

Unable to “shell” to a subprogram. Check for badCOMPSEL (DOS) or PBOS setting.

Unable to open file An error occurred while attempting to open a file. To resolvethis problem:• Verify paths specified on the Global/Local INI file

screens and the environment variables• Verify all files in the PbAdmin DB directory have

read/write permission set for all.

Unable to open PBCONFIG.CFG The ProtoBase file PBCONFIG.CFG in the ProtoBasedirectory could not be accessed. Verify the directory andfile permissions for this directory are set to read/write for all.

Unable to update selection list The processor, terminal, or device list could not be built.Verify the PbAdmin DB directory has read/write permissionsset.

Unable to write to AdministratorLog

The location’s Administrator Log could not be updated.Make sure all of the files in the PbAdmin DB directory haveread/write permissions set for all.

Unable to write to printer port The port specified in Location Information cannot beaccessed. Check permissions, verify path, and configurethe device name.

Glossary


ProtoBase

®

Glossary

Glossary


ProtoBase and Payment Services Industry Terms

ABA - See American Bankers Association.

ACCOUNT NUMBER - A primary cardholder account number that is embossedand encoded on a plastic card. This number identifies the issuing agent andthe cardholder.

ACH - See Automated Clearing house.

ACQUIRER - A bank or company that acquires data relating to transactions froma merchant or card acceptor for processing. The acquirer enters this datainto interchange, either directly or indirectly. See Interchange.

ACQUIRING BANK - Bank that receives the credit card transactions and thensettles with the issuing banks. This is an acquirer.

ADDRESS VERIFICATION SERVICE (AVS) - A service to help combat fraud inmail order/telephone order transactions by use of cardholder billing addressinformation in the authorization request.

AMERICAN BANKERS ASSOCIATION (ABA) - The trade association ofAmerican bankers. This body also has the responsibility of assigning theregistration authority for identification numbers.

AMERICAN EXPRESS - A company that specializes in the issuance of Traveland Entertainment (T&E) credit cards. They are in competition with Visa,MasterCard, and other card issuing companies. They offer many differentcards ranging from their Classic card to a Small Business card. AmericanExpress services the cards that they issue. They are their own transactionprocessor with their own processing network.

APPROVAL RESPONSE - An authorization response when a transaction isapproved.

ARBITRATION - The procedure used to determine responsibility for achargeback-related dispute between two members. To file an arbitrationcase, a completed Summary of Arbitration Documentation form is submittedafter unsuccessful dispute resolution through a three-stepchargeback/presentment cycle. This usually occurs between the transactionprocessors or institutions and a card company such as Visa or MasterCard.

ATM - See Automated Teller Machine.

Glossary


ATM/DEBIT CARD - This is a plastic card that is used at ATM’s to access thecardholder’s monetary accounts (Checking, Saving, Lines of Credit).

AUTHORIZATION - A process where an issuer, an authorizing processor, orstand-in processing approves an authorization request. This includesdomestic authorization and international authorization. An approvedauthorization places a hold against the cardholder’s credit limit for the dollaramount approved. Most authorizations have a life cycle of three to five days,then the hold against the cardholder’s credit limit is released. A transactionwhich settles will usually match an approved authorization amount and clear itfrom the authorization status, thus removing the hold against a cardholder’scredit limit.

AUTHORIZATION CODE - A code that an issuer, its authorizing processor, orstand-in processing provides to indicate approval or denial for anauthorization request. The code is returned in the authorization responsemessage and is usually recorded on the transaction receipt as proof ofauthorization.

AUTHORIZATION ONLY - Used to reserve an amount against a credit card’savailable limit for intended purchases. Auth Onlys are most frequently usedin the lodging, restaurant, and car rental industries, where the transactionamount is finalized later and entered via a Prior Authorized Sale transaction.

AUTHORIZATION PROCESSOR (“AUTHORIZER”) - Third-party transactionprocessor such as NaBANCO, FDR, TransNet, or National Data Corp(NDC). Processors route transactions to the appropriate authorizer servicesand settlement banks.

AUTHORIZATION REVERSAL - A transaction for a specified dollar amount usedto reverse an approved authorization request.

AUTHORIZATION TOLERANCE - In PbAdmin, the percentage a Prior-Authorized Sale transaction can vary from the corresponding originalAuthorization Only without either returning an error or having to run anIncremental Authorization or Authorization Reversal.

AVS - See Address Verification Service.

AUTOMATED CLEARING HOUSE (ACH) - A group of processing institutionslinked by a computer network to exchange (clear and settle) electronicpayment transactions. They electronically processes payment of funds andgovernment securities among financial institutions and businesses.

AUTOMATED TELLER MACHINE (ATM) - An unattended, magnetic stripereading terminal that requires the entry of a personal identification number(PIN). It disburses currency and performs other teller functions, such astransfer of funds and deposits.

Glossary


BANK CARD - A debit or credit card issued by a bank.

BANK CARD ASSOCIATION - A group of banks formed either for the purpose ofsponsoring a program, (Visa or MasterCard) or to use common processingand administrative facilities.

BANK IDENTIFICATION NUMBER (BIN) - A six-digit number assigned by Visaor MasterCard and used to identify a card issuing institution, who issuesplastic cards with their logos. This number is the first six numbers embossedon the cards. The ranges are governed by ISO standards.(See InternationalOrganization for Standardization).

BASE I - The data processing systems, networks, and operations that are used tosupport and deliver authorization-related services for transactions that aresubsequently cleared and settled through BASE II at Visa.

BASE II - The VisaNet data processing systems, networks, and operations thatare used to support and deliver the clearing and settlement services relatedto the interchange of paper with Visa.

BATCH - A group of approved credit card transactions that occurred during agiven time interval. A batch is introduced by a batch header record, containsone or more batch detail records, and is summarized in a batch trailerrecord. Within one batch the following fields are homogeneous: batchsender, batch receiver, settlement currency. Batches of transactions aresubsequently transmitted to a third-party transaction processor for fundstransfer.

BATCH DEPOSIT - Process by which batch file data has been electronicallytransmitted to the transaction processor and is being processed.

BATCH FILE - A computer disk file containing one or more batches of transactiondata.

BATCH PROCESSING - A type of data processing operation and datacommunications transmission where related transactions are groupedtogether and transmitted for processing, usually by the same computer andunder the same application; generally regarded as non real-time data trafficcomprising large files; type of data traffic where response time is not critical.

BATCH SETTLEMENT - Process by which batch file data is electronicallytransmitted to a transaction processor.

BIN - See Bank Identification Number.

CARDHOLDER - An individual to whom a card is issued, or who is authorized touse an issued card.

Glossary


CARD ISSUER - Any association member financial institution, bank, credit union,or company that issues, or causes to be issued, plastic cards to cardholders.

CARD READER - Any device that is capable of reading encoding on plasticcards. See Magnetic Stripe Reader.

CARD CONFIGURATION - ProtoBase configuration file section that defines thetype of credit, debit, or other tender types accepted by the merchant.

CARD VERIFICATION CODE (CVC) - A unique check value encoded on themagnetic stripe of a card to validate card information during the authorizationprocess. The card verification value is calculated from the data encoded onthe magnetic stripe using a secure cryptographic process. This method isused by MasterCard.

CARD VERIFICATION VALUE (CVV) - A unique check value encoded on themagnetic stripe of a card to validate card information during the authorizationprocess. The card verification value is calculated from the data encoded onthe magnetic stripe using a secure cryptographic process. This method isused by Visa.

CASHIER - Generic term for the employee performing a transaction for abusiness.

CARTE BLANCHE - This is a T&E credit card that competes mainly withAmerican Express, JCB, and Diners Club. See T&E.

CASH ADVANCE - A cash disbursement obtained by a cardholder throughpresentation of their card at a financial institution in person, by mail, orthrough an ATM.

CASH DISBURSEMENT - A transaction that is posted to a cardholder’smonetary accounts when they receive cash from a teller, an ATM, or by mail.

CASH DISPENSER - This is the simplest ATM which will only allow cashwithdrawals.

CHARGEBACK - A transaction returned through interchange by an issuer to anacquirer. A transaction is returned because of rules and regulationsviolations or because it is disputed by a cardholder.

CHARGEBACK PERIOD - The number of calendar days from the endorsementdate of a transaction receipt (or processing date, as applicable), duringwhich time the issuer may exercise a chargeback right.

CHARGEBACK REASON CODE - This is a two-digit code identifying the reasonfor a chargeback.

Glossary


CHECK AUTHORIZATION - This is an authorization request being sent to acheck processing organization to validate a check presented as payment forservices. The processor usually approves or declines the authorizationrequest based on the presenter’s check writing history.

CHECK DIGIT VERIFICATION - An algorithm that is performed on the primaryaccount number (PAN) to ensure that numbers were not transposed ormiskeyed. The result is the last position of the account number, or checkdigit. It is performed to validate a credit card number. Many card issuersuse the MOD-10 Check Digit routine.

CHECK GUARANTEE - A system providing merchants with varying degrees ofinsurance against bad check losses by guaranteeing payment of the checkby the financial institution or the third party processor.

CHECK READER - A device that reads the numbers encrypted on the bottom ofmost checks.

CHECK VERIFICATION - A system providing merchants with varying degrees ofinsurance against bad check losses by verifying the authenticity of the checkand/or its presenter by using a check processing organization.

CIRRUS - Cirrus System Incorporated, a wholly-owned subsidiary of MasterCardInternational Incorporated, operates the international ATM sharingassociation known as “MasterCard/Cirrus ATM Network”.

CLEARING - All of the functions necessary to collect a clearing record from anacquirer in the transaction currency and deliver it to the issuer in the billingcurrency. It is used to reverse transactions as well. It can also process a feecollection transaction. Clearing is part of the settlement process.

CLEARING PROCESSOR - A processor that provides clearing and settlementservices for merchants or other members.

CO-BRANDED CARD - This is a plastic card that is issued to a cardholder wherethere is a joint sponsorship of that card between a merchant and the issuer.Both of their names usually appear on this type of card.

COMMERCIAL CARDS - This is the formal name for the following three types ofplastic cards: Corporate Card, Purchase Card, and Business Card.• A Corporate card is usually issued to the employees of a corporation,

where the corporation assumes all liability for the card’s usage. This isusually issued to larger corporations.

• The Purchase card is issued to corporations. It allows the corporationnumerous parameters to control daily and monthly spending limits, totalcredit limits, and where the card may be used. Many employees may beissued the same card number.

Glossary


• The Business card is similar to the Corporate card, but issued to abusiness with a few employees and where each employee is responsiblefor their purchases.

COMMUNICATIONS - Collective term for any electronic transfer of data betweena merchant and a third-party transaction processor.

COMPLIANCE - A process where Visa or MasterCard resolves disputes betweenmembers arising from violations of the International Operating Regulations,when the requesting member can certify that a financial loss has occurred, orwill occur for a specific amount, and no chargeback right is available.

CONVERSION RATE - The rate applied to convert a transaction amount in theacquirer's currency to U.S. dollars. The U.S. dollar amount is then convertedto the issuer amount by using the rate of the U.S. dollars to the issuer'ssettlement currency.

CORRESPONDENT BANK - A depository institution that holds an account with,or on behalf of, a settlement bank, and engages in an exchange of serviceswith that bank.

COUNTERFEIT CARD - One of the following:• A device or instrument that is printed, embossed, or encoded so as to

purport to be a card, but that is not a card because an issuer did notauthorize its printing, embossing, or encoding.

• An instrument that is printed with the authority of the issuer and that issubsequently embossed or encoded without the authority of the issuer.

• A card that an issuer has issued and that is altered or re-fabricated,except one on which the only alteration or re-fabrication compromisesmodification of the signature panel or cardholder signature.

CPS - See Custom Payment Service.

CREDIT LIMIT - This is a dollar amount assigned to a cardholder as the limit ofcredit that they are approved to borrow. Credit card purchases are actuallyloans to the cardholder by the issuer.

CREDIT UNION - A non-bank financial institution that is comprised of individualmembers who are depositors, borrowers, and shareholders of the institution.Credit unions usually offer their members the same services available atmost banks.

CUSTOM PAYMENT SERVICE (CPS) - Visa’s regulations for the informationthat must be submitted with each transaction. Transactions must meet CPScriteria in order to qualify for lowest transaction processing fees available.Similar to MasterCard’s Merit. Approved transactions will deduct the dollaramount from the cardholder’s “open to buy” or credit available.

Glossary


CVC - See Card Verification Code.

CVV - See Card Verification Value.

DATA CAPTURE - Also known as electronic draft capture (EDC) or draft capture.A data processing term for collecting, formatting, and storing data incomputer memory according to predefined fields, for example, customername, account number, and dollar amount of purchase. When a terminalreads this information from a plastic card or from entries at a terminal, theinformation is stored in computer memory for later output as a hard copyprintout or as soft copy on a CRT display. See Electronic Draft Capture.

DATA COMMUNICATIONS - High-speed communications between computers,or between a computer and an associated input terminal or financial serviceterminal (ATM, POS). Data communication involves telephone lines,interfacing equipment, plus the computer and the terminal.

DATA ENCRYPTION STANDARD (DES) - A cryptographic algorithm adoptedby the National Bureau of Standards for data security. Encryption scramblespersonal identification numbers (PINs) and transaction data for safetransmission.

DATASWITCH - This is a computer network that primarily serves the credit unionassociations and was developed to exchange (clear and settle) electronictransactions for processing institutions. It is similar in function to the ACH(Automated Clearing House).

DEBIT - A charge to a customer’s bankcard account. A transaction, such as acheck, automated teller machine (ATM) withdrawal, or point-of-sale (POS)debit purchase that debits a demand deposit account. On-line transactionsrequire the use of a personal identification number (PIN) and debit theamount, usually the same day. Off-line transactions, which use separateauthorization and clearing messages, require a signature, and the account isdebited a few days later.

DEBIT CARD - This term is used to identify an ATM card as well as a Visa Checkcard or a MasterCard MasterMoney card. It can also refer to any privatelabel card that might debit a cardholders cash accounts. Simply it is aplastic card used to initiate a debit transaction. In general, thesetransactions are used primarily to purchase goods and services and toobtain cash, for which the cardholder's asset account is debited by theissuer.

DEDICATED LINE - A communications circuit between two endpoints that ispermanently connected and always available. Also called a leased line orprivate line.

Glossary


DEMO MODE - A non-communicating start mode for ProtoBase/PBDIRECT. Itsimulates the functions of ProtoBase without communicating or dialing out tothe processor. Adding a –d argument to the command line will startProtoBase in Demo mode. Since the processor is not involved, there are nocommunication costs involved in testing ProtoBase for successfulintegration. Also called No Comm mode.

DEPOSIT - Process of transmitting a batch of transactions from the merchant tothe acquiring institution in preparation for settlement.

DERIVED UNIQUE KEY PER TRANSACTION (DUKPT) - A type of debitencryption system in which a new key is generated with every transaction.The other type of debit encryption system is called Master Session.

DEVICE CONFIGURATION - ProtoBase configuration file section that defines thedevice information. You must create a device configuration entry for eachport used to dial out or connect to a transaction processor computer.

DEVICE DRIVER - Software module providing for the use of a specific hardwaredevice, such as a modem or a card reader.

DINERS CLUB - Diners Club International is another T&E credit card. Theycompete mostly with American Express, JCB, and Carte Blanche for theircredit card usage.

DISCOUNT FEE - Fee paid by the merchant to the merchant bank or othercontracted party for processing the merchant’s credit card sales(transactions).

DISCOUNT RATE - This is the percentage rate that a merchant institutioncharges the merchant giving deposit credit for handling merchant salesdrafts or electronic sales transmissions. The discount fee is the dollaramount charged.

DISCOVER - Owned by Dean Witter, Discover & Co., this corporation issuescredit cards to individual cardholders and manages those accounts in-house.They are a for-profit organization in competition with Visa and MasterCardand other credit card Issuing Corporations They are closely tied to the NovusFinancial Corporation, another Dean Witter company. See Novus.

DRAFT CAPTURE - The act of electronically capturing transactions.. SeeElectronic Draft Capture.

DUKPT - See Derived Unique Key Per Transaction.

EBT - See Electronic Benefits Transfer Card.

EDC - See Electronic Draft Capture.

Glossary


EFT - See Electronic Funds Transfer.

EFTA - See Electronic Funds Transfer Act.

EFTS - See Electronic Funds Transfer System.

EIRF - See Electronic Interchange Reimbursement Fee.

ELECTRONIC AUTHORIZATION - Obtaining authorization for use of acredit card by electronic means, as via computer equipment andtelephone line.

ELECTRONIC BENEFITS TRANSFER CARD (EBT) - This card mayhave a magnetic stripe or a small microprocessor on it. The cardis used to replace the paper distributed by the government forprograms like the Women, Infants, and Children program and foodstamps. The cardholder may use this card and have the chargesdeducted from their available benefit dollars for the program thatthey are participating in. It is a card that is increasing in popularityand use throughout the United States.

ELECTRONIC CREDIT APPLICATION - A credit application that istransmitted electronically to a credit evaluation company (such asEquifax) for approval recommendations.

ELECTRONIC DRAFT CAPTURE (EDC) - Use of electronic communications todeposit credit card transactions for funding. This method routes thetransactions to Visa, MasterCard, American Express, Discover, other cardcompanies, or third-party processors.

ELECTRONIC FUNDS TRANSFER (EFT) - Process of electronically transferringfunds to or from an account. This evolved to eliminate the costly and timeconsuming paper method.

ELECTRONIC FUNDS TRANSFER ACT (EFTA) - This is the federal regulationwhich governs the electronic transfer of funds between all parties concerned.It sets the guidelines or parameters for transferring funds electronically.

ELECTRONIC FUNDS TRANSFER SYSTEM (EFTS) - An electronic systemthat moves financial data, designed to eliminate the paper instrumentsnormally associated with such fund movement. Examples classified asEFT’s are ACH, POS, ATM, direct deposit, telephone bill paying, ECR’s,automated merchant authorization systems, and pre-authorized payments.

ELECTRONIC INTERCHANGE REIMBURSEMENT FEE (EIRF) - Anintermediate Visa program for transactions that do not meet CPS criteria butare cleared within three days.

Glossary


ELECTRONIC WARNING BULLETIN - This is a data file containing all of therestricted accounts or ranges on the Account Management System. This is afile comprised of Visa and MasterCard account numbers that haverestrictions against them. An example would be a lost or stolen card. Thisfile is updated daily and is formatted to include each restricted accountnumber or range, chargeback effective date, and purge dates.

EMBOSSING - This is the term referring to the information that is printed in raisedlettering on the front of plastic cards. For example: There are four possiblelines which may be embossed on a Visa plastic card. They are the Accountnumber, the Expiration date, and two lines for the cardholder(s) name(s).

ENCRYPTION - The technique of modifying a known bit stream on a transmissionline so that it appears to be a random sequence of bits to an unauthorizedobserver. It often is done automatically in the terminal or computer beforedata is transmitted.

EXPIRATION DATE - The date, expressed numerically as month and year, afterwhich a plastic card is considered invalid.

EXPIRED CARD -A card on which the embossed, encoded, or printed expirationdate has passed.

FIELDS - Smallest data element defined within a file. A series of fields make up arecord; a group of records make up a file.

FLOOR LIMIT - An amount that Visa and MasterCard have established for singletransactions at specific types of merchant outlets and branches, above whichauthorization is required. Many companies have their own floor limits andsome merchants have agreements with their merchant banks that includefloor limits. The two types of floor limits are:• Standard Floor Limit. (Transaction amounts above this limit must request

an authorization.)• Zero-Floor Limit (All transaction amounts must request an authorization.)

Glossary


FORCED AUTHORIZATION - In PbAdmin, a manual authorization, such as avoice authorization.

FRAUDULENT USER - An individual who is not the cardholder or designee andwho uses a card (or, in a mail/phone order or recurring transaction, anaccount number) to obtain goods or services without the cardholder’sconsent.

FRAUDULENT TRANSACTION - A transaction unauthorized by the cardholder ofa bankcard. Such transactions are categorized as lost, stolen, not received,issued on a fraudulent application, counterfeit, fraudulent processing oftransactions, account takeover, or other fraudulent conditions as defined bythe card company or the member company.

FULFILLMENT - The satisfaction of a retrieval request. The acquirer supplies theissuer with the original slip, a legible reproduction thereof, or a substitutedraft if applicable. The fulfillment record confirms the completion of thataction and effects reimbursement to the acquirer. See Retrieval Request.

GATEWAY - A node or switch that permits communication between two dissimilarnetworks. A technical means by which users of one computer system canaccess another computer system without a separate connection.

GLOBAL PAYMENT SYSTEMS (GPS) - Parent company of the MasterCardAutomated Point-of-Sale Program (MAPP). They are another third-partyprocessor entity that processes all tender types.

GPS - See Global Payment Systems.

GUEST FOLIO - A lodging merchant's guest record that contains the cardholder'stransaction information, including check-in and departure dates, rate,anticipated length of stay at check-in time, applicable charges, and taxes.The check-in date and the dated amount and authorization approval code ofeach authorization must be included on the folio if not on the sales draft.

HARDWARE CONFLICTS - Caused when two devices are in contention for thesame interrupt(s). Each communications port, network card, and printer portshould have the exclusive use of a hardware interrupt.

HOLOGRAM - A laser-created photograph that produces a three dimensionalimage used to make counterfeiting plastic cards more difficult.

HOST CAPTURE - Method where transaction data is stored in batches on thehost computer at the third-party transaction processor.

IMPRINTER - A device used to imprint the embossed lines of a plastic card on apaper transaction sales draft.

Glossary


INCREMENTAL AUTHORIZATION - This is a request for an additional dollaramount on a prior authorization. It is used when a transaction is for a greaterdollar amount than the original authorization was for. See AuthorizationTolerance.

INDEPENDENT SERVICE ORGANIZATION (ISO) - Similar to a third partytransaction processor.

INET - The MasterCard clearing and settlement system which is a centralizedfacility owned and operated by MasterCard International.

INITSTRING - String of commands that is sent to the modem prior to every dial-out attempt.

INPUT FILE - File that provides ProtoBase with the necessary information toperform a transaction, that is, transaction type, transaction amount, accountnumber, etc.

INTEGRATED - When two or more automated systems work together and sharedata, as when a property management system calls an integrated utility atcredit card tendering time and then receives output data back from that utility.

INTEGRATED SERVICES DIGITAL NETWORK (ISDN) - An all-digitaltelephone line that offers the ability to transmit digital data and voice datawithout a modem.

INTERCHANGE - The exchange of clearing records between members throughVisa or MasterCard in accordance with their rules and regulations.

INTERCHANGE FEE - Charge levied and collected by either the merchant bankor card issuer for the processing of interchange credit card transactions.

INTERCHANGE REIMBURSEMENT FEE - One of the following:• A fee that an acquirer pays to an issuer in the clearing and settlement of

an interchange transaction, based on either the standard (paper-based)rate or electronic rate.

• A fee that an issuer pays to an acquirer for making a cash disbursementto a cardholder or cheque purchaser.

INTERRUPT REQUEST (IRQ) - A mechanism that forces the computerprocessor to briefly interrupt the current program and execute an interrupt handler.

Glossary


INTERNATIONAL ORGANIZATION FOR STANDARDIZATION - Aninternational organization that provides industry standards for financialtransactions and telecommunications messages. They work with othercommittees to maintain financial services standards, such as bankidentification numbers and merchant category codes. The standards set bythis organization are sometimes referred to as ISO standards (not to beconfused with Independent Service Organization).

IRQ - See Interrupt Request.

ISDN - See Integrated Services Digital Network.

ISO - See Independent Service Organization.

ISSUER - See Card Issuer.

JCB CARD - Card issued by JCB (Japan Credit Bureau) International Credit CardCompany, Ltd. JCB Is now issuing this credit card in thirteen countries.(1997) Seventy percent of the card’s usage takes place in Japan, but theyare now concentrating on the US and other countries. Their merchant basenow rivals American Express. This card is a T&E credit card. JCB is alsogetting involved in the co-branded card business. See Co-Branded Cards.

JULIAN DATE - Day of the year expressed as a three-position number, with arange of 001 through 366 (for example, 001 on 1 January).

LIVE MODE - The normal communicating start mode for ProtoBase/PBDIRECT.It allows ProtoBase to perform all of its normal functions, includingcommunicating and dialing out to the processor. Leaving off the –dargument from the command line will start ProtoBase in Live mode.

LOCATION INFORMATION - In PbAdmin, a set of information tied to a particularlocation. This is usually a separate POS terminal, group of terminals, or workstation within a business. Each location must have a unique user/loginname.

MAGNETIC INK CHARACTER RECOGNITION (MICR) - The process used toread the numbers on a check. The MICR characters (0-9 and 4 specialcharacters) are printed in special toner or ink. When the check is passedthrough a reader/sorter, it passes by two magnetic heads. The first onemagnetizes the MICR character and the second one reads the (now)magnetic MICR character. The character quickly loses its magnetic chargeafter that.

Glossary


MAGNETIC STRIPE - A stripe of magnetic information affixed to the back of aplastic credit or debit card. It contains customer and account informationrequired to complete electronic financial transactions. The physical andmagnetic characteristics of this stripe are specified in the InternationalOrganization for Standardization standards 7810, 7811, and 7813.

MAGNETIC-STRIPE READER - A device that reads information from themagnetic stripe and transmits that information to a transaction processor orcomputer terminal. Also referred to as card reader..

MAGNETIC-STRIPE TERMINAL - A terminal that reads the magnetic stripe on aplastic card.

MAIL/PHONE ORDER MERCHANT - A merchant that transacts business by mailor phone.

MAIL/PHONE ORDER TRANSACTION - A transaction where a cardholderorders goods or services from a merchant by telephone, mail or other meansof telecommunication, and neither the card nor the cardholder is present atthe merchant outlet.

MASTERCARD - MasterCard International Inc., and all of its subsidiaries andaffiliates.

MASTERCARD ACQUIRER - A member that signs a MasterCard merchant ordisburses currency to a MasterCard cardholder in a cash disbursement, anddirectly or indirectly enters the resulting transaction receipt into interchange.

MASTERCARD CARD - A card that bears the MasterCard symbol, enabling aMasterCard cardholder to obtain goods, services, or cash from aMasterCard merchant or an acquirer. A MasterCard card is always one ofthe following: MasterCard Card, Gold MasterCard, Platinum ClassMasterCard, MasterCard BusinessCard, MasterCard Corporate Card,MasterCard Corporate Purchasing Card, MasterCard Corporate Fleet Card,or MasterCard MasterMoney Card.

MASTERCARD ISSUER - A member that issues MasterCard cards.

MASTER SESSION ENCRYPTION - The simplest form of debit encryption, inwhich the customer’s PIN pad is preprogrammed or “injected” with a masterkey. Also called “Static”. The other type of debit encryption is called DerivedUnique Key Per Transaction.

MEMBER - An entity that is a member of Visa or MasterCard and refers toacquirer, associate, ATM acquirer, charter member, disbursing member,electron acquirer, electron issuer, group member, issuer, merchant bank,participant, principal, Visa or MasterCard acquirer, and Visa or MasterCardissuer.

Glossary


MEMORY CONFLICT - A situation where more than one piece of hardwareand/or software is attempting to access the same memory block.

MERCHANT - An entity that contracts with merchant banks or ISO’s to originatetransactions an that displays the Visa or MasterCard symbol and refers toairline, car rental company, cash disbursement merchant, electron merchant,high-risk telemarketing merchant, hotel, international airline, mail/phoneorder merchant, prepaid card merchant, quasi-cash merchant, retailmerchant, single merchant, T&E merchant, timeshare merchant, and wiretransfer merchant. There may be additional types of merchants notspecifically mentioned.

MERCHANT AGREEMENT - A written agreement between a merchant and abank containing their respective rights, duties, and warranties with respect toacceptance of the bankcard and matters related to the bankcard activity.

MERCHANT BANK - Bank that has a merchant agreement with a merchant toaccept (acquire) deposits generated by bank card transactions.

MERCHANT CATEGORY CODE - Four-digit classification codes used in thewarning bulletin, authorization, clearing, and settlement systems to identifythe type of merchant business in various stages of transaction processing.

MERCHANT DEPOSITORY ACCOUNT - Demand deposit account establishedby a merchant with the acquiring bank to receive payment for sales draftssubmitted to the bank card plan.

MERCHANT DISCOUNT - Compensation received by a bank from a merchantfor processing and accepting credit card risk on the merchant’s credit cardsales.

MERCHANT NUMBER - A series or group of digits that uniquely identifies themerchant to the merchant signing bank for account and billing purposes.

MERIT - MasterCard’s latest series of regulations that are similar to CPSrequirements by Visa.

MICR - See Magnetic Ink Character Recognition.

MODEM - A communication device that enables computers to talk to each other byconverting digital signal to analog and then back to digital.

MULTIPLE TRANSACTION PROCESSING (MULTI-TRANS) - Electroniccommunications process where multiple authorization requests andresponses are exchanged during a single phone connection with the third-party transaction processor.

Glossary


MULTI-THREADING - The process of transmitting multiple transaction requestson one communications device, and receive multiple responsessimultaneously, relating them each back to each original request.

NEGATIVE FILE - A file used for Stand-In purposes that identifies thosecardholders and accounts for which charge privileges have been revoked orrestricted by the issuer.

NETWORK ADAPTER - A piece of firmware (card) that resides in yourworkstation or server, which enables access to the LAN or WAN.

NO COMM - See Demo Mode.

NO-SHOW TRANSACTION - A transaction that a hotel participating in the HotelReservation Service or a Car Rental Company participating in theSpecialized Vehicle Reservation Service completes, resulting from acardholder’s alleged failure to cancel or use the reservation.

NOTIFICATION - Written notice delivered by mail, courier, facsimile, telex, orhand. Notification is effective when posted, sent , or transmitted by Visa orMasterCard to the member or its agent.

NOVUS - The Novus Network is a Dean Witter company and is the third largestcredit card network in the United States. Their cards include the DiscoverCard and Bravo brands.

NSF - This stands for Non-sufficient funds. It refers to a check or check cardtransaction that exceeds the amount of funds available in a person’schecking or share draft account.

OFFLINE - This refers to requesting an authorization non-electronically.

OFFLINE DEBIT - This refers to a debit transaction that gets treated the same asa credit card transaction. It will not debit the cardholder’s accountimmediately, but will be processed through a normal credit card venuesettlement.

ONLINE - A method of requesting an authorization through a communicationsnetwork other than voice, to an issuer, an authorizing processor, or stand-inprocessing.

ONLINE DEBIT - This is a debit or ATM transaction that has used a PIN pad toprocess the transaction and it should have a real-time affect on thecardholder’s checking or share draft account.

ONLINE FINANCIAL TRANSACTION - A transaction that is authorized, cleared,and settled in a single online message.

Glossary


ON-US TRANSACTION - A transaction where the issuer and the acquirer are thesame.

OPEN TO BUY AMOUNT - Dollar amount of credit remaining for customer at thetime of authorization.

OUTPUT FILE - A file containing all response data to be parsed by the callingprogram.

OVERDRAFT PROTECTION - This is a means of reducing the risk of loss byidentifying a backup account to access when a cardholder’s account isoverdrawn by a check or debit transaction.

OVERLIMIT - This refers to a cardholder’s account that has surpassed its creditlimit with a transaction. (Their outstanding balance is beyond their creditlimit.)

PAPER DRAFT - Sales slips, credit slips, cash disbursement slips, drafts,vouchers, and other obligations indicating use of a card or a card account.

PARALLEL PORT - Sometimes referred to as a printer port. Parallel portsconduct signals through eight separate wires simultaneously, one for each bitof a byte of data, that re enclosed together in a single cable.

PB - The executable file which acts as a front end for ProtoBase. PB interacts withthe POS software.

PBADMIN - See ProtoBase Administrator.

PBCOM - ProtoBase program that defines which protocol to use with the host andadds the necessary characters for communication. Multiple copies ofPBCOM run simultaneously of multiple devices (modems) are configured.

PBCONFIG - Configuration compiler executable program that createsPBDEV.DAT, PBROC.DAT, and TTTT.TRM data files. Run this programafter you edit the PBCONFIG.CFG file.

PBCONFIG.CFG - System configuration file used by PBCONFIG. Contains allprocessor configuration and phone data, system terminal and credit carddata, and system device data.

PBDIRECT - A program that acts as the ProtoBase director. It waits continuallyfor transactions and performs load balancing and scheduling.

PBFE (PROTOBASE ADMINISTRATOR FRONT END PROGRAM) - Front endprogram for PbAdmin that parses and builds transaction processormessages. It also verifies the fields passed in the input file.

Glossary


PBKILL - ProtoBase Communications Director termination executable program.It is used to queue a shutdown request to stop and restart the system.

PERSONAL IDENTIFICATION NUMBER (PIN) - A number (alpha or numericcode) that identifies a cardholder in an authorization request originating at aterminal with authorization-only or data capture-only capability.

PER TRANSACTION FEES - Fees paid by the merchant to the merchant bank orother contracted party on a per transaction basis.

PIN - See Personal Identification Number.

PIN ENCRYPTION - The technique of scrambling a personal identificationnumber, so that it is illegible to unauthorized observers.

PIN GENERATION - The production of PINs for allocation to cardholders, doneunder strict security to prevent fraud.

PIN OFFSET - The difference between the customer’s chosen or assigned PINand the PIN derived based on a specific algorithm that is applied against theprimary account number (PAN). If used, PIN offset information is encoded ontrack 2 of the card’s magnetic stripe.

PIN PAD - A numeric key pad, which is connected to a terminal or POS, used bythe cardholder to enter the PIN and/or other information.

PIN VERIFICATION - A procedure that enables the issuer to validate thecardholder identity when making a comparison with the PIN and cardholderaccount number..

PLASTIC (CARD) - This is a generic term used to identify any of the various cardsissued to cardholders.

PLUS PROGRAM - A program through which a PLUS participant provides ATMservices to cardholders by acting as an issuer, an ATM acquirer, or both.

POINT OF SALE (POS) - Location in a merchant establishment at which sale isconsummated by payment for goods or services received. Can also refer tothe direct debit of a purchase amount to a customer’s checking account.

POS ENTRY MODE - A V.I.P system field indicating the method by which a point-of-transaction terminal obtains and transmits the cardholder informationnecessary to complete a transaction.

POS SYSTEM - Point-of-sale system that processes sale and other transactions,such as an electronic cash register with specialized software.

Glossary


POSITIVE BALANCE - This usually refers to the cash balance in a person’schecking or share draft account. Offline debit card transactions place holdsagainst this balance. Online debit card transactions deduct from thisbalance.

POSTING - The process of updating individual cardholder account balances toreflect merchandise sales, instant cash, cash advances, adjustments,payments, and any other charges or credits.

PRESENTMENT - A clearing record that an acquirer presents to an issuerthrough interchange, either initially (a first presentment) or after a chargeback(a re-presentment).

PRIMARY ACCOUNT NUMBER (commonly called PAN) - The number that isembossed, encoded, or both, on a plastic card that identifies the issuer andthe particular cardholder account. The PAN consists of a major industryidentifier, issuer identifier, individual account identifier, and check digit.

PRIVATE LABEL CARD - A merchant’s proprietary card that is accepted only atits own locations. ATM cards are actually considered private label cards. Amerchant whose cards are considered private label must be membersponsored and also accept Visa and MasterCard.

PRIOR AUTHORIZATION - An authorization usually done before a transactiontakes place. The approved authorization request may be held for anextended length of time before a card is present or not.

PROCESSING DATE - The date on which the transaction is processed by theacquiring bank.

PROCESSOR - Third-party transaction processor such as Envoy or NaBANCO.Processors aid in routing transactions to the appropriate authorizer services.

PROCESSOR CONFIGURATION - A section of the ProtoBase PBCONFIG.CFGfile which contains information pertinent to communications with theprocessor.

PROPRIETARY CARD - A card issued by financial institutions and otherorganizations to their customers, primarily for the purpose of accessingcredit or deposit accounts. These cards are considered "proprietary" if theyare issued with the logo or emblem of the issuing organization being theacceptance mark instead of a "national" or "global" service mark or logosuch as Visa or MasterCard.

Glossary


PROTOBASE - Data communication software developed by SouthernDataComm, Inc. for electronic payments processing. Along with processor-specific software modules called SofTrans, ProtoBase provides the linkbetween the third-party transaction processor or acquirer and the merchantat the point-of-sale (POS). ProtoBase is fully integrated into the point-of-salesystem. It works directly with the POS system to accept credit card, check,and other payment media for various transactions, including authorization,sale, and settlement.

PROTOBASE ADMINISTRATOR (PBADMIN) - A screen-based, data baseapplication that stores data for several transaction and payment types duringelectronic payment processing, including credit cards, debit cards, andchecks. It is an add-on product and intermediate interface to ProtoBase.

PROTOBASE DIRECTOR - Program, known as PBDIRECT, that directs the flowof communication to PBCOM.

REAL-TIME TRANSACTION - An online transaction, such as an ATM withdrawal,which is usually settled immediately.

RECEIPT - A hard copy document recording a transaction that took place at thepoint of sale, with a description that usually includes: date, merchantname/location, primary account number, amount, and reference number.

REFERENCE NUMBER - Number assigned to each monetary transaction in adescriptive billing system. Each reference number is printed on the monthlystatement to aid in retrieval of the document, should it be questioned by thecardholder.

REGULATION E - This federal regulation governs the electronic access to aperson’s account or funds. See EFTA for additional information.

REGULATION Z - This federal regulation governs all aspects concerning creditcards. It pertains to the issuer and cardholder, as well as any organizationinvolved in the processing of credit cards.

REPORTS SECURITY - In PbAdmin, a screen which defines the access aparticular user has within a location to particular reports.

REPRESENTMENT - A clearing record that an acquirer presents to an issuerthrough interchange after a chargeback.

RETAIL MERCHANT - A merchant that provides goods and/or services in theretail industry, but is not a mail/phone merchant, a recurring servicesmerchant, or a T&E merchant.

Glossary


RETRIEVAL REQUEST - An issuer’s request for a transaction receipt, whichcould include the original, a paper copy or facsimile, or an electronic versionthereof.

REVERSAL - An online financial transaction used to negate or cancel atransaction that has been sent through interchange in error.

SALES DRAFT - A paper record evidencing the purchase of goods or services bya cardholder from a merchant using a plastic card.

SELECTED - In PbAdmin, indicates transactions that are check-marked on theSelect/View/Edit Transactions screen (main database) or the View HistoryTransactions screen (history database) to be included in various functions.

SERIAL PORT - Data communications port, usually asynchronous. The port takes8, 16, or 32 parallel bits and turns them into a long series pulse chain.

SERVER - In PbAdmin, this is the employee performing a transaction in therestaurant industry.

SETTLEMENT - The reporting of settlement amounts owed by one member toanother, or to a card issuing concern, as a result of clearing. This is theactual buying and selling of transactions between the merchants, processors,and acquirers; along with the card issuing entities.

SETTLEMENT BANK - A bank, including a correspondent or intermediary bank,that is both located in the country where a member’s settlement currency isthe local currency, and authorized to execute settlement of interchange onbehalf of the member or the member’s bank.

SETTLEMENT OF TRANSACTION - A process in which the PropertyManagement System software requests a Deposit transaction to send orrelease the current batch of transactions to the transaction processor.

SMART CARD - A credit or debit card embodying a computer chip with memoryand interactive capabilities used for identification and to store additionaldata about the cardholder, cardholder account, or both. Also called anintegrated circuit card or a chip card.

SOFTRANS - The part of the ProtoBase application that contains all data filesrequired to operate with a third-party transaction processor.

STANDARD FLOOR LIMIT - A floor limit that varies by merchant type. This refersto a dollar limit on transactions above which authorization requests arerequired.

STAND-BESIDE TERMINAL - A terminal connected to the POS system for thepurpose of communicating with transaction processors.

Glossary


STAND-IN PROCESSING - The V.I.P. system component that providesauthorization services on behalf of an issuer when the Positive CardholderAuthorization System is used or when the issuer or its authorizing processoris unavailable.

STATIC KEY - See Master Session Encryption.

T&E - An abbreviation for Travel and Entertainment.

T&E MERCHANT - An airline, car rental company, or hotel whose primary functionis to provide travel-related services. A travel agency (excluding one that isprimarily engaged in the sale of transportation or travel-related arrangementservices by mail/phone order) is a T&E merchant to the extent that it acts asthe agent of an airline, car rental company, or hotel.

TCP/IP - Transport Control Protocol/Internet Protocol. A standard format fortransmitting data from one computer to another. TCP deals with theconstruction of the data. IP routes the data from one computer to another.

TERMINAL - An input-output device whereby a user is able to communicatedirectly with a computer.

TERMINAL CAPTURE - Method where transaction data is stored in the POSterminal until the batch is settled.

TERMINAL CONFIGURATION - A section of the ProtoBase PBCONFIG.CFGfile which contains information pertinent to the terminal. The terminalconfiguration entry specifies, for one terminal or many terminals, the validcredit card (or other payment) types and the transaction processor(s) throughwhich each type will be authorized and settled.

TERMINAL ID - Name of the terminal initiating a transaction. This name mustmatch a .TRM file defined in the Terminal configuration file. Can be used tosort and total the reports produced by ProtoBase. Defined as Field 109 inthe Input and Output File. This file is in all ProtoBase versions prior to 4.8.

THIRD-PARTY TRANSACTION PROCESSOR - An entity that validates andauthorizes credit card purchases. They may also service the actual accountson behalf of the issuers, emboss cards, and mail cards to cardholders.

TRACK 1 - Bank discretionary data encoded on a magnetic stripe. Includes creditcard account number, card holder name, and expiration date. It is read-only,and its contents are defined in ISO 7813.

TRACK 2 - Bank discretionary data encoded on a magnetic stripe. Track 2includes credit card account number and expiration date. It is read-only, andits contents are defined in ISO 7813.

Glossary


TRANSACTION - Action between a cardholder and a merchant or a cardholderand a member that results in activity on the cardholder account.

TRANSACTION DATE - The date on which a transaction between a cardholderand a merchant, an acquirer, or a carrier, occurs.

TRANSACTION PROCESSOR - See Third-Party Transaction Processor.

TRANSACTION TYPE - A specific type of financial detail transaction activity thatcan be submitted to the clearing system.

UDP/IP - User Datagram Protocol/Internet Protocol. UDP is a connectionlessprotocol that offers a direct way to send and receive datagrams over an IPnetwork. UDP is useful when TCP would be too complex, too slow, or justunnecessary.

USER SECURITY - In PbAdmin, defines the access a particular user has within alocation to particular functions.

UNBUNDLED FEES - Other fees paid by the merchant to the merchant bank orother contracted party for transaction processing.

VISA - Visa International Service Association and all of its subsidiaries andaffiliates.

VISA ACQUIRER - A member that signs a Visa merchant or disburses currencyto a Visa cardholder in a cash disbursement, and directly or indirectly entersthe resulting transaction receipt into interchange.

VISA CARD - A card that bears the Visa symbol, enabling a Visa cardholder toobtain goods, services, or cash from a Visa merchant or an acquirer. A VisaCard is always one of the following: Visa Business Card, Visa Classic Card,Visa Corporate Gold, Visa Gold Card, Visa Premier Card, Visa PurchasingCard, or Visa Check Card.

VISA ISSUER - A member that issues Visa Cards.

VISA MERCHANT - A merchant that displays the Visa symbol and accepts allVisa cards.

VISA/PLUS ATM - An ATM that displays both the Visa symbol and the PLUSsymbol.

VISANET - The systems and services, including the V.I.P. system and BASE II,through which Visa delivers online financial processing, authorization,clearing, and settlement services to members.

Glossary


VOID - Nullifies a transaction that has been recorded for settlement, but not yetsettled. This removes the transaction from the batch of transactions to besettled.

VOICE AUTHORIZATION - An approval response obtained through interactivecommunication between an issuer and an acquirer, their authorizingprocessors, or stand-in processing, through telephone, facsimile, or telexcommunications.

VSAT (VERY SMALL APERTURE TERMINAL) - Satellite systems that providewireless connection between a data center and remote user equipment orbetween the remote user equipment. The user equipment can be telephone,fax, personal computer (PC), minicomputer, computer with the function ofinterfacing the local area networks (LAN) or their combination.

WIRE TRANSFER TRANSACTION - A transaction representing the sale of acheck or money order for transfer to a payee (who may or may not be thecardholder) by electronic funds transfer.

ZERO-FLOOR LIMIT - A floor limit with a currency amount of zero (meaningauthorization is required for all transactions).

Glossary


INDEX

A

Add New Detail Transaction Screen 151–54, 244Add transaction 244Add/Edit Credit Cards Screen 99, 137–40Address Verification Info Screen 242Administrator Configuration Report 211–12Administrator Log 219Administrator Setup Menu 88American Express Status Check 260American Express Utility

integration considerations 18Authorization Date & Time Report 251Authorization Date and Time Report 198Authorization Only 21Authorization problems 292, 296–97Authorization Reversal 23, 36–37Authorization, incremental 23Authorization, incremental 36–37Auto close 40AVS (address verification) 38

B

Batch Out of Balance 298

C

Card number validations 42Card Type Detail Report 202–3Card Type Reports 252Card Type Summary Report 200–201Cashier (Server) Detail Report 179–80Cashier (Server) Summary Report 177–78Cashier Extended Detail Report

Direct Marketing 190–91Lodging 186–87Rental Car 188–89Retail 181–83

Cashier Reports 249Check Authorization 23Check settlement information 279Close of Open Transaction 24Configuration 82–106

automatic, overview 82DB directory, backing up 83manual, overview 82printing 106running 102–5

Configuration problems 82–106READCFG 295

Configuration, automatic 83–86activating new values 85–86

overview 82running 85–86steps to configure 84

Configuration, manual 87–106accessing configuration menu 87–88activating new values 102–5credit card tables 96–100devices 100–101overview 82payment types 96–100processors 90–92ProtoBase Configuration menu 89running 102–5terminals 93–95

Copy to main database 273CPS compliance, error messages 294C-tree errors 300

D

Database Management Menu 275Databases

exporting 60, 68, 69importing 62, 70

DBEXPORTExport to different database to troubleshoot 291

Delete logs 289Deleting transactions

all records in transaction database 283from selected history database 285individual 242

Deposit Date and Time Report 274Deposit Status Log 251, 258

viewing 259–61Deposit Status Report 197Deposit Transactions 254–58Deselect transactions, for settlement

individual 235multiple 237–38

Deselect transactions, history 270–71Detail View of History Transaction Screen 268–69Detail View of Transaction Screen 156–57, 241

Direct Marketing 173–75Lodging/Front Desk 167–69Lodging/Restaurant 163–66Lodging/Retail 161–62Rental Car 170–72Restaurant 163–66Retail 32–33

Device Edit Screen 101, 141–47Device List Screen 100Directories

API/Settlement 226

ProtoBase Administrator User Guide – Index


BATCH subdirectory 226created by PbAdmin during use 224–27DB 224–25DB subdirectory 223DBHIST subdirectory 225DEBUG subdirectory 225DEFAULT subdirectory 223descriptions 220–27PBADMIN 222PBFE 221provided as part of installation 221–23

E

Edit Credit Card Table Screen 97, 136Editing transactions 235–44Environment Settings Screen 147Error messages, table of 301–5

PbAdmin errors 306–15Exiting PbAdmin 233Exporting databases 60, 68, 69

F

FilesAPI/Settlement directory 226BATCH subdirectory 226created by PbAdmin during use 224–27DB directory 224–25DB subdirectory 223DBHIST subdirectory 225DEBUG subdirectory 225DEFAULT subdirectory 223descriptions 220–27PBADMIN directory 222PBFE directory 221provided as part of installation 221–23

Fix settlement information 280Force field (12) 41

G

Gateways 40Integrating with File Server Gateway 51–53

Generating reports 245–47Global INI File Screen 73, 112–15

H

History Search Criteria Screen 267History Transactions

viewing 263–65

I

Importing databases 62, 70Incremental Authorization 23Incremental Authorization 36–37Incremental Authorization Report 199, 251

Input fieldsaddress verification 34checks 35direct marketing 34–35lodging 31–32rental car 33–34required, by transaction type 25restaurant 31retail 32–33suggested, by industry type 26table of 29–35

Installing PbAdmin 55–109DOS/LAN, Windows NT/95, OS/2 56–63

steps to install first time 58–59steps to upgrade 60–63system requirements 57

UNIXsteps to install first time 65–67steps to upgrade 68–71system requirements 64

Integrationdiagram 20introduction 18PBFE 18

L

Local INI FileIntegrating with File Server Gateway 51–53

Local INI File Screen 73, 112–15Location Information Screen 76–77, 76–77Locations Screen 75Locations, multiple 40locked files 300

M

Main Menu 232–33Memory, running out 295Merchant Key Detail Report 206–7Merchant Key reports 253Merchant Key Summary Report 204–5Modify transaction status 275–77Multi-merchant settlement 95, 135, 226, 256Multiple locations 40

N

Network problems 299

O

Output fields 27–28

P

PBADREP (PbAdmin Report Generator) 43–53PBFE

test transactions 107–9



PBFE (ProtoBase Administrator Front End)American Express Utility 18Authorization Reversal 20functions of 19Incremental Authorization 19

Printer setup 41Prior-Authorized Sale 19, 22, 38Problems

authorizations 293, 296–97configuration 82–106READCFG 295running 296–97settlement 293, 297transactions, running 296

Processor Edit Screen 92, 130Processor List Screen 90Processors Screen 91ProtoBase Configuration Menu 89, 102Purge history files 285Purge log 289Purge old authorizations 278Purge transaction database 283

R

READCFG, problems running 295Real-Time transactions 40Rebuild history file 284Rebuild transaction database 281–82Remove Open Transaction 24Reports 249–53

Administrator Configuration 211–12Administrator Log 219Authorization Date & Time 251Authorization Date and time 198Card Type 252Card Type Detail 202–3Card Type Summary 200–201Cashier 249Cashier (Server) Detail 179–80Cashier (Server) Summary 177–78Cashier Extended Detail

Direct Marketing 190–91Lodging 186–87Rental Car 188–89Retail 181–83

configuration report 106Deposit Date and Time 274Deposit Status 197Deposit Status Log 251, 258generating 245–47Incremental Authorization 199, 251Merchant Key 253Merchant Key Detail 206–7Merchant Key Summary 204–5

Server Extended Detail 184–85Server Tip 208–9, 251Settlement from ProtoBase 258Terminal 250Terminal Detail 194–95Terminal Extended Detail 196Terminal Summary 192–93Transaction Log 215

Reports Menu 246Reports security screen 80–81Reports Security Screen 80–81Reports, Generating Outside PbAdmin 43–53Return 22Reverse and copy to main database 272

S

Sale 21Screens

Add New Detail Transaction 244Add New Detail Transaction Screen 151Add/Edit Credit Cards 137Add/Edit Credit Cards 99Address Verification Info 242Administrator Setup Menu 88Database Management Menu 275Deposit Transactions Status Window 254Detail View of History Transaction 268–69Detail View of Transaction 156, 241

Direct Marketing 173Lodging/Front Desk 167Lodging/Restaurant 163Lodging/Retail 161Rental Car 170Restaurant 163Retail 160

Device Edit 101, 141Device List 100Edit Credit Card Table 97, 136Environment Settings 147Global INI File 73, 112History Search Criteria Screen 267Local INI File 112Location Information 76–77, 116Locations 75Main Menu 232–33Processor Edit 92, 130Processor List 90Processors 91ProtoBase Configuration Menu 89, 102Reports Menu 246Reports Security 80–81, 127Search Criteria 155, 239Select Transaction Criteria 158, 237, 270Select/View/Edit Transactions 148, 234



Terminal Edit 94, 95Terminal Edit Screen 134Terminal List 93, 96, 98Transaction History Menu 262Transaction History Search 263User Login 74User Security 78–79, 124View History Transactions 213–14, 264

Search Criteria Screen 155, 239Search for transaction, history 266Search for transaction, main 239–40Select display mode 236Select Transaction Criteria Screen 158–59, 237, 270Select transactions, for settlement

individual 235multiple 237–38

Select transactions, history 270–71Select/View/Edit Transactions Screen 148–50, 235–44

add transaction 244search for transaction 239–40select display mode 236select transactions 235select/deselect multiple transactions 237–38toggle status 243view/modify transaction detail 241–42

Server Extended Detail Report 184–85Server Tip Report 208–9, 251Setting up PbAdmin 72–81

global INI file 73location information 76–77locations 75reports security 80–81user login 74user security 78–79

Settlement 39Settlement Group 95, 135, 256Settlement Log 251, 258

viewing 259–61Settlement problems 293Settlement Report from ProtoBase 258Settlement, problems running 254–58Settling 254–58

multi-merchant 256Starting PbAdmin 231System requirements

DOS/LAN, Windows NT/95, OS/2 57UNIX 64

T

Technical referenceintroduction 111

Terminal Detail Report 194–95Terminal Edit Screen 94, 134–35

Terminal Extended Detail Reports 196Terminal List Screen 93, 96, 98Terminal Reports 250Terminal Summary Report 192–93Test transactions, running 107–9Time out reversal 41Toggle Status (R/r or U/h) 243Transaction History Menu 262

reports 274Transaction history search 213–14

copy to main database 273reverse and copy to main database 272search for transaction 266Select/deselect transactions 270–71view transaction detail 268–69

Transaction History Search Screen 263Transaction inquiry 42Transaction Inquiry 23Transaction Log 215–18

layout 216program source ID codes 217–18sample 215

Transaction qualifier field (115) 40Transaction types

input fields, required 25input fields, suggested 26table of 21–24

U

User defined field (11) 41User login screen 74User security screen 78–79User Security Screen 124–26

V

VALID.DAT 21validation of field data 21Version number, checking 291View Deposit (Settlement) Log 259–61View history transactions 263–65View History Transactions Screen 213–14View logs 286–88View transaction detail 268View/modify transaction detail 241–42Void return 38Void Return 22Void sale 38Void Sale 22

W

Working Key Update 24

ProtoBase User's Guide1).pdfProtoBase Administrator User Guide - Version 4.3.002 - Introduction...

Documents

Transcript of ProtoBase User's Guide1).pdfProtoBase Administrator User Guide - Version 4.3.002 - Introduction...