RDA2 Programmers Guide

Retail Pro® 8 Series RDA2 Programmers Guide

Retail Pro 3252 Holiday Court La Jolla, CA 92037 USA USA 1-800-738-2457 International +1-858-550-3355 www.retailpro.com

Retail Pro® 8 RDA2 Programmers Guide

Copyright © 2008 Retail Pro. All rights reserved ii

About this Guide This document is intended to be a guide to help Software Developers use the Retail Pro APIs to create extensions and customizations to the Retail Pro® software.

If you believe the information presented here is incomplete or inaccurate, we encourage you to contact us at [email protected].

The software described herein is furnished under a license agreement.

Retail Pro 3252 Holiday Court

La Jolla, CA 92037 USA

USA 1-800-738-2457) International +1-858-550-3355

www.retailpro.com

Copyright

Copyright © 2008 Intuit, Inc.® All rights reserved. Redistributed by Retail Pro under license.

Retail Pro 3252 Holiday Court La Jolla, CA 92037 U.S.A.

Trademarks

Retail Pro and the Retail Pro logo are registered trademarks and/or registered service marks in the United States and other countries. Oracle and Oracle 9i are registered trademarks and/or registered service marks of Oracle Corporation. All rights reserved. Other parties’ trademarks or service marks are the property of their respective owners and should be treated as such.


Copyright © 2008 Retail Pro. All rights reserved iii

Table of Contents About this Guide ............................................................................................................................. ii Introduction ......................................................................................................................................1

Revision History ........................................................................................................................1 The RDA2 Object Model .................................................................................................................2

RDA2 and the Retail Pro Database............................................................................................2 RDA2 Basics..............................................................................................................................2

Tables...................................................................................................................................... 2 Documents .............................................................................................................................. 2

Nested Documents .....................................................................................................................3 Fields..........................................................................................................................................3

RDA2 Server Interface (IRdaDB) ....................................................................................................4 RDA2 Server Interface (IRdaDB) ....................................................................................................5

Properties and Methods..............................................................................................................5 All TableNames Property ....................................................................................................... 5 Connected Property................................................................................................................. 6 Preferences Property ............................................................................................................... 6 Connect Method...................................................................................................................... 6 CreateTableByID Method....................................................................................................... 7 CreateTableByName Method ................................................................................................. 7 Disconnect Method ................................................................................................................. 7 UpdatePreferences Method..................................................................................................... 7

IRDATable Interface ........................................................................................................................8 Properties and Methods..............................................................................................................9

Active Property ..................................................................................................................... 10 ActiveIndexID Property........................................................................................................ 10 ActiveIndexName Property .................................................................................................. 10 AllIndexNames Property ...................................................................................................... 11 Bof Property.......................................................................................................................... 11 Bookmark Property............................................................................................................... 11 CustomInterface Property ..................................................................................................... 12 DataPath Property ................................................................................................................. 12 DirectAccess Property .......................................................................................................... 12 Empty Property ..................................................................................................................... 12 Eof Property.......................................................................................................................... 12 FileName Property................................................................................................................ 13 History Property.................................................................................................................... 13 IndexCount Property............................................................................................................. 13 IsRecordDeleted Property..................................................................................................... 13


Copyright © 2008 Retail Pro. All rights reserved iv

Name Property ...................................................................................................................... 14 NoSequences Property.......................................................................................................... 14 UseBlockReadWrite Property............................................................................................... 14 Close Method........................................................................................................................ 14 Document Method ................................................................................................................ 14 EraseRecord Method............................................................................................................. 15 Find Method.......................................................................................................................... 15 First Method.......................................................................................................................... 15 Last Method .......................................................................................................................... 16 NewRecord Method.............................................................................................................. 16 Next Method ......................................................................................................................... 16 Open Method ........................................................................................................................ 16 PostRecord Method............................................................................................................... 17 Prior Method......................................................................................................................... 17

IRdaHistory Interface...............................................................................................................18 Properties and Methods............................................................................................................18

Month Property ..................................................................................................................... 18 Year Property........................................................................................................................ 18 SetMonthYear Method ......................................................................................................... 19

IRdaDirectAccess Interface............................................................................................................20 Properties and Methods............................................................................................................20

RecordCount Property .......................................................................................................... 20 RecordNumber Property ....................................................................................................... 20 GoToRecord Method ............................................................................................................ 21

IRdaDocument Interface ................................................................................................................22 Properties and Methods............................................................................................................22

Add2XMLNode Method....................................................................................................... 23 AllFieldNames Property ....................................................................................................... 24 AllNestedDocNames Property.............................................................................................. 24 Count Property...................................................................................................................... 24 CustomInterface Property ..................................................................................................... 24 DescriptiveInfo Property....................................................................................................... 25 DeSyncDetected Method ...................................................................................................... 25 EditMode Property................................................................................................................ 25 FieldByID Method................................................................................................................ 26 FieldByName Method........................................................................................................... 26 GetBoolean Method.............................................................................................................. 27 GetDateTimeMethod ............................................................................................................ 27 GetDouble Method ............................................................................................................... 27 GetInteger Method................................................................................................................ 28


Copyright © 2008 Retail Pro. All rights reserved v

GetString Method ................................................................................................................. 28 GetSubDouble Method ......................................................................................................... 28 LoadFromStream Method..................................................................................................... 29 Name Property ...................................................................................................................... 29 NestedDocByID Property ..................................................................................................... 29 NestedDocByName Property................................................................................................ 30 NoInventoryLookups Property ............................................................................................. 30 RefreshDocument Method.................................................................................................... 30 RefreshProvider Method....................................................................................................... 31 ReSyncPosition Method ....................................................................................................... 31 ReSyncToLastSetPosition Method ....................................................................................... 31 SaveToStream Method ......................................................................................................... 32 SetBoolean Method............................................................................................................... 32 SetDate/Time Method........................................................................................................... 32 SetDouble Method ................................................................................................................ 33 SetInteger Method................................................................................................................. 33 SetPosition Method............................................................................................................... 33 SetString Method .................................................................................................................. 34 SetSubDouble Method.......................................................................................................... 34 XMLDOMDocument Method .............................................................................................. 34 XMLSchema2Dir Method .................................................................................................... 35

IRdaField Interface.........................................................................................................................36 Properties and Methods............................................................................................................36

Caption Property ................................................................................................................... 36 Description Property ............................................................................................................. 36 FieldType Property ............................................................................................................... 37 ID Property ........................................................................................................................... 37 LookupList Property ............................................................................................................. 37 Name Property ...................................................................................................................... 37 Size Property......................................................................................................................... 38 Value Property ...................................................................................................................... 38 Text Method.......................................................................................................................... 38

IRdaInventory Interface..................................................................................................................39 Properties and Methods............................................................................................................39

UseInTransit Property........................................................................................................... 39 UseMinMax Property ........................................................................................................... 40 UseMulti Property................................................................................................................. 40 UsePrice Property ................................................................................................................. 40 UseProm Property................................................................................................................. 41 UseSroQ Property ................................................................................................................. 41


Copyright © 2008 Retail Pro. All rights reserved vi

ConnectItemToStyle Method................................................................................................ 41 DisconnectItemFromStyle Method....................................................................................... 41 StyleItems Method................................................................................................................ 42

IRdaSO Interface ............................................................................................................................43 Properties and Methods............................................................................................................43

AddDeposit Method.............................................................................................................. 43 IRdaVouTerms Interface ................................................................................................................44

Percent/Day Pairs.....................................................................................................................44 Properties and Methods............................................................................................................45

Date Property ........................................................................................................................ 45 Kind Property........................................................................................................................ 45 Split Property ........................................................................................................................ 46 SplitTotal Property................................................................................................................ 46 Get_PercentDays Method ..................................................................................................... 46 Set_PercentDays Method...................................................................................................... 47

IRdaTender Interface......................................................................................................................48 Properties and Methods............................................................................................................48

AddItem Method................................................................................................................... 49 CreditCardIsRounded Property............................................................................................. 49 DeleteItem Method ............................................................................................................... 49 RoundedUndefined Property ................................................................................................ 50 Sum Property ........................................................................................................................ 50 TenderItems Property ........................................................................................................... 50 Undefined Property............................................................................................................... 50 XML Property....................................................................................................................... 51

IRdaTenderItem Interface ..............................................................................................................52 Associated Data Types.............................................................................................................52

Tender Type.......................................................................................................................... 52 Properties and Methods............................................................................................................52

Amount Property................................................................................................................... 53 Desc Property........................................................................................................................ 53 Info Property ......................................................................................................................... 53 TenderType Property ............................................................................................................ 53

IRdaStoreCredit Interface...............................................................................................................54 Properties and Methods............................................................................................................54

InitStoreCreditID Method..................................................................................................... 54 StoreCreditID Interface......................................................................................................... 54

IRdaFC Interface ............................................................................................................................55 Properties and Methods............................................................................................................55

FCName Property ................................................................................................................. 55


Copyright © 2008 Retail Pro. All rights reserved vii

FCAmount Property.............................................................................................................. 55 IRdaCheck Interface.......................................................................................................................56

Properties and Methods............................................................................................................56 BankNumber Property .......................................................................................................... 56 CheckNumber Property ........................................................................................................ 56 CustomerName Property....................................................................................................... 56 DateofBirth Property............................................................................................................. 57 DriverLicenseNumber Property............................................................................................ 57 StateCode Property ............................................................................................................... 57

IRdaCreditCard Interface ...............................................................................................................58 Properties and Methods............................................................................................................58

AuthorizationNum Property ................................................................................................. 58 CardNumber Property........................................................................................................... 58 CardType Property................................................................................................................ 59 ControlNum Property ........................................................................................................... 59 ExpMonth Property............................................................................................................... 59 ExpYear Property ................................................................................................................. 59 ReferenceNum ...................................................................................................................... 59

IRdaCharge Interface .....................................................................................................................60 Properties and Methods............................................................................................................60

DiscountDays Property ......................................................................................................... 60 DiscountPercent Property ..................................................................................................... 60 NetDays Property.................................................................................................................. 61

IRdaPayments Interface..................................................................................................................62 Properties and Methods............................................................................................................62

NumofPayments Property..................................................................................................... 62 PaymentAmount Property..................................................................................................... 62 StartingDate Property ........................................................................................................... 62

IRdaGift Interface...........................................................................................................................63 Properties and Methods............................................................................................................63

GiftNumber Property ............................................................................................................ 63 InitGiftNumber Method........................................................................................................ 63

IRdaCollection Interface ................................................................................................................64 Properties and Methods............................................................................................................64

Item Method.......................................................................................................................... 64 Length Property .................................................................................................................... 64

RDA2 Table Information ...............................................................................................................65 Table ID Numbers and Names.................................................................................................65 Table Indexes ...........................................................................................................................65

Departments .......................................................................................................................... 66


Copyright © 2008 Retail Pro. All rights reserved viii

Customers ............................................................................................................................. 66 Vendors................................................................................................................................. 67 Items ..................................................................................................................................... 67 Invoices................................................................................................................................. 68 POs........................................................................................................................................ 68 SOs........................................................................................................................................ 69 Former Vouchers .................................................................................................................. 69 Pending Vouchers ................................................................................................................. 70 ASN Vouchers ...................................................................................................................... 70 Memos .................................................................................................................................. 71 Slips ...................................................................................................................................... 71 SubLocDefs .......................................................................................................................... 71 SubLocQtys .......................................................................................................................... 72 MovNotes ............................................................................................................................. 72 MovOrders ............................................................................................................................ 73 TOs ....................................................................................................................................... 73

Nested Document Names and ID Numbers .............................................................................74 Table Schemas .........................................................................................................................75

Departments .......................................................................................................................... 75 Customers ............................................................................................................................. 76 Vendors................................................................................................................................. 78 Items ..................................................................................................................................... 79 Invoices................................................................................................................................. 83 ReceiptItem (Nested Table) .................................................................................................. 88 POs........................................................................................................................................ 91 POItem (Nested Table) ......................................................................................................... 94 SO ......................................................................................................................................... 97 SOItem (Nested Table) ....................................................................................................... 102 SODeposit (Nested Table) .................................................................................................. 106 SOHistory (Nested Table) .................................................................................................. 106 Former Vouchers ................................................................................................................ 107 Pending Vouchers ............................................................................................................... 111 ASN Vouchers .................................................................................................................... 115 VoucherItem (Nested Table) .............................................................................................. 119 Memos ................................................................................................................................ 122 MemoItem(Nested Table)................................................................................................... 124 Slips .................................................................................................................................... 126 SlipItem (Nested Table)...................................................................................................... 129 SubLocDefs ........................................................................................................................ 131 SubLocQtys ........................................................................................................................ 131


Copyright © 2008 Retail Pro. All rights reserved ix

MovNotes ........................................................................................................................... 132 MovNoteItem (Nested Table) ............................................................................................. 134 MOs .................................................................................................................................... 136 MOItem (Nested Table)...................................................................................................... 138 TOs ..................................................................................................................................... 140 TOItem (Nested Table) ....................................................................................................... 141

XML Preferences .........................................................................................................................144 Updating Preferences .............................................................................................................144

Sample Preference Document............................................................................................. 145 Programming with RDA2.............................................................................................................146

Tips and Tricks ......................................................................................................................146 Converting SID Types ........................................................................................................ 146 Setting Fee and Shipping Amounts..................................................................................... 146 Using COM Objects in a Delphi Console Application ....................................................... 147 RDA2 and .NET – A Word of Warning ............................................................................. 148

Visual Basic Examples ..........................................................................................................149 Connecting to the Database ................................................................................................ 149 Adding Table Names to a Combo Box ............................................................................... 149 Opening a Table and Setting the Active Index ................................................................... 149 Add a Department............................................................................................................... 149 Add an Item to a Purchase Order........................................................................................ 150 Use a Field with a Lookup List to Populate a Combo Box................................................. 151 Create an IrdaInventory Object........................................................................................... 151 Create an IRdaSO Object.................................................................................................... 151

Create IRdaTender Objects....................................................................................................152 To create an IRdaTender Object for the Invoices Table..................................................... 152 To create an IRdaTender Object for SO deposits ............................................................... 152 Get the Terms of a Purchase Order..................................................................................... 152 Get the Tender Information for a Receipt........................................................................... 154


Copyright © 2008 Retail Pro. All rights reserved 1

Introduction This document is intended to be a guide to help Software Developers use the Retail Pro APIs to create extensions and customizations to the Retail Pro software. The RDA2.dll is used for standalone applications to read and write information to the Retail Pro database, but the interfaces used in RDA2 are also used to pass data in the Retail Pro plugins API. It is necessary to understand the RDA2 object model i order to create functional Retail Pro plugins.

Revision History Revision 2 – In RDA2 versions dated 12/5/01 and later the IRdaTenderXML object has been renamed IRdaTender. The Programmer’s Guide now refers only to IRdaTender.

Revision 3 – Updated Documentation to include IRdaTenderItem and the specific tender interfaces. Added new properties and methods to the IRdaDocument Interface



The RDA2 Object Model RDA2 and the Retail Pro Database

The Retail Pro Version 8 and earlier is built on B-Tree Filer. As such, data is not stored in a traditional table format.

RDA2 uses the underlying structure of the Retail Pro database and presents the data in a more traditional table oriented format; therefore, the table schema exposed by RDA2 do not reflect the physical (and in some cases, logical) structure of Retail Pro itself.

RDA2 Basics

The major classes found in the RDA2 library are the IRdaTable, IRdaDocument and IRdaField classes.

Tables

IRdaTables represent tables. All other RDA2 objects are created from IRdaTable. IRdaTable itself does not directly expose individual fields and values but does control the current record position of a table as well as other table parameters.

Documents IRdaDocuments are created from IRdaTable objects or existing IRdaDocument objects. Internally, IRdaDocuments use XML documents and can present data in the XML format.

IRdaDocument objects directly expose the individual fields and values of a table.

There are two types of IRdaDocuments: standard and nested. Standard documents are linked to IRdaTables and created from IRdaTable objects.



Nested Documents Nested documents are used in places where multiple records of information can exist for a single record in a table. Nested documents are always “attached” to standard documents (that is, they are created from IRdaDocument objects that are “standard” documents). Nested documents do not exist for every table in the Rda2 model.

For example, the Invoices table consists of what would normally be thought of as Invoice header records. An IRdaTable object is created for the Invoices table. There is an IRdaDoucment object automatically connected to the IRdaTable object. In this case, the IRdaDocument object could be used to manipulate the invoice header records, add a new invoice, delete an invoice, etc.

The Invoice items (i.e. the items connected to the Invoice header records) would be accessed using a nested document. In this case, it would be the “ReceiptItems” nested document. (Nested documents are sometimes referred to as nested tables). The nested document is an IRdaDocument object created using the methods of IRdaDocument itself. In this case, the ReceiptItems nested document exposes the fields and values of the invoice items.

For a complete list of nested documents and the standard documents they are attached to, see Nested Document Names and ID Numbers.

Fields Most of the data in the Retail Pro database is presented by RDA2 using a table model with fields as the table columns and rows representing each record of data.

The fields themselves are manipulated using the IRdaDocument object or IRdaField object.

There are two ways to specify a particular field in RDA2: Field ID numbers and Field names.

Every field in an RDA2 table is assigned a field ID number. Almost every field ID number is assigned to a constant enumerated in the RDA2 object model. Field ID constants start with the FID prefix (F-I-D). For example, the constant fidTaxAmt when used with the Receipts table refers to the field that contains the total amount of tax for the receipt.

Fields are also assigned Field names. Field names are not enumerated in the RDA2 library. Field names are only used with the IRdaField object. Field names start with FLD.

Note: since FID and FLD can appear very similar in lower case depending on type font (fid and fld), field ID number constant names have sometimes been confused with field names.



RDA2Server (IRdaDB)

IRdaTable IRdaInventory

IRdaSO IRdaHistory

IRdaDirectAccess

IRdaDocument IRdaVouTerms

IRdaTender IRdaDocument (Nested)

IRdaTenderItem IRdaField

DOMDocument

IRdaField

DOMDocument

IRdaCollection

IRdaStoreCredit

IRdaFC

IRdaCheck

IRdaCreditCard

IRdaCharge

IRdaPayments

IRdaGift



RDA2 Server Interface (IRdaDB) The Rda2Server object is used to connect to a specific Retail Pro database. All other objects in the RDA2 object model are created from the Rda2Server object.

Use the Connect method of Rda2Server to connect to an Retail Pro database. Once connected, use the CreateTableByID or CreateTableByName methods to create IRdaTable objects that enable access to the Retail Pro data.

Use the Disconnect method to close the connection to the database. You only need to explicitly disconnect from the Retail Pro database if you want to reuse the same object to connect to a different database; otherwise, when your program releases the RDA2Server object it will automatically close any open tables and disconnect.

The Preferences property returns an XML document containing the system preferences. The UpdatePreferences method allows you to set currency rates.

Properties and Methods AllTableNames Property – Returns all available table names.

Connected Property – Indicates state of connection to database.

Preferences Property – Returns the Retail Pro preferences.

Connect Method – Connects to the database.

CreateTableByID – Creates an IRdaTable object.

CreateTableByName – Creates an IRdaTable object.

Disconnect Method – Disconnects from the database.

UpdatePreferences Method – Updates the Retail Pro Preferences.

All TableNames Property AllTableNames returns a list of available tables as an IRdaCollection object.

Syntax: IRdaCollection := Rda2Server.AllTableNames; Remarks:

The tables exposed by the Rda2Server object may vary with different versions of Retail Pro. The AllTableNames property returns the names of all the tables available in the current Retail Pro database.



Connected Property Returns a boolean value indicating whether or not the Rda2Server object is currently connected to the database. Read only.

Syntax: blnDBConnected := Rda2Server.Connected;

Preferences Property Returns a DOMDocument object that contains a subset of the Retail Pro preferences. Read only. (See the documentation on the XML Preferences Document.)

Syntax: DOMDocument := Rda2Server.Preferences;

Connect Method Establishes a connection to an RPro database. Example.

Syntax: Rda2Server.Connect(DataPath, Workstation, UserName, Password) Parameters:

DataPath – a string value containing the path to Retail Pro. Example: 'c:\Retail'

Workstation – a long integer indicating the workstation number.

UserName – Not implemented, leave blank.

Password – Not implemented, leave blank.

Remarks:

If you set the Workstation parameter to zero, Retail Pro will use the value of the environment variable RPROWS to determine the workstation number. Using zero without this variable set will lead to various error conditions.

There is no provision for an error return or error value using the Connect method. Use the Connected property to determine whether or not the connection was successful.

The workstation parameter will affect data such as preferences and sequence numbers that are workstation dependent.

If there is no workstation directory for the workstation specified in the Connect method, a new workstation directory will be created.



CreateTableByID Method Creates and returns an IRdaTable object based on a table ID. This method does not actually create a new table structure. Rather, it creates an IRdaTable object based on table structures that are predefined by Rda2.

Syntax: Set IRdaTable = Rda2Server.CreateTableByID(TableID) Parameters:

TableID – a long integer. Must be a valid table ID number. (See the RDA2 Table Schema Document).

CreateTableByName Method Creates and returns an IRdaTable object based on a table name.

Syntax: Set IRdaTable = Rda2Server.CreateTableByName(TableName) Parameters:

TableName – a string containing a valid table name. The parameter is case sensitive.

Disconnect Method Disconnects the Rda2Server object from the Retail Pro database. In most cases, it is not necessary to use the Disconnect method.

Syntax: Rda2Server.Disconnect

UpdatePreferences Method Used to update the currency rate preferences. This method will only change the currency rates for currencies that are already in the system. (See the VB RDA2ObjectModel project for an example.)

Syntax: Rda2Server.UpdatePreferences(Preference) Parameters:

Preference – an IXMLDOMElement corresponding to the CURRENCY node in the XML Preferences document.



IRDATable Interface The IRdaTable object presents data from the Retail Pro database in a table like format.

The properties and methods of the IRdaTable interface are used to manipulate the data on a row-by-row basis. Individual fields are not accessible from the IRdaTable object. Use the IRdaDocument and IRdaField interfaces to manipulate individual fields.

IRdaTable objects are instantiated using the CreateTableByID and CreateTableByName methods of an Rda2Server object. The RDA2 object model contains a predefined table schema. (See the RDA2 Table Schema Documentation). New table structures cannot be defined or opened using RDA2.

IRdaTables do not reflect a true relational model for the Retail Pro database. Data is represented in a row/column format where the columns of the table are fields in the Retail Pro database. Once a table is opened, RDA2 maintains a current record position within the table. Row order within an open table is determined by the current active index of the table. The current index can be changed using the ActiveIndexName and ActiveIndexID properties.

Use the Open and Close method or the Active property of IRdaTable to open and close the table. Use the First, Last, Next, Prior, Find methods, or the Bookmark property to change the current record position.

The Bof and Eof properties indicate whether the current position is at the beginning or the end of the table.

Use the NewRecord method to add a new record to the table and the PostRecord method to save a new record or update the current record.

IRdaDocument, IrdaDirectAccess, and IrdaHistory objects are created using the Document method and DirectAccess and History properties of IRdaTable respectively.



Properties and Methods Active Property – Indicates whether a table is active (open) or not.

ActiveIndexID Property – Sets the active index for a table.

ActiveIndexName Property – Sets the active index for a table.

AllIndexNames Property – Returns the names of all available indexes.

Bof Property – Indicates that the current table is at the first record.

Bookmark Property – Gets or sets the current record.

CustomInterface Property – Creates an IRdaInventory or IRdaSO object.

DataPath Property – Not used.

DirectAccess Property – Allows direct access to table positioning.

Empty Property – Indicates that a table is empty.

Eof Property – Indicates that the current position is the last record in the table.

FileName Property – Returns the name of the current data file.

History Property – Creates an IRdaHistory object.

IndexCount Property – Returns the number of available indexes.

IsRecordDeleted Property – Indicates that a record has been deleted.

Name Property – Not used.

NoSequences Property – Indicates the state for sequence numbers.

UseBlockReadWrite Property – Allows block reading and writing.

Close Method – Closes the table.

Document Method – Creates an IRdaDocument object.

EraseRecord Method – Deletes a record.

Find Method – Finds an index key value.

First Method – Sets the current record position to the first record.

Last Method – Sets the current record position to the last record.

NewRecord Method – Inserts a new record.

Next Method – Moves the current record position to the next record.

Open Method – Opens a table.

PostRecord Method – Saves the current record to the database.

Prior Method – Moves the current record position to the prior record.



Active Property Returns a true/false value indicating whether a table is active (open) or not. Can also be used to set the Active property for a table.

Syntax: blnTableActive := IrdaTable.Active; or IrdaTable.Active := True | False; Remarks:

Setting this property can force a table to open or close. If the Active property is False and is set to True, the table will be opened. If the Active property is True and is set to False, the table will be closed.

ActiveIndexID Property Returns or sets active index of a table using the index ID number (long integer). Example.

Syntax: lngIndexID := IrdaTable.ActiveIndexID; or IRdaTable.ActiveIndexID := lngIndexID; Remarks:

Setting the Active index of a table changes the record order within the table. For example, if the active index of the Departments table is DCS then the table is ordered by the DCS field. If the active index is changed to DCS Name, the table is ordered by DCS Name.

Setting the Active index of a table affects the behavior of the Find method.

Note: Each table has a default index that is active when the table is opened. See the list of Table Indexes.

ActiveIndexName Property Returns or sets the active index of a table using the index name (string).

Syntax: strIndexName := IrdaTable.ActiveIndexName; or IRdaTable.ActiveIndexName := strIndexName; See the remarks under ActiveIndexByID property.



AllIndexNames Property Returns a list of all index names available for the table. The index names are returned as an IRdaCollection object. This property is read only.

Syntax: IndexNames := IrdaTable.AllIndexNames;

Bof Property Returns a Boolean value that indicates if the current record is the first record in the table.

Syntax: blnBOF := IrdaTable.Bof;

Bookmark Property Use the Bookmark property to get or set the current record position in the IRdaTable object. Bookmarks are returned as integers expressed as a variant data type.

Syntax: vntBMark := IRdaTable.Bookmark; or IRdaTable.Bookmark := vntBMark; Remarks:

Bookmarks makes for a quick way of revisiting a known record in an IRdaTable. If you need to do a lot of searching through a table that does not have a suitable index you can create a hash table based on your search criteria and store the bookmarks in it. It takes some time to initially go through the entire table and generate hash values and read bookmark values, but it pays if you have to to many reoccurring searches on the same table.

In the Items table, the Bookmark is synonymous to Item ID so if you know the item ID you can quickly locate that item using the Bookmark property.



CustomInterface Property Returns an RDA2 object. The returned object depends on the IRdaTable that has been opened. Read only.

Syntax: Object := IRdaTable.CustomInterface; Remarks:

CustomInterface returns the following objects based on the IRdaTable that has been opened:

Table CustomInterface Object

Inventory IRdaInventory

SOs IRdaSO

Invoices IRdaTender

SODeposit IRdaTender

DataPath Property The DataPath property has been superceded by the DataPath parameter of the Connect method. The IRdaTable DataPath property is no longer used.

DirectAccess Property Returns an IRdaDirectAccess object for the IRdaTable object. Read only.

Syntax: IRdaDirectAccess := IrdaTable.DirectAccess; See the documentation on IrdaDirectAccess.

Empty Property Returns a Boolean value indicating whether the table is empty. Read only.

Syntax: blnTableEmpty := IrdaTable.Empty;

Eof Property Returns a Boolean value indicating whether the current record is the last record in the table. Read only.

Syntax: blnEof := IRdaTable.Eof;



FileName Property Returns or sets the name of the file used by IRdaTable table directly. This property can sometimes be used to access a file that is not normally exposed by RDA2.

Syntax: IRdaRTable.FileName := strFileName; or strFileName := IrdaRTable.FileName; strFileName is a string variable.

CAUTION: When using this property to set the file name, the file itself must match the schema of the currently open table. Setting the FileName property incorrectly can have catastrophic and/or unpredictable results.

History Property Returns an IRdaHistory object for the table. Read only. (See IRdaHistory).

Syntax: IRdaHistory := IRdaTable.History; Remarks:

Not every table supports the IRdaHistory object. IRdaHistory objects can only be created for the Invoices, Former Vouchers, Pending Vouchers, ASN Vouchers, Memos and Slips tables.

IndexCount Property Returns the number of indexes for a table as a long integer. Read only.

Syntax: lngIndexCount := IRdaRTable.IndexCount;

IsRecordDeleted Property Returns a Boolean value indicating whether or not a record in the table is marked for deletion. Read only. Applies only to tables that are using ‘Default Order’ as the active index. (See ActiveIndexID and ActiveIndexName properties.)

Syntax: blnRecordDeleted := IRdaTable.IsRecordDeleted; Remarks:

When using the ‘Default Order’ as the active index for a table, all records from the database are included in the table. Due to the way the Retail Pro database operates, records that are marked for deletion, but not yet actually deleted, could be included in the table. IsRecordDeleted will be true for records that are marked for deletion but not yet deleted.



Name Property No longer used in RDA2.

NoSequences Property Indicates whether RetailPro is using sequenced numbers for receipts, sales orders, etc. Returns a boolean value. Read only.

Syntax: blnNoSeq := IRdaTable.NoSequences; Remarks:

If sequence numbers are not being used, NoSequences returns True. If sequence numbers are being used, NoSequences returns False.

UseBlockReadWrite Property Returns or sets the block read/write flag.

Syntax: IRdaTable.UseBlockReadWrite := True | False; or blnUseBlock := IRdaTable.UseBlockReadWrite; Remarks:

Setting UseBlockReadWrite to True can result in faster read and write times when reading an entire table using IRdaDirectAccess. In general, UseBlockReadWrite should be set to False.

Close Method Closes a table. Setting the Active property to False will also close the table.

Syntax: IRdaTable.Close

Document Method Returns the IRdaDocument object for the table. (See IRdaDocument).

Syntax: IRdaDocument = IRdaTable.Document; Remarks:

The table must be open before calling this method.



EraseRecord Method Deletes the current record of the IRdaTable.

Syntax: IRdaTable.EraseRecord; Remarks:

Although the record is erased, the current position in the IRdaTable object does not change as a result of invoking EraseRecord. In other words, the Bookmark value remains the same after the EraseRecord method is invoked and the field values are available until the current record position in the table is changed.

Find Method Searches the current active index for a key value and returns a boolean value indicating whether the record was found or not. Example.

Syntax: blnFound := IRdaTable.Find(FindValue, ExactMatch); Parameters:

FindValue – a string expression containing the key value to find.

ExactMatch – boolean – Setting ExactMatch to True causes RDA2 to locate the key that matches FindValue exactly. See remarks.

Remarks:

If the key value is found, Find returns True and the current record is positioned to the found record. If the index value is not found, Find returns false and the current record is unchanged.

Find does not operate as a filter on the RDA table. Find attempts to find the first record that matches the FindValue. Find will not operate on indexes that do not have unique values.

In general, ExactMatch should be set to False when using this method. The actual structure of the RPro index keys makes it difficult to construct a FindValue that will exactly match an RPro key.

First Method Positions the current record at the first record of the table based on the active index.

Syntax: IRdaTable.First; Remarks:

Invoking the First method will also set the Bof property to true.



Last Method Positions the current record at the last record of the table based on the active index.

Syntax: IRdaTable.Last; Remarks:

Invoking the Last method will also set the Eof property to true.

NewRecord Method Creates a new record in the table. Example.

Syntax: IRdaTable.NewRecord; Remarks:

NewRecord is used only to create a new row in the table represented by the IRdaTable object. NewRecord does not update the data file itself. The PostRecord method is used to update the data file.

Immediately after NewRecord is called, the table’s Bookmark property will be 0. The Bookmark property will contain the Bookmark of the new record after the PostRecord method is called. If PostRecord is never called, the table is not updated.

If the current position of the table is changed after the NewRecord method is called but before PostRecord is called, the results are unpredictable and the table (and data file) may be corrupted. The recommended procedure is to call NewRecord, set all necessary fields and call PostRecord.

Next Method Positions the current record to the next record of the table based on the active index.

Syntax: IRdaTable.Next; Remarks:

Invoking the Next method when the Eof property is true has no effect.

Open Method Opens the table and positions the current record to the first record based on the default index for the table. (See Table Indexes).

Syntax: IRdaTable.Open;



PostRecord Method Updates the current row of the table in the database. If the NewRecord method is called and the current row is a new row for the table, then PostRecord inserts the new row into the database. Example.

Syntax: IRdaTable.PostRecord; Remarks:

The current active row of the table (and the Bookmark property) do not change as a result of calling PostRecord. PostRecord causes all fields of the table to be updated.

In some instances, the record position after calling PostRecord may be lost. This can lead to problems if you are, for example: iterating through a table and making changes to several records in a row. If you run into this problem a way of solving it is to save the Bookmark property immediately before calling PostRecord and resetting it to the saved value immediately afterwards.

Prior Method Positions the current record to the prior record of the table based on the active index.

Syntax: IRdaTable.Prior; Remarks:

Invoking the Prior method when the Bof property is true has no effect.



IRdaHistory Interface IRdaHistory objects are created using the History property of IRdaTable.

Data in the RPro database is stored on a month/year basis. When opened, an IRdaTable points to the most current month/year in the RPro database. The IRdaHistory object is used to manipulate the month/year setting so that history data can be accessed by the IRdaTable object.

Use the IRdaHistory Month and Year properties to determine the month/year currently set for the IRdaTable object. Use the SetMonthYear method to change the month/year for the IRdaTable object.

Not every table supports the IRdaHistory object. IRdaHistory objects can only be created for the Invoices, Former Vouchers, Pending Vouchers, ASN Vouchers, Memos and Slips tables.

Properties and Methods Month Property – Returns the current month setting.

Year Property – Returns the current year setting.

SetMonthYear Method – Sets a new month/year.

Month Property Returns the history month as a long integer. For a table that is opened on the current RPro database, the Month property will contain the current month. Read only.

Syntax: lngMonth := IRdaHistory.Month;

Year Property Returns the history year as a long integer. For a table that is opened on the current RPro database, the Year property will contain the current year. Read only.

Syntax: lngYear := IRdaHistory.Year;



SetMonthYear Method Sets the IRdaTable to a history month and year. The table MUST be closed before using this method.

Syntax: IRdaHistory.SetMonthYear(Month, Year); Parameters:

Month – the month number (1 to 12) as a long integer.

Year – the Year number (ex. 2000) as a long integer.

Remarks:

Setting the history month and year to a month and year that don’t exist does NOT generate an error condition. Errors are not generated until an attempt is made to read the table data.

You can use the IRdaTable.FileName property to verify whether the selected data file actually exist before trying to open the table.



IRdaDirectAccess Interface Provides a means of directly accessing the record count and number of an IRdaTable and changing the active record of an IRdaTable. (See IRdaTable DirectAccess Property).

Properties and Methods RecordCount Property – Returns the number of records in a table.

RecordNumber Property – Returns the current record number (bookmark).

GoToRecord Method – Sets the current record of the table.

RecordCount Property Returns the number of records in a table as a long integer. Read only.

Syntax: lngRecCount := IRdaDirectAccess.RecordCount; Remarks:

RecordCount is only valid for tables that have ‘Default Order’ as an index and only when ‘Default Order’ is the active index on the table. Otherwise, RecordCount will return a –1. (See the ActiveIndexID property and the section on Table Indexes).

RecordNumber Property Returns the current record number of the table as a long integer. Read only.

Syntax: lngRecNumber := IRdaDirectAccess.RecordNumber; Remarks:

The value returned by RecordNumber will be affected by using any of the table positioning methods (First, Last, Next or Prior). The record number returned is identical to the IRdaTable Bookmark property.



GoToRecord Method Sets the current record of the IRdaTable and returns a boolean value indicating whether the current record was set or not.

Syntax: blnGoTo := IRdaDirectAccess.GoTo(lngRecNumber); Parameters:

lngRecNumber – the record number expressed as a long integer. (Identical to the Bookmark value of the IRdaTable object).

Remarks:

The GoToRecord method can only be used with tables that have ‘Default Order’ as an index and only when ‘Default Order’ is the active index. Otherwise, GoToRecord will always return false and the current record of the table will not be changed. (See the ActiveIndexID property and the section on Table Indexes).



IRdaDocument Interface The IRdaDocument object can be used to manipulate the fields in an IRdaTable. IRdaDocument objects are created using the Document method of IRdaTable and are linked to the IRdaTable object.

IRdaField objects are instantiated using the FieldByID and FieldByName methods of IRdaDocument.

Nested documents (see Nested Documents) are created using the NestedDocByID and NestedDocByName properties of IRdaDocument.

Some methods of the IRdaDocument (DesyncDetected, ResyncPosition, ResyncToLastSetPosition, RefreshDocument, and RefreshProvider) are only functional when called from inside a Retail Pro plugin.

Properties and Methods Add2XMLNode Method – Adds a node to an XML document.

AllFieldNames Property – Returns a list of all field names in the current document.

AllNestedDocNames Property – Returns a list of all nested document names in the current document.

Count Property – Returns the number of records in a nested document.

CustomInterface Property – Creates an IRdaTender or IRdaVouTerms object.

DescriptiveInfo Property – Returns an XML document containing field descriptions.

DesyncDetectedMethod – IRdaField and IRdaDocument (nested) data providers are desynchronized.

EditMode Property – Reads or sets whether Retail Pro has the current document in editable mode or not.

FieldByID Method – Creates an IRdaField object.

FieldByName Method – Creates an IRdaField object.

GetBoolean Method – Returns the value of a field with datatype boolean.

GetDateTime Method – Returns the value of a field with datatype date.

GetDouble Method – Returns the value of a field with datatype double.

GetInteger Method – Returns the value of a field with datatype integer.

GetString Method – Returns the value of a field with datatype string.

GetSubDouble Method – Returns the value of a double datatype field that can have multiple values.

LoadFromStream Method – Implments a method of pasting an IRdaDocument.

Name Property – Returns the name of an IRdaDocument as a string.

NestedDocByID Property – Creates an IRdaDoucment object for a nested document.



NestedDocByName Property – Creates an IRdaDoucment object for a nested document.

NoInventoryLookups Property – Disables lookup of extended item information on nested item documents.

RefreshDocument Method – Refreshes the values in the UI with data from the IRdaDocument data provider.

RefreshProvider Method – Forces the IRdaDocument to update its values with the data currently in the UI.

ResyncPosition Method – Forces the IRdaDocument (nested) position to be the same as the UI position.

ResyncToLastSetPosition Method – Forces UI position to be set to current IRdaDocument (nested) position.

SaveToStream Method – Implements a method of copying an IRdaDocument.

SetBoolean Method – Sets the value of a field with datatype boolean.

SetDateTime Method – Sets the value of a field with datatype date.

SetDouble Method – Sets the value of a field with datatype double.

SetInteger Method – Sets the value of a field with datatype integer.

SetPosition Method – Sets the current record of a nested document.

SetString Method – Sets the value of a field with datatype string.

SetSubDouble Method – Sets the value of a double datatype field that can have multiple values.

XMLDOMDocument Method – Returns an XML document representing the current record.

XMLSchema2Dir Method – Saves the XML schema of a document to a file.

Add2XMLNode Method Adds a node to an XML document. The method is not used to write any information to the RPro database. This method could be used to add nodes to an existing XML document to include additional information prior to exporting the document to another system.

Syntax: IRdaDocument.Add2XMLNode(XMLNode, IncludeSchemaTag); Parameters:

XMLNode – IXMLDOMNode object – the XML node to be added to the XML document.

IncludeSchemaTag – boolean – If true, the schema tag is added along with the node. If false, no schema tag is added.



AllFieldNames Property Returns a list of all the field names contained in the IRdaTable. The list is returned as an IRdaCollection object. Read only.

Syntax: Set FieldList = IRdaDocument.AllFieldNames

AllNestedDocNames Property Returns a list of all the IRdaDocuments nested within the current IRdaDocument. The list is returned as an IRdaCollection object. Read only.

Syntax: NestedDocumentNames := IRdaDocument.AllNestedDocNames;

Count Property Returns or sets the number of records in a nested document. (See Nested Documents.) Example.

Syntax: lngNestCount := IRdaDocument.Count; or IRdaDocument.Count := lngRecCount;

CustomInterface Property Returns an IRdaTender or IRdaVouTerms object. The returned object depends on the table that was used to create the IRdaDocument object. Read only.

Syntax: Object := IRdaDocument.CustomInterface; Remarks:

CustomInterface applies to IRdaDoucment objects created from IRdaTable objects and IRdaDocuments created as nested documents from existing IRdaDocuments.

If the IRdaDocument was created from an IRdaTable for the Invoices table or is a SODeposit nested document of the SOs table, CustomInterface returns an IRdaTender object.

If the IRdaDocument was created from an IRdaTable object for the POs table, CustomInterface returns an IRdaVouTerms object. Example.

If the IRdaDocument was created as the SODeposit nested document from an IRdaTable object for the SOs table, then CustomInterface returns an IRdaTender object.



DescriptiveInfo Property Returns a DOMDocument object (XML) that contains descriptions for the fields in the IRdaTable. Read only.

Syntax: xmlDescripInfo := IRdaDocument.DescriptiveInfo; Remarks:

The DOMDocument returned by DescriptiveInfo is not a complete table schema. The XML document returned by DescriptiveInfo consists of a FIELDS node with a child FIELD node for every field in the table. The FIELDS node has a COUNT attribute with the number of fields in the table. Each child FIELD node has the CAPTION, ID and TYPE attributes. (See Sample Descriptive Info Document.) Note: DOMDocument is a class of MSXML.dll.

DeSyncDetected Method Sometimes when accessing nested documents from within a plugin you will end up with a state where the IRdaDocument data provider and the IRdaField data provider are pointing to different records in the nested table.

DesyncDetected returns True if this is the case.

Syntax: blnProvidersOutOfSync := IRdaDocument.DesyncDetected; Remarks:

This method is only meaningful when called from within a plugin, and then only if the current document is a nested document. Use this method before calling ResyncPosition or ResyncToLastSetPosition to avoid uneccessary resynchronization calls.

EditMode Property Sets or returns whether Retail Pro has the current document in editable mode or not. This is useful for example to enable a side button plugin only if current document is in edit mode.

Syntax: blnDocEditable := IRdaDocument.EditMode; or IRdaDocument.EditMode := True | False; Remarks:

This method is only meaningful when called from within a plugin.



FieldByID Method Returns an IRdaField object for a table field specified by the field ID number.

Syntax: IRdaField := IRdaDocument.FieldByID(ID); Parameters:

ID – long - the field ID number.

Remarks:

The field ID must be for a field that is part of the IRdaTable. You cannot create an IRdaField object for fields that are not in the IRdaTable object linked to the IRdaDocument. FieldByID cannot be used for fields in nested documents.

Do not use field names with the FieldByID method. Field ID numbers are enumerated in the RDA2 library - see Field ID Constants.

FieldByName Method Returns an IRdaField object for a table field specified by the field name. Example.

Syntax: IRdaField := IRdaDocument.FieldByName(Name); Parameters:

Name – string - the field name. Case-sensitive.

Remarks:

The field name must be a field that is in the IRdaTable. You cannot reference fields that are not in the IRdaTable. FieldByName cannot be used for fields in a nested document. The name parameter is case sensitive and must match the field name in the RDA2 table schema.

See the RDA2 Table Schema for the list of field names in each table. Field names can also be obtained by using the AllFieldNames property of IRdaDocument. Do not use field ID constants with the FieldByName method.



GetBoolean Method Returns the value of an IRdaDocument field with type boolean as a boolean.

Syntax: Boolean := IRdaDocument.GetBoolean(FieldID, IsNull); Parameters:

FieldID - long integer - the field ID number.

IsNull – boolean - True if the value is null, otherwise False.

Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to access the value of fields with type boolean.

GetDateTimeMethod Returns the value of an IRdaDocument field with type datetime as a datetime.

Syntax: DateTime := IRdaDocument.GetDateTime(FieldID, IsNull); Parameters:



Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to access the value of fields with type datetime.

GetDouble Method Returns the value of an IRdaDocument field with type double as a double.

Syntax: Double := IRdaDocument.GetDouble(FieldID, IsNull); Parameters:



Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to access the value of fields with type double.



GetInteger Method Returns the value of an IRdaDocument field with type integer as an integer.

Syntax: Integer := IRdaDocument.GetInteger(FieldID, IsNull); Parameters:



Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to access the value of fields with type integer.

GetString Method Returns the value of an IRdaDocument field with type string as a string.

Syntax: String := IRdaDocument.GetString(FieldID, IsNull); Parameters:



Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to access the value of fields with type string.

GetSubDouble Method Some fields in the Retail Pro database can contain “multiple” values (i.e. fields that have different values by stores number or price level). GetSubDouble allows you to designate which one of the available values is returned. For example, for installations with multiple stores, inventory quantities will be stored by store number. The GetDouble method would return the quantity for the store running the application using RDA2. GetSubDouble can return the value for any of the stores. Values are returned as data type double.

Syntax: Double = IRdaDocument.GetSubDouble(FieldID, SubID, IsNull); Parameters:

FieldID – long integer – the ID number of the field.

SubID – long integer – value indicating which one of the multiple values to return.




LoadFromStream Method Loads a previously saved stream (variant). Equivalent to pasting a new document object into the IRdaDocument.

Syntax: IrdaDocument.LoadFromStream(Stream); Parameters:

Stream – a variant created using the SaveToStream method of IRdaDocument.

Name Property Returns the name of the IRdaDocument object as a string. Read only.

Syntax: Name := IRdaDocument.Name;

NestedDocByID Property Returns the IRdaDocument object for a nested document using the nested document’s ID number. Read only.

Syntax: NestedIRdaDocument := IRdaDocument.NestedDocByID(ID); Parameters:

ID – a long integer representing the ID number of the nested document.

Remarks:

Not all IRdaDocument objects will return nested documents. Whether or not an IRdaDocument object will return nested documents depends on the IRdaTable to which it is attached. Nested documents exist in IRdaDocument objects linked to the Invoices, POs, SOs, Former Vouchers, Pending Vouchers, ASN Vouchers, Memos or Slips tables. (See Nested Document Names and ID Numbers).



NestedDocByName Property Returns the IRdaDocument object for a nested document using the nested document’s name. Read only. Example.

Syntax: NestedIRdaDocument := IRdaDocument.NestedDocByName(NestedDocName); Parameters:

NestedDocName – string – the name of the nested document.

See the Remarks in the NestedDocByID Property section above. (See NestedDocByNames and NestedDocByID properties).

NoInventoryLookups Property Prevents nested items documents (ReceiptItems, SOItems, etc.) from looking up the extended item information from inventory when loading. This means that only basic item information will be available however it will result in a significant performance increase if iterating through many nested item documents.

Syntax: blnNoInventoryLookups := IRdaDocument.NoInventoryLookups; or IRdaDocument.NoInventoryLookups := True | False; Remarks:

See the RDA2 Table Schema Documentation for information regarding which fields are basic vs. extended item information.

RefreshDocument Method The RefreshDocument method allows a plugin to force the Retail Pro UI to update its values based on the data currently in the IRdaDocument data provider. This is useful when a plugin has written information to the current IRdaDocument but it does not trigger Retail Pro to update its UI automatically.

Syntax: IRdaDocument.RefreshDocument; Remarks:

This method is only useful in plugins.



RefreshProvider Method This method is the opposite of RefreshDocument, it will force the values in the Retail Pro UI to be saved to the IRdaDocument data provider.

Syntax: IRdaDocument.RefreshProvider; Remarks:

This method is only useful in plugins. Be careful with calling this method since it can force an update of the current document. This can lead to unexpected results, especially when the current document is new and unfinished.

ReSyncPosition Method The ResyncPosition method allows a plugin to resynchronize the positions of the IRdaField (UI) and IRdaDocument on a nested document. This method will force the IRdaDocument position to move to the IRdaField (UI) position.

Syntax: IRdaDocument.ResyncPosition; Remarks:

This method is only useful in plugins. This method can be time consuming, make sure to use DesyncDetected to verify that it is really necessary to resynchronize first.

Example: if IRdaDocument.DesyncDetected then IRdaDocument.ResyncPosition;

ReSyncToLastSetPosition Method The ResyncToLastSetPosition method allows a plugin to resynchronize the positions of the IRdaField (UI) and IRdaDocument on a nested document. This method will force the IRdaField and the highlighted position in the Retail Pro UI to move to the position selected in the last call to SetPosition.

Syntax: IRdaDocument.ResyncToLastSetPosition; Remarks:

This method is only useful in plugins. This method can be time consuming, make sure to use DesyncDetected to verify that it is really necessary to resynchronize first.

Example: if IRdaDocument.DesyncDetected then IRdaDocument.ResyncToLastSetPosition;



SaveToStream Method Returns the current document in IRdaDocument as a variant.

Syntax: Variant = IrdaDEocument.SaveToStream(); Remarks:

The SaveToStream and LoadFromStream methods provide a means of copying and pasting a document from and to the IRdaDocument object. The variant returned by SaveToStream should not be used for any other purpose.

SetBoolean Method Sets the value of an IRdaDocument field with type boolean.

Syntax: IRdaDocument.SetBoolean(Value, FieldID); Parameters:

Value – boolean – New value for the field.

FieldID – long integer - the field ID number.

Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to set the value of fields with type boolean.

SetDate/Time Method Sets the value of an IRdaDocument field with type date.

Syntax: IRdaDocument.SetDate(Value, FieldID); Parameters:

Value – date – New value for the field.


Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to set the value of fields with type date.



SetDouble Method Sets the value of an IRdaDocument field with type double. Example.

Syntax: IRdaDocument.SetDouble(Value, FieldID); Parameters:

Value – double – New value for the field.


Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to set the value of fields with type double.

SetInteger Method Sets the value of an IRdaDocument field with type integer.


Value – integer – New value for the field.


Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to set the value of fields with type integer.

SetPosition Method Sets the “current record” position of an IRdaDocument object. Example.

Syntax: IrdaDocument.SetPosition(RecNum); Parameters:

RecNum – long integer – “record” number.

Remarks:

The RecNum value cannot exceed the value of the Count property minus 1.



SetString Method Sets the value of an IRdaDocument field with type string. Example.


Value – string – New value for the field.


Remarks:

This method can be used with “regular” and nested IRdaDocument objects. For nested IRdaDocument objects, this method is the only way to set the value of fields with type integer.

SetSubDouble Method Some fields in the RPro database can contain “multiple” values (for example, fields that have different values by stores number or price level). SetSubDouble allows you to designate which of the multiple values is being set. See GetSubDouble for additional information.

Syntax: IRdaDocument.SetSubDouble(Value, FieldID, SubID); Parameters:

Value – double – the new field value.

FieldID – long – the ID number of the field.

SubID – long – an integer value indicating which one of the multiple values to return. SubID is zero based.

XMLDOMDocument Method Returns an XML document representing the current record of the IRdaDocument object.

Syntax: xmlDoc := IrdaDocument.XMLDOMDocument(IncludeSchemaTag); Parameters:

IncludeSchemaTag – boolean – If True, the schema tag is included in the XML document. If False, the tag is not included.

Remarks:

xmlDoc is an DOMDocument object (member of the MSXML class). The XML document returned by this method contains a single element node whose attribute values are the values of the fields in the IRdaDocument object. Valid for “regular” and nested IRdaDocuments.



XMLSchema2Dir Method Writes the schema for a table or nested document to an XML Document file and returns the name of the output file.

Syntax:

OutputFileName := IRdaDocument.XMLSchema2Dir(DirName, FullData);

Parameters:

DirName – a string expression containing the directory name for the output.

FullData – a boolean value that determines the scope of the output. If FullData is set to False, only the XML field name and data type are included in the schema. If FullData is set to True, the schema includes the XML field name, data type, label (equivalent to caption of the IRdaField object), description and length.



IRdaField Interface IRdaField objects are created using the FieldByID and FieldByName methods of the IRdaDocument object. An IRdaField object can be created for each field of the IRdaDocument.

Properties and Methods Caption Property – Returns the field caption.

Description Property – Returns the description of a field.

FieldType Property – Returns the datatype of the field.

ID Property – Returns the field ID number of a field.

LookupList Property – Returns the list of available values for fields with preset values.

Name Property – Returns the name of a field as a string.

Size Property – Returns the size of a field in bytes.

Value Property – Returns or sets the value of a field.

Text Method – Returns the value of a field as a string representation.

Caption Property Returns the caption used for the field as a string value. (The caption is the short description for the field and is used in Retail Pro as column headings in grids). Read only.

Syntax: Caption := IrdaField.Caption;

Description Property Returns the description used for the field as a string value. Read only.

Syntax: Description := IRdaField.Description;



FieldType Property Returns a long integer value representing the data type of the field. Read only.

Syntax: DataType := IRdaField.FieldType; Remarks:

Field data types are enumerated in RDA2 as follows: Constant Value Data Type

ftpstring 1 String

ftpinteger 2 Integer

ftpdouble 3 Double

ftpdate 4 Date

ftpboolean 5 Boolean

ftpenum 6 Enumeration

ID Property Returns the field ID number as a long integer. Read only.

Syntax: ID := IRdaField.ID; Remarks:

Field ID numbers are also enumerated as a set of constants in RDA2.

LookupList Property The LookupList property applies only to database fields that have pre-defined values that appear in drop down lists or combo boxes in RetailPro. LookupList returns an IRdaCollection containing the list of available items. Read only. Example.

Syntax: List := IRdaField.LookupList; Remarks:

Some fields in RetailPro allow the user to enter a value as well as select a value from a drop down list. LookupList will return an IRdaCollection object for these fields.

Name Property Returns the name of the field as a string. Read only.

Syntax: Name := IRdaField.Name;



Size Property Returns the size of the field in bytes (as a long integer) for fields with data type string. Otherwise, returns 0. Read only.

Syntax: Size := IRdaField.Size;

Value Property Returns or sets the value of the field as a variant. Example.

Syntax: FieldValue := IRdaField.Value; or IRdaField.Value := NewValue; Remarks:

The Value property is not enabled for the fields of a nested IRdaDocument. Use the Get and Set methods for various data types to get or set the values for fields in nested documents.

Text Method Returns the value of the field as a string.

Syntax: TextValue := IRdaField.Text;



IRdaInventory Interface The IRdaInventory object is used to manipulate inventory items and connect or disconnect individual items to or from styles. IRdaInventory objects are instantiated using the CustomInterface property of IRdaTable but only when the IRdaTable has been created for the Items (inventory) table. (See the CustomInterface property of IRdaTable).

IMPORTANT NOTE: An IRdaInventory object should only be created after the IRdaTable has been opened. IRdaInventory objects should be explicitly destroyed before the IRdaTable is closed. In Visual Basic, closing the IRdaTable or destroying an IRdaTable object with an IRdaInventory object still created will result in a catastrophic fatal error. (See the code extract and the RDA2 Visual Basic example project.)

Properties and Methods UseInTransit Property – Returns or sets the use of “In Transit” quantities in inventory.

UseMinMax Property – Returns or sets the use of min/max quantities in inventory.

UseMulti Property – Returns or sets the use of quantities by store in inventory.

UsePrice Property – Returns or sets the use of price levels in inventory.

UseProm Property – Returns or sets the use of promotional pricing for inventory.

UseSroQ Property – Returns or sets the use of sold, received, order quantities for inventory.

ConnectItemToStyle Method – Adds an inventory item to a style.

DisconnectItemFromStyle Method – Removes an inventory item from a style.

StyleItems Method – Returns a list of all inventory item numbers in a style.

UseInTransit Property Returns or sets the use of “in transit” quantities in the RPro inventory. Boolean.

Syntax: Boolean := IRdaInventory.UseIntransit; or IRdaInventory.UseInTransit := True | False; Remarks:

Fields in the inventory table used for in transit quantities will return null values if UseInTransit is set to false.



UseMinMax Property Returns or sets the use of min and max quantities in the RPro inventory. Boolean.

Syntax: Boolean := IRdaInventory.UseMinMax; or IRdaInventory.UseMinMax := True | False; Remarks:

Fields in the inventory table used for min and max quantities will return null values if UseMinMax is set to false.

UseMulti Property Returns or sets the use of quantity by store in the RPro inventory. Boolean.

Syntax: Boolean := IRdaInventory.UseMulti; or IRdaInventory.UseMulti := True | False; Remarks:

Fields in the inventory table used for store level quantities will return null values if UseMulti is set to false.

UsePrice Property Returns or sets the use of price levels in the RPro inventory. Boolean.

Syntax: Boolean := IRdaInventory.UsePrice; or IRdaInventory.UsePrice := True | False; Remarks:

Fields in the inventory table used for prices by price level will return null values if UsePrice is set to false.



UseProm Property Returns or sets the use of promotional pricing in the RPro inventory. Boolean.

Syntax: Boolean := IRdaInventory.UseProm; or IRdaInventory.UseProm := True | False; Remarks:

Fields in the inventory table used for promotional prices will return null values if UseProm is set to false.

UseSroQ Property Returns or sets the use of sold, received and on order quantities in the RPro inventory. Boolean.

Syntax: Boolean := IRdaInventory.UseSroQ; or IRdaInventory.UseSroQ := True | False; Remarks:

Fields in the inventory table used for sold, received and on order quantities will return null values if UseSroQ is set to false.

ConnectItemToStyle Method Connects an inventory item to the same style as another inventory item.

Syntax: IRdaInventory.ConnectItemToStyle(ItemID, StyleItemID); Parameters:

ItemID – long – the item number of the item to be connected to an existing item’s style.

StyleItemID – long – the item number of an existing item.

DisconnectItemFromStyle Method Disconnects an item from its assigned style.

Syntax: IRdaInventory.DisconnectItemFromStyle(ItemID); Parameters:

ItemID – long – the item number of the item to be disconnected from a style.



StyleItems Method The StyleItems method accepts an inventory item number as a parameters and returns a one dimensional variant array containing the item numbers of all inventory items assigned to the same style.

Syntax: vntItems := IRdaInventory.StyleItems(ItemNum); Parameter:

ItemNum – long integer – the item number of the inventory item.

Remarks:

The item number passed as a parameter is included in the returned array. If there are no other items assigned to the same style, only the passed item number is returned in the array. The returned array is one-based (i.e. the first subscript will be 1).



IRdaSO Interface The IRdaSO object is used to add a deposit to a sales order. IRdaSO objects are created using the CustomInterface proprerty of an IRdaTable object created for the SOs table. Example.

Properties and Methods AddDeposit Method – Adds a deposit to a sales order.

AddDeposit Method AddDeposit is the only method of IRdaSO. Call this method to add a deposit to a sales order.

Syntax: IRdaSO.AddDeposit() Remarks:

There are no parameters for the AddDeposit method. AddDeposit adds a deposit to the sales order represented by the current record of the IRdaTable object to which the IRdaSO object is attached. It also creates a deposit receipt and automatically sets the receipt number and document date.

This method assumes that an SO deposit has been set up and is ready to be added to the sales order. Setting up a sales order deposit requires the use of the SODeposit nested document and the IRdaTender object as follows:

Create an IRdaTable object for the SOs table and open the table. Create an IRdaSO object using the CustomInterface property of the IRdaTable object. Set the current record of the IRdaTable object to the sales order to which the deposit should be added (or create a new sales order using the properties and methods of the IRdaTable object).

Create an IRdaDocument object for the SODeposit nested document using the NestedDocByName or NestedDocByID methods of the IRdaDocument for the IRdaTable SOs table object.

Create an IRdaTender object using the CustomInterface property of the IRdaDocument object for the SODeposit nested document.

Increment the Count property of the IRdaDocument for the SODeposit nested document and use the SetPositon method to set the “current record” of the SODeposit nested document to the Count property minus 1.

The SODeposit nested document has 6 fields: fldInvcNum, fldDocDate, fldCashier, fldAmount, fldTender and fldSODepoCancelled. Use the SetPosition methods (i.e. SetDouble, SetString, etc.) of the SODeposit nested document to set field values. Do NOT set the fldInvcNum (this will be the number of the receipt for the deposit).

The SO deposit requires tender information, i.e. a description of how the amount of the deposit is tendered. Create an XML string for an IRdaTender object using one of the tender types. Create an XML DOMDoucment and load the tender XML string into this document. Set the IRdaTender.XML to the tender XML document.

Call the AddDeposit method of the IRdaSO object.



IRdaVouTerms Interface The IRdaVouTerms object contains the description of the terms on purchase orders and vouchers or default terms for a vendor. IRdaVouTerms objects are created using the CustomInterface property of an IRdaDocument object that is linked to the Vendors, POs, Fromer Vouchers, Pending Vouchers or ASN Vouchers table (IRdaTable object).

Terms are described by combinations of date and/or percentages for a specific number of days (percent/day pairs). The Kind property is used to set or get the general type of terms (i.e. COD, EOM, etc.). The Date property is used to set or get a specific date.

Percent/Day Pairs Some types of terms are described using a percentage and a number of days. These are referred to as percent/day pairs. For example, a purchase order could have terms of 2% 10 days and net 30 days. There can be multiple percent/days pairs for a single IRdaVouTerms object. The pairs are accessed as an indexed list using the Get_PercentDays and Set_PercentDays methods of IRdaVouTerms. The list index is 1-based and the list consists of a Percent value and a Days value.

There is no way of directly determining how many pairs are in the list. However, if percent/days pairs are used for the description, there will always be a percent/day pair with a Days value of 0. This list entry indicates that there are no more percent/days pairs on the list.

Percent values are entered as the percentage itself as if the percent sign were appended. For example, 2% is entered as 2. Percent values of 0 indicate NET.

Examples Index Percent Days Notes

1 0 15 First entry, indicates NET 15 Days

2 0 0 Days = 0 indicates no more pairs in the list

Index Percent Days Notes

1 2 10 2 % for the first 10 days

2 0 30 Net due in 30 days

3 0 0 No more pairs in list

Also see Get the Terms of a Purchase Order and the RDA2ObjectModel VB project.



Properties and Methods Date Property – Returns or sets the date for terms.

Kind Property – Returns or sets the type of terms.

Split Property – Returns or sets the amount for one type of term for split terms on a voucher.

SplitTotal Property – Returns the total amount for all split terms on a voucher.

Get_PercentDays Method – Gets the values of a percent/day pair.

Set_PercentDays Method – Sets the value of a percent/day pair.

Date Property Sets or gets the terms date (as a date datatype) when the Kind property is vpPrePaid or vpDue. Example.

Syntax: IRdaVouTerms.Date := TermsDate; or TermsDate := IRdaVouTerms.Date;

Kind Property Sets or gets the kind of terms (i.e. COD, EOM, PrePaid, etc.). Example.

Syntax: TermsKind : IRdaVouTerms.Kind; or IRdaVouTerms.Kind := VouPaidID; Remarks:

VouPaidID is an enumerated constant list in RDA2 and indicates the kind of terms the IRdaVouTerms object describes. The Kind property determines if the Date property and the methods of IRdaVouTerms are active and valid or not as follows:

VouPaidID Value Date Property Percent Day/Pairs

vpDays 0 Unused Active

vpCOD 1 Unused Unused

vpCredit 2 Unused Unused

vpReplace 3 Unused Unused

vpPrePaid 4 Active Unused

vpDue 5 Active Unused

vpPays 6 Unused Active

vpEOM 7 Unused Active

vpSplit 8 Unused Unused



Split Property The Split property applies only to Vouchers and only when the Kind property is vpSplit. The Split property gets or sets the amounts that have been allocated to the different types of split terms. Amounts can be split between COD, Credit, Replacement, Prepaid and Due. The Split property is data type double.

Syntax: Amount := IRdaVouTerms.Split (Kind); or IRdaVouTerms.Split (Kind) := Amount; Parameters:

Kind – enumerated list – the vpPaidID for the Kind of terms within the split. In the case of the Split property, Kind must be one of vpCOD, vpCredit, vpReplace, vpPrePaid or vpDue. Splits returns the amount allocated to the Kind.

SplitTotal Property SplitTotal applies only to Vouchers and only when the Kind property is vpSplit. SplitTotal returns the total amount for all types of terms within the split. SplitTotal is datatype double and is read only.

Syntax: TotalAmount := IRdaVouTerms.SplitTotal;

Get_PercentDays Method The Get_PercentDays method returns the percentage/day pairs when the Kind property is set to vpDays, vpPays or vpEOM. Example.

Syntax: IRdaVouTerms.Get_Percent(Index, Percent, Days); Parameters:

Index – long integer – Index number for the percent/days pair returned by the method.

Percent – double – the percentage.

Days – long integer – number of days.

Remarks:

See additional information on percent/days pairs above.



Set_PercentDays Method The Set_PercentDays method sets a percentage/day pair when the Kind property is set to vpDays, vpPays or vpEOM.

Syntax: IRdaVouTerms.Set_Percent(Index, Percent, Days); Parameters:

Index – long integer – Index number for the percent/days pair to be set.

Percent – double – the percentage.

Days – long integer – number of days.

Remarks:

To change the value of an existing percent/day pair, set Index to the pair to be changed.

To add a new percent/day pair: If there are no exsiting pairs, use Set_PercentDays with Index = 1 for the first pair. If there are existing pairs, find the Index number with Days=0. Use Set_PercentDays with this Index number for the first pair to be added. After all new pairs have been added, use Set_PercentDays with Index equal to the highest Index already set plus 1 and Days = 0.

See additional information on Percent/Days pairs above.



IRdaTender Interface IRdaTender is used to set or get tender information for transactions involving currency. IRdaTender objects apply to invoices and sales order deposits.

IRdaTender objects for invoices are created using the CustomInterface property of an IRdaDocument object created from an IRdaTable object for the Invoices table. These IRdaTender objects can be used to get tender information for an existing receipt or set new tender information for a receipt.

IRdaTender objects for sales order deposits are created using the CustomInterface property of an IRdaDocument object that represents the SODeposit nested document.

Each entry (row) in the tender is accessible as a IRdaTenderItem object, depending of the type of tender this IRdaTenderItem object may be type casted into a more specific tender type object (IRdaStoreCredit, IRdaFC, IRdaCheck, IRdaCreditCard, IRdaCharge, IRdaPayments, or IrdaGift).

Add new tender entries with AddItem and delete entries with DeleteItem.

Properties and Methods AddItem Method – Adds a new tender item (tender row) to the tenders.

CreditCardIsRounded Property – True if credit card is a rounded tender in Retail Pro preferences.

DeleteItem Method – Removes a tender item (row) from the tenders.

RoundedUndefined Property – Same as Undefined but rounded based on rounding rules in Preferences.

Sum Property – Sum of all the tender items.

TenderItems Property – An IRdaCollection containing all tender items in current tender.

Undefined Property – Discrepancy amount between tender sum and receipt total.

XML Property – Sets or returns an XML document that contains the tender information.



AddItem Method Adds a new tender item (row) to the current document. The AType parameter determines what kind of tender is created.

Syntax: newTender := IrdaTender.AddItem (AType); Parameters:

AType – Integer (TenderType) – the type of tender to add.

Remarks:

The new tender item is returned as a Variant, receive it in a variable of type IUnknown and then typecast it to the correct Interface.

By default, the amount of the new tender item created is set equal to the Undefined amount to create a balanced tender. If you want to create a tender item with a different amount you have to explicitly set the IrdaTenderITem.Amount after you add it.

Example: var newTender := IUnknown; newCCTender := IrdaCreditCard; begin newTender := rdaTender.AddItem (ttCreditCard); newCCTender := newTender as IrdaCreditCard; newCCTender.CardNumber := ‘1234567891011121’; newCCTender.ExpMonth := 12; newCCTender.ExpYear := 2006; end;

CreditCardIsRounded Property Returns true if credit card is set as a rounded tender in Retail Pro preferences.

Syntax: blnRoundedCC := IRdaTender.CreditCardIsRounded;

DeleteItem Method Removes a tender item (row) from the tenders.

Syntax: IrdaTender.DeleteItem(Index); Parameters:

Index – Integer – The index (row) of the tender item to remove.



RoundedUndefined Property Same value is the Undefined property except it is rounded according to the rules set in Retail Pro preferences.

Syntax: dblRoundedUndefinedAmount := IRdaTender.RoundedUndefined;

Sum Property The total sum of all the tender items.

Syntax: dblSum := IRdaTender.Sum;

TenderItems Property Returns an IRdaCollection object of all tender items in the current tender.

Syntax: rcollTenderItems := IRdaTender.TenderItems; Remarks:

Typecast the tender item to an IRdaTenderItem interface, then check its TenderType property and possibly typecast it to a more specialized tender interface.

Example: var rcollTenderItems: IRdaCollection; intTenderITerator: Integer; tmpTenderItem: IUnknown; tenderItem: IRdaTenderItem; tenderPayments: IRdaPayments; begin rcollTenderItems := IRdaTender.TenderItems; for intTenderIterator := 0 to rcollTenderItems.length – 1 do begin tmpTenderItem := rcollTenderItems.item(intTenderIterator); tenderItem := tmpTenderItem as IRdaTenderItem; if tenderItem.TenderType = ttPayments then tenderPayments := tenderItem as IRdaPayments; end; end;

Undefined Property The un-tendered amount. Difference between the Sum property and the receipt total. This is how much you need to tender in order to make a balanced tender.

Syntax: dblUndefined := IRdaTender.Undefined;



XML Property Sets or returns a DOMDocument object containing the tender information. Example.

Syntax: IRdaTender.XML := xmlDoc; or xmlDoc := IRdaTender.XML; Remarks:

Do not use the tender XML to add or edit tender information, it is not reliable. Instead use the AddItem, DeleteItem methods and the TenderItemsProperty together with the other tender interfaces.



IRdaTenderItem Interface The IRdaTenderItem interface is used to get information about each tender item (row) in the tender. IRdaTender describes the tender as a whole, that can include one or more tender items for example for split tenders or change tenders etc.

Associated Data Types

Tender Type TenderType is an enumerated constant list in RDA2 and indicates the type of tender of a certain tender item. Since the tender as a whole can consist of several tenders (split tender) there is no tender type associated directly with the IRdaTender object. Note that TenderType is not the same value as the fidTender field of a receipt.

TenderTypeID Value Associated Tender Item Interface

ttCash 1 None

ttCOD 2 None

ttDeposit 3 None

ttStoreCredit 4 IRdaStoreCredit

ttFC 5 IRdaFC

ttCheck 6 IRdaCheck

ttCreditCard 7 IRdaCreditCard

ttCharge 8 IRdaCharge

ttPayments 9 IRdaPayments

ttGift 10 IRdaGift

ttGiftCard 11 IRdaCreditCard

ttDebitCard 12 IRdaCreditCard

Properties and Methods Amount Property – Gets or sets the amount of the tender item.

Desc Property – Tender item description (first column in Retail Pro tender screen).

Info Property – Tender item information (second column in Retail Pro tender screen).

TenderType – Returns the type of the tender item.



Amount Property The amount of the tender item.

Syntax: dblAmount := IRdaTenderItem.Amount; or IRdaTenderItem.Amount := dblAmount; Remarks:

When a new tender item is created, Amount is by default set to the IRdaTender.Undefined amount to create a balanced tender.

Desc Property This property gives you the same information about the tender item (row) that Retail Pro lists in the first column of the tender screen.

Syntax: strTenderDescription := IRdaTenderITem.Desc;

Info Property This property gives you the same information about the tender item (row) that Retail Pro lists in the second column of the tender screen.

Syntax: strTenderInformation := IRdaTenderITem.Info;

TenderType Property Returns the tender type of the tender item.

Syntax: ttTenderType := IRdaTenderItem.TenderType; Remarks:

Use this information to typecast the tender item to the correct tender interface if you need to get more information from it.



IRdaStoreCredit Interface Interface for store credit tender items. Type cast an IRdaTenderItem object of TenderType ttStoreCredit to this interface to access specific store credit information.

Properties and Methods InitStoreCreditID Method – Asks Retail Pro to generate a new store credit ID.

StoreCreditID Property – Gets or sets the store credit ID.

InitStoreCreditID Method Asks Retail Pro to generate a new store credit ID based on the system preferences.

Syntax: IRdaStoreCredit.InitStoreCreditID (blnIncrement); Parameters:

Increment – boolean – If set to true Retail Pro will take not the next available ID but increment it first.

StoreCreditID Interface Get or set the store credit ID.

Syntax: IRdaStoreCredit.StoreCreditID := strStoreCreditID; or strStoreCreditID := IRdaStoreCredit.StoreCreditID; Remarks:

You must set the store credit ID of a new tender item unless you call InitStoreCreditID to do that for you.



IRdaFC Interface Interface for foreign currency tender items. Type cast an IRdaTenderItem object of TenderType ttFC to this interface to access foreign currency specific tender information.

Properties and Methods FCName Property – The name of the foreign currency.

FCAmount Property – Tender item amount in the foreign currency.

FCName Property The name of the foreign currency. Must match a currency name defined in system properties.

Syntax: IRdaFC.FCName := strCurrencyName; or strCurrencyName := IRdaFC.FCName;

FCAmount Property The tender item amount in the foreign currency.

Syntax: IRdaFC.FCAmount := dblCurrencyAmount; or dblCurrencyAmount := IRdaFC.FCAmount; Remarks:

IRdaTenderItem.Amount is always the amount in the base currency.



IRdaCheck Interface Interface for check tender items. Type cast an IRdaTenderItem object of TenderType ttCheck to this interface to access check specific tender information.

Properties and Methods BankNumber Property – Not used.

CheckNumber Property – The check number.

CustomerName Property – Name of customer on check.

DateofBirth Property – D.O.B. of customer on check.

DriverLicenseNumber Property – Drivers license number.

StateCode Property – Drivers license issue state.

BankNumber Property Not used.

CheckNumber Property The number of the check being used. This is the sequence number on the check, not the account or routing numbers.

Syntax: IRdaCheck.CheckNumber := strCheckNo; or strCheckNo := IRdaCheck.CheckNumber;

CustomerName Property The customer name on the check.

Syntax: IRdaCheck.CustomerName := strCustomerName; or strCustomerName := IRdaCheck.CustomerName;



DateofBirth Property Date of Birth of the customer on the check.

Syntax: IRdaCheck.DateOfBirth := dtCustDOB; or dtCustDOB := IRdaCheck.DateOfBirth;

DriverLicenseNumber Property The drivers license number of the customer on the check.

Syntax: IRdaCheck.DriverLicenseNumber := strDriverLicenseNumber; or strDriverLicenseNumber := IRdaCheck.DriverLicenseNumber;

StateCode Property The state code of the state where the customer’s drivers license was issued.

Syntax: IRdaCheck.StateCode := strStateCode; or strStateCode := IrdaCheck.StateCode;



IRdaCreditCard Interface Interface for credit card tender items. Type cast an IRdaTenderItem object of TenderType ttCreditCard to this interface to access credit card specific tender information.

Properties and Methods AuthorizationNum Property – An authorization number returned by the card processor.

CardNumber Property – The credit card account number.

CardType Property – The credit card type.

ControlNum Property – A control number returned by the card processor.

ExpMonth Property – Month portion of the card expiration date.

ExpYear Property – Year portion of the card expiration date.

ReferenceNum Property – A reference number returned by the card processor.

AuthorizationNum Property An authorization number usually returned by the credit card processor after transaction has been approved.

Syntax: IRdaCreditCard.AuthorizationNum := ‘1234567890’; or strAuthNo := IRdaCreditCard.AuthorizationNum;

CardNumber Property The credit card account number.

Syntax: IRdaCreditCard.CardNumber := ‘1111222233334444’; or strCardNo := IRdaCreditCard.CardNumber;



CardType Property The credit card type i.e. VISA, Master Card, etc.

Syntax: IRdaCreditCard.CardType := ‘VISA’; or strCardType := IrdaCreditCard.CardType; Remarks:

The credit card type is often set automatically by the card processor when the transaction is sent for approval.

ControlNum Property A control number usually returned by the credit card processor after transaction has been approved.

Syntax: IRdaCreditCard.ControlNum := ‘12345’; or strCtrlNo := IRdaCreditCard.ControlNum;

ExpMonth Property Syntax: IRdaCreditCard.ExpMonth := 12; or intExpMonth := IRdaCreditCard.ExpMonth;

ExpYear Property Syntax: IRdaCreditCard.ExpYear := 2006; or intExpYear := IRdaCreditCard.ExpYear;

ReferenceNum A reference number usually returned by the credit card processor after transaction has been approved.

Syntax: IRdaCreditCard.ReferenceNum := ‘123456789’; or strRefNo := IrdaCreditCard.ReferenceNum;



IRdaCharge Interface Interface for charge tender items. Type cast an IRdaTenderItem object of TenderType ttCharge to this interface to access charge specific tender information. Often with a charge account the customer receives a small discount if the full balance is paid within a certain number of days.

Properties and Methods DiscountDays Property – The number of days during which the customer can receive a discount.

DiscountPercent Property – The discount percentage available for the above number of days.

NetDays Property – The number of days until full balance is due.

DiscountDays Property If the customer pays the balance in full within this number of days, the customer will receive the discount specified in the DiscountPercent Property.

Syntax: IRdaCharge.DiscountDays := 30; or intDiscountDays := IrdaCharge.DiscountDays; Remarks:

Can be zero when no discount will be given.

DiscountPercent Property The percentage of discount that will be given to the customer if he/she pays the balance in full within DiscountDays days.

Syntax: IRdaCharge.DiscountPercent := 10; or intDiscountPercent := IrdaCharge.DiscountPercent; Remarks:

Can be zero when no discount will be given.



NetDays Property The number of days that the customer has to pay the balance in full.

Syntax: IRdaCharge.NetDays := 90; or intNetDays := IrdaCharge.NetDays;



IRdaPayments Interface Interface for payments tender items. Type cast an IRdaTenderItem object of TenderType ttPayments to this interface to access payments specific tender information.

Properties and Methods NumOfPayments Property – The number of payments to be made.

PaymentAmount Property – The amount of each payment.

StartingDate Property – The starting date of the payment schedule.

NumofPayments Property The number of payments that needs to be made to pay the balance in full.

Syntax: IRdaPayments.NumOfPayments := 10; or intNumOfPayments := IRdaPayments.NumOfPayments;

PaymentAmount Property The amount of each payment to be made.

Syntax: IRdaPayments.PaymentAmount := 39.95; or dblPaymentAmt := IRdaPayments.PaymentAmount;

StartingDate Property The date on which the first payment is due.

Syntax: IRdaPayments.StartingDate := Now + 10; //Sets starting date to 10 days from now. or dtPaymentStartDate := IrdaPayments.StartingDate;



IRdaGift Interface Interface for gift tender items. Type cast an IRdaTenderItem object of TenderType ttGift to this interface to access gift specific tender information.

Properties and Methods GiftNumber Property – The gift certificate number.

InitGiftNumber Method – Asks Retail Pro to generate a new store credit ID.

GiftNumber Property Get or set the gift certificate number.

Syntax: IRdaGift.GiftNumber := ‘1234567890’; or strGiftNum := IRdaGift.GiftNumber ; Remarks:

You must set the gift certificate number of a new tender item unless you call InitGiftNumber to do that for you.

InitGiftNumber Method Asks Retail Pro to generate a new gift certificate number based on the system preferences.

Syntax: IRdaGift.InitGiftNumber (blnIncrement); Parameters:

Increment – boolean – If set to true Retail Pro will take not the next available number but increment it first.



IRdaCollection Interface IRdaCollection is an object containing an array of variants. It is used in the RDA2 object model to contain various types of lists.

Properties and Methods Item Method – Gets or sets the value of an item in the collection.

Length Property – Returns the number of items in the collection.

Item Method Returns the number of items in the collection as a long integer. Read only.

Syntax: intItems := IRdaCollection.Length;

Length Property Returns the value of an item in the IRdaCollection object. The value is a variant data type.

Syntax: varIndex := IRdaCollection.Item(Index); Parameters:

Index - long integer – the index of the item. (Index is 0 based).



RDA2 Table Information

Table ID Numbers and Names ID Table Name TDBTables

1 Departments tblDepartmetns

2 Customers tblCustomers

3 Vendors tblVendors

4 Items tblItems

5 Invoices tblInvoices

6 POs tblPOs

7 SOs tblSOs

8 Former Vouchers tblFrmrVouchers

9 Pending Vouchers tblPendVouchers

10 ASN Vouchers tblASNVouchers

11 Memos tblMemos

12 Slips tblSlips

13 SubLocDefs tblSubLocDefs

14 SubLocsQtys tblSubLocs

15 MovNotes tblMovNotes

16 MovOrders tblMovOrders

17 TOs tblTOs

*TDBTables is an enumerated list of constants in RDA2. The TDBTables constants can be used in the CreateTableByID method of IRdaTable.

Table Indexes Indexes marked with * are the default indexes that are active when a table is opened. ‘Default Order’ is an index that uses the Bookmark order of the table as an index. (See Bookmark property of the IRdaTable object). This information applies to ActiveIndexName and ActiveIndexID properties of the IRdaTable object.



Departments Index ID Index Name RDA2 Constant

1 DCS* idxDeptsDC

2 DCS Name idxDeptsName

Customers Index ID Index Name RDA2 Constant

1 Last* idxCustLName

2 Customer SID idxCustSID

4 Phone idxCustPhone

6 Cust ID idxCustID

7 Company idxCustCompany

8 Info idxCustInfo

9 Mark

10 UDF 1 idxCustUDF0










Vendors Index ID Index Name RDA2 Constant

1 Vend Code* idxVndrCode

2 Company idxVndrCompany

3 Last idxVndrLName

4 Phone idxVndrPhone

5 Info idxVndrInfo

6 UDF 1 idxVndrUDF0

7 UDF 2 idxVndrUDF1

8 UDF 3 idxVndrUDF2

9 UDF 4 idxVndrUDF3

10 UDF 5 idxVndrUDF4




Items Index ID Index Name RDA2 Constant

-1 Item #* idxItemsRecNo

1 UPC idxItemsUPC

2 DCS/Vend Code/Desc 1 idxItemsDC

3 ALU idxItemsALU

4 -User Defined Index- idxItemsUDI0

5 -User Defined Index- idxItemsUDI1

7 Style SID



Invoices Index ID Index Name RDA2 Constant

-1 Default Order

1 Receipt #

2 Cust.(Company Priority)

3 Bill To Cust #

5 SO Number

6 St/Sta/Cashier

7 St/Sta/Ws/Date

11 Bill To Cust. SID

12 Cust.(Name priority)

POs Index ID Index Name RDA2 Constant

1 PO# idxPOrdNumber

2 SO Number

3 Vend Code

5 Associate

6 Ord Date

7 Ship

8 Cancel

9 Last Act. D.



SOs Index ID Index Name RDA2 Constant

1 Store/SO Number

7 SO Number idxSOrdNumber

3 Cust PO#

4 Bill To L.Name

5 Ship To L.Name

9 Associate

10 Bill To Company

11 Ship To Company

13 Cancel Date

14 Ordered Date

15 Ship Date

Former Vouchers Index ID Index Name RDA2 Constant

-1 Default Order

1 Voucher #

2 Vend Code

3 PO #

4 Date

6 Associate

7 Post Date

9 Package #

10 Invoice #



Pending Vouchers Index ID Index Name RDA2 Constant

-1 Default Order

1 Voucher #

2 Vend Code

3 PO #

4 Date

6 Associate

7 Post Date

9 Package #

10 Invoice #

ASN Vouchers Index ID Index Name RDA2 Constant

-1 Default Order

1 Voucher #

2 Vend Code

3 PO #

4 Date

6 Associate

7 Post Date

9 Package #

10 Invoice #



Memos Index ID Index Name RDA2 Constant

-1 Default Order

1 Memo #

2 Associate

3 Date

4 Source

5 Prc Lvl

6 Type

Slips Index ID Index Name RDA2 Constant

-1 Default Order

1 Memo #

2 Associate

3 Date

4 Source

5 Prc Lvl

6 Type

SubLocDefs Index ID Index Name RDA2 Constant

1 Sub-Loc ID

2 Store

3 Sub-Loc Name



SubLocQtys Index ID Index Name RDA2 Constant

1 Item SID

2 Item #

3 Sub-Loc ID

4 Sub-Loc Name

5 Last Rcvd

MovNotes Index ID Index Name RDA2 Constant

-1 Default Order

1 Number

2 Date

3 Store

4 Associate

5 SID

6 Ref Doc #

7 UDF1

8 UDF2

9 UDF3

10 UDF4

11 Shipment Number

12 Carton Number

13 Type

14 Note Source



MovOrders Index ID Index Name RDA2 Constant

1 MO Number

2 Date

3 Store

4 Associate

5 SID

6 UDF1

7 UDF2

8 UDF3

9 UDF4

10 Shipment Number

11 Carton Number

12 Movement Date

13 Priority

TOs Index ID Index Name RDA2 Constant

1 TO # idxTOrdNumber

2 PO #

3 Associate



Nested Document Names and ID Numbers (Applies to the NestedDocByID and NestedDocByName properties of the IRdaDocument object).

Nested Document ID Nested Document Name TDBNestedTables Enum* Parent IRdaTable Name

100 POItem ntblPOItems POs

101 ReceiptItem ntblInvoiceItems Invoices

102 SOItem ntblSOItems SOs

103 SODeposit ntblSODeposits SOs

104 SOHistory ntblSOHistory SOs

105 VoucherItem ntblVoucherItems Former Vouchers Pending Vouchers ASN Vouchers

106 MemoItem ntblMemoItems Memos

107 SlipItem ntblSlipItems Slips

108 MoveNoteItem ntblMovNoteItems MovNotes

109 MoveOrderItem ntblMovOrdItems MovOrders

110 TOItem ntblTOItems TOs

*TDBNestedTables is an enumerated constant list in RDA2. TDBNestedTable constants may be used in the NestedDocByID property of IRdaDocument.



Table Schemas (Applies to FieldByID and FieldByName methods of the IRdaDocument object.)

Departments RDA2 Constant ID# Name Type Size Caption Description

fidDC1 50 fldDept String 1 Dept Department

fidClass 51 fldClass String 1 Class Class

fidSubClass 52 fldSubClass String 1 Subclass Subclass

fidDC 2 fldDCS String 9 DCS Full Department Code

fidTax 49 fldTaxCd Enumerated 0 Tax Tax Code

fidCoeff 115 fldCoeff Double 0 Coef Coefficient

fidQuantityDecimals 200 fldDecimals Boolean 0 Qty Decimals Quantity Decimals

fidAllocPttrn 201 fldAllocPttrn String 20 Alloc Pattern Allocation Pattern

fidDeptName 3 fldDCSName String 30 DCS Name Full Department Name

fidMrgP 13 fldDefMgnPrc Integer 0 Mrg% Default Margin %

fidMupP 104 fldDefMkUpPrc Integer 0 MkUp% Default Mark Up %

fidDeptPicture 209 fldDeptPicture String 20 Department Image Department Image

fidDeptName10 29 fldDeptName String 10 Dept Name Department Name

fidClassName10 30 fldClassName String 10 Class Name Class Name

fidSubClassName10 31 fldSubClassName String 10 Sub-class Name Sub-class Name

fidPureDCS 7222 fldPureDCS String 9 Internal DCS code Internal unformatted DCS code



Customers RDA2 Constant ID# Name Type Size Caption Description

fidCustID 236 fldCustID Integer 0 Cust ID Customer ID

fidCustCompany 210 fldCompany String 25 Company Company Name

fidCustTitle 211 fldTitle String 15 Title Title

fidCustFName 212 fldFName String 30 First First Name

fidCustLName 213 fldLName String 30 Last Last Name

fidCustAddr1 214 fldAddr1 String 31 Address 1 Address 1



fidCustZIP 217 fldZIP String 10 ZIP ZIP Code

fidCustPhone1 218 fldPhone1 String 15 Phone 1 Telephone 1

fidCustPhone2 219 fldPhone2 String 15 Phone 2 Telephone 2

fidCustInfo1 221 fldInfo1 String 20 Info 1 Information 1

fidCustInfo2 222 fldInfo2 String 20 Info 2 Information 2

fidCustShare 238 fldShare Enumerated 0 Share Sharing Status

fidCustAR 239 fldCliAR Enumerated 0 AR Accounts Receivable

fidCustAcptChks 240 fldAccChk Boolean 0 Checks Accept Checks

fidCustStoreCr 241 fldStCred Double 0 Store Credit Store Credit

fidCustCredLim 242 fldCredLim Double 0 Chrg Limit Charge Limit

fidCustCredUsed 243 fldCredUsed Double 0 Chrg Bal Charge Balance

fidCustLastSale 244 fldLastSale Date 0 Last Sale Last Sale Date

fidCustUDF0 224 fldCntUDF0 Date 0 UDF 1 User-Defined Field 1

-None- 225 fldCntUDF1 Date 0 UDF 2 User-Defined Field 2

-None- 226 fldCntUDF2 String 20 UDF 3 User-Defined Field 3





fidCustUDF7 231 fldCntUDF7 String 20 UDF 8 User-Defined Field 8

fidCustSearchPhone 220 fldSrchPhone String 15 Phone Telephone

fidCustSearchInfo 223 fldSrchInfo String 20 Info Information

fidTaxArea 54 fldTaxArea String 11 Tax Area Tax Area

fidCustomerPicture 247 fldCustomerPicture String 20 Customer Image Customer Image



RDA2 Constant ID# Name Type Size Caption Description

fidCustSID 245 fldCustSID Int64 0 Customer SID Customer System ID

fidStoreStation 563 fldStoreStatn String 4 Str/Sta Store and Station

fidPrcLvl 107 fldPrcLvl Enumerated 0 Prc Lvl Price Level

fidCustMark1 248 fldCustMark1 String 4 Mark 1 Mark 1

fidCustMark2 249 fldCustMark2 String 4 Mark 2 Mark 2

fidCustSrchMark 250 fldCustSrchMark String 4 Mark Mark

fidCustDetax 251 fldCustDetax Boolean 0 Export Export

fidFullName 235 fldFullName String 0 Full Name Full Name

fidCustInactive 270 fldCustInactive Boolean 0 Inactive Inactive

fidCustAux0 280 fldCustAux0 Enumerated 0 Aux 1 Auxiliary field 1

-None- 281 fldCustAux1 Enumerated 0 Aux 2 Auxiliary field 2










fidCustAux11 291 fldCustAux11 Enumerated 0 Aux 12 Auxiliary field 12

fidCustDiscPercentAlwd 292 fldCustDiscPerce

ntAlwd Double 0 Customer Disc % Customer discount percent

fidCustSysDate 293 fldCustSysDate Date 0 Customer System Date Customer System Date

fidCustNotes 232 fldCustNotes String 245 Cust.Notes Cust.Notes

fidEMail 237 fldEMail String 60 E-Mail E-Mail address

fidTaxArea2 7005 fldTaxArea2 String 11 Tax Area 2 Tax Area 2

fidCustMarkedForDeletion 294 fldCustMarkedF

orDeletion Boolean 0 Marked For Deletion Marked For Deletion



Vendors RDA2 Constant ID# Name Type Size Caption Description

fidVndrCompany 210 fldCompany String 25 Company Company Name

fidVndrTitle 211 fldTitle String 15 Title Title

fidVndrFName 212 fldFName String 30 First First Name

fidVndrLName 213 fldLName String 30 Last Last Name

fidVndrAddr1 214 fldAddr1 String 31 Address 1 Address 1



fidVndrZIP 217 fldZIP String 10 ZIP ZIP Code

fidVndrPhone1 218 fldPhone1 String 15 Phone 1 Telephone 1


fidVndrInfo1 221 fldInfo1 String 20 Info 1 Information 1


fidVndrNotes 232 fldNotes String 245 Vendor Notes Vendor Notes

fidVndrAccNum 233 fldAccNum String 10 Acct # Account Number

fidVndrAP 234 fldVndAP Enumerated 0 AP Accounts Payable

fidVndrUDF0 224 fldCntUDF0 Date 0 UDF 1 User-Defined Field 1

-None- 225 fldCntUDF1 Date 0 UDF 2 User-Defined Field 2






fidVndrUDF7 231 fldCntUDF7 String 20 UDF 8 User-Defined Field 8

fidVndrSearchPhone 220 fldSrchPhone String 15 Phone Telephone

fidVndrSearchInfo 223 fldSrchInfo String 20 Info Information

fidVC 4 fldVendorCode String 3 Vend Code Vendor Code

fidVouPaid 516 fldVouTerms String 0 Terms Payment Terms

fidVndrPicture 246 fldVendorPicture String 20 Vendor Image Vendor Image

fidTradeDiscPercent 194 fldTradeDiscPercent Double 0 Trade Discount % Trade Discount %

fidEMail 237 fldEMail String 60 E-Mail E-Mail address



Items RDA2 Constant ID# Name Type Size Caption Description



fidDesc1 5 fldDesc1 String 16 Desc 1 Description 1


fidAttr 6 fldAttr String 4 Attr Attribute

fidSIZE 7 fldSize String 4 Size Size

fidUPC 9 fldUPC String 13 UPC UPC

fidALU 166 fldALU String 20 ALU Alternate Look Up

fidUsrCd0 146 fldUDF0 Enumerated 0 UDF 1 User-Defined Field 1




fidCommCod 181 fldCommCod Integer 0 Comm Code Commission Code

fidSPIF 182 fldSPIF Double 0 SPIF Sales Person Incentive Fee


fidInvenFlag 127 fldFlag Enumerated 0 Flag Inventory Flag

fidEDIStatus 109 fldEDI Enumerated 0 EDI EDI Status

fidPromoPrc 145 fldPlnPrc Boolean 0 Plan Price Planned Price Flag

fidDateRcvd 14 fldLRecvD Date 0 Last Rcvd Last Received Date

fidDateSold 15 fldLSoldD Date 0 Last Sold Last Sold Date

fidFDateRcvd 66 fldFRecvD Date 0 First Rcvd First Received Date

fidDateMarked 173 fldLMrkDnD Date 0 Last MkDn Last Markdown Date

fidDateDiscon 176 fldDiscD Date 0 Discont Date Discontinue Date

fidInvnPrc 11 fldPrice Double 0 Inven P$ Inventory Price

fidInvnCost 12 fldCost Double 0 Cost Cost

fidMrgD 69 fldMgn Double 0 Margin $ Margin Amount

fidMrgP 13 fldMgnPrc Integer 0 Mrg% Margin %


fidTaxP 118 fldTaxPrc Double 0 Tax % Tax %

fidTaxAmt 119 fldTax Double 0 Tax $ Tax Amount

fidQTY 10 fldQty Double 0 Qty Quantity

fidLastCost 16 fldOrdCost Double 0 Ord C$ Order Cost




fidFrmrPrc 17 fldFrmrPrc Double 0 Frmr P$ Former Price

fidMin 55 fldMin Double 0 Min Minimum

fidMax 56 fldMax Double 0 Max Maximum

fidInvnPWT 116 fldPrcWTx Double 0 Inven P$T$ Inventory Price with Tax

fidMrgT 70 fldMrgWTx Double 0 M$T$ Margin with Tax

fidFrmrPWT 128 fldFrmrPrcWTx Double 0 Frmr P$T$ Former Price with Tax

fidUnitsPerCase 135 fldUnitsCase Integer 0 Units/Case Units/Case

fidQtyCas 136 fldCaseQty Double 0 Case Qty Case Quantity

fidNumberOfDecimals 202 fldNDecimals Integer 0 Qty Decimals Number of Decimals

fidPrtTag 184 fldPrintTags Boolean 0 Tags Print Tags


fidMupP 104 fldMkUpPrc Integer 0 MkUp% Mark Up %

fidTotO_H 18 fldTotOnHnd Double 0 Cmp Qty Company Quantity

fidTotO_O 19 fldTotOnOrder Double 0 Cmp On Ordr Company On Order

fidTotRcvd 20 fldTotRcvd Double 0 Cmp Rcvd Company Received

fidTotSold 21 fldTotSold Double 0 Cmp Sold Company Sold

fidStrOrd 101 fldStrOnOrder Double 0 Str On Ordr Store On Order

fidStrRcvd 102 fldStrRcvd Double 0 Str Rcvd Store Received

fidStrSold 100 fldStrSold Double 0 Str Sold Store Sold

fidStyleSid 207 fldStyleSID Int64 0 Style SID Style SID

fidStylePicture 204 fldStylePicture String 20 Style Image Style Image

fidItemNo 1 fldItemNum Integer 0 Item # Item Number

fidItemSID 208 fldItemSID Int64 0 Item SID Item SID

fidItemPicture 199 fldItemPicture String 20 Item Image Item Image

fidFC1Prc 177 fldFC1Prc Double 0 FC1 P$ Foreign Currency 1 Price

fidFC1PWT 178 fldFC1PrcWTx Double 0 FC1 P$T$ Foreign Currency 1 Price with Tax

fidFC1TaxAmt 179 fldFC1Tx Double 0 FC1 T$ Foreign Currency 1 Tax Amount

fidItemScale 205 fldItemScale Enumerated 0 Scale Item Scale

fidSchedNo 175 fldDscSch Integer 0 Promo # Promotional Pricing Number

fidDC1 50 fldDept String 1 Dept Department

fidClass 51 fldClass String 1 Class Class

fidSubClass 52 fldSubClass String 1 Subclass Subclass

fidCmpMin 57 fldCmpMin Double 0 Cmp Min Company Minimum




fidCmpMax 58 fldCmpMax Double 0 Cmp Max Company Maximum



fidInvnUDFStr 75 fldInvnUDFStr String 20 UDF Name User-Defined Name

fidInvnAux0 78 fldInvnAUX0 Enumerated 0 Aux 1 Auxiliary Field 1

-None- 79 fldInvnAUX1 Enumerated 0 Aux 2 Auxiliary Field 2







fidInvnUDFDate 87 fldInvnUDFDate Date 0 UDF Date User-Defined Date

fidInvnFrstPrc 195 fldInvnFrstPrc Double 0 First P$ First Price

fidInvnFrstPWT 196 fldInvnFrstPWT Double 0 First P$T$ First Price with Tax

fidInvnSerialFlg 88 fldInvnSerialFlg Enumerated 0 Serial Serial Item Flag

fidFCC 89 fldFCC Double 0 FOC$ Foreign Order Cost

fidFCCType 90 fldFCCType Enumerated 0 FOC$ Type Foreign Order Cost Type

fidMaxDisc1 97 fldMaxDisc1 Double 0 Max Discount Percentage 1 Max Discount Percentage 1

fidMaxDisc2 98 fldMaxDisc2 Double 0 Max Discount Percentage 2 Max Discount Percentage 2

fidVndrListCst 193 fldVndrListCst Double 0 Vendor List Cost Vendor List Cost


fidInvnCostCode 36 fldCostCode String 0 Cost Code Cost Code

fidLastRcvdCode 37 fldLRcvdCode String 0 Last Rcvd Code Last Received Code

fidKitItemType 96 fldKitItemType Enumerated 0 Kit Item Type Kit Item Type

fidNonInventory 1099 fldNonInventory Boolean 0 Non-Inventory Non-Inventory

fidCommitted 1097 fldCommitted Boolean 0 Committed Committed

fidDocLastEdit 569 fldDocLastEdit Date 0 Last Edit Last Edit

fidSaleDiscPercent 1123 fldSaleDiscPercent Double 0 Sale Disc % Sale Disc %

fidSaleDisc 1124 fldSaleDisc Double 0 Sale Disc $ Sale Disc $

fidTotalTaxAmt 7003 fldTotalTax Double 0 Total Tax $ Total Tax Amount

fidTax2Prc 7000 fldTax2Prc Double 0 Tax 2 % Tax 2 Percent

fidTax2Amt 7001 fldTax2 Double 0 Tax 2 $ Tax 2 Amount




fidAltTax2 7004 fldTax2Cd String 0 Tax Code 2 Tax Code 2

fidAltTax1 7002 fldTax1Cd String 0 Tax Code Tax Code



Invoices RDA2 Constant ID# Name Type Size Caption Description

fidInvcHdrNotes 350 fldInvcHdrNotes String 7 Notes Receipt Header Notes




fidDiscPercent 500 fldDiscPrc Double 0 Disc % Discount %

fidDisc 34 fldDiscount Double 0 Disc $ Discount Amount

fidShipping 505 fldShipping Double 0 Shipping Shipping

fidFee 508 fldFee Double 0 Fee Fee Amount

fidInvcComment1 371 fldInvcComment1 String 25 Comment 1 Receipt Comment 1

fidInvcComment2 372 fldInvcComment2 String 25 Comment 2 Receipt Comment 2


fidShippingPercent 504 fldShippingPrc Double 0 Shipping % Shipping %

fidFeeType 506 fldFeeType String 6 Fee Type Fee Type

fidFeeTaxPercent 507 fldFeeTaxPrc Double 0 Fee Tax % Fee Tax %

fidTaxOnFeeShip 509 fldTaxOnFeeShip Double 0 Tax On Fee/Ship Tax On Fee/Ship

fidTaxRebatePercent 510 fldTaxRebatePrc Double 0 Tax Rebate % Tax Rebate %

fidTaxRebate 511 fldTaxRebate Double 0 Tax Rebate Tax Rebate Amount

fidInvcRoundAmt 375 fldInvcRoundAmt Double 0 Round $ Receipt Round Amount

fidInvcTotalRoundAmt 376 fldInvcTotalRoundAmt Double 0 Total+Round $ Receipt Total Plus Round Amount

fidItemsCount 512 fldItemsCount Integer 0 No of Items Items Count

fidInvcTotalOfLineDisc 377 fldInvcTotalOfLineDisc Double 0 Total of Line Disc Receipt Total of Line Discount

fidInvcHdrRcptStatus 378 fldInvcHdrRcptStatus Enumerated 0 Receipt Status Receipt Status

fidInvcHdrRcptType 379 fldInvcHdrRcptType Enumerated 0 Receipt Type Receipt Type

fidCashier 517 fldCashier String 8 Cashier Cashier

fidDocDate 518 fldDocDate Date 0 Date Document Date

fidInvcNum 560 fldInvcNum Integer 0 Receipt # Receipt Number

fidClerk 65 fldClerk String 8 Associate Associate

fidBillToCustID 520 fldBillToCustNumber String 0 Bill To Cust # Bill To Customer Number

fidBillToCustComp 521 fldBillToCustCompany String 25 Bill To Company Bill To Company

fidBillToCustFName 523 fldBillToFName String 30 Bill To F.Name Bill To First Name

fidBillToCustLName 522 fldBillToLName String 30 Bill To L.Name Bill To Last Name

fidBillToCustTitle 524 fldBillToTitle String 15 Bill To Title Bill To Title




fidBillToAddr1 525 fldBillToAddr1 String 31 Bill To Address 1 Bill To Address 1



fidBillToZip 528 fldBillToZip String 10 Bill To ZIP Bill To ZIP

fidBillToInfo1 531 fldBillToInfo1 String 20 Bill To Info 1 Bill To Info 1


fidShipToCustID 540 fldShipToCustNumber String 0 Ship To Cust # Ship To Customer Number

fidShipToCustComp 541 fldShipToCustCompany String 25 Ship To Company Ship To Company

fidShipToCustFName 543 fldShipToFName String 30 Ship To F.Name Ship To First Name

fidShipToCustLName 542 fldShipToLName String 30 Ship To L.Name Ship To Last Name

fidShipToCustTitle 544 fldShipToTitle String 15 Ship To Title Ship To Title

fidShipToAddr1 545 fldShipToAddr1 String 31 Ship To Address 1 Ship To Address 1



fidShipToZip 548 fldShipToZip String 10 Ship To ZIP Ship To ZIP

fidShipToInfo1 551 fldShipToInfo1 String 20 Ship To Info 1 Ship To Info 1


fidBillToCustSID 533 fldBillToCustSID Int64 16 Bill To Cust. SID Bill To Customer SID

fidShipToCustSID 553 fldShipToCustSID Int64 16 Ship To Cust. SID Ship To Customer SID

fidSubTotal 564 fldSubtotal Double 0 SubTotal SubTotal

fidTotal 565 fldTotal Double 0 Total Total

fidBillToFullName 536 fldBillToFullName String 0 Bill To Full Name Bill To Full Name

fidShipToFullName 556 fldShipToFullName String 0 Ship To Full Name Ship To Full Name

fidWorkstation 501 fldWorkstation Integer 0 Wks Workstation

fidDocTime 502 fldDocTime Date 0 Time Document Time

fidBillToSC 537 fldBillToSC Double 0 St. Credit Bill To Store Credit

fidBillToChks 538 fldBillToChks Boolean 0 Checks Bill To Checks

fidSONum 600 fldSONumber String 14 SO Number SO Number

fidSOType 609 fldSOType Enumerated 0 SO Type SO Type

fidBillToPicture 557 fldBillToPicture String 20 Bill To Image Bill To Image

fidShipToPicture 558 fldShipToPicture String 20 Ship To Image Ship To Image


fidFlag1 575 fldFlag1 Enumerated 0 Flag 1 Flag 1






fidGL 578 fldGL Boolean 0 GL General Ledger

fidAR1 579 fldAR1 Boolean 0 AR Accounts Receivable

fidPR 582 fldPR Boolean 0 PR Payroll

fidInvcIdx2 381 fldInvcIdx2 String 53 Cust.(Company priority) Customer (Company priority)

fidInvcIdx12 382 fldInvcIdx12 String 53 Cust.(Name priority) Customer (Name priority)

fidBillToPhone1 529 fldBillToPhone1 String 15 Bill To Phone 1 Bill To Phone 1


fidShipToPhone1 549 fldShipToPhone1 String 15 Ship To Phone 1 Ship To Phone 1


fidBusCon 591 fldBusCon Enumerated 0 Business/Consumer Business/Consumer

fidCustPONumber 601 fldSOCustPONumber String 10 Cust PO # Customer Purchase Order Number

fidStoreHeading1 585 fldStoreHeading1 String 40 Store Heading 1 Store Heading 1



fidInvcIdx7 383 fldInvcIdx7 String 0 St/Sta/Ws/Date Store/Station/Workstation/Date

fidTender 519 fldTender Enumerated 0 Tender Tender

fidInvcIdx6 384 fldInvcIdx6 String 0 St/Sta/Cashier Store/Station/Cashier

fidStore 53 fldStore String 3 Store Store

fidStation 48 fldStation String 1 Station Station


fidTransmitted 823 fldTransmitted Boolean 0 Transmitted Transmitted


fidDocPostDate 568 fldDocPostDate Date 0 Post Date Post Date

fidTrackingNum 652 fldTrackingNum String 24 Tracking # Tracking Number

fidCustCredLim 242 fldCredLim Double 0 Chrg Limit Charge Limit

fidRefDocNum 300 fldRefDocNum String 0 Reference Doc # Reference Doc Number

fidRefDocPostDt 301 fldRefDocPostDt Date 0 Reference Post Date Reference Post Date

fidTotalQty 597 fldInvcTotalQty Double 0 Total Qty Sold Total Quantity Sold

fidCustCredUsed 243 fldCredUsed Double 0 Chrg Bal Charge Balance

fidFC1Total 1110 fldTotalFC1 Double 0 FC1 Total Foreign Currency 1 Total








fidExtOrigPrice 61 fldExtOrigPrc Double 0 Ext. Orig. Price Extened Original Price

fidOrigStoreStation 1121 fldOrigStoreStatn String 4 Orig. Str/Sta Originating Store and Station

fidAudited 1122 fldAudited Boolean 0 Audited Audited





fidDefSubLoc 1127 fldDefSubLoc String 12 Default Sub-Location Default sub-location

fidMovNoteShipNum 1128 fldMovNoteShipNum String 9 Movement Note Shipment# Movement note shipment number

fidWSSeqNo 1129 fldSeqWSNo Integer 0 WS Seq # WS Seq #

fidDataOrigin 1131 fldDataOrigin Enumerated 0 Data Origin Data Origin

fidChargeDueDate 1132 fldChargeDueDate Date 0 Charge Due Date Charge Due Date

fidSubTotalWithoutTax 562 fldSubTotalWithoutTax Double 0 Subtotal w/o Tax Subtotal w/o Tax

fidShipToAux11 7211 fldShipToAux12 Enumerated 0 Ship To Aux 12 Auxiliary field 12

-None- 7210 fldShipToAux11 Enumerated 0 Ship To Aux 11 Auxiliary field 11











fidBillToAux11 7111 fldBillToAux12 Enumerated 0 Bill To Aux 12 Auxiliary field 12

-None- 7110 fldBillToAux11 Enumerated 0 Bill To Aux 11 Auxiliary field 11














fidBillToUDF7 7120 fldBillToUDF8 String 20 Bill To UDF 8 User-Defined Field 8

-None- 7119 fldBillToUDF7 String 20 Bill To UDF 7 User-Defined Field 7





-None- 7114 fldBillToUDF2 Date 0 Bill To UDF 2 User-Defined Field 2

fidShipToUDF7 7220 fldShipToUDF8 String 20 Ship To UDF 8 User-Defined Field 8

-None- 7219 fldShipToUDF7 String 20 Ship To UDF 7 User-Defined Field 7





-None- 7214 fldShipToUDF2 Date 0 Ship To UDF 2 User-Defined Field 2

fidBillToUDF0 7113 fldBillToUDF1 Date 0 Bill To UDF 1 User-Defined Field 1

fidShipToUDF0 7213 fldShipToUDF1 Date 0 Ship To UDF 1 User-Defined Field 1

fidBillToEMail 534 fldBillToEMail String 60 Bill To E-Mail Bill To E-Mail address

fidShipToEMail 554 fldShipToEMail String 60 Ship To E-Mail Ship To E-Mail address

fidDocVAT 7227 fldDocVAT Boolean 0 VAT Document VAT flag

fidRefDocSID 299 fldRefDocSID Int64 0 Ref Doc SID Ref document SID

fidDocSID 595 fldDocSID Int64 0 SID Document SID



ReceiptItem (Nested Table) RDA2 Constant ID# Name Type Size Caption Description













fidCommCod 181 fldCommCod Integer 0 Comm Code Commission Code


fidCommAmt 183 fldCommAmt Double 0 Comm $ Commission Amount









fidQtyO_H 26 fldStrQty Double 0 Str Qty Store Quantity





fidDocItmPrc 41 fldInvcItemPrc Double 0 Rcpt P$ Receipt Price

fidDocItmPWT 132 fldInvcItemPWT Double 0 Rcpt P$T$ Receipt Price with Tax

fidDocItmCost 44 fldInvcItemCost Double 0 Rcpt C$ Receipt Cost

fidDiscPercent 500 fldDocItemDisc Double 0 Disc % Item Discount %







fidExtPrc 33 fldExtPrc Double 0 Ext P$ Extended Price

fidExtCost 38 fldExtCost Double 0 Ext C$ Extended Cost

fidExtPwt 117 fldExtPWT Double 0 Ext P$T$ Extended Price with Tax

fidDiscLvl 106 fldDocItemDiscLvl Enumerated 0 Disc Type Discount Type

fidQtyO_HCas 138 fldCaseStrQty Double 0 Str Case Qty Store Quantity in Cases

fidOrigPrc 32 fldDocItemOrigPrc Double 0 Orig P$ Original Price

fidOrigTax 162 fldDocItemOrigTax Double 0 Orig T$ Original Tax Amount


fidItemLookup 567 fldItemLookup String 20 Item # Item Lookup



fidItemModified 590 fldItemModified Boolean 0 MOD Modified

fidOrigPWT 123 fldDocItemOrigPWT Double 0 Orig P$T$ Original Price with Tax


fidDisc 34 fldDocItemDiscAmt Double 0 Disc $ Item Discount

-None- 2003 fldRecNo Integer 0 Rec # Record Number






















fidSerialNum 651 fldSerialNum String 25 Serial # Serial Number


fidDocCostCode 559 fldInvcItemCostCode String 0 Rcpt Cost Code Rcpt Cost Code

fidDocItmKitFlg 310 fldDocItmKitFlg Enumerated 0 KIT Kit Item Type

fidDocItmPkgItmNo 311 fldDocItmPkgItmNo Integer 0 PIN Package Item Number

fidKitComponent 305 fldKitComponent String 30 Component Component



fidRoundDiscPrc 1120 fldDocItemRndDisc Double 0 Round Disc % Discount % rounded










fidSeqNum 1130 fldSeqNum Integer 0 Seq # Sequence number

fidExtTax 121 fldExtTax Double 0 Ext T$ Extended Tax

fidExtTax2 7006 fldExtTax2 Double 0 Ext Tax 2 $ Extended Tax 2 Amount

fidExtTotalTax 7007 fldExtTotalTax Double 0 Ext Total Tax $ Extended Total Tax Amount

fidUsrDscPrc 1126 fldDocItmUsrDisc Double 0 Doc Disc % Doc Disc %


fidItemDetaxFlag 7223 fldItemDetaxFlag Boolean 0 Item Detax Item detax flag

fidItemDetaxTaxP 7224 fldItemDetaxTaxP Double 0 Item Tax% Ovrd Item detax tax% override

fidItemDetaxTaxA 7225 fldItemDetaxTaxA Double 0 Item T$ Ovrd Item detax T$ override

fidItemDetaxPWT 7226 fldItemDetaxPWT Double 0 Item PWT Ovrd Item detax PWT override



POs RDA2 Constant ID# Name Type Size Caption Description

fidPONumber 400 fldPONumber String 20 PO # PO Number

fidPODate 404 fldPODate Date 0 Ord Date PO Date

fidPOStartShipDate 405 fldPOStartShipDate Date 0 Ship PO Ship Date

fidPOCancelDate 406 fldPOCancelDate Date 0 Cancel PO Cancel Date



fidPOEDIDate 409 fldEDIDate Date 0 EDI Date EDI Date

fidPOLastActivityDate 417 fldLastActivityDate Date 0 Last Act. D. Last Activity Date


fidPOTotalPrice 420 fldPOTotalPrice Double 0 Price Price

fidPOTotalQty 421 fldPOTotalQty Double 0 Qty Ordered Qty Ordered





fidVndrPicture 246 fldVendorPicture String 20 Vendor Image Vendor Image

fidPOInstruction1 422 fldPOInstruction1 String 60 Instruction 1 Instruction 1





fidUnfilledPrc 584 fldUnfilledPrc Double 0 Unfilled % Unfilled %


fidPOType 401 fldPOType Enumerated 0 PO Type PO Type







fidPOBillTo 429 fldPOBillTo String 3 Bill To # Bill To Number

fidPOBillToHeading1 436 fldPOBillToHeading1 String 40 Bill To Heading 1 Bill To Heading 1




fidPOShipTo 427 fldPOShipTo String 3 Ship To # Ship To Number

fidPOShipToHeading1 439 fldPOShipToHeading1 String 40 Ship To Heading 1 Ship To Heading 1

fidPOMarkedFor 431 fldPOMarkedFor String 3 Marked For # Marked For Number

fidPOMarkedForHeading1 442 fldPOMarkedForHeadi

ng1 String 40 Marked For Heading 1 Marked For Heading 1

fidPOEDIStatus 433 fldPOEDIStatus Enumerated 0 EDI EDI Status




fidPOTotalQtyRcvd 434 fldPOTotalQtyRcvd Double 0 Qty Received Qty Received

fidPOTotalQtyDue 435 fldPOTotalQtyDue Double 0 Qty Due Qty Due






















fidArchived 588 fldArchived Boolean 0 Archived Archived

fidPOFromSONum 445 fldPOFromSONum String 14 From SO # From SO Number











fidDocLocked 618 fldDocLocked Boolean 0 Locked Locked


fidSNQty 446 fldSNQty Double 0 ASN Quantity ASN Voucher Quantity

fidMarked 592 fldMarked Boolean 0 Marked Marked


fidDocHeld 617 fldSOHeld Boolean 0 Held Held


fidPOFromSOFlag 447 fldPOFromSOFlag Boolean 0 Created from SO Createf from SO indicator

fidPOTotalPrcTax 448 fldPOTotalPrcTax Double 0 P$T$ P$T$



POItem (Nested Table) RDA2 Constant ID# Name Type Size Caption Description


fidDocItmCost 44 fldPOItmCost Double 0 PO C$ PO Cost























fidStrRcvd 102 fldStrRcvd Double 0 Str Rcvd Store Received

fidDocItmPrc 41 fldPOItmPrice Double 0 PO P$ PO Price


fidFrmrPrc 17 fldFrmrPrc Double 0 Frmr P$ Former Price







fidFrmrPWT 128 fldFrmrPrcWTx Double 0 Frmr P$T$ Former Price with Tax

fidDocItmPWT 132 fldPOPrcWTx Double 0 PO P$T$ PO Price with Tax


fidQtyOrdCas 139 fldCaseQtyOrd Double 0 Case Ord Case Quantity Ordered

fidQtyRcvdCas 140 fldCaseQtyRcvd Double 0 Case Rcvd Case Quantity Received



fidPOItmDue 414 fldPOItmQtyDue Double 0 PO Qty Due PO Quantity Due

fidQtyDueCas 142 fldCaseQtyDue Double 0 Case Due Case Quantity Due

fidQtyRcvd 28 fldItmRcvd Double 0 Qty Rcvd Quantity Received





fidSelQty 22 fldSelQty Double 0 Doc.Qty Document Quantity


























fidVndrListCst 193 fldVndrListCst Double 0 Vendor List Cost Vendor List Cost



fidDocCostCode 559 fldPOCostCode String 0 PO Cost Code PO Cost Code

fidSNQty 446 fldSNQty Double 0 ASN Quantity ASN Voucher Quantity


fidSelQtyCas 137 fldSelQtyCas Double 0 Doc.Case Qty Document Case Quantity













SO RDA2 Constant ID# Name Type Size Caption Description

fidSONum 600 fldSONumber String 14 SO Number SO Number

fidCustPONumber 601 fldSOCustPONumber String 10 Cust PO # Customer Purchase Order Number

fidBillToCustID 520 fldBillToCustNumber String 0 Bill To Cust # Bill To Customer Number

fidShipToCustID 540 fldShipToCustNumber String 0 Ship To Cust # Ship To Customer Number

fidSOTargetStore 602 fldSOTargetStore String 4 Process At Process At

fidSOShipFromStore 603 fldSOShipFromStore String 3 Sell From Sell From

fidSOPriority 604 fldSOPriority Enumerated 0 Priority Priority

fidSOShipPartial 605 fldSOShipPartial Boolean 0 Ship Partial Ship Partial

fidShipMethod 514 fldShipMethod String 10 Ship Method Ship Method

fidHowPaid 515 fldSOTerms Enumerated 0 Terms Payment Terms

fidSOOrderedDate 606 fldSOOrderedDate Date 0 Ordered Date SO Ordered Date

fidSOShippedDate 607 fldSOShippedDate Date 0 Ship Date SO Shipped Date

fidSOCancelDate 608 fldSOCancelDate Date 0 Cancel Date SO Cancel Date


fidSOType 609 fldSOType Enumerated 0 SO Type SO Type




fidShipping 505 fldShipping Double 0 Shipping Shipping

fidShippingPercent 504 fldShippingPrc Double 0 Shipping % Shipping %



fidFeeTaxPercent 507 fldFeeTaxPrc Double 0 Fee Tax % Fee Tax %







fidSOComment 610 fldSOComment String 20 Comment Comment

fidSOInstruction1 611 fldSOInstruction1 String 50 Instruction 1 Instruction 1








fidSONote 616 fldSONote String 10 Note Note

fidDocHeld 617 fldSOHeld Boolean 0 Held Held

fidDocLocked 618 fldDocLocked Boolean 0 Locked Locked


fidSODue 619 fldSODue Double 0 Balance Due Balance Due

fidBillToCustComp 521 fldBillToCustCompany String 25 Bill To Company Bill To Company

fidBillToCustFName 523 fldBillToFName String 30 Bill To F.Name Bill To First Name

fidBillToCustLName 522 fldBillToLName String 30 Bill To L.Name Bill To Last Name

fidBillToCustTitle 524 fldBillToTitle String 15 Bill To Title Bill To Title

fidBillToFullName 536 fldBillToFullName String 0 Bill To Full Name Bill To Full Name




fidBillToZip 528 fldBillToZip String 10 Bill To ZIP Bill To ZIP





fidShipToCustComp 541 fldShipToCustCompany String 25 Ship To Company Ship To Company

fidShipToCustFName 543 fldShipToFName String 30 Ship To F.Name Ship To First Name

fidShipToCustLName 542 fldShipToLName String 30 Ship To L.Name Ship To Last Name

fidShipToCustTitle 544 fldShipToTitle String 15 Ship To Title Ship To Title

fidShipToFullName 556 fldShipToFullName String 0 Ship To Full Name Ship To Full Name




fidShipToZip 548 fldShipToZip String 10 Ship To ZIP Ship To ZIP









fidSOItmSent 632 fldSOQtySent Double 0 Qty Sent SO Quantity Sent

fidSOItmDue 633 fldSOQtyDue Double 0 Qty Due SO Quantity Due



fidUnfilledPrc 584 fldUnfilledPrc Double 0 Unfilled % Unfilled %

fidSORecorded 620 fldSORecorded Boolean 0 Recorded Recorded

fidBusCon 591 fldBusCon Enumerated 0 Business/Consumer Business/Consumer


fidSOPmtDueDate 621 fldSOPmtDueDate Date 0 Payment Due Payment Due

fidSOTotDueDate 622 fldSOTotDueDate Date 0 Total Due By Total Due By


fidSOTermsDetail 593 fldSOTermsDetail String 0 Terms Detail Terms Detail

fidSODepoBalance 623 fldSODepoBalance Double 0 Deposit Balance Deposit Balance

fidSubtotalWTax 566 fldSubTotalWTax Double 0 Subtotal w/tax Subtotal With Tax

fidStoreStation 563 fldOrigStore String 4 Orig.Store Originating Store

fidStoreHeading1 585 fldOrigStoreHeading1 String 40 Orig.Store Heading 1 Originating Store Heading 1



fidSOTargetStoreHeading1 624 fldSOTargetStoreHeading1 String 40 Process At

Heading 1 Process At Heading 1





fidSOShipFromStoreHeading1 627 fldSOShipFromStoreHea

ding1 String 40 Sell From Heading 1 Sell From Heading 1





fidArchived 588 fldArchived Boolean 0 Archived Archived

fidSOStNum 630 fldSOStNum String 14 Store/SO Number Store/SO Number

fidBillToCustSID 533 fldBillToCustSID Int64 16 Bill To Cust. SID Bill To Customer SID

fidShipToCustSID 553 fldShipToCustSID Int64 16 Ship To Cust. SID Ship To Customer SID


fidRefSONum 631 fldRefSONumber String 14 Ref SO# Referenced by SO



















































fidBillToUDF0 7113 fldBillToUDF1 Date 0 Bill To UDF 1 User-Defined Field 1

-None- 7114 fldBillToUDF2 Date 0 Bill To UDF 2 User-Defined Field 2






fidBillToUDF7 7120 fldBillToUDF8 String 20 Bill To UDF 8 User-Defined Field 8

fidShipToUDF0 7213 fldShipToUDF1 Date 0 Ship To UDF 1 User-Defined Field 1

-None- 7214 fldShipToUDF2 Date 0 Ship To UDF 2 User-Defined Field 2






fidShipToUDF7 7220 fldShipToUDF8 String 20 Ship To UDF 8 User-Defined Field 8

fidBillToSC 537 fldBillToSC Double 0 St. Credit Bill To Store Credit



fidSubTotalWithoutTax 562 fldSubTotalWithoutTax Double 0 Subtotal w/o Tax Subtotal w/o Tax

fidBillToEMail 534 fldBillToEMail String 60 Bill To E-Mail Bill To E-Mail address

fidShipToEMail 554 fldShipToEMail String 60 Ship To E-Mail Ship To E-Mail address

fidDocVAT 7227 fldDocVAT Boolean 0 VAT Document VAT flag



SOItem (Nested Table) RDA2 Constant ID# Name Type Size Caption Description


























fidDocItmPrc 41 fldSOItmPrice Double 0 SO P$ SO Price

fidDocItmCost 44 fldSOItmCost Double 0 SO C$ SO Cost

fidSOItmSent 632 fldSOQtySent Double 0 Qty Sent SO Quantity Sent

fidSOItmDue 633 fldSOQtyDue Double 0 Qty Due SO Quantity Due







fidDiscLvl 106 fldDocItemDiscLvl Enumerated 0 Disc Type Discount Type




fidDocItmPWT 132 fldSOItmPrcTax Double 0 SO P$T$ SO Price with Tax




fidQtySentCas 141 fldCaseQtySent Double 0 Case Sent Case Quantity Sent


fidOrigPrc 32 fldDocItemOrigPrc Double 0 Orig P$ Original Price

fidOrigTax 162 fldDocItemOrigTax Double 0 Orig T$ Original Tax Amount





fidItemModified 590 fldItemModified Boolean 0 MOD Modified



fidOrigPWT 123 fldDocItemOrigPWT Double 0 Orig P$T$ Original Price with Tax


























fidDocCostCode 559 fldSOItmCostCode String 0 SO Cost Code SO Cost Code

fidDocItmKitFlg 310 fldDocItmKitFlg Enumerated 0 KIT Kit Item Type

fidDocItmPkgItmNo 311 fldDocItmPkgItmNo Integer 0 PIN Package Item Number

fidKitComponent 305 fldKitComponent String 30 Component Component



fidCmpMax 58 fldCmpMax Double 0 Cmp Max Company Maximum

fidCmpMin 57 fldCmpMin Double 0 Cmp Min Company Minimum

fidMin 55 fldMin Double 0 Min Minimum

fidMax 56 fldMax Double 0 Max Maximum

fidRoundDiscPrc 1120 fldDocItemRndDisc Double 0 Round Disc % Discount % rounded










fidExtTax2 7006 fldExtTax2 Double 0 Ext Tax 2 $ Extended Tax 2 Amount

fidExtTotalTax 7007 fldExtTotalTax Double 0 Ext Total Tax $ Extended Total Tax Amount






fidUsrDscPrc 1126 fldDocItmUsrDisc Double 0 Doc Disc % Doc Disc %

fidItemDetaxFlag 7223 fldItemDetaxFlag Boolean 0 Item Detax Item detax flag

fidItemDetaxTaxP 7224 fldItemDetaxTaxP Double 0 Item Tax% Ovrd Item detax tax% override

fidItemDetaxTaxA 7225 fldItemDetaxTaxA Double 0 Item T$ Ovrd Item detax T$ override

fidItemDetaxPWT 7226 fldItemDetaxPWT Double 0 Item PWT Ovrd Item detax PWT override



SODeposit (Nested Table) RDA2 Constant ID# Name Type Size Caption Description

fidCashier 517 fldCashier String 8 Cashier Cashier


fidTender 519 fldTender Enumerated 0 Tender Tender

fidAmount 561 fldAmount Double 0 Amount Amount

fidSODepoCancelled 835 fldSODepoCancelled Boolean 0 Cancelled Cancelled

fidInvcNum 560 fldSODepInvcNum Integer 0 SO Dep Receipt # Receipt #

fidSODepoRvrsFlg 834 fldSODepoRvrsFlg Enumerated 0 Reverse Reverse

SOHistory (Nested Table) RDA2 Constant ID# Name Type Size Caption Description



fidInvcNum 560 fldSOHistDocNum String 14 Document # Document Number

fidSOHistDocType 635 fldSOHistDocType Enumerated 0 Doc Type Document Type



Former Vouchers RDA2 Constant ID# Name Type Size Caption Description





fidVouNumber 700 fldVouNumber Integer 0 Voucher # Voucher Number










fidVouArrivalDate 701 fldVouArrivalDate Date 0 Arriv. Date Arrival Date

fidVouPayeeCode 702 fldVouPayeeCode String 6 Payee Payee Code

fidVouPayeeName 703 fldVouPayeeName String 26 Payee Name Payee Name

fidVouInvoiceNumber 704 fldVouInvcNumber String 15 Invoice # Invoice Number

fidVouFreight 706 fldVouFreight Double 0 Freight Freight

fidVouTaxIncPrc 707 fldVouTaxIncPrc Double 0 Tax Incl % Tax Included %

fidVouTaxIncAmt 708 fldVouTaxIncAmt Double 0 Tax Incl $ Tax Included Amount

fidVouTaxExcPrc 709 fldVouTaxExcPrc Double 0 Tax Excl % Tax Excluded %

fidVouTaxExcAmt 710 fldVouTaxExcAmt Double 0 Tax Excl $ Tax Excluded Amount

fidVouInvoiceDate 711 fldVouInvcDate Date 0 Invoice Date Invoice Date

fidVouType 712 fldVouType Enumerated 0 Type Voucher Type

fidVouStatus 713 fldVouStatus Enumerated 0 Status Voucher Status


fidVouCostMethod 714 fldVouCostMethod Enumerated 0 Cost Method Cost Method


fidAP 581 fldAP Boolean 0 AP Accounts Payable

fidPC 583 fldPC Boolean 0 PC Purchase Clearing















fidVouPackageNumber 715 fldVouPackageNumber String 20 Package # Package Number

fidVouComm1 716 fldVouComm1 String 60 Comment 1 Voucher Comment 1

-None- 717 fldVouComm2 String 60 Comment 2 Voucher Comment 2









fidVouPayeeAddr1 726 fldVouPayeeAddr1 String 31 Payee Address 1 Payee Address 1



fidVouPayeeZip 729 fldVouPayeeZip String 10 Payee ZIP Payee ZIP Code

fidVouPayeeAcctNum 730 fldVouPayeeAcctNum String 10 Payee Acct # Payee Account Number

fidTONumber 950 fldTONumber String 8 TO # TO Number














fidVouPayeeTitle 731 fldVouPayeeTitle String 15 Payee Title Payee Title

fidVouPayeeFName 732 fldVouPayeeFName String 30 Payee First Payee First Name

fidVouPayeeLName 735 fldVouPayeeLName String 30 Payee Last Payee Last Name

fidVouPayeePhone1 736 fldVouPayeePhone1 String 15 Payee Phone 1 Payee Telephone 1


fidVouPayeeInfo1 738 fldVouPayeeInfo1 String 20 Payee Info 1 Payee Information 1






fidShipmentNum 1079 fldShipmentNumber String 16 Shipment Number Shipment Number



fidTotalQty 597 fldVchrTotalQty Double 0 Total Qty Received Total Quantity Received







fidMovNoteShipNum 1128 fldMovNoteShipNum String 9 Movement Note Shipment#

Movement note shipment number



fidVndrInvcTotal 1135 fldVndrInvcTotal Double 0 Vendor Invoice Total Vendor Invoice Total

fidReviewedBy 1137 fldReviewedBy String 8 Reviewed By Reviewed By

fidReviewedDT 1138 fldReviewedDT Date 0 Reviewed Date/Time Reviewed Date/Time

fidApprovedBy 1139 fldApprovedBy String 8 Approved By Approved By

fidApprovedDT 1140 fldApprovedDT Date 0 Approved Date/Time Approved Date/Time






fidVouTotalPrice 449 fldVouTotalPrice Double 0 Price Price

fidVouTotalPrcTax 450 fldVouTotalPrcTax Double 0 P$T$ P$T$



Pending Vouchers RDA2 Constant ID# Name Type Size Caption Description























































































fidShipmentNum 1079 fldShipmentNumber String 16 Shipment

Number Shipment Number










fidMovNoteShipNum 1128 fldMovNoteShipNum String 9 Movement Note

Shipment# Movement note shipment number

















ASN Vouchers RDA2 Constant ID# Name Type Size Caption Description

































































































fidMovNoteShipNum 1128 fldMovNoteShipNum String 9 Movement Note Shipment# Movement note shipment number

















VoucherItem (Nested Table) RDA2 Constant ID# Name Type Size Caption Description






















fidQtyRcvd 28 fldItmRcvd Double 0 Qty Rcvd Quantity Received






fidQtyRcvdCas 140 fldCaseQtyRcvd Double 0 Case Rcvd Case Quantity Received



fidDocItmCost 44 fldVouItmCost Double 0 Voucher C$ Voucher Cost

fidDocItmPWT 132 fldVouItmPWTx Double 0 Voucher P$T$ Voucher Price with Tax




fidDocItmPrc 41 fldVouItmPrc Double 0 Voucher P$ Voucher Price

fidVouItmCartonID 733 fldCartonID Integer 0 Carton ID Carton ID


fidVouItmOrigQty 734 fldVouItmOrigQty Double 0 Ship Qty Ship Quantity


































-None- 740 fldAssociatePO String 20 Associate PO Associate PO


fidDocCostCode 559 fldVouItmCostCode String 0 Voucher Cost Code Voucher Cost Code















Memos RDA2 Constant ID# Name Type Size Caption Description





fidMemoSource 800 fldMemoSource Enumerated 0 Source Memo Source

fidMemoCreatingDocNum 801 fldMemoCreatingDocNum Integer 0 Creating Doc # Creating Doc Number

fidMemoType 802 fldMemoType Enumerated 0 Type Memo Type

fidMemoReason 803 fldMemoReason String 8 Reason Memo Reason

fidMemoNum 804 fldMemoNum Integer 0 Memo # Memo Number


fidMemoOldStrQty 807 fldMemoOldStrQty Double 0 Old Str Qty Old Store Quantity

fidMemoOldCmpQty 808 fldMemoOldCmpQty Double 0 Old Cmp Qty Old Company Quantity

fidMemoAdjStrQty 809 fldMemoAdjStrQty Double 0 Adj Str Qty Adjusted Store Quantity

fidMemoAdjCmpQty 810 fldMemoAdjCmpQty Double 0 Adj Cmp Qty Adjusted Company Quantity

fidMemoOldPrcPWT 812 fldMemoOldPrcPWT Double 0 Old Prc Old Price

fidMemoAdjPrcPWT 813 fldMemoAdjPrcPWT Double 0 Adj Prc Adjusted Price

fidMemoOldCost 815 fldMemoOldCost Double 0 Old C$ Old Cost

fidMemoAdjCost 816 fldMemoAdjCost Double 0 Adj C$ Adjusted Cost

fidMemoDifQty 811 fldMemoDifQty Double 0 Dif Qty Difference in Quantity

fidMemoDifPrcPWT 814 fldMemoDifPrcPWT Double 0 Dif Prc Difference in Price

fidMemoDifCost 817 fldMemoDifCost Double 0 Dif C$ Difference in Cost





fidMemoReversed 821 fldMemoReversed Enumerated 0 Status Memo Status

fidMemoCopyed 822 fldMemoCopyed Boolean 0 Copied Copied

fidMemoODBCancelled 825 fldMemoODBCancelled Boolean 0 RDW Cancelled RDW Cancelled









fidMemoComm1 836 fldMemoComm1 String 60 Comment 1 Memo Comment 1

-None- 837 fldMemoComm2 String 60 Comment 2 Memo Comment 2








fidMemoComm10 845 fldMemoComm10 String 60 Comment 10 Memo Comment 10



fidODSExported 1066 fldODSExported Boolean 0 ODS Exported ODS Exported







fidMovNoteShipNum 1128 fldMovNoteShipNum String 9 Movement Note Shipment#







MemoItem(Nested Table) RDA2 Constant ID# Name Type Size Caption Description








fidMemoOldCmpQty 808 fldMemoOldCmpQty Double 0 Old Cmp Qty Old Company Quantity

fidMemoOldStrQty 807 fldMemoOldStrQty Double 0 Old Str Qty Old Store Quantity

fidMemoAdjStrQty 809 fldMemoAdjStrQty Double 0 Adj Str Qty Adjusted Store Quantity

fidMemoOldCost 815 fldMemoOldCost Double 0 Old C$ Old Cost

fidMemoAdjCost 816 fldMemoAdjCost Double 0 Adj C$ Adjusted Cost


fidMemoOldPrcPWT 812 fldMemoOldPrcPWT Double 0 Old Prc Old Price

fidMemoAdjPrcPWT 813 fldMemoAdjPrcPWT Double 0 Adj Prc Adjusted Price


fidMemoQtyDiff 826 fldMemoQtyDiff Double 0 Qty Diff Quantity Difference











fidMemoDifCost 817 fldMemoDifCost Double 0 Dif C$ Difference in Cost

fidMemoDifPrcPWT 814 fldMemoDifPrcPWT Double 0 Dif Prc Difference in Price



















Slips RDA2 Constant ID# Name Type Size Caption Description





fidSlipFromStore 900 fldSlipFromStore String 3 From Store From Store

fidSlipToStore 901 fldSlipToStore String 3 To Store To Store

fidSlipConfirmation 902 fldSlipConfirmation Enumerated 0 Confirmation Confirmation

fidSlipCarrier 903 fldSlipCarrier String 15 Carrier Carrier

fidSlipETA 904 fldSlipETA Date 0 ETA ETA

fidSlipTONum 905 fldSlipTONum String 8 TO # TO Number

fidSlipNum 906 fldSlipNum Integer 0 Slip # Slip Number

fidOutSlipNum 907 fldOutSlipNum Integer 0 Out Slip # Out Slip Number


fidSlipPrice 45 fldSlipPrice Double 0 Total Price Total Price

fidSlipCost 46 fldSlipCost Double 0 Total Cost Total Cost

fidSlipFreight 910 fldSlipFreight Double 0 Freight Freight



fidSlipStatus 912 fldSlipStatus Enumerated 0 Status Slip Status






fidSlipComm1 922 fldSlipComm1 String 60 Comment 1 Slip Comment 1

-None- 923 fldSlipComm2 String 60 Comment 2 Slip Comment 2











fidSlipComm10 931 fldSlipComm10 String 60 Comment 10 Slip Comment 10

fidSlipToStoreHeading1 932 fldSlipToStoreHeading1 String 40 To Store

Heading 1 To Store Heading 1






fidSlipCopied 936 fldSlipCopied Boolean 0 Copied Copied

fidSlipODBCancelled 938 fldSlipODBCancelled Boolean 0 RDW Cancelled RDW Cancelled



fidSlipType 939 fldSlipType Enumerated 0 Slip Type Slip Type




fidSlipCompStore 940 fldSlipCompStore String 6 Out To Comp/Store Out To Comp/Store

fidSlipCompStoreDesc 941 fldSlipCompStoreDesc String 0 Comp/Store Description Comp/Store Description



fidTotalQty 597 fldSlipTotalQty Double 0 Total Qty Transferred Total Quantity Transferred











fidSlipDaysInTransit 942 fldSlipDaysInTransit Integer 0 Days In-Transit Days In-Transit

fidSlipTargetUpdated 943 fldSlipTargetUpdated Boolean 0 Target Updated Target Updated


fidSlipTransferCompleted 944 fldSlipTransferComple

te Date 0 Transfer Complete Transfer Complete

fidSlipResolvedBy 945 fldSlipResolvedBy String 8 Resolved By Resolved By

fidSlipResolutionMethod 946 fldSlipResolutionMethod Enumerated 0 Resolution

Method Resolution Method




fidSlipResolutionTime 947 fldSlipResolutionTime Date 0 Resolution Date/Time Resolution Date/Time


fidMovNoteShipNum 1128 fldMovNoteShipNum String 9Movement Note Shipment#





fidSlipPackageNum 4000 fldSlipPackageNum String 15 Package # Slip Package #





SlipItem (Nested Table) RDA2 Constant ID# Name Type Size Caption Description


























fidDocItmPWT 132 fldSlpPWT Double 0 Slip P$T$ Slip Price with Tax






fidDocItmPrc 41 fldSlipItmPrice Double 0 Slip P$ Slip Price




fidDocItmCost 44 fldSlipItmCost Double 0 Slip C$ Slip Cost



















fidDocCostCode 559 fldSlipCostCode String 0 Slip Cost Code Slip Cost Code













SubLocDefs RDA2 Constant ID# Name Type Size Caption Description

fidSubLocID 1050 fldSubLocID String 12 Sub-Loc ID Sub-Location ID

fidSubLocName 1051 fldSubLocName String 20 Sub-Loc Name Sub-Location Name


fidSecLvl 594 fldSecLvl Enumerated 0 Security Level Security Level

fidSubLocSID 1076 fldSubLocSID Int64 0 Sub-Location SID Sub-Location SID

fidSubLocSuspended 1052 fldSubLocSuspended Boolean 0 Suspended Suspended

fidSubLocAssStore 1074 fldSubLocAssStore String 3 Associated Store Associated Store

fidSubLocAssDCS 1075 fldSubLocAssDCS String 9 Associated DCS Associated DCS

fidSubLocDefault 1089 fldSubLocDefault Boolean 0 Default Default Sub-Location

fidSubLocDefType 1090 fldSubLocType Enumerated 0 Type Sub-Location Type

fidSubLocSeg1 1091 fldSubLocSeg1 String 1 Sub-Loc Seg. 1 Sub-Loc Seg. 1

fidSubLocSeg2 1092 fldSubLocSeg2 String 1 Sub-Loc Seg 2 Sub-Loc Seg 2

fidSubLocSeg3 1093 fldSubLocSeg3 String 1 Sub-Loc Seg 3 Sub-Loc Seg 3

fidSubLocSingleItem 1094 fldSubLocSingleItem Boolean 0 Single Item Restrict Sub-Location to single item


SubLocQtys RDA2 Constant ID# Name Type Size Caption Description


fidSubLocID 1050 fldSubLocID String 12 Sub-Loc ID Sub-Location ID

fidSubLocName 1051 fldSubLocName String 20 Sub-Loc Name Sub-Location Name




fidSubLocQty 1085 fldSubLocQty Double 0 Sub-Loc Qty Sub-Loc Quantity

fidTotalQty 597 fldTotalQty Double 0 Total Qty Total Quantity



MovNotes RDA2 Constant ID# Name Type Size Caption Description


fidMovNoteNumber 1057 fldMovNoteNumber Integer 0 Number Movement Note Number

fidMovNoteRefDoc 1059 fldMovNoteRefDoc String 16 Ref Doc # Creating Doc Number

fidMovNoteRefDocDate 1060 fldMovNoteRefDocDate Date 0 Ref Doc Date Date for Referencing Doc

fidMovNoteRefDocType 1061 fldMovNoteRefDocType Enumerated 0 Ref Doc Type Type of the document that created note

fidMovDocComment 1063 fldMovDocComment String 238 Comment Movement Document Comment

fidMovNoteReversed 1065 fldMovNoteReversed Boolean 0 Reversed Movement Note Reversed









fidMovDocUDF1 1069 fldMovDocUDF1 String 15 UDF1 Movement Document User Defined Field 1

-None- 1070 fldMovDocUDF2 String 15 UDF2 Movement Document User Defined Field 2



fidMovDocUDFDate 1073 fldMovDocUDFDate Date 0 UDF Date Movement Document User Defined Date

fidMovNoteType 1078 fldMovNoteType Enumerated 0 Type Movement Note Type

fidMovNoteAcknowledged 1077 fldMovNoteAcknowledged Boolean 0 Acknowledged Movement Note Acknowledged


fidMovDocCartonNum 1080 fldMovDocCartonNum String 16 Carton Number Carton Number

fidMovNoteAckClerk 1087 fldMovNoteAckClerk String 8 Ack Clerk Ack Clerk

fidMovNoteAckDateTime 1088 fldMovNoteAckDateTime Date 0 Ack Date/Time Ack Date/Time

fidMONumber 1081 fldMONumber String 14 MO Number Movement Order Number











fidCustID 236 fldCustIDLookup String 0 CustID Customer ID

fidMovNoteCrtSeqNum 1095 fldMovNoteCrtSeqNum Integer 0 Carton Seq. Num. Carton Sequence Number

fidMovNoteCrtSeqCnt 1096 fldMovNoteCrtSeqCnt Integer 0 Carton Seq. Cnt. Carton Sequence Count

fidSubLocFrom 1053 fldMovDocDefLocFrom String 12 Def From Sub-Loc Default From Sub-Location

fidSubLocTo 1054 fldMovDocDefLocTo String 12 Def To Sub-Loc Default To Sub-Location



fidMovNoteSource 1098 fldMovNoteSource Enumerated 0 Note Source Note Source


fidSubLocFromName 1055 fldMovDocDefLocFromName String 20 Def From Sub-Loc

Name Def From Sub-Loc Name

fidSubLocToName 1056 fldMovDocDefLocToName String 20 Def To Sub-Loc Name Def To Sub-Loc Name

fidBridgeExported 1067 fldBridgeExported Boolean 0 Bridge Exported Bridge Exported

fidCMSExported 1068 fldCMSExported Boolean 0 CMS Exported CMS Exported







MovNoteItem (Nested Table) RDA2 Constant ID# Name Type Size Caption Description

fidSubLocFrom 1053 fldSubLocFrom String 12 From Sub-Loc From Sub-Loc

fidSubLocTo 1054 fldSubLocTo String 12 To Sub-Loc To Sub-Loc

fidSubLocFromName 1055 fldSubLocFromName String 20 From Sub-Loc Name From Sub-Loc Name

fidSubLocToName 1056 fldSubLocToName String 20 To Sub-Loc Name To Sub-Loc Name

fidMovDocItmRefNote 1058 fldRefMovNote Integer 0 Mov Note Ref # Document number of Movement Note that previously moved item/qty

















fidMovDocItmAckQty 1086 fldMovNoteItmAckQty Double 0 Acknowledged Qty Acknowledged Qty



















MOs RDA2 Constant ID# Name Type Size Caption Description


fidMovNoteNumber 1057 fldMovNoteNumber Integer 0 Number Movement Note Number

fidMovNoteRefDoc 1059 fldMovNoteRefDoc String 16 Ref Doc # Creating Doc Number

fidMovNoteRefDocDate 1060 fldMovNoteRefDocDate Date 0 Ref Doc Date Date for Referencing Doc

fidMovNoteRefDocType 1061 fldMovNoteRefDocType Enumerated 0 Ref Doc Type Type of the document that created note

fidMovDocComment 1063 fldMovDocComment String 238 Comment Movement Document Comment

fidMovNoteReversed 1065 fldMovNoteReversed Boolean 0 Reversed Movement Note Reversed













fidMovDocUDFDate 1073 fldMovDocUDFDate Date 0 UDF Date Movement Document User Defined Date

fidMovNoteType 1078 fldMovNoteType Enumerated 0 Type Movement Note Type

fidMovNoteAcknowledged 1077 fldMovNoteAcknowledged Boolean 0 Acknowledged Movement Note Acknowledged


fidMovDocCartonNum 1080 fldMovDocCartonNum String 16 Carton Number Carton Number

fidMovNoteAckClerk 1087 fldMovNoteAckClerk String 8 Ack Clerk Ack Clerk

fidMovNoteAckDateTime 1088 fldMovNoteAckDateTime Date 0 Ack Date/Time Ack Date/Time

fidMONumber 1081 fldMONumber String 14 MO Number Movement Order Number











fidCustID 236 fldCustIDLookup String 0 CustID Customer ID

fidMovNoteCrtSeqNum 1095 fldMovNoteCrtSeqNum Integer 0 Carton Seq. Num. Carton Sequence Number

fidMovNoteCrtSeqCnt 1096 fldMovNoteCrtSeqCnt Integer 0 Carton Seq. Cnt. Carton Sequence Count

fidSubLocFrom 1053 fldMovDocDefLocFrom String 12 Def From Sub-Loc Default From Sub-Location

fidSubLocTo 1054 fldMovDocDefLocTo String 12 Def To Sub-Loc Default To Sub-Location



fidMovNoteSource 1098 fldMovNoteSource Enumerated 0 Note Source Note Source


fidSubLocFromName 1055 fldMovDocDefLocFromName String 20 Def From Sub-

Loc Name Def From Sub-Loc Name

fidSubLocToName 1056 fldMovDocDefLocToName String 20 Def To Sub-Loc Name Def To Sub-Loc Name

fidBridgeExported 1067 fldBridgeExported Boolean 0 Bridge Exported Bridge Exported

fidCMSExported 1068 fldCMSExported Boolean 0 CMS Exported CMS Exported







MOItem (Nested Table) RDA2 Constant ID# Name Type Size Caption Description

fidSubLocFrom 1053 fldSubLocFrom String 12 From Sub-Loc From Sub-Loc

fidSubLocTo 1054 fldSubLocTo String 12 To Sub-Loc To Sub-Loc

fidSubLocFromName 1055 fldSubLocFromName String 20 From Sub-Loc Name From Sub-Loc Name

fidSubLocToName 1056 fldSubLocToName String 20 To Sub-Loc Name To Sub-Loc Name

fidMovDocItmRefNote 1058 fldRefMovNote Integer 0 Mov Note Ref # Document number of Movement Note that previously moved item/qty

















fidMovDocItmAckQty 1086 fldMovNoteItmAckQty Double 0 Acknowledged Qty Acknowledged Qty



















TOs RDA2 Constant ID# Name Type Size Caption Description





fidTOTransferFrom 951 fldTOTransferFrom String 3 Transfer From Transfer From

fidTOFromHeading1 952 fldTOFromHeading1 String 40 From Header 1 From Header 1



fidTONotes1 955 fldTONotes1 String 30 Notes 1 Notes 1

fidTONotes2 956 fldTONotes2 String 30 Notes 2 Notes 2

fidTODate 957 fldTODate Date 0 Order Date Order Date

fidTOActivateOn 958 fldTOActivateOn Date 0 Activate On Activate On

fidTOLastActivity 959 fldTOLastActivity Date 0 Last Activity Last Activity

fidTOIncomplete 960 fldTOIncomplete Double 0 Incomplete Incomplete

fidTOAssigned 961 fldTOAssigned Double 0 Total Assigned Total Assigned

fidTODone 962 fldTODone Double 0 Total Sent Total Sent

fidTORemaining 963 fldTORemaining Double 0 Total Due Total Due








TOItem (Nested Table) RDA2 Constant ID# Name Type Size Caption Description

























































fidPOItmDue 414 fldPOItmQtyDue Double 0 PO Qty Due PO Quantity Due

fidQtyDueCas 142 fldTOItmPoQtyDue Double 0 PO Case Due PO Case Due

fidTOItmTotalQty 970 fldTOItmTotalQty Double 0 Qty Assigned Qty Assigned

fidTOItmTotalQtySent 971 fldTOItmTotalQtySent Double 0 Qty Sent Qty Sent

fidTOItmTotalQtyDue 972 fldTOItmTotalQtyDue Double 0 Qty Due Qty Due
















XML Preferences The RPro preference settings are retrieved from the database using the Preferences property of the Rda2Server object. This property returns a DOMDocument object (DOMDocument is a class of MSMXL. Explanation of XML documents and the XML document object model are beyond the scope of this document. See the Microsoft XML SDK for more information).

Preferences are exposed in the returned xml document as a series of nodes. Most of these nodes are element-type nodes with attributes containing name/value pairs for specifc preferences. (See the Sample Preferences Document below.)

Updating Preferences Only currency exchange information can be updated in the current version of RDA2.

Currency exchange information is located in RATE nodes. There will be a RATE node for each foreign currency in the system. Each RATE node is an element-type node with NAME, GIVE and TAKE as attributes. The attribute values contain the name of the currency and the give/take exchange rates.

The RATE nodes are child nodes of the CURRENCY node. The CURRENCY node is a child of the INTERNATIONAL node, which is a child of a COMPANY node. (COMPANY nodes are child nodes of the xml document root).

New RATE nodes cannot be added to the preferences. Only existing RATE nodes can be updated.

The UpdatePreferences method accepts an XMLDOMElement object as a parameter. This XMLDOMElement object MUST be the CURRENCY node of the XML Preferences document and MUST have the RATE nodes as children.

To update the currency name or exchange rates, locate the CURRENCY node and set an XMLDOMElement to this node. Locate the child RATE node and change the appropriate attribute value of the RATE node. Pass the XMLDOMElement object for the CURRENCY node to Rda2Server using the Update Preferences method.



Sample Preference Document Following is a text listing of a sample XML document containing RPro preferences: <?xml version="1.0"?> <RPRO_SETTINGS> <COMPANY> <INVENTORY NO_OF_PRICES="2" PRICE_COST_DECIMALS="2" PRICE_DECIMALS="2" COST_DECIMALS="2" TAX_DECIMALS="5"> <INVENTORY_SCALES/> </INVENTORY> <POINT_OF_SALE> <POS_FEE_TYPES_AND_SHIPPING> <SHIPPING NAME="Shipping" TAX_PERCENT="0" TAX_INCLUDED="0" CLASS="0" REQ.CUST="0" INCL_TAX_TO_COMPUTE="0" USE_DEFAULT_PERCENT="0" DEFAULT_PERCENT="0"/> </POS_FEE_TYPES_AND_SHIPPING> <TAX USE_VAT="0" USE_ICM="0" ROUND_EXT_TAX_UP="0" TAX_CODE_SUBTOTAL_CALC="0" MULTI_TAX="0" TAX_AREA_SPEC_TAX_CODES="0" INCLUDE_1ST_TAX_IN_2ND="0" TAX_COMPATIBILITY_MODE="-1" TAX_THRESHOLD1="0" TAX_THRESHOLD2="0" TAX_ROUND_AT_DOC_LEVEL="0" TAX_ROUND_METHOD="NORMAL"> <TAX_CODE TAX_CODE_NUM="0">Taxable</TAX_CODE> <TAX_CODE TAX_CODE_NUM="1">Exempt</TAX_CODE> <TAX_CODE TAX_CODE_NUM="2">Luxury</TAX_CODE> </TAX> </POINT_OF_SALE> <INTERNATIONAL> <GENERAL DATE_FORMAT="STD" FOUR_DIGIT_YEAR="0" NUMERIC_PUNCTUATION="COMMA_DOT" ZIP_POSITION="AFT_ADDR3"/> <CURRENCY CURRENCY_SYMBOL="$" SYMBOL_POSITION="$_123" USE_FOREIGN_CURRENCY="0" BASE_CURRENCY="DOLLARS"/> <TAX_REBATE ALLOW_TAX_REBATE="0" DEFAULT_PERCENTAGE="0" REBATE_TRESHOLD_AMOUNT="0"/> </INTERNATIONAL> <STORES_AND_REGIONS STORE_NUMBER="0" STATION_NUMBER="0" SBS_NO="0" NUMBER_OF_STORES="1"> <STORE NUMBER="-2" CODE="BIL" NAME="" ADDR1="" ADDR2=""/> <STORE NUMBER="252" CODE="CRP" NAME="" ADDR1="" ADDR2=""/> <STORE NUMBER="254" CODE="INF" NAME="" ADDR1="" ADDR2=""/> <STORE NUMBER="0" CODE="000" NAME="" ADDR1="" ADDR2=""/> <STORE NUMBER="1" CODE="001" NAME="" ADDR1="" ADDR2=""/> </STORES_AND_REGIONS> <GENERAL_DOCS_REPS LOOK_UP_MODE="Item#/UPC#/ALU" USE_DECIMALS_IN_REPS="0" DECIMALS_IN_REPS="2" UPPERCASE_REPS="0"/> <EMPLOYEES/> </COMPANY> <WORKSTATION/> </RPRO_SETTINGS>



Programming with RDA2 Tips and Tricks Converting SID Types SIDs are used in two different formats in RDA2, either as a 64-bit integer or as a character string representation. The string representation is necessary since some languages—for example Visual Basic—cannot handle 64-bit integers.

You can use the following methods to convert between the two formats: //TSID is declared as signed 64-bit integer. //TSIDKey is a String. type TSID = Int64; const SIDKeyLen = SizeOf(TSID) * 2; type TSIDKey = string[SIDKeyLen]; TSIDBytes = array[0..SizeOf(TSID)-1] of byte; //Function which converts numerical SID to 16-character string: function GetSIDKey(SID:TSID): TSIDKey; var CharNum: byte; Bytes: TSIDBytes absolute SID; begin Result := ''; for CharNum := 0 to SizeOf(TSID) - 1 do Result := Result + char((Bytes[CharNum] div 16) + ord('A')) + char((Bytes[CharNum] mod 16) + ord('A')); end; //Function which converts 16-character string to numerical SID: function GetSIDFromKey(Key:TSIDKey):TSID; var Bytes: TSIDBytes; CharNum: byte; begin for CharNum := 0 to SizeOf(TSID) - 1 do Bytes[CharNum] := (byte(Key[CharNum*2+1]) – ord('A')) * 16 + (byte(Key[CharNum*2+2]) - ord('A')); move(bytes, Result, sizeof(bytes)); end;

Setting Fee and Shipping Amounts The Fee and Shipping fields, for example in Invoices and SOs, are actually display only fields. You cannot set a Fee value by writing to fidFee.

Instead you need to use the fidFeeEdt and fidShippingEdt respectively to set these values.



Using COM Objects in a Delphi Console Application Using COM Objects in Delphi is very simple, almost all the work is done for you by the IDE and compiler itself; however, if you are writing a console application then there are a few steps you need to take in order to be able to use COM objects.

1) Include the ActiveX unit in the uses clause.

2) Call a version of the CoInitialize method before instantiating any COM object.

3) Call CoUnInitialize when done with the COM objects.

Example: program ListTables; // A small command line program that will list all RDA2 table names. // Example of using COM in a console application. {$APPTYPE CONSOLE} uses SysUtils, ActiveX, RDA2_TLB; procedure ExecuteProgram; var rdaDB: IRdaDB; rcollAllTables: IRdaCollection; intTableIterator: Integer; begin rdaDB := CoRda2Server.Create; rdaDB.Connect('c:\retail', 1, '', ''); if rdaDB.Connected then begin rcollAllTables := rdaDB.AllTableNames; for intTableIterator := 0 to rcollAllTables.length - 1 do WriteLn (rcollAllTables.item(intTableIterator)); end {if rdaDB.Connected then} else raise Exception.Create('Could not connect to the Retail Pro Database.'); end; begin try CoInitializeEx(nil, COINIT_APARTMENTTHREADED); //Coinitialize must be called before any COM object can be used. ExecuteProgram; except on e: Exception do begin //Handle error condition WriteLn('Program terminated due to an exception'); WriteLn(e.Message); //Set ExitCode <> 0 to flag error condition (by convention) ExitCode := 1; end; {on e: Exception do} end; CoUninitialize; //Clean up any remainig COM objects before exiting the application. End.



RDA2 and .NET – A Word of Warning Unfortunately, there is a known problem with Delphi 5 which is used to compile the RDA2.dll. The problem is manifested in COM objects created with Delphi 5 which may have problems marshaling data if used as an out-of-process COM server. Normally nearly any programming language treats a COM dll as an in-process server in which case there is no problem. However, .NET is inherently using all COM objects out-of-process.

The problem is most likely to be seen when typecasting one interface object to another, for example when getting an IRdaTender interface using the CustomInterface method, or when typcasting an IRdaTenderItem object to another tender item interface.

Since Delphi 5 is no longer maintained by Borland, this bug will most likely never be fixed.



Visual Basic Examples Following are various code extracts that illustrate the use of the RDA2 object model. More complete examples are in the RDA2ObjectModel Visual Basic Project.

Connecting to the Database dim rdaServer as new Rda2Server ‘ ‘ connect for workstation 1. ‘ rdaServer.Connect “C:\Retail\RPro”, 0 if not(rdaServer.Connected) then msgbox “Database connection failed.”, VBOKOnly end if

Adding Table Names to a Combo Box dim rdaServer as new RDA2Server dim intCnt as integer ‘ rdaServer.Connect “C:\RetailPro\RPro”, 1 cboTable.Clear For intCnt = 0 To rdaServer.AllTableNames.Length - 1 cboTable.AddItem rdaServer.AllTableNames.Item(intCnt) Next intcnt

Opening a Table and Setting the Active Index dim rdaServer as new Rda2Server dim rdaTable as IRdaTable ‘ rdaServer.Connect “C:\Retail\RPro”, 1 set rdaTable = rdaServer.CreateTableByName(“Customers”) rdaTable.open ‘ ‘ Set the active index to Cust ID. ‘ rdaTable.ActiveIndexID = 6

Add a Department Dim rdaServer As New Rda2Server Dim rdaTable As IRdaTable ' rdaServer.Connect "C:\Retail\RPro", 0 Set rdaTable = rdaServer.CreateTableByName("Departments") rdaTable.Open rdaTable.NewRecord With rdaTable.Document .FieldByName("fldDept").Value = "Z" .FieldByName("fldClass").Value = "." .FieldByName("fldSubClass").Value = "." .FieldByName("fldDeptName").Value = "ZEBRAS" End With rdaTable.PostRecord rdaTable.Close



Add an Item to a Purchase Order sub AddPO() Dim rdaServer As New Rda2Server Dim rdaTable As IRdaTable Dim rdaPOItem As IRdaDocument Dim strPONum As String Dim strItemNum As String Dim strQty As String Dim blnFound As Boolean ' rdaServer.Connect "C:\Retail\RPro", 0 Set rdaTable = rdaServer.CreateTableByName("POs") rdaTable.Open ' ' Set the active index to PO # ' rdaTable.ActiveIndexID = 1 Do strPONum = InputBox("Enter the PO Number:") Loop Until IsNumeric(strPONum) Do strItemNum = InputBox("Enter the item number to add:") Loop Until IsNumeric(strItemNum) Do strQty = InputBox("How many?") Loop Until IsNumeric(strQty) ' ' Find the PO in the table. ' blnFound = rdaTable.Find(strPONum, False) If Not blnFound Then MsgBox "The PO was not found.", vbOKOnly Exit Sub End If ' ' Set the POItem nested table. ' Set rdaPOItem = rdaTable.Document.NestedDocByName("POItem") ' ' Increment the nested doc count to add the new item. ' With rdaPOItem .Count = .Count + 1 .SetPosition (.Count - 1) ' ' Set the item number and quantity fields. ' Item number is field # 567 (or fidItemLookUp) ' Quantity is field # 10 (or fidQty) ‘ This doesn’t insert the cost or extensions. ' .SetString strItemNum, 567 .SetDouble Val(strQty), 10 End With rdaTable.PostRecord end sub



Use a Field with a Lookup List to Populate a Combo Box Dim rdaServer As New Rda2Server Dim rdaTable As IRdaTable Dim rdaField As IRdaField Dim intCnt As Integer ' rdaServer.Connect "C:\Retail\RPro", 0 Set rdaTable = rdaServer.CreateTableByName("Departments") rdaTable.Open Set rdaField = rdaTable.Document.FieldByName("fldTaxCd") For intCnt = 0 To rdaField.LookupList.Length - 1 cboList.AddItem rdaField.LookupList.Item(intCnt) Next intCnt rdaTable.Close

Create an IrdaInventory Object dim rdaServer as new RDA2Server dim rdaTable as IRdaTable dim rdaIventory as IRdaInventory rdaServer.Connect “C:\RetailPro\RPro”, 1 Set rdaTable = rdaServer.CreateTableByName(“Items”) ‘ ‘ The table must be opened before creating the inventory object. ‘ rdaTable.Open Set rdaInventory = rdaTable.CustomInterface ... do some strange and wonderful thing ... ‘ ‘ Set the inventory object to nothing before closing the table. ‘ Set rdaInventory = Nothing ‘ ‘ Now close the table and clean up. ‘ rdaTable.Close Set rdaTable = Nothing rdaServer.Disconnect Set rdaServer = Nothing

Create an IRdaSO Object dim rdaServer as new Rda2Server dim rdaTable as IRdaTable dim rdaSO as IRdaSO ‘ rdaServer.Connect “C:\RetailPro\RPro”, 1 Set rdaTable = rdaServer.CreateTableByName(“SOs”) ‘ ‘ Create an IRdaSO object from the document linked to rdaTable. ‘ Set rdaSO = rdaTable.CustomInterface



Create IRdaTender Objects

To create an IRdaTender Object for the Invoices Table dim rdaServer as new RDA2Server dim rdaTable as IRdaTable dim rdaTender as IRdaTender ‘ rdaServer.Connect “C:\RetailPro\RPro”, 1 Set rdaTable = rdaServer.CreateTableByName(“Invoices”) ‘ ‘ Create an IRdaTender object from the document linked to rdaTable. ‘ Set rdaTender = rdaTable.Document.CustomInterface

To create an IRdaTender Object for SO deposits dim rdaServer as new RDA2Server dim rdaTable as IRdaTable dim rdaNested as IRdaDocument dim rdaTender as IRdaTender ‘ rdaServer.Connect “C:\RetailPro\RPro”, 1 Set rdaTable = rdaServer.CreateTableByName(“Invoices”) ‘ ‘ Create the nested document for deposits. ‘ Set rdaNested = rdaTable.Document.NestedDocByName(“SODepsosits”) ‘ ‘ Now create the tender object from the nested document. ‘ Set rdaTender = rdaNested.CustomInterface

Get the Terms of a Purchase Order Dim rdaServer As New Rda2Server Dim rdaTable As IRdaTable Dim rdaTerms As IRdaVouTerms Dim strPONum As String Dim strTerms As String Dim blnFound As Boolean ' rdaServer.Connect "C:\Retail\RPro", 1 Set rdaTable = rdaServer.CreateTableByName("POs") rdaTable.Open ' ' Set the active index to the PO number. ' rdaTable.ActiveIndexID = 1 ' ' Create the IRdaVouTerms object. ' Set rdaTerms = rdaTable.Document.CustomInterface ‘ ‘ Start a loop to get a PO number, find the PO and display the terms. ‘ Do Do ‘ Get a PO Number. strPONum = InputBox("Enter a PO number:") Loop Until IsNumeric(strPONum) Or strPONum = "" ‘



‘ Exit if no PO entered. ‘ If strPONum = "" Then Exit Do ‘ ‘ Find the PO in the table. ‘ blnFound = rdaTable.Find(strPONum, False) If blnFound Then ' ' rdaTerms now contains the terms of the PO. ' strTerms = "Terms for PO# " & strPONum & ":" & Chr(13) With rdaTerms ‘ ‘ The .Kind property has the type of terms. ‘ Based on .Kind, construct a string with the ‘ description of the terms. ‘ GetPDString function (below) returns a formatted ‘ string with Percent/Day pairs. ‘ Select Case .Kind Case vpDays strTerms = strTerms & GetPDString(rdaTerms) Case vpCOD strTerms = strTerms & "COD" Case vpCredit strTerms = strTerms & "Credit Account" Case vpReplace strTerms = strTerms & "Replace" Case vpPrepaid strTerms = strTerms & "Prepaid on " & _ Format(.Date, "mm/dd/yyyy") Case vpDue strTerms = strTerms & "Due on " & Format(.Date, "mm/dd/yyyy") Case vpPays strTerms = strTerms & "Payments:" & GetPDString(rdaTerms) Case vpEOM strTerms = strTerms & "EOM:" & GetPDString(rdaTerms) End Select End With ‘ ‘ Display the terms. ‘ MsgBox strTerms, vbOKOnly End If Loop rdaTable.Close Private Function GetPDString(rdaTerms As IRdaVouTerms) As String Dim lngIndex As Long Dim dblPcnt As Double Dim lngDays As Long Dim strPcnt As String ' ' Returns the Percent/Day pairs as a string with embedded ' carriage returns. ' ‘ Uses Get_PercentDays method of IRdaVouTerms which takes an ‘ index as a parameter. The index is 1-based. ‘ lngIndex = 1 Do rdaTerms.Get_PercentDays lngIndex, dblPcnt, lngDays ‘ ‘ Days = 0 means that this pair is not valid and there are ‘ no more pairs in the collection. ‘ If lngDays = 0 Then Exit Do ‘



‘ Percent = 0 means NET. ‘ If dblPcnt = 0 Then strPcnt = "NET " Else strPcnt = Trim(Str(dblPcnt)) & "% " End If If lngIndex > 0 Then GetPDString = GetPDString & Chr(13) ‘ ‘ Add the percent/days to the return string. ‘ GetPDString = GetPDString & strPcnt & Trim(Str(lngDays)) & " Days" lngIndex = lngIndex + 1 Loop End Function

Get the Tender Information for a Receipt Dim rdaServer As New Rda2Server Dim rdaTable As IRdaTable Dim rdaTender As IRdaTender Dim strInvNum As String Dim blnFound As Boolean Dim xmlRoot As IXMLDOMElement Dim xmlElement As IXMLDOMElement Dim strTender As String ' rdaServer.Connect "C:\Retail\RPro", 1 Set rdaTable = rdaServer.CreateTableByName("Invoices") rdaTable.Open ' ' Set the active index to 1 (Receipt#). ' rdaTable.ActiveIndexID = 1 ' ' Set the IRdaTender object. ' Set rdaTender = rdaTable.Document.CustomInterface ' ' Get a receipt number, find the receipt and display the ' tender information. ' Do Do strInvNum = InputBox("Enter a receipt number:") Loop Until IsNumeric(strInvNum) Or strInvNum = "" If strInvNum = "" Then Exit Do ' ' Find the receipt in the table. ' blnFound = rdaTable.Find(strInvNum, False) If blnFound Then Set xmlRoot = rdaTender.XML.documentElement ' ' The root node of the tender XML is the TENDER node. ' Tender information is in the child nodes which are ' element type nodes with attributes. ' There will be a child node for each part of the ' tender information. ' strTender = "Tender information:" For Each xmlElement In xmlRoot.childNodes strTender = strTender & Chr(13) With xmlElement ' ' The node name of the child node is the ' tender type (i.e. cash, check, etc.). '



Select Case .nodeName Case "Cash", "Check", "CreditCard" strTender = strTender & .nodeName ' ' For these types, get the amount. ' The amount is an attribute of the child node. ' There are several ways to retrieve this value. ' This example uses the GetAttribute method for ' an element node. ' strTender = strTender & " Amount=" & _ .getAttribute("Amount") Case "FC" ' ' This tender is foreign currency. The name of the ' currency will be in the FCName attribute. ' In this case, get the name of the currency and ' the amount. There are other attributes that could be ' retrieved including 'Take' and 'Give'. ' ' The FCName attribute has the name ' of the currency. ' strTender = strTender & .getAttribute("FCName") ' ' Now get the amount. ' strTender = strTender & " Amount=" & _ .getAttribute("Amount") End Select End With Next MsgBox strTender, vbOKOnly End If Loop Set rdaTender = Nothing rdaTable.Close