Xstorepos 170 Hig PDF

Oracle® Retail Xstore Point of Service
Host Interface Guide

Release 17.0
E91883-01
January 2018
Oracle® Retail Xstore Point of Service, Host Interface Guide, Release 17.0
E91883-01
Copyright © 2018, Oracle and/or its affiliates. All rights reserved.
Primary Author: A. Meske
This software and related documentation are provided under a license agreement containing
restrictions on use and disclosure and are protected by intellectual property laws. Except as
expressly permitted in your license agreement or allowed by law, you may not use, copy,
reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or
display any part, in any form, or by any means. Reverse engineering, disassembly, or
decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be
error-free. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing
it on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated
software, any programs installed on the hardware, and/or documentation, delivered to U.S.
Government end users are “commercial computer software” pursuant to the applicable Federal
Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,
disclosure, modification, and adaptation of the programs, including any operating system,
integrated software, any programs installed on the hardware, and/or documentation, shall be
subject to license terms and license restrictions applicable to the programs. No other rights are
granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management
applications. It is not developed or intended for use in any inherently dangerous applications,
including applications that may create a risk of personal injury. If you use this software or
hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe,
backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its
affiliates disclaim any liability for any damages caused by use of this software or hardware in
dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be
trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC
trademarks are used under license and are trademarks or registered trademarks of SPARC
International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or
registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open
Group.
This software or hardware and documentation may provide access to or information on content,
products, and services from third parties. Oracle Corporation and its affiliates are not responsible
for and expressly disclaim all warranties of any kind with respect to third-party content, products,
and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle
Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to
your access to or use of third-party content, products, or services, except as set forth in an
applicable agreement between you and Oracle.
Value-Added Reseller (VAR) Language
Oracle Retail VAR Applications
The following restrictions and provisions only apply to the programs referred to in this section
and licensed to you. You acknowledge that the programs may contain third party software (VAR
applications) licensed to Oracle. Depending upon your product and its version number, the VAR
applications may include:
(i) the MicroStrategy Components developed and licensed by MicroStrategy Services Corporation
(MicroStrategy) of McLean, Virginia to Oracle and imbedded in the MicroStrategy for Oracle
Retail Data Warehouse and MicroStrategy for Oracle Retail Planning & Optimization applications.
(ii) the Wavelink component developed and licensed by Wavelink Corporation (Wavelink) of
Kirkland, Washington, to Oracle and imbedded in Oracle Retail Mobile Store Inventory
Management.
(iii) the software component known as Access Via™ licensed by Access Via of Seattle, Washington,
and imbedded in Oracle Retail Signs and Oracle Retail Labels and Tags.
(iv) the software component known as Adobe Flex™ licensed by Adobe Systems Incorporated of
San Jose, California, and imbedded in Oracle Retail Promotion Planning & Optimization
application.
You acknowledge and confirm that Oracle grants you use of only the object code of the VAR
Applications. Oracle will not deliver source code to the VAR Applications to you.
Notwithstanding any other term or condition of the agreement and this ordering document, you
shall not cause or permit alteration of any VAR Applications. For purposes of this section,
"alteration" refers to all alterations, translations, upgrades, enhancements, customizations or
modifications of all or any portion of the VAR Applications including all reconfigurations,
reassembly or reverse assembly, re-engineering or reverse engineering and recompilations or
reverse compilations of the VAR Applications or any derivatives of the VAR Applications. You
acknowledge that it shall be a breach of the agreement to utilize the relationship, and/or
confidential information of the VAR Applications for purposes of competitive discovery.
The VAR Applications contain trade secrets of Oracle and Oracle's licensors and Customer shall
not attempt, cause, or permit the alteration, decompilation, reverse engineering, disassembly or
other reduction of the VAR Applications to a human perceivable form. Oracle reserves the right to
replace, with functional equivalent software, any of the VAR Applications in future releases of the
applicable program.
Contents
1 Overview...........................................................................................1-1
How this Document is Organized ............................................................................ 1-2
Audience........................................................................................................................ 1-2
General Information ................................................................................................... 1-3
Data Formats .......................................................................................................... 1-3
General Rules: ................................................................................................. 1-3
Action Codes & Record Identifiers ..................................................................... 1-4
File Formats ............................................................................................................ 1-4
Required Fields ...................................................................................................... 1-4
Default Values........................................................................................................ 1-4
Fixed Sequence Components - Base Xstore Point of Service........................... 1-5
Xstore Point of Service International Support ....................................................... 1-6
Column Data Types: varchar or nvarchar ......................................................... 1-6
2 System Codes & Values..................................................................2-1

Organization Hierarchy Record (ORG_HIER)....................................................... 2-1
Retail Location Record (RETAIL_LOCATION) .................................................... 2-3
Retail Location Property (RETAIL_LOCATION_PROPERTY).......................... 2-7
Retail Location Coordinates (RETAIL_LOCATION_COORDINATES).......... 2-8
Workstation Record (WORKSTATION)................................................................. 2-9
Workstation Property (WORKSTATION_PROPERTY) .................................... 2-10
Code Value Record (CODE_VALUE) .................................................................... 2-11
Reason Code Record (REASON_CODE) .............................................................. 2-13
Reason Code Property Record (REASON_CODE_PROPERTY) ...................... 2-16
Receipt Text Record (RECEIPT_TEXT) ................................................................. 2-18
Sequence Record (SEQUENCE).............................................................................. 2-20
Sequence Record (SEQUENCE_PART)................................................................. 2-21
Exchange Rate Record (EXCHANGE_RATE) ...................................................... 2-23
Exchange Rate Hierarchy Record (EXCHANGE_RATE_HIER) ....................... 2-24
Retail Location Close Date Record (RETAIL_LOCATION_CLOSE_DATE). 2-25
Retail Location Question Record (RETAIL_LOCATION_QUESTION) ........ 2-26
Retail Location Question Choices Record
(RETAIL_LOCATION_QUESTION_CHOICES)................................................ 2-28
Translation Record (TRANSLATION).................................................................. 2-29
Transaction Prompt Properties Record (TRANS_PROMPT_PROPERTIES) 2-30
Shipping Fee Record (SHIPPING_FEE) ................................................................ 2-33
Shipping Fee Tier Record (SHIPPING_FEE_TIER)............................................ 2-36
Simple Shipping Fee Record (SIMPLE_SHIPPING_FEE)................................. 2-39
Shipping Cost Record (SHIPPING_COST).......................................................... 2-44
Report Organizer Record (REPORT_ORGANIZER).......................................... 2-46
Address Country Record (ADDRESS_COUNTRY)............................................ 2-47
Address Postal Code Record (ADDRESS_POSTAL_CODE)............................ 2-49
Address State Record (ADDRESS_STATE) ......................................................... 2-51
4
Country Return Map Record (COUNTRY_RETURN_MAP) ............................ 2-53
Sales Goal Record (SALES_GOAL) ....................................................................... 2-54
Device Configuration Record (DEVICE_CONFIG)............................................ 2-55
3 Items & Pricing.................................................................................3-1

Item Record (ITEM)..................................................................................................... 3-1
Item Options Record (ITEM_OPTIONS).............................................................. 3-12
Non-Physical Item Record (NON_PHYSICAL_ITEM) ...................................... 3-20
Price Update Record (PRICE_UPDATE_2) ........................................................... 3-23
Merchandise Hierarchy Record (MERCH_HIER) ............................................... 3-25
Pricing Hierarchy Record (PRICING_HIER) ....................................................... 3-27
Item Property (ITEM_PROPERTY) ........................................................................ 3-29
Kit Component Record (KIT_COMPONENT) .................................................... 3-30
Kit Component Property (KIT_COMPONENT_PROPERTY).......................... 3-32
Item Dimension Type Record (ITEM_DIMENSION_TYPE) ........................... 3-34
ITEM DIMENSION VALUE (ITEM_DIMENSION_VALUE) ......................... 3-36
Item Cross-Reference Record (ITEM_XREF)........................................................ 3-38
Item Images Record (ITEM_IMAGES).................................................................. 3-40
Item Vendor Record (ITEM_VENDOR)................................................................ 3-41
Item Vendor Property (ITEM_VENDOR_PROPERTY)..................................... 3-44
Price History Record (PRICE_HISTORY_2)......................................................... 3-45
Attached Items Record (ATTACHED_ITEMS) ................................................... 3-47
Item Prompt Property Record (ITEM_PROMPT_PROPERTY)........................ 3-49
Item Message Record (ITEM_MESSAGE)............................................................ 3-52
Item Message Type Record (ITEM_MESSAGE_TYPE) ..................................... 3-54
Item Message Cross-Reference Record (ITEM_MESSAGE_XREF)................. 3-55
Item Message Sale Record (ITEM_MESSAGE_SALE)....................................... 3-56
Item Restriction Record (ITEM_RESTRICTION) ............................................... 3-58
Item Restriction Calendar Record (ITEM_RESTRICTION_CALENDAR) .... 3-60
Item Restriction Mapping Record (ITEM_RESTRICTION_MAPPING) ....... 3-62
Substitute Items Record (SUBSTITUTE_ITEMS)............................................... 3-63
Refund Proration Record (REFUND_PRORATION) ......................................... 3-64
Item Matrix Sort Order Record (ITEM_MATRIX_SORT_ORDER) ................ 3-66
Quick Items Record (QUICK_ITEMS) .................................................................. 3-67
Item Tax Group (ITEM_TAX_GROUP) ................................................................ 3-68
Item Deal Property (ITEM_DEAL_PROPERTY) ................................................. 3-69
4 Parties - Customers & Employees .................................................4-1

Party Record (PARTY) ................................................................................................ 4-1
ApplicabilityCondition......................................................................................... 4-8
ApplicabilityCondition......................................................................................... 4-8
Party Email Record (PARTY_EMAIL) ..................................................................... 4-9
Party Property Record (PARTY_PROPERTY) ...................................................... 4-10
Party Telephone Record (PARTY_TELEPHONE) ............................................... 4-11
5
Party Id Cross-Reference Record (PARTY_ID_XREF)........................................ 4-12
Party Cross-Reference Record (PARTY_XREF).................................................... 4-13
Party Address Record (PARTY_ADDRESS) ........................................................ 4-14
Employee Record (EMPLOYEE) ............................................................................. 4-16
Employee Store Record (EMPLOYEE_STORE) ................................................... 4-21
Employee Note Record (EMPLOYEE_NOTE)...................................................... 4-22
Employee Password Record (EMPLOYEE_PASSWORD) ................................. 4-23
Employee Task Record (EMPLOYEE_TASK) ...................................................... 4-24
Employee Task Notes Record (EMPLOYEE_TASK_NOTES) .......................... 4-26
Employee Message Record (EMPLOYEE_MESSAGE) ...................................... 4-27
Customer Group Record (CUST_GROUP)........................................................... 4-29
Customer Affiliation Record (CUST_AFFILIATION) ...................................... 4-31
Customer Note Record (CUST_NOTE) ................................................................. 4-32
Customer Merge Record (CUSTOMER_MERGE) .............................................. 4-33
Customer Consent Information Record (CUSTOMER_CONSENT_INFO) .. 4-35
Anonymize Customer Record (CUSTOMER_ANONYMIZE) ......................... 4-36
Anonymize Employee Record (EMPLOYEE_ANONYMIZE)........................... 4-46
5 Inventory...........................................................................................5-1
Stock Ledger Record (STOCK_LEDGER)............................................................... 5-1
Inventory Document Record (INV_DOC) .............................................................. 5-3
Inventory Document Property Record (INV_DOC_PROPERTY)...................... 5-9
Carton Record (CARTON) ....................................................................................... 5-11
Inventory Document Line Item Record (INV_DOC_LINE_ITEM) ................. 5-13
Inventory Valid Destination Record (INV_VALID_DESTINATIONS) ........ 5-17
Inventory Valid Destinations Property
(INV_VALID_DESTINATIONS_PROPERTY) ................................................... 5-19
Inventory Bucket Record (INVENTORY_BUCKET) .......................................... 5-21
Inventory Bucket Property (INVENTORY_BUCKET_PROPERTY) ............... 5-23
Inventory Count Record (INV_COUNT) .............................................................. 5-25
Inventory Count Bucket Record (INV_COUNT_BUCKET).............................. 5-26
Inventory Count Sheet Record (INV_COUNT_SHEET).................................... 5-27
Inventory Count Sheet Property (INV_COUNT_SHEET_PROPERTY) ......... 5-29
Inventory Count Sheet Line Item Record (INV_COUNT_SHEET_LINEITEM)5-31
Inventory Count Sheet Line Item Property
(INV_COUNT_SHEET_LINEITEM_PROPERTY) .............................................. 5-33
Inventory Document Line Serial Record (INV_DOC_LINE_SERIAL)........... 5-35
Inventory Document Shipment Carton Record
(INV_DOC_SHIPMENT_CARTON)..................................................................... 5-37
Inventory Document Shipment Line Item Record
(INV_DOC_SHIPMENT_LINEITEM) .................................................................. 5-39
Inventory Document Shipment Line Item Record Property
(INV_DOC_SHIPMENT_LINEITEM_PROPERTY)........................................... 5-41
Inventory Item Account Modifier Record (INV_ITEM_ACCOUNT_MODIFIER)
5-43
6
Inventory Location Record (INV_LOCATION) .................................................. 5-45
Inventory Location Property (INV_LOCATION_PROPERTY)........................ 5-46
Inventory Location Availability Record (INV_LOCATION_AVAILABILITY)5-48
Inventory Location Bucket Record (INV_LOCATION_BUCKET).................. 5-49
Inventory Location Bucket Property (INV_LOCATION_BUCKET_PROPERTY)5-
50
Inventory Location Modifier Record (INV_LOCATION_MODIFIER).......... 5-52
Inventory Serialized Stock Ledger Record (INV_SERIALIZED_STOCK_LEDGER)
5-54
Document Note Record (DOCUMENT_NOTE) .................................................. 5-55
Inventory Shipper Record (INV_SHIPPER)......................................................... 5-57
Inventory Shipper Method Record (INV_SHIPPER_METHOD) .................... 5-58
Inventory Document In Record (INV_DOC_IN) ................................................ 5-60
Inventory Replenishment Document Line Item Record
(INV_REP_DOC_LINE_ITEM) ............................................................................... 5-62
Shipment Record (SHIPMENT).............................................................................. 5-65
Shipment Property (SHIPMENT_PROPERTY) ................................................... 5-68
Inventory Cross Reference Record (INV_CROSS_REF).................................... 5-70
Fiscal Year Record (FISCAL_YEAR) ...................................................................... 5-72
Inventory Cost Item Yearend Record (INV_CST_ITEM_YEAREND) ............ 5-73
6 Discounts, Coupons, Deals, & Documents ...................................6-1

Discount Record (DISCOUNT) ................................................................................ 6-1
Discount No Groups Record (DISCOUNT_NO_GROUPS) ............................... 6-5
Discount Compatibility Record (DISCOUNT_COMPATIBILITY) ................. 6-6
Discount Group Mapping Record (DISCOUNT_GROUP_MAPPING) ......... 6-7
Discount Item Exclusions Record (DISCOUNT_ITEM_EXCLUSIONS) ......... 6-8
Discount Item Inclusions Record (DISCOUNT_ITEM_INCLUSIONS).......... 6-9
Discount Type Eligibility Record (DISCOUNT_TYPE_ELIGIBILITY) ........ 6-10
Coupon Cross-Reference Record (COUPON_XREF).......................................... 6-11
Deal Customer Group Mapping Record (DEAL_CUST_GROUPS)................ 6-13
Deal Record (DEAL).................................................................................................. 6-14
Deal Trigger Record (DEAL_TRIGGER) .............................................................. 6-20
Deal Trigger Exclude Record (DEAL_TRIGGER_EXCLUDE).......................... 6-21
Deal Rules Record (DEAL_ITEM).......................................................................... 6-23
Deal Item Mapping Record (DEAL_ITEM_TEST).............................................. 6-26
Deal Document Cross-Reference Record (DEAL_DOCUMENT_XREF)........ 6-32
Deal Week Record (DEAL_WEEK) ........................................................................ 6-33
Free Giftcard Record (FREE_GIFTCARD)............................................................ 6-34
Rebate Record (REBATE) ......................................................................................... 6-39
Coupon Deal Record (COUPON_DEAL).............................................................. 6-44
Document Record (DOCUMENT).......................................................................... 6-46
Document Properties Record (DOCUMENT_PROPERTIES) .......................... 6-48
7
7 Taxing ...............................................................................................7-1
Tax Bracket Record (TAX_BRACKET) .................................................................... 7-1
Tax Location Record (TAX_LOCATION) ............................................................... 7-3
Tax Retail Location Mapping Record (TAX_RETAIL_LOCATION_MAPPING)7-4
Tax Authority Record (TAX_AUTHORITY) ......................................................... 7-5
Tax Group Record (TAX_GROUP)........................................................................... 7-8
Tax Group Property (TAX_GROUP_PROPERTY) ................................................ 7-9
Tax Group Rule Record (TAX_GROUP_RULE) .................................................. 7-10
Tax Rate Rule Record (TAX_RATE_RULE) ......................................................... 7-13
Tax Rate Rule Override Record (TAX_RATE_RULE_OVERRIDE)................. 7-16
Tax Postal Code Mapping Record (TAX_POSTAL_CODE_MAPPING) ....... 7-19
Tax Group Mapping Record (TAX_GROUP_MAPPING) ................................ 7-20
Tax Exemption Record (TAX_EXEMPTION) ....................................................... 7-22
8 Accounts, Loyalty & Warranties.....................................................8-1

Customer Account Properties Record (CUST_ACCT_PROP) ............................ 8-1
Customer Account Card Record (CUST_ACCT_CARD) ..................................... 8-3
Customer Charge Account Record (CUST_CHARGE_ACCT) .......................... 8-5
Customer Charge Account Users Record (CUST_CHARGE_ACCT_USERS). 8-8
Customer Charge Account History Record
(CUST_CHARGE_ACCT_HIST) ............................................................................ 8-10
Customer Charge Account Invoice Record (CUST_CHARGE_ACCT_INVOICE)8-
12
Customer Loyalty Account Record (CUST_LOYALTY_ACCT) ....................... 8-14
Customer Award Record (CUST_AWARD) ......................................................... 8-16
Customer Account Note Record (CUST_ACCT_NOTE).................................... 8-17
Customer Account Plan Record (CUST_ACCT_PLAN)..................................... 8-18
Warranty Item Record (WARRANTY_ITEM) ...................................................... 8-20
Warranty Item Price Record (WARRANTY_ITEM_PRICE).............................. 8-23
Warranty Item Cross-Reference Record (WARRANTY_ITEM_XREF) ........... 8-25
Warranty Record (WARRANTY) ............................................................................ 8-26
Warranty Property (WARRANTY_PROPERTY) ................................................. 8-32
Escrow Account Record (ESCROW_ACCT) ......................................................... 8-33
9 Work Orders .....................................................................................9-1

Customer Work Order Task Record (CWO_TASK) ............................................. 9-1
Customer Work Order Category Record (CWO_CATEGORY) .......................... 9-3
Customer Work Order Service Location Record (CWO_SERVICE_LOCATION)9-
5
Customer Work Order Price Code Record (CWO_PRICE_CODE).................... 9-6
Customer Work Order Pricing Record (CWO_PRICING)................................... 9-8
Customer Work Order Category Service Location Record
(CWO_CATEGORY_SERVICE_LOCATION)....................................................... 9-9
8
10 Tenders, Vouchers, & Till Sessions.............................................10-1
Tender Record (TENDER)........................................................................................ 10-1
Tender Availability Record (TENDER_AVAILABILITY)................................. 10-9
Tender Denomination Record (TENDER_DENOMINATION)..................... 10-10
Tender Options Record (TENDER_OPTIONS)................................................. 10-12
Tender Type Record (TENDER_TYPE) ............................................................... 10-20
Tender User Settings Record (TENDER_USER_SETTINGS)......................... 10-22
Tender Repository Record (TENDER_REPOSITORY) .................................... 10-25
Tender Repository Property (TENDER_REPOSITORY_PROPERTY) ......... 10-27
Tender Repository Float Record (TENDER_REPOSITORY_FLOAT) .......... 10-29
Tender Repository Float Property (TENDER_REPOSITORY_FLOAT_PROPERTY)
10-30
Tender Repository Status Record (TENDER_REPOSITORY_STATUS) ..... 10-32
Voucher Record (VOUCHER) ............................................................................... 10-33
Session Record (SESSION).................................................................................... 10-35
Session Tender Record (SESSION_TENDER)................................................... 10-37
11 Security...........................................................................................11-1
Security Group Record (SEC_GROUP)................................................................. 11-1
Security Privilege Record (SEC_PRIVILEGE) ..................................................... 11-3
Security Access Type Record (SEC_ACCESS_TYPE) ......................................... 11-6
Security Access Control List Record (SEC_ACL) ................................................ 11-7
Shared Secret Removal (SEC_PASSWORD)........................................................ 11-8
12 Payroll, Scheduling & Timecard...................................................12-1

Work Code Record (WORK_CODE)...................................................................... 12-1
Payroll Category Record (PAYROLL_CAT) ......................................................... 12-4
Payroll Note Record (PAYROLL_NOTE).............................................................. 12-5
Schedule Record (SCHEDULE) .............................................................................. 12-6
Schedule Employee Timeoff Record (SCHEDULE_EMPLOYEE_TIMEOFF)12-8
Schedule Shift Record (SCHEDULE_SHIFT) .................................................... 12-10
Timecard Entry Record (TIMECARD_ENTRY)................................................. 12-12
13 Thermal Printer Support ...............................................................13-1

Item Label Batch Record (ITEM_LABEL_BATCH)............................................. 13-1
Item Label Property Record (ITEM_LABEL_PROPERTY) ................................ 13-3
14 Airport Retail Location Support ...................................................14-1

Airport Record (AIRPORT) ..................................................................................... 14-1
Airport Zone Record (AIRPORT_ZONE) ............................................................. 14-2
Airport Zone Detail Record (AIRPORT_ZONE_DETAIL) ............................... 14-2
Flight Information Record (FLIGHT_INFORMATION)................................... 14-3
9
15 Country Pack Information.............................................................15-1
Tax Free Country Record (TAXFREE_COUNTRY) ............................................. 15-1
16 Xstore Office Users .......................................................................16-1

Xstore Office User (XADMIN_USER) ................................................................... 16-2
Xstore Office User Node (XADMIN_USER_NODE).......................................... 16-4
17 Transaction Records .....................................................................17-1

Overview ..................................................................................................................... 17-1
Transaction Header Record (TRANS_HEADER) ................................................ 17-1
Transaction Line Item Record (TRANS_LINE_ITEM)....................................... 17-5
Transaction Line Item Tax Record (TRANS_LINE_ITEM_TAX)..................... 17-8
Transaction Tax Record (TRANS_TAX).............................................................. 17-11
Transaction Tender Record (TRANS_LINE_TENDER) ................................... 17-14
Line Item Association Type Code Record
(LINE_ITEM_ASSOCIATION_TYPE_CODE) .................................................. 17-17
Valid Commands for a Data File Record ............................................................ 17-19
Transaction Returned Item Journal (TRANS_RETURNED_ITEM_JOURNAL)17-
20
18 Valid Commands for a Data File Record .....................................18-1

DataLoader Commands ............................................................................................ 18-1
19 DataLoader .....................................................................................19-1
Overview ..................................................................................................................... 19-1
DataLoader Operation .............................................................................................. 19-2
Starting DataLoader ............................................................................................ 19-2
DataLoader Operation Description .................................................................. 19-2
About .lst files ................................................................................................. 19-2
DataLoader Execution ................................................................................. 19-2
About the failures.dat File.................................................................................. 19-4
Sample failures.dat Line.............................................................................. 19-4
DataLoader Logging ........................................................................................... 19-4
DataLoader Data Files............................................................................................... 19-5
Data File Line Example....................................................................................... 19-5
Replacement File Processing ................................................................................... 19-5
Example................................................................................................................. 19-6
*.reo (reorganize) Files ................................................................................. 19-6
Replacement File Types Processing Comparison ........................................... 19-6
Valid Commands for a Data File Record .............................................................. 19-7
About the “UPDATE” and “UPDATE_SELECT” Action Types .................. 19-7
About the “RUN_SQL” Action Type ........................................................ 19-8
10
Header and Comments ............................................................................................. 19-9
XML Header ......................................................................................................... 19-9
Line Count ..................................................................................................... 19-9
Download Id ................................................................................................. 19-9
Application Date........................................................................................... 19-9
Target Org Node........................................................................................... 19-9
Deployment Name ....................................................................................... 19-9
Download Time ............................................................................................ 19-9
Apply Immediately .................................................................................... 19-10
Example: Dataloader header for file created by Xstore Office. All DataLoader
files created by Xstore Office will have this header. ............................. 19-10
Example: Dataloader header for file not created by Xstore Office...... 19-10
DataLoader Configuration ..................................................................................... 19-10
DataLoaderConfig.xml ..................................................................................... 19-11
DataLoaderConfig.xml Record Definition..................................................... 19-13
DataLoaderConfig.xml Value Translation ......................................................... 19-14
Example Value Translator Usage: StringConcatTranslator......................... 19-14
Dao and Sql Statement Applicability.............................................................. 19-17
Failure Reporting ..................................................................................................... 19-17
A Change History ............................................................................... A-1

Version 17.0.................................................................................................................. A-1
Version 16.0.0.1, Revision 03..................................................................................... A-2
Version 16.0.0.1, Revision 02..................................................................................... A-2
Version 16.0.0.1............................................................................................................ A-3
Version 16.0, Revision 02........................................................................................... A-3
Version 16.0.................................................................................................................. A-3
11
Send Us Your Comments
Oracle welcomes customers' comments and suggestions on the quality and usefulness of
this document.
Your feedback is important, and helps us to best meet your needs as a user of our
products. For example:
• Are the implementation steps correct and complete?
• Did you understand the context of the procedures?
• Did you find any errors in the information?
• Does the structure of the information help you with your tasks?
• Do you need different information or graphics? If so, where, and in what format?
• Are the examples correct? Do you need more examples?
If you find any errors or have any other suggestions for improvement, then please tell us
your name, the name of the company who has licensed our products, the title and part
number of the documentation and the chapter, section, and page number (if available).
Note: Before sending us your comments, you might like to check that
you have the latest version of the document and if any concerns are
already addressed. To do this, access the Online Documentation
available on the Oracle Technology Network Web site. It contains the
most current Documentation Library plus all documents revised or
released recently.
Send your comments to us using the electronic mail address: retail-doc_us@oracle.com

Please give your name, address, electronic mail address, and telephone number
(optional).
If you need assistance with Oracle software, then please contact your support
representative or Oracle Support Services.
If you require training or instruction in using Oracle software, then please contact your
Oracle local office and inquire about our Oracle University offerings. A list of Oracle
offices is available on our Web site at www.oracle.com
12
Preface
This guide describes the DataLoader, and the format of the DataLoader files used to
populate the Xstore Point of Service database.
Audience
This Host Interface Guide is written for the following audiences:
• Business analysts
• System analysts
• Integrators and implementation personnel
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility
Program website at http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=docacc.
Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For
information, visit http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=trs if you are hearing impaired.
Related Documents
For more information, see the following documents in the Xstore Point of Service 17.0
documentation set:
• Xstore Suite Release Notes
• Xstore Suite Oracle Retail Xstore Suite 17.0/Merchandising 16.0.1 Implementation
Guide
• Xstore Point-of-Service User Guide
• Xstore Point-of-Service Mobile User Guide
• Xstore Point-of-Service Reports Guide
• Xstore Point-of-Service Manager's Guide
• Xstore Point-of-Service Shipping, Receiving, and Inventory Guide
• Xstore Office User Guide
• Oracle Retail Xstore Point-of-Service, Lane Checkout User Interface User Guide
• Xstore Suite Implementation and Security Guide
• Xstore Point-of-Service Frameworks and Technologies Guide
• Xstore Suite Deal Pricing Guide
• Xenvironment User Guide
13
Customer Support
• Xstore Point-of-Service Services Guide

• Xstore Point-of-Service Technical Guide
• Xstore Point-of-Service POS Log Files
• Xstore Point-of-Service Database Dictionary Guide
• Xstore Office Database Dictionary Guide
Customer Support
To contact Oracle Customer Support, access My Oracle Support at the following URL:
https://support.oracle.com
When contacting Customer Support, please provide the following:
• Product version and program/module name
• Functional and technical description of the problem (include business impact)
• Detailed step-by-step instructions to re-create
• Exact error message received
• Screen shots of each step you take
Review Patch Documentation

When you install the application for the first time, you install either a base release (for
example, 17.0) or a later patch release (for example, 17.0.1). If you are installing the base
release or additional patch releases, read the documentation for all releases that have
occurred since the base release before you begin installation. Documentation for patch
releases can contain critical information related to the base release, as well as
information about code changes since the base release.
Oracle Retail Documentation on the Oracle Technology

Network
Documentation is packaged with each Oracle Retail product release. Oracle Retail
product documentation is also available on the following Web site:
http://www.oracle.com/technology/documentation/oracle_retail.html
(Data Model documents are not available through Oracle Technology Network. These
documents are packaged with released code, or you can obtain them through My Oracle
Support.)
Documentation should be available on this Web site within a month after a product
release.
Conventions
Navigate: This is a navigate statement. It tells you how to get to the start of the procedure
and ends with a screen shot of the starting point and the statement “the Window Name
window opens.”
This is a code sample
It is used to display examples of code
14
Conventions
15
1
Overview
The following information is intended for programmers and implementation personnel

to use when interfacing the Xstore Point of Service® application to home office systems.
The information provided here identifies the files produced by the Xstore Point of
Service application for transmission to host systems and the files accepted for processing
updates to Xstore Point of Service operating tables.
Each record affects one or more database tables. Information in this document includes
the download record and the database table or tables it affects, as well as the fields
within the tables that are populated. Since the Action Code and Record Identifier fields
(fields 1 and 2) are never inputted into the database, but instead identify the record
action and type, any Field entries listed as “All Fields” do not include fields 1 and 2.
The following download record categories require an Xstore Point of Service restart on
each register once the download file has finished processing:
• “System Codes & Values”
• “Discounts, Coupons, Deals”
• “Taxing”
• “Tenders, Vouchers, & Till Sessions”
• “Security”
• “Payroll, Scheduling & Timecard”
Note: “Items & Pricing” does not require an Xstore Point of Service
restart, but these changes will not take effect in the middle of a
transaction.
Overview 1-1
How this Document is Organized
How this Document is Organized

The following chapters provide record layout information, including the fields, field
positions, data types and sizes, whether or not a field is required, and a brief description
of each record and field within the record. The record information in these chapters are
grouped by functional area:
• Chapter 2, “System Codes & Values”
• Chapter 3, “Items & Pricing”
• Chapter 4, “Parties - Customers & Employees”
• Chapter 5, “Inventory”
• Chapter 6, “Discounts, Coupons, Deals, & Documents”
• Chapter 7, “Taxing”
• Chapter 8, “Accounts, Loyalty & Warranties”
• Chapter 9, “Work Orders”
• Chapter 10, “Tenders, Vouchers, & Till Sessions”
• Chapter 11, “Security”
• Chapter 12, “Payroll, Scheduling & Timecard”
• Chapter 13, “Thermal Printer Support”
• Chapter 14, “Airport Retail Location Support”
• Chapter 15, “Country Pack Information”
• Chapter 16, “Xstore Office Users”
• Chapter 17, “Transaction Records”
• Chapter 18, “Valid Commands for a Data File Record”
• Chapter 19, “DataLoader” provides detailed information about the DataLoader
application used for translating flat data files into database data that can be used by
Xstore Point of Service.
Audience
This guide is intended for anyone responsible for interfacing the Xstore Point of Service
application to home office systems, including Operations Technical Support and
Customer Technical Support.
1-2 Host Interface Guide

General Information
General Information
Data Formats
DateTime fields are always yyyy-mm-dd hh:mm:ss.nnn for a total length of 23
characters. Time values are always in 24-hour format. (e.g. January 15, 2004 2:10 pm will
format as 2004-01-15 14:10:00.000)
Note: SQL server does not provide data types for storing the date
exclusively or the time exclusively. In Microsoft SQL server, only a
DATETIME data type is supported. In Oracle SQL server, the data type
is TIMESTAMP.
For this reason, the date fields (effective_date and end_date)
include a time in addition to the date. The time fields (start_time
and end_time) include a date in addition to the time.
Integer fields are usually a maximum of 11 characters, but may change depending upon
the underlying database. Leading zeroes are suppressed. When the number is negative,
the sign will float in front.
BigInt fields are usually a maximum of 22 characters, but may change depending upon
the underlying database. Leading zeroes are suppressed. When the number is negative,
the sign will float in front.
Decimal fields are usually a maximum of 17 characters. Leading zeroes are suppressed.
The decimal point is always explicit. Most decimal fields will contain 6 places to the right
of the decimal point. The length of decimal fields is specified with the first number
representing the total field width (less the decimal point) followed by a comma and the
precision of the number. A field with a length listed as 17, 6 may hold up to 19 characters
(up to 11 numerals to the left of the decimal point, the decimal point itself, and up to 6
numerals to the right of the decimal point). When the number is negative, the sign will
float in front.
String fields are usually a maximum of 254 characters.
Boolean fields are a maximum of 5 characters. (Note: Value based on FALSE=5
characters.)
The DataLoader will recognize the following:
• FALSE = {0, “false”} // “false” is case-insensitive
• TRUE = {1, “true”} // “true” is case-insensitive
General Rules:
The following sizes and datatypes are used consistently in Xstore Point of Service:
• Organization ID: Integer
• Retail Location ID: Integer
• Party ID: BigInt
• Item ID: String(60)
• Percentage (tax): Decimal(8,6)
• Price, dollar amounts: Decimal(17,6)
• Quantities: Decimal(11,4)
Overview 1-3
General Information
Action Codes & Record Identifiers

The first two columns of each record are reserved for the action code and record
identifier.
Action Codes
See Chapter 18, “Valid Commands for a Data File Record” for more information.
The first column identifies the action code of the record.
Record Identifiers
The second column is the record identifier. This value will identify to the system the type
of record that follows. Each record identifier may specify a unique field layout for the
record.
File Formats
The DataLoader is designed to adapt flat data files into relational data that Xstore Point
of Service can use. These flat files are referred to generically as “data files” within the
DataLoader. The DataLoader treats each line in the file as a record. Every file line begins
with a command field followed by a record type field which is then followed by the
appropriate data for that record. Fields are typically delimited by an ASCII character and
are referred to by the DataLoader via their index number. Field position indices are 1-
based, where the command is field 1, the record type is field 2, and the first piece of
actual data is 3, and so on. The DataLoader auto-detects the delimiter, so the delimiter
can be any ASCII character that is guaranteed not to appear in the data itself. However,
the same delimiter should be used at all times.
Required Fields
The required fields are denoted by the  symbol in the following tables. A blank entry
indicates the field is not required, and the * symbol indicates that additional information
can be found in the comments section.
All flags default to FALSE and are not required unless otherwise noted.
Default Values
When applicable, a default constraint defines the value that will be supplied for a
column whenever a user fails to enter a value.

General Information
Fixed Sequence Components - Base Xstore Point of Service

Xstore Point of Service-generated sequences make varying assumptions about the width
of fixed sequence components such as the store and register numbers. To avoid problems
that may result if a given sequence reserves too few characters for the store/register
number, or truncation errors occur due to host system aggregation of data in a common
table that Xstore Point of Service treats as disparate, the following sequence rules are
enforced:
• A store # sequence component has a 0-padded width of 4.
• A register # sequence component has a 0-padded width of 3.
Table 1-1: Sequence Formats for Version 3.5 and Above
Sequence Type Context Old New Change

Length Length
[newLength/change]: field
EMPLOYEE Create Employee 14 14 [3/-1]: workstationId

[7/+1]: sequence
Party Create Customer 14 14 [3/-1]: workstationId

Create Employee [7/+1]: sequence
Voucher 14 14 [3/-1]: workstationId

[7/+1]: sequence
GIFT_CERTIFICATE Sell Gift 10 12 [4/+1]: retailLocationId

Certificate
[3/+1]: workstationId
STORE_CREDIT Issue Store 11 13 [4/+1]: retailLocationId

Credit
[3/+1]: workstationId
GIFT_CARD 14 14 [3/-1]: workstationId

[7/+1]: sequence
MERCHANDISE_ 14 14 [3/-1]: workstationId

CREDIT_CARD
[7/+1]: sequence
TAX_EXEMPTION 14 13 [3/-1]: workstationId
Overview 1-5
Xstore Point of Service International Support
Xstore Point of Service International Support

Xstore Point of Service supports international conventions. All Xstore Point of Service
databases (e.g. xstore, training, replication, xcenter and admin) have been constructed to
support Unicode or double-byte data. This allows Xstore Point of Service to save
international alphabet characters (e.g. Japanese, Chinese and Korean letters) in the
database.
Column Data Types: varchar or nvarchar

The Xstore Point of Service database has standardized on column datatypes for the
domestic base; where the domestic Xstore Point of Service base uses varchar column
types, the international base version uses nvarchar.
The Xcenter database is a reproduction of the Xstore Point of Service database and it also
maintains nvarchar datatypes for regional data.
The nvarchar datatype provides support for the double-byte (sometimes referenced as
Unicode) characters. This support is required regionally for countries that require
double-byte character sets to represent their alphabet and numbers. Japan and China are
examples of two regions that require double-byte “Kanji” characters and require
nvarchar data types in the database to properly represent the data.

2
System Codes & Values
Organization Hierarchy Record (ORG_HIER)

The ORG_HIER record populates the loc_org_hierarchy table and defines a largely
arbitrary, self-referential hierarchy of location information, with more general locations
closer to the top of the hierarchy. This information allows discounts and other functions
to be applied based on the corporate structure. Lower levels will override higher levels.
For example, a “city” component will override a “region” component. (This can be used
to enable location-based item pricing.)
Database Table Updated Fields Dao name
loc_org_hierarchy All Fields OrgHierarchy
Organization Hierarchy Record (ORG_HIER) (Sheet 1 of 2)
Field # Name Type Width Required Comment

“Field Name” Table.Column
1. Action Code String as  See Chapter 18, “Valid

specified Commands for a Data File
Record”.
2. Record Identifier String 30  “ORG_HIER”
3. Level Code String 30  The level code based on the

customer’s store structure.
“LevelCode”
Describes the type of
organization node.
loc_org_hierarchy.org_code
4. Level Value String 60  The value for the level code.

“LevelValue”
loc_org_hierarchy.org_value
5. Parent Code String 30 The parent code of this current

level.
“ParentCode”
loc_org_hierarchy.parent_code
System Codes & Values 2-1

Organization Hierarchy Record (ORG_HIER)
Organization Hierarchy Record (ORG_HIER) (Sheet 2 of 2)

6. Parent Value String 60 The parent value of this current

level.
“ParentValue”
loc_org_hierarchy.parent_value
7. Level Manager String 254 The name of the person

managing the organization
“LevelManager”
represented by the node.
loc_org_hierarchy.level_mgr
8. Description String 254 A description of the node.

“Description”
loc_org_hierarchy.description
9. Level Order Integer The order of current hierarchy.

Example: If the organization
“LevelOrder”
structure is DISTRICT, CHAIN,
STORE, the order number would
be 10, 20, 30.
loc_org_hierarchy.level_
order
10. Sort Order Integer Determines the order in which a

list is sorted.
“SortOrder”
loc_org_hierarchy.sort_
order
11. Inactive flag Boolean 5 If true, the org hierarchy is

currently inactive.
"Inactive"
loc_org_hierarchy.inactive_flag

Retail Location Record (RETAIL_LOCATION)

Contains store name and address information specific to one store.
loc_rtl_loc All Fields RetailLocation
Retail Location Record (RETAIL_LOCATION) (Sheet 1 of 4)


Record”.
2. Record Identifier String 30  “RETAIL_LOCATION”
3. Retail Location Integer  Unique identifier for a specific

ID (PK) retail store within the
organization.
“RetailLocation
Id” loc_rtl_loc.rtl_loc_id
4. Store Number String 254  Retailer-assigned store number.

“StoreNbr” loc_rtl_loc.store_nbr
5. Store Name String 254 Name of the store.

“StoreName” loc_rtl_loc.store_name
6. Description String 254 Description of the store.

“Description” loc_rtl_loc.description
7. Address 1 String 254 First line of the mailing address.

“Address1” loc_rtl_loc.address1
8. Address 2 String 254 Second line of the mailing

address.
“Address2”
loc_rtl_loc.address2
9. Apartment String 30 Apartment or suite number of

the mailing address.
“Apartment”
loc_rtl_loc.apartment
10. City String 254 City component of the mailing

address.
“City”
loc_rtl_loc.city
11. State String 30 State component of the mailing

address.
“State”
loc_rtl_loc.state


12. Postal Code String 30 Postal or ZIP code component of

“PostalCode”
loc_rtl_loc.postal_code
13. Country String 254  Country component of an

address.
“Country”
loc_rtl_loc.country
14. Telephone 1 String 32 Primary telephone number.

“Telephone1” loc_rtl_loc.telephone1
15. Telephone 2 String 32 Alternate telephone number.



18. This field is no longer in use. Any value present in this field will be ignored, but the field
must exist.
19. Store Manager String 254 The name of the store manager.
“StoreManager” loc_rtl_loc.store_manager
20. Default Tax Decimal 8, 6 The display text used for the tax
Percentage percentage and also shown on
receipts for the store.
“DefaultTax
Percentage” loc_rtl_loc.
default_tax_percentage
21. Latitude Decimal 17, 6 Latitude is defined with respect

to an equatorial reference plane.
“Latitude”
Format=Decimal Degree
loc_rtl_loc.latitude
22. Longitude Decimal 17, 6 Longitude is defined in terms of

meridians.
“Longitude”
Format=Decimal Degree
loc_rtl_loc.longitude
23. Delivery Boolean 5 If true, item delivery is available

Available Flag from this location.
“DeliveryAvaila loc_rtl_loc.delivery_
ble” available_flag
24. Pickup Available Boolean 5 If true, item pickup is available

Flag from this location.
“Pickup loc_rtl_loc.pickup_
Available” available_flag


25. Transfer Boolean 5 If true, item transfer is available

Available Flag from this location.
“Transfer loc_rtl_loc.transfer_
Available” available_flag
26. Email Address String 254 The email address for the retail
location.
“EmailAddress”
loc_rtl_loc.email_addr
27. Location Type String 60 Used to control types of retail

locations such as store and
“LocationType”
warehouse.
loc_rtl_loc.location_type
28. District String 30 The store location district. For

example, a division or part of a
"District"
city or town. Used for
regionalizing information.
loc_rtl_loc.district
29. Area String 30 The store location area. For

example, a geographical tract or
"Area"
zone. Used for regionalizing
information.
loc_rtl_loc.area
30. Locale String 30  Two character language code

(ISO-6391), underscore, two
"Locale"
character country code (ISO-
3661-1). For example, “fr_CA”
for a French-speaking Canadian
employee.
loc_rtl_loc.locale
31. Currency Id String 3  The three-letter ISO currency

code. For example, USD, EUR,
"CurrencyId"
etc.
loc_rtl_loc.currency_id
32. Geo Code String 20 A Taxware-defined code used to

distinguish locations that have
"GeoCode"
more than one ZIP Code and
cities that are located in more
than one county. Also used to
identify locations inside or
outside city limits.
(Used to determine default
taxing when unable to connect to
Taxware.)
loc_rtl_loc.geo_code


33. Uez Indicator Boolean 5 A Taxware-defined flag. If true,

Flag this store location is within an
Urban Enterprise Zone. (Used to
“UezIndicator”
determine default taxing when
unable to connect to Taxware.)
loc_rtl_loc.uez_flag
34. Alternate Store String 254 Retailer-assigned store number,

Number used with WinRetail integration.
"AlternateStore loc_rtl_loc.alternate_store_nbr
Nbr"
Note jump in filePosition.
37. Address 3 String 254 Third line of the mailing

address.
"Address3"
38. Address 4 String 254 Fourth line of the mailing

address.
"Address4"
must exist.
40. UseTill Boolean 5  Determines whether the store

Accountability runs in Till Accountability Mode
(true) or Register Mode.
UseTill
Accountability loc_rtl_loc.
use_till_accountability_flag
41. DepositBank String 254 The Deposit Bank Name printed

Name when franking.
DepositBank loc_rtl_loc.deposit_bank_name
Name
42. DepositBank String 30 The Deposit Bank Account

AcctNbr Number printed when franking.
DepositBank loc_rtl_loc.
AcctNbr deposit_bank_account_number
43. Neighborhood String 254 Neighborhood component of the

address.
"Neighborhood"
loc_rtl_loc.neighborhood
44. County String 254 County component of the

address.
"County"
loc_rtl_loc.county
45. Airport Code String 3 Three-letter airport code.

“AirportCode”

Retail Location Property (RETAIL_LOCATION_PROPERTY)
Retail Location Property (RETAIL_LOCATION_PROPERTY)

Contains property information for retail locations.
loc_rtl_loc_p All Fields RetailLocationProperty
Retail Location Property Record (RETAIL_LOCATION_PROPERTY)
Name Comment
Field # “Field Name” Type Width Required Table.Column

Record”.
2. Record Identifier String 30  “RETAIL_LOCATION_

PROPERTY”
3. Retail Location Integer  The location identifier.

ID (PK)
loc_rtl_loc_p.rtl_loc_id
“RetailLocation
Id”
4. Property Code String 30  Identifies the property

(PK) associated with table
loc_rtl_loc_p.
“PropertyCode”
loc_rtl_loc_p.property_code
5. Type String 30  Identifies type of value stored

by this record. Must be
“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
loc_rtl_loc_p.type
6. String Value String MAX The property value if

Type=STRING
“StringValue”
loc_rtl_loc_p.string_value
7. Date Value DateTime The property value if

Type=DATE
“DateValue”
loc_rtl_loc_p.date_value
8. Decimal Value Decimal 17,6 The property value if

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
If Type=BOOLEAN, 1=True
and 0=False.
loc_rtl_loc_p.decimal_value

Retail Location Coordinates (RETAIL_LOCATION_COORDINATES)
Retail Location Coordinates

(RETAIL_LOCATION_COORDINATES)
Contains the latitude and longitude coordinates for a retail location.
loc_rtl_loc All Fields N/A
Retail Location Coordinates Record (RETAIL_LOCATION_COORDINATES)
Name Comment
1. Action Code String as  “UPDATE”

specified

COORDINATES”
3. Retail Location Integer  The item identifier.

ID (PK)
loc_rtl_loc.rtl_loc_id
4. Latitude Decimal 17,6  Store latitude.

loc_rtl_loc.latitude
5. Longitude Decimal 17,6  Store latitude.

loc_rtl_loc.longitude

Workstation Record (WORKSTATION)

Contains information about a register/handheld device within a store.
loc_wkstn All Fields Workstation


Record”.
2. Record Identifier String 30  “WORKSTATION”

Id (PK) retail store within the
organization.
“RetailLocationI
d” loc_wkstn.rtl_loc_id
4. Workstation Id BigInt  The unique identifier for the

(PK) workstation.
“WorkstationId” loc_wkstn.wkstn_id

Workstation Property (WORKSTATION_PROPERTY)
Workstation Property (WORKSTATION_PROPERTY)

Contains property information for workstations.
loc_wkstn_p All Fields WorkstationProperty
Workstation Property Record (WORKSTATION_PROPERTY)
Name Comment

Record”.
2. Record Identifier String 30  “WORKSTATION_

PROPERTY”
3. Retail Location Integer  The location identifier.

ID (PK)
loc_wkstn_p.rtl_loc_id
“RetailLocation
Id”
4. Workstation ID BigInt  Identifier for the workstation

(PK) within the location.
“WorkstationId” loc_wkstn_p.wkstn_id

loc_wkstn_p.
“PropertyCode”
loc_wkstn_p.property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
loc_wkstn_p.type

Type=STRING
“StringValue”
loc_wkstn_p.string_value

Type=DATE
“DateValue”
loc_wkstn_p.date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
loc_wkstn_p.decimal_value

Code Value Record (CODE_VALUE)

General configurable codes used throughout Xstore.
com_code_value All Fields CodeValue
Code Value Record (CODE_VALUE) (Sheet 1 of 2)


Record”.
2. Record Identifier String 30  “CODE_VALUE”
3. Category (PK) String 30  The code value category

identifier, used for grouping
“Category”
multiple codes.
com_code_value.
category
4. Code (PK) String 60  The code value for a category.

“Code” com_code_value.code
5. Description String 254 A description of the code.

“Description” com_code_value.
description
6. Sort Order Integer Used to sort codes within a

category for display.
“SortOrder”
com_code_value.sort_
order
7. Hidden Boolean 5 Determines whether or not this

code is displayed to the user.
“Hidden”
False or NULL = the code will be
displayed.
True = the code will not be
displayed.
com_code_value.
hidden_flag
must exist.
must exist.
10. Image Url String 254 The image location.

"ImageUrl" com_code_value.
image_url

Code Value Record (CODE_VALUE) (Sheet 2 of 2)

11. Rank Integer The rank associated to the user

within the Xstore application.
"Rank"
com_code_value.
rank
12. Config Element String 100  Profile Group Id & Profile

Element ID definition (profile
"ConfigElement"
group/element pair).
Provides support for data
created in Configurator to be
associated with the profile group
and element under which it was
created.
com_code_value.config_element

Reason Code Record (REASON_CODE)

General configurable reason codes used throughout Xstore.
com_reason_code All Fields ReasonCode
Reason Code Record (REASON_CODE) (Sheet 1 of 3)


Record”.
2. Record Identifier String 30  “REASON_CODE”
3. Reason Type String 30  The reason code type.

Code (PK)
Possible Values:
“ReasonType
TAX_EXEMPT
Code”
TAX_CHANGE
POST_VOID
PRICE_CHANGE
TRANSACTION_CANCEL
NO_SALE
PAID_IN
PAID_OUT
RETURN
com_reason_code.
reason_typcode
4. Reason Code String 30  The reason code value.

(PK)
com_reason_code.
“ReasonCode” reason_code
5. Description String 254 A description of the reason code.

“Description” com_reason_code.
description
6. Comment String 10 Possible values: PROMPT,

Required REQUIRED. (PROMPT allows
for prompting, without
“Comment
requiring a comment to be
Required”
entered.)
com_reason_code.
comment_req
7. Sort Order Integer Used to sort reason codes within

a type for display.
“SortOrder”
com_reason_code.
sort_order


8. Parent Code String 30 The parent reason code

(hierarchy level) upon which a
“ParentCode”
nested reason code is based;
used to build a reason code
hierarchy.
com_reason_code.
parent_code
9. GL Account String 254 GL account recorded when the

Number reason code is selected. Used for
paid in/out transactions.
“GlAccount
Number” com_reason_code.
gl_acct_nbr
10. Minimum Decimal (17,0) Minimum amount required to

Amount select the reason code. Used for
“MinimumAmt”
com_reason_code.
minimum_amt
11. Maximum Decimal (17,0) Maximum amount allowed to

Amount select the reason code. Used for
“MaximumAmt”
com_reason_code.
maximum_amt
must exist.
13. Customer String 254 Message to prompt the user with

Message after selecting the reason code.
“Customer com_reason_code.
Message” cust_msg
14. Inventory Action String 30 The inventory action to be taken

Code based on the reason code.
“Inventory com_reason_code.
ActionCode” inv_action_code
15. Inventory String 60 Inventory location tied to the

Location ID reason code. For return reason
codes, this is the inventory
“Inventory
location to which the item will
LocationId”
be returned.
com_reason_code.
location_id
16. Inventory Bucket String 60 Inventory bucket tied to the

ID reason code. For return reason
codes, this is the inventory
“Inventory
bucket within the location to
BucketId”
which the item will be returned.
com_reason_code.
bucket_id


17. Hidden Boolean 5 Determines whether or not this

code is displayed to the user.
“Hidden”
False or NULL = the code will be
displayed.
displayed.
com_reason_code.
hidden_flag

"ConfigElement"
created.
com_reason_code.config_elemen
t

Reason Code Property Record (REASON_CODE_PROPERTY)

Contains property information for reason codes.
com_reason_code_p All Fields ReasonCodeProperty
Reason Code Property Record (REASON_CODE_PROPERTY) (Sheet 1 of 2)


Record”.
2. Record Identifier String 30  “REASON_CODE_PROPERTY”
3. Reason Type String 30  The reason code type.

Code (PK)
Possible Values:
“ReasonType
TAX_EXEMPT
Code”
TAX_CHANGE
POST_VOID
PRICE_CHANGE
TRANSACTION_CANCEL
NO_SALE
PAID_IN
PAID_OUT
RETURN
com_reason_code_p.
reason_typcode
4. Reason Code String 30  The reason code value.

(PK)
com_reason_code_p.
“ReasonCode” reason_code
5. Property Code String 30 Identifies type of value stored by

this record. Must be STRING,
“PropertyCode”
BIGDECIMAL, DATE, or
BOOLEAN.
com_reason_code_p.type
6. Type String 30 The property value if

Type=STRING
“Type”
com_reason_code_p.
string_value
7. StringValue String MAX The property value if

Type=DATE
“StringValue”
com_reason_code_p.date_value

Reason Code Property Record (REASON_CODE_PROPERTY) (Sheet 2 of 2)

8. Date Value Date 23 The property value if

Time Type=BIGDECIMAL or
“DateValue”
Type=BOOLEAN.
If Type=BOOLEAN, 1=True and
0=False.
com_reason_code_p.
decimal_value
9. Decimal Value Decimal 17,6 Identifies type of value stored by

this record. Must be STRING,
“DecimalValue”
BIGDECIMAL, DATE, or
BOOLEAN.
com_reason_code_p.type

Receipt Text Record (RECEIPT_TEXT)

Allows for additional text to be included in pre-defined areas on receipts based on the
current store location and date.
Dependencies:
The RcptConfig.xml file must already be configured for the Text Code and Text
Subcode (fields 4 & 5) for the text to appear.
com_receipt_text All Fields ReceiptText
Receipt Text Record (RECEIPT_TEXT) (Sheet 1 of 2)


Record”.
2. Record Identifier String 30  “RECEIPT_TEXT”
must exist.
4. Text Code (PK) String 30  Unique primary identifier for the

receipt text.
“Textcode”
com_receipt_text.
text_code
5. Text Subcode String 30  Unique secondary identifier for

(PK) the receipt String.
“TextSubcode” com_receipt_text.
text_subcode
6. Text Sequence Integer  Indicates the order in which the

text is to be printed on the
“TextSequence”
receipt.
com_receipt_text.
text_seq
7. Receipt Text String 254  The text that will be printed on

the receipt.
“ReceiptText”
com_receipt_text.
receipt_text
8. Effective Date DateTi 23 The date on which the text will

me begin to be printed on the
“EffectiveDate”
receipt.
com_receipt_text.
effective_date

Receipt Text Record (RECEIPT_TEXT) (Sheet 2 of 2)

9. Expiration Date DateTi 23 The date on which the text will

me stop being printed on the receipt.
“Expiration
Date” com_receipt_text.
expiration_date
10. Reformat Boolean 5 If false, the text will be formatted

on the receipt exactly as found in
“Reformat” Default
receipt_text. If true, (default), the
=1
carriage returns, white space,
etc. will be trimmed/reformatted
before printing.
com_receipt_text.
reformat_flag
11. Line Format String 254 Allows for formatting a single

line rather than the entire text
"LineFormat"
block. Valid values: BOLD,
UNDERLINE, REVERSE,
ITALIC, DOUBLE_HIGH,
DOUBLE_WIDE, CENTERED,
RIGHT, and LEFT.
com_receipt_text.
line_format

(PK) Element ID definition (profile
"ConfigElement"
created.
com_receipt_text.config_element

Sequence Record (SEQUENCE)
Sequence Record (SEQUENCE)

Header information defining composition of sequences generated by Xservices. Used to
store sequence numbers that were last used for a given sequence Id.
com_sequence All Sequence
Sequence Record (Sequence)


Record”.
2. Record Identifier String 30  “SEQUENCE”
3. Retail Location Integer  Retail location Id information

Id for the sequence.
“RetailLocat com_sequence.rtl_loc_id
ionId”
4. Work station Id Integer  Workstation Id information for

the sequence.
“Workstation
Id” com_sequence.wkstn_id
5. Sequence Id String 255  Unique identifier for the

sequence. The Sequence Id
“SequenceId”
should match the value
specified in
SequenceConfig.xml.
com_sequence.sequence_id
6. Sequence Numeric 19,0 Current sequence value.

Number
com_sequence.sequence_nbr
“SequenceNum
ber”

Sequence Record (SEQUENCE_PART)

Parameters defining composition of individual components comprising Xservices-
generated sequences. Used to store the definition of what a fully realized sequence
number would look like for a given sequence Id.
com_sequence_part All SequencePart
Sequence Record (Sequence_Part) (Sheet 1 of 2)


Record”.
2. Record Identifier String 30  “SEQUENCE_PART”
3. Sequence Id String 255  Unique identifier for the

sequence. The Sequence Id
“SequenceId”
should match the value
specified in
SequenceConfig.xml.
com_sequence_part.sequence_
id
4. Prefix String 30 If not using a numeric

sequence, then this value is
“Prefix”
prepended to the sequence
value.
com_sequence_part.prefix
5. Suffix String 30 If not using a numeric

sequence, then this value is
“Suffix”
appended to the sequence
value.
com_sequence_part.suffix
6. Encode Boolean Flags whether the sequence

value is encoded.
“Encode”
com_sequence_part.encode_fl
ag
7. Check Digit String 30 Checksum algorithm to use if

Algorithm adding a checksum digit to
sequence value (MOD10,
“CheckDigitA
XSTORE). If null or blank, no
lgorithm”
checksum digit is added.
com_sequence_part.check_dig
it_algo

Sequence Record (Sequence_Part) (Sheet 2 of 2)

8. Numeric Boolean Flags whether sequence value

is numeric.
“Numeric”
com_sequence_part.numeric_f
lag
9. Pad Length Integer Number of characters to pad

sequence value with.
“PadLength”
com_sequence_part.pad_lengt
h
10. Pad Character String 2 Character to use for padding.

“PadCharacte com_sequence_part.pad_chara
r” cter
11. Initial Value Integer Initial sequence value.

“InitialValu com_sequence_part.initial_val
e” ue
12. Maximum Value Numeri 10,0 Maximum sequence value.

c
“MaxValue” com_sequence_part.max_valu
e
13. Value Increment Integer Value to increment sequence

value by each time sequence is
“ValueIncrem
used.
ent”
com_sequence_part.value_incr
ement
14. Include Store Id Boolean Whether or not to include

store id as part of the sequence
“IncludeStor
value.
eId”
com_sequence_part.include_st
ore_id
15. Store Pad Length Integer How many characters to pad

store id before adding it to
“StorePadLen
sequence value.
gth”
com_sequence_part.store_pad
_length
16. Include Work Boolean Whether or not to add

Station Id workstation id as part of
sequence value.
“IncludeWork
stationId” com_sequence_part.include_w
kstn_id
17. Work Station Integer How many characters to pad

Pad Length workstation id before adding
it to sequence value.
“Workstation
PadLength” com_sequence_part.wkstn_pa
d_length

Exchange Rate Record (EXCHANGE_RATE)

Contains information used to convert monetary values from one currency code to
another.
tnd_exchange_rate All Fields TenderExchangeRate


Record”.
2. Record Identifier String 30  “EXCHANGE_RATE”
<Field literal="STORE" name="LevelCode" />

tnd_exchange_rate.level_code
3. Level Value (PK) String 60  Value for the organization

level. This field is used in
"LevelValue"
conjunction with level code.
tnd_exchange_rate.
level_value
4. Base Currency String 3  The code for the store's local/

Code (PK) home currency.
“BaseCurrency” tnd_exchange_rate.
base_currency
5. Target Currency String 3  The code for the non-local

Code (PK) currency used in the exchange
of tenders.
“Target
Currency” tnd_exchange_rate.
target_currency
6. Exchange Rate Decimal 17,6  The exchange rate to use for

the conversion. This is the
“ExchangeRate”
amount of target currency
given for 1 unit of base
currency.
tnd_exchange_rate.rate

Exchange Rate Hierarchy Record (EXCHANGE_RATE_HIER)

Contains information used to convert monetary values from one currency code to
another. This record provides hierarchical location support for configuring tender
exchange rates, providing the ability to configure a single chain-wide rate as opposed to
strictly store-based exchange rate configuration.
tnd_exchange_rate All Fields TenderExchangeRate


Record”.
2. Record Identifier String 30  “EXCHANGE_RATE_HIER”
3. Level Code (PK) String 30  Value for the organization

level within the organizational
"LevelCode"
hierarchy tree. Used in
conjunction with Level Value.
tnd_exchange_rate.level
_code
4. Level Value (PK) String 60  Value for the organization

level. Used in conjunction
"LevelValue"
with Level Code.
tnd_exchange_rate.level_
value
5. Base Currency String 3  The code for the store's local/

Code (PK) home currency.
“BaseCurrency” tnd_exchange_rate.
base_currency
6. Target Currency String 3  The code for the non-local

Code (PK) currency used in the exchange
of tenders.
“Target
Currency” tnd_exchange_rate.
target_currency
7. Exchange Rate Decimal 17,6  The exchange rate to use for

the conversion. This is the
“ExchangeRate”
amount of target currency
given for 1 unit of base
currency.
tnd_exchange_rate.rate

Retail Location Close Date Record (RETAIL_LOCATION_CLOSE_DATE)
Retail Location Close Date Record

(RETAIL_LOCATION_CLOSE_DATE)
Dates on which a store will be closed due to a holiday or other circumstance.
loc_close_dates All Fields CloseDates
Retail Location Close Date Record (RETAIL_LOCATION_CLOSE_DATE)


Record”.
2. Record Identifier String 30  “RETAIL_LOCATION_CLOSE

_DATE”

organization.
"retailLocationId
" loc_close_dates.
rtl_loc_id
4. Close Date DateTime 23  The date on which the store

will be closed.
"closeDate"
loc_close_dates.
close_date
5. Reason Code String 254 The reason that the store will
be closed on the Close Date.
"reasonCode"
loc_close_dates.
reason_code

Retail Location Question Record (RETAIL_LOCATION_QUESTION)
Retail Location Question Record

(RETAIL_LOCATION_QUESTION)
Contains questions to be asked during the system cycle (open/close).
loc_cycle_questions All Fields CycleQuestion
Retail Location Question Record (RETAIL_LOCATION_QUESTION) (Sheet 1 of 2)


Record”.

QUESTION”
3. Question Id (PK) String 60  A unique identifier for the

question.
"questionId"
loc_cycle_questions.
question_id
4. Question Text String 254 Translation key for the

Key question.
"questionText loc_cycle_questions.
Key" question_text_key
5. Sort Order Integer Determines the order in which

a list is sorted.
"sortOrder"
sort_order
6. Effective Date DateTime 23 The date and time on which a

specific question becomes
"effectiveDate"
operative.
effective_datetime
7. Expiration Date DateTime 23 The date and time when a

specific question becomes
"expiration
inoperative.
Date"
expiration_datetime
8. Retail Location Integer A unique identifier for a

Id specific retail store within the
organization.
"retailLocationId
" loc_cycle_questions.
rtl_loc_id

Retail Location Question Record (RETAIL_LOCATION_QUESTION)
Retail Location Question Record (RETAIL_LOCATION_QUESTION) (Sheet 2 of 2)

9. Corporate Boolean 5 When true, an information-

Message Flag type message is displayed.
(No user response required.)
"corporate
Message" loc_cycle_questions.
corporate_message_flag
10. Question Type String 30 A code denoting when a

Code message should be displayed.
Valid values include
"questionType
STORE_CLOSE,
Code"
STORE_CLOSE_DEPOSIT_
COMPLETE
question_typcode

Retail Location Question Choices Record (RETAIL_LOCATION_QUESTION_CHOICES)
Retail Location Question Choices Record

(RETAIL_LOCATION_QUESTION_CHOICES)
Contains the multiple-choice question options asked during the system cycle (open/
close).
loc_cycle_question_choices All Fields CycleQuestionChoice
Retail Location Question Choices Record (RETAIL_LOCATION_QUESTION_CHOICES)


Record”.

QUESTION_CHOICES”
3. Question Id (PK) String 60  A unique identifier for the

question.
"questionId"
loc_cycle_question_
choices.question_id
4. Answer Id (PK) String 60  A unique identifier for the

answer.
"answerId"
loc_cycle_question_
choices.answer_id
5. Answer Text Key String 254 Translation key for the answer
text.
"answerTextKey"
loc_cycle_question_
choices.answer_text_key

a list is sorted.
"sortOrder"
loc_cycle_question_
choices.sort_order

Translation Record (TRANSLATION)

Contains locale/translation information for maintaining translation keys in the database.
com_translations All Fields DatabaseTranslation


Record”.
2. Record Identifier String 30  “TRANSLATION”
3. Locale (PK) String 30  A combination of ISO-639-1

and ISO-3661-1 to denote the
"locale"
employee's language as
spoken in a particular country.
com_translations.locale
4. Translation Key String 150  The value to translate.

(PK)
com_translations.
"translation translation_key
Key"
5. Translation String 255 The translated (localized)

String.
"translation"
com_translations.
translation
6. Org Code String 30  The organization hierarchy

code.
"OrgCode"
default="*"
com_translations.
org_code
7. Org Value String 60  The value associated with the

organization hierarchy code.
"OrgValue"
default="*"
com_translations.
org_value

Transaction Prompt Properties Record (TRANS_PROMPT_PROPERTIES)
Transaction Prompt Properties Record

(TRANS_PROMPT_PROPERTIES)
Contains the options to configure transaction prompting and to control these prompts
within the location hierarchy.
com_trans_prompt_properties All Fields TransactionPropertyPrompt
Transaction Prompt Properties Record (TRANS_PROMPT_PROPERTIES) (Sheet 1 of 3)


Record”.
2. Record Identifier String 30  “TRANS_PROMPT_

PROPERTIES”
3. Property Code String 30  Identifier of the property

(PK) associated with the transaction
prompt. (key/value pair)
"propertyCode"
For example,
PHONE_NUMBER,
POSTAL_CODE
com_trans_prompt_
properties.property_code
4. Effective Date DateTime 23  The date the prompt is ready

(PK) for use.
"effectiveDate" com_trans_prompt_
properties.effective_date
5. Org Code String 30  Identifies the organization

"orgCode"
hierarchy tree. For example:
REGION, DISTRICT.
default="*"
com_trans_prompt_
properties.org_code
6. Org Value String 60  Identifies the value for the

organization level.
"orgValue"
default="*"
com_trans_prompt_
properties.org_value
7. Expiration Date DateTime 23 The date the prompt is no

longer used.
"expiration
Date" com_trans_prompt_
properties.expiration_date


8. Code Category String 30 The category identifier,

grouping multiple codes.
"codeCategory"
com_trans_prompt_
properties.code_category
9. Prompt Title Key String 60 Translation key for the prompt

title.
"promptTitle
Key" com_trans_prompt_
properties.prompt_title_key
10. Prompt Message String 60 Translation key for the prompt

Key message.
"promptMessage com_trans_prompt_
Key" properties.prompt_msg_key
11. Required Flag Boolean 5 If true, the information is

required.
"required"
com_trans_prompt_
properties.required_flag

prompts will be displayed.
"sortOrder"
com_trans_prompt_
properties.sort_order
13. Prompt Method String 30 A code that signifies the

Code prompting method. For
example; MASK,
"promptMethod
PROMPT_KEY, LIST
Code"
com_trans_prompt_
properties.prompt_mthd_code
14. Prompt Edit String 30 The mask pattern.

Pattern
com_trans_prompt_
"promptEdit properties.prompt_edit_patter
Pattern" n
15. Validation Rule String 30 The key that points to the code
Key necessary to provide data
validation in
"validation
validationRuleConfig.xml.
RuleKey"
com_trans_prompt_
properties.validation_rule_key
16. Transaction State String 30 The transaction state. Valid

values include: PRE_TENDER,
"transaction
POST_TENDER
State"
com_trans_prompt_
properties.transaction_state


17. Prompt Key String 30 Translation key of the message

to be displayed.
"promptKey"
com_trans_prompt_
properties.prompt_key
18. Chain Key String 30 The chain to run as part of the

prompt.
"chainKey"
com_trans_prompt_
properties.chain_key

Shipping Fee Record (SHIPPING_FEE)

Defines the shipping fee types used by Special Orders, Send sales, Remote Sends, and
Orders.
com_shipping_fee All Fields ShippingFee
Shipping Fee Record (SHIPPING_FEE) (Sheet 1 of 3)


Record”.
2. Record Identifier String 30  “SHIPPING_FEE”
3. Rule Name (PK) String 30  Unique name for this shipping

fee.
“ruleName”
com_shipping_fee.
rule_name
4. Org Code String 30  The code for the

organizational hierarchy level
"orgCode"
where this record applies. For
example: STORE or CHAIN
default="*"
com_shipping_fee.
lorg_code
5. Org Value String 30  The value for the

organizational hierarchy
"orgValue"
example: 101 (as in STORE
101)
default="*"
com_shipping_fee.
org_value
6. Priority Integer Defines the order in which a

group of potential shipping
“priority”
fee records will be evaluated
for applicability to the current
transaction.
com_shipping_fee.
priority


7. Ship Item ID String 60 The item id of the shipping fee

item to use as the shipping fee
“shipItemID”
line item for the account.
(Must match the item id of a
NON PHYSICAL shipping fee
item.)
com_shipping_fee.
ship_item_id
8. Aggregation String 30 The aggregation method to

Type apply to the shipping fee
calculation in the case of a per
“aggregationTyp
item calculation type. Since
e”
Xstore displays a single
shipping fee line item, this
value determines how the
individual per item fees are
totaled. Valid values include:
TOTAL - add all the fees
together and make that sum
the shipping fee for the
account
AVERAGE - take the average
of all the fees and make that
the shipping fee for the
account
HIGHEST - take the highest
shipping fee among all the
individual item fee and make
that the shipping fee for the
account
LOWEST - take the lowest
shipping fee among all the
individual item fee and make
that the shipping fee for the
account
(Must map to a
FeeAggregation\dtv:id
defined in
ShippingFeeConfig.)
com_shipping_fee.
aggregation_type


9. Rule Type String 30 A rule to evaluate as part of

determining if the shipping
“ruleType”
fee record applies for the
given transaction.
Valid values include:
SHIP_TO_STATE_RULE -
checks to see if the ship to
address state matches the
parameter.
SHIP_TO_ZIP_RULE - checks
to see if the ship to address
Zip code for the account
matches the parameter.
ACCOUNT_TYPE_RULE -
checks to see if the account
type matches the parameter.
TRUE_RULE - Always
evaluates to true: Same as a
blank rule_type.
FALSE_RULE - Always
evaluates to false: Used for
turning shipping fees and
shipping fee tiers off.
(Must map to a
ShippingRule\dtv:id defined
in ShippingFeeConfig)
com_shipping_fee.
rule_type
10. Parameter 1 String 30 First parameter for the

rule_type evaluation.
“param1”
com_shipping_fee.
param1
11. Parameter 2 String 30 Second parameter for the

“param2”
com_shipping_fee.
param2

Shipping Fee Tier Record (SHIPPING_FEE_TIER)

Contains an ordered set of shipping rules with associated shipping costs.
com_shipping_fee_tier All Fields ShippingFeeTier
Shipping Fee Tier Record (SHIPPING_FEE_TIER) (Sheet 1 of 3)


Record”.
2. Record Identifier String 30  “SHIPPING_FEE_TIER”
3. Rule Name (PK) String 30  Unique name for this shipping

fee tier record.
“ruleName”
com_shipping_fee_tier.
rule_name
4. Parent Rule  Rule name of shipping fee

Name (PK) record this tier record belongs
to. (Must match the rule name
“parentRuleNam
of an existing shipping fee
e”
record.)
parent_rule_name

“priority”
fee tier records will be
evaluated for applicability to
the current item or
transaction.
priority


6. Fee Type String 20 Specifies whether the shipping

is a flat fee, a percentage of the
“feeType”
item's/transaction's price, or
based on the shipping fee line
item's price.
FEE - a flat shipping fee will
be assigned to the account, the
fee assigned is equal to the
fee_value of the selected
shipping fee tier record
FEE_PERCENT - a fee will be
calculated based on a
percentage of the shippable
subtotal. The shippable
subtotal is multiplied by
fee_value. Normally, fee_value
should have a value between 0
and 1.
SHIP_ITEM_PRICE - the fee
for the account will be equal to
the price of the shipping fee
item specified by the selected
shipping fee record. Any value
in fee_value is ignored.
fee_type
7. Fee Value Decimal 17, 6 The value of the shipping flat

fee or percentage. Ignored in
“feeValue”
the case of a fee type of
SHIP_ITEM_PRICE.
fee_value
8. Ship Method String 60 Filter based on the current

item's selected shipping
“shipMethod”
method. Ignored during a per
transaction calculation.
ship_method
9. Minimum Price Decimal 17, 6 Filter on the transaction's or

current item's price. A price
“minPrice”
passes the filter if it is greater
than or equal to the minimum
price.
min_price


10. Maximum Price Decimal 17, 6 Filter on the transaction's or

“maxPrice”
passes the filter if it is less than
the maximum price.
max_price
11. Item Id String 60 Filter based on the current

item's item id. An item passes
“itemId”
the filter if its item id matches
item number. Ignored during
a per transaction calculation.
item_id

“ruleType”
fee tier record applies for the
given transaction or item.
Example:
parameter. (Must map to a
in ShippingFeeConfig.)
rule_type

“param1”
param1

“param2”
param2

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value

Simple Shipping Fee Record (SIMPLE_SHIPPING_FEE)

A composite record type to facilitate the manipulation of a shipping fee record with a
single child shipping fee tier record.
com_shipping_fee 3-11 ShippingFee
com_shipping_fee_tier 3-5, 12-20 ShippingFeeTier
Simple Shipping Fee Record (SIMPLE_SHIPPING_FEE) (Sheet 1 of 5)


Record”.
2. Record Identifier String 30  “SIMPLE_SHIPPING_FEE”
3. Rule Name String 30  Unique name for this shipping

fee.
“ruleName”
com_shipping_fee.
rule_name
Parent Rule
Name
rule_name
parentRuleName
parent_rule_name
4. Org Code String 30  The code for the

organizational hierarchy level
“orgCode”
example: STORE or CHAIN
com_shipping_fee.
org_code
org_code
5. Org Value String 30  The value for the

organizational hierarchy
“orgValue”
example: 101 (as in STORE
101)
com_shipping_fee.
org_value
org_value

“priority”
fee records will be evaluated
for applicability to the current
transaction.
com_shipping_fee.
priority


7. Ship Item ID String 60 The item id of the shipping fee

item to use as the shipping fee
“shipItemID”
line item for the account.
(Must match the item id of a
NON PHYSICAL shipping fee
item.)
com_shipping_fee.
ship_item_id
8. Aggregation String 30 The aggregation method to

Type apply to the shipping fee
calculation in the case of a per
“aggregationTyp
item calculation type. Valid
e”
values include:
TOTAL - the sum of all the
item shipping fees is
calculated
AVERAGE - the average of the
item shipping fees is
calculated
HIGHEST - the highest item
shipping fee is selected
(Must map to a
FeeAggregation\dtv:id
defined in
ShippingFeeConfig.)
com_shipping_fee.
aggregation_type



“ruleType”
fee record applies for the
given transaction.
Valid values include:
parameter.
SHIP_TO_ZIP_RULE - checks
to see if the ship to address
Zip code for the account
matches the parameter.
TRUE_RULE - Always
evaluates to true: Same as a
blank rule_type.
FALSE_RULE - Always
evaluates to false: Used for
turning shipping fees and
shipping fee tiers off.
(Must map to a
in ShippingFeeConfig)
com_shipping_fee.
rule_type

“param1”
com_shipping_fee.
param1

“param2”
com_shipping_fee.
param2


12. Fee Type String 20 Specifies whether the shipping

is a flat fee, a percentage of the
“feeType”
item's/transaction's price, or
based on the shipping fee line
item's price.
FEE - a flat shipping fee will
be assigned to the account, the
fee assigned is equal to the
fee_value of the selected
shipping fee tier record
FEE_PERCENT - a fee will be
calculated based on a
percentage of the shippable
subtotal. The shippable
subtotal is multiplied by
fee_value. Normally, fee_value
should have a value between 0
and 1.
SHIP_ITEM_PRICE - the fee
for the account will be equal to
the price of the shipping fee
item specified by the selected
shipping fee record. Any value
in fee_value is ignored.
fee_type
13. Fee Value Decimal 17, 6 The value of the shipping flat
fee or percentage. Ignored in
“feeValue”
the case of a fee type of
SHIP_ITEM_PRICE.
fee_value
14. Ship Method String 60 Filter based on the current

item's selected shipping
“shipMethod”
method. Ignored during a per
transaction calculation.
ship_method
15. Minimum Price Decimal 17, 6 Filter on the transaction's or

“minPrice”
passes the filter if it is greater
than or equal to the minimum
price.
min_price
16. Maximum Price Decimal 17, 6 Filter on the transaction's or

“maxPrice”
passes the filter if it is less than
the maximum price.
max_price


17. Item ID String 60 Filter based on the current

item's item id. An item passes
“itemId”
the filter if its item id matches
item number. Ignored during
a per transaction calculation.
item_id

“ruleType”
fee tier record applies for the
given transaction or item.
Example:
parameter. (Must map to a
in ShippingFeeConfig.)
rule_type

“param1”
param1

“param2”
param2
<Field literal="1" name="priority"/>

com_shipping_fee_tier.priority
(Tier's priority should always be 1 because a simple shipping fee should have a single tier
record.)

code.
"OrgCode"
default="*"
com_shipping_fee.
org_code
org_code

"OrgValue"
default="*"
com_shipping_fee.
org_value
org_value

Shipping Cost Record (SHIPPING_COST)

Defines decimal ranges of values with an associated “cost” related to shipping,
segregating the ranges by category.
com_shipping_cost All Fields ShippingCost
Shipping Cost Record (SHIPPING_COST) (Sheet 1 of 2)


Record”.
2. Record Identifier String 30  “SHIPPING_COST”
3. Begin Range Decimal 11,2  The starting range, inclusive;

(PK) for example, a minimum
weight.
"beginRange"
com_shipping_cost.
begin_range
4. End Range (PK) Decimal 11,2  The ending range, inclusive;

for example, the maximum
"endRange"
weight.
com_shipping_cost.
end_range
5. Cost (PK) Decimal 17,6  The cost associated with this

range. This value will always
"cost"
be multiplied by the number
of weighted units to which the
cost is being applied.
com_shipping_cost.
cost
6. Category String 30  A label used to group this

range of values with other
"category"
ranges having the same
category (i.e., by task, such as
“SPECIAL_ORDER”,
“SEND_SALE”)
com_shipping_cost.
category
7. Minimum Cost Decimal 17,6 Optional; the minimum

shipping cost associated with
"minimumCost"
this record; can be used to
override a computed value
based on this record.
com_shipping_cost.
minimum_cost

Shipping Cost Record (SHIPPING_COST) (Sheet 2 of 2)

8. Maximum Cost Decimal 17,6 Optional; the maximum

shipping cost associated with
"maximumCost"
this record; can be used to
override a computed value
based on this record.
com_shipping_cost.
maximum_cost
9. Item Id String 60 The item_id to represent the

shipping cost for this record.
"itemId"
com_shipping_cost.
item_id

code.
"OrgCode"
default="*"
com_shipping_cost.
org_code

"OrgValue"
default="*"
com_shipping_cost.
org_value

Report Organizer Record (REPORT_ORGANIZER)

Contains report specifications to control report formatting and layout.
rpt_organizer All Fields Organizer


Record”.
2. Record Identifier String 30  “REPORT_ORGANIZER”
3. Report Name String 254  The name of the report.

(PK)
rpt_organizer.
"reportName" report_name
4. Report Group String 254  The report classification in the

(PK) report. For example, Sale,
Tender, etc.
"reportGroup"
rpt_organizer.
report_group
5. Report Element String 254  The specific component within

(PK) the report group. For example,
the “Sale” report group may
"reportElement"
include elements such as
Discounts, Gross Sales, Net
Sales, Returns, etc.
rpt_organizer.
report_element
6. Report Order Integer The element display order

within the report group.
"reportOrder"
rpt_organizer.
report_order

Address Country Record (ADDRESS_COUNTRY)

Contains the mappings of country IDs to the full country names and the maximum
length of those countries' postal codes.
com_address_country All Fields AddressCountry
Address Country Record (ADDRESS_COUNTRY) (Sheet 1 of 2)


Record”.
2. Record Identifier String 30  “ADDRESS_COUNTRY”
3. Country Id (PK) String 2  The id of the country that is

being mapped.
"CountryId"
com_address_country.
country_id
4. Country Name String 60 The full name of the mapped

country.
“CountryName”
country_name
5. Postal Code Integer The maximum length of the

Maximum mapped country's postal
Length codes.
“PostalCodeMax com_address_country.max_po
Length” stal_length

Address Country Record (ADDRESS_COUNTRY) (Sheet 2 of 2)

6. Address Mode String 60  default="DEFAULT"

(PK)
The mode of the address
“AddressMode” service that uses these
mappings. Supported Address
Service Modes:
DEFAULT – Used if the data
for more-specific modes is not
populated
SENDSALE – Receiving
Documents, Send Sale
CUSTOMER – Customer
Maintenance/Search, Credit
Application, Large Cash
Payments
EMPLOYEE – Employee
Maintenance
HOME_OFFICE_CHECK –
Home office check info
prompts
SHIPPING – Shipping
documents
TAX_EXEMPT – Editing tax
exemptions
REPORTING – Reporting
prompts
TENDER – Identity
Verification for tender
operations
address_mode

Address Postal Code Record (ADDRESS_POSTAL_CODE)

Contains the mappings of country IDs and postal codes to state and city information.
com_address_postalcode All Fields AddressPostalCode
Address Postal Code Record (ADDRESS_POSTAL_CODE) (Sheet 1 of 2)


Record”.
2. Record Identifier String 30  “ADDRESS_POSTAL_CODE”
3. Country Id (PK) String 2  Id of the country that the

postal code belongs to.
"CountryId"
com_address_
postalcode.country_id
4. Postal Code Id String 30  PostalCodeId - A version of

the postal code with all of the
"PostalCodeId"
white space stripped. (Typed
Postal Code values in Xstore input fields
that do not allow spaces.)
"PostalCode"
com_address_
postalcode.postal_code_id
PostalCode - The version of
the postal code in its original
format. (Used for display and
print.)
com_address_
postalcode.postal_code
Note:
The valuetranslator.String
ReplaceTranslator performs a
“search and replace” on the
current field value. (i.e.
Extracts any spaces from the
PostalCode and replaces it with
the PostalCodeID.)
<ValueTranslator
className="dtv.data2.dataloader.valuetranslator.StringReplaceTranslator">
<Param key="searchFor" value="" />
<Param key="replaceWith" value="" />
</ValueTranslator>
5. State Id String 2 The id of the state that the

country/postal code maps to.
"StateId"
com_address_
postalcode.state_id

Address Postal Code Record (ADDRESS_POSTAL_CODE) (Sheet 2 of 2)

6. City Name String 60 The city name that the

country/postal code maps to.
"CityName"
com_address_
postalcode.city_name

(PK)
Service Modes:
populated
Payments
Maintenance
prompts
documents
exemptions
prompts
TENDER – Identity
operations
com_address_postalcode.addr
ess_mode

Address State Record (ADDRESS_STATE)

Contains mapping information of country IDs and state IDs to state names.
com_address_state All Fields AddressState
Address State Record (ADDRESS_STATE) (Sheet 1 of 2)


Record”.
2. Record Identifier String 30  “ADDRESS_STATE”
3. Country Id (PK) String 2  The Id of the country the state

belongs to.
"CountryId"
com_address_state.
country_id
4. State Id (PK) String 10  The Id of the state.

"StateId" com_address_state.
state_id
5. State Name String The full name of the state.

"StateName" com_address_state.
state_name

Address State Record (ADDRESS_STATE) (Sheet 2 of 2)


(PK)
Service Modes:
populated
Payments
Maintenance
prompts
documents
exemptions
prompts
TENDER – Identity
operations
com_address_state.
address_mode

Country Return Map Record (COUNTRY_RETURN_MAP)

A mapping table containing the country codes for cross-border returns.
com_country_return_map All Fields CountryReturnMap


Record”.
2. Record Identifier String 30  “COUNTRY_RETURN_MAP”
3. Purchased From String 254  Valid country code of stores

(PK) where the items can be
purchased from.
"purchasedFrom
" com_country_return_map.pur
chased_from
4. Return To (PK) String 254  Valid country code of stores

where the items can be
“returnTo”
returned to.
com_country_return_map.retu
rn_to
5. Disallow Cross Boolean 5 Indicates whether the county

Border Flag code combination
(purchased_from - return_to)
“disallowCrossB
allows returns.
orderFlag”
If true, returns are not allowed
for this country code
combination.
com_country_return_map.
disallow_cross_border_flag

Sales Goal Record (SALES_GOAL)

Contains sales goal definition information.
sls_sales_goal All Fields SalesGoal


Record”.
2. Record Identifier String 30  “SALES_GOAL”
3. Sales Goal Id String 60  Sales goal identifier.

(PK)
sls_sales_goal.
"salesGoalId" sales_goal_id
4. Sales Goal Value Decimal 17, 6  Sales goal value.

"salesGoal sls_sales_goal.
Value" sales_goal_value
5. Effective Date DateTime 23  Date goal becomes effective.

"effectiveDate" sls_sales_goal.
effective_date
6. End Date DateTime 23  Date goal ends.

"endDate" sls_sales_goal.
end_date
7. Description String 254 Goal description.

"description" sls_sales_goal.
description

code.
"OrgCode"
default="*"
sls_sales_goal.
org_code

"OrgValue"
default="*"
sls_sales_goal.
org_value

Device Configuration Record (DEVICE_CONFIG)

Contains configuration information for devices.
ctl_device_config All Fields DeviceConfig


Record”.
2. Record Identifier String 30  “DEVICE_CONFIG”
3. Retail Location Int  Sales goal identifier.

ID (PK)
ctl_device_config.
"RetailLocation rtl_loc_id
Id"
4. Workstation ID BigInt  Sales goal value.

"WorkstationId" ctl_device_config.
wkstn_id
5. Hardware String 100  Date goal becomes effective.

Family Type
ctl_device_config.
"Hardware hardware_family_type
FamilyType"
6. Hardware Use String 100  Date goal ends.

"HardwareUse" ctl_device_config.
hardware_use
7. Description String 254 Goal description.

"Description" ctl_device_config.
description


3
Items & Pricing
Item Record (ITEM)

Contains item information for the lowest merchandise level for which inventory and
sales records are retained within the retail store.
Database Tables Updated Fields Dao name
itm_item 3-5, 7-13, 18, 42, 46-47, 82-85, Item

91-92, 97
itm_item_options 3, 14-17, 19-22, 27-41, 43-45, ItemOptions

48-49, 52-55, 59, 70-71, 73-81,
86-90, 93-98
Item Record (ITEM) (Sheet 1 of 11)


Record”.
2. Record Identifier String 30  “ITEM”
3. Item ID (PK) String 60  Unique item identifier code

for each item. Can be the
“ItemId”
retailer's SKU number.
itm_item.item_id
itm_item_options.item_id
4. Item Level Code String 30  For item records, this value

must be ITEM. For style
“ItemLevel
records, this value must be
Code”
STYLE.
itm_item.item_lvlcode
Items & Pricing 3-1

Item Record (ITEM)

5. Parent Item ID String 60 * The item ID of this item's

style.
“ParentItemId”
*Required for items that have
a style. For style records and
items that do not have a style,
the value must be NULL.
itm_item.parent_item
_id
must exist.
7. Item Type Code String 30  Denotes the type of item. The

following values are fixed:
“ItemTypeCode”
STANDARD
NON_PHYSICAL
NOT_ON_FILE
KIT
Must be one of these values.
Note: Do not use
NON_PHYSICAL for item
record.
Note: If multiple
NOT_ON_FILE items, all will
be listed.
itm_item.item_typcode
8. Name String 254 Name or short description by

which the item is known.
“Name”
itm_item.name
9. Description String 254  Text description of the item

and its characteristics.
“Description
Dao” itm_item.description
10. Department ID String 60 Unique identifier for the POS

selling location within the
“DepartmentId
store.
Dao”
itm_item.department_id
11. Subdepartment String 60 Unique identifier within a

ID department.
“Subdepartment itm_item.
IdDao” subdepartment_id
12. Class ID String 60 Unique identifier that

designates a class of items as a
“ClassIdDao”
product of a single supplier or
manufacturer.
itm_item.class_id

Item Record (ITEM)

13. Subclass ID String 60 Unique identifier within a

class.
“SubclassIdDao”
itm_item.subclass_id
14. Season Code String 30 * Code denoting the season that

this item is associated with.
“SeasonCodeDa
o” *Display only field.
itm_item_options.season_code
15. Vendor String 254 * Source (supplier) of the item.

“VendorIdDao” *Display only field.
itm_item_options.vendor
16. Part Number String 254 * Part number identifying this

item.
“PartNumber”
*Display only field.
itm_item_options.part_numbe
r
17. Current Sale Decimal 17, 6 *No longer used

Price
Current retail price per sale
“CurrentSale unit of the item. This
Price” monetary amount is used as
the basis for deriving retail
price at the point of sale.
itm_item_options.curr_sale_
price
18. List Price Decimal 17, 6 Suggested sale unit retail price
provided by the item
“ListPrice”
manufacturer.
Important! This field should
not be used for pricing an
item.
itm_item.list_price
19. Compare at Price Decimal 17, 6 An item reference price that

can be used on the register,
“CompareAt
receipt and shelf label,
Price”
typically to highlight savings.
itm_item_options.compare_at
_price
20. Unit Cost Decimal 17, 6 * Cost for each retail sale unit of
this item.
“UnitCost”
*Display only field, unless a
measuring device such as a
scale or gas pump is used.
itm_item_options.unit_cost
Items & Pricing 3-3

Item Record (ITEM)

21. Unit of Measure String 30  Code used to specify the units

Code in which a value is being
expressed, or manner in which
“UnitOfMeasure
a measurement has been
Code”
taken. This code relates to the
UCC data element 355.
itm_item_options.unit_of_
measure_code
22. Qty Scale Integer 11  Multiple of the unit of

measure at which this item is
“QtyScale”
sold.
itm_item_options.qty_scale
must exist.
must exist.
must exist.
must exist.
27. Messages Flag Boolean 5 Indicator that there are

additional messages attached
“Messages”
to this item.
itm_item_options.messages_fl
ag
28. Tax Group ID String 60  Unique retailer-assigned

identifier for the tax group.
“TaxGroupId”
itm_item_options.tax_group_
id
29. Restocking Fee Decimal 17, 6 Fee applied when this item is
returned.
“RestockingFee”
itm_item_options.restocking_f
ee
30. Apply Boolean 5 If true, the restocking fee will

Restocking Fee be applied when this item is
Flag returned.
“Apply itm_item_options.apply_
RestockingFee” restocking_fee_flag
31. Attached Items Boolean 5 If true, the system will check

Flag for attached items to be added
to the transaction.
“AttachedItems”
itm_item_options.attached_
items_flag

Item Record (ITEM)

32. Force Quantity Boolean 5 If true, the system will force

of One Flag the quantity of this item to
always be one.
“ForceQuantity
OfOne” itm_item_options.force_quanti
ty_of_one_flag
33. Minimum Sale Decimal 11, 4 Minimum quantity of this

Unit Count item that may be sold in a
single transaction.
“MinimumSale
UnitCount” itm_item_options.min_sale_un
it_count
34. Maximum Sale Decimal 11, 4 The maximum quantity of this

single transaction.
“MaximumSale
UnitCount” itm_item_options.max_sale_u
nit_count
35. Disallow Boolean 5 If true, the system will not

Discounts Flag allow this item to be
discounted.
“Disallow
Discounts” itm_item_options.disallow_
discounts_flag

Layaway Flag allow this item to be added to
a layaway.
“Disallow
Layaway” itm_item_options.disallow_
layaway_flag
37. Disallow Price Boolean 5 If true, the system will not

Change Flag allow the price of this item to
be changed.
“DisallowPrice
Change” itm_item_options.disallow_pri
ce_
change_flag
38. Disallow Send Boolean 5 If true, the system will not

Sale Flag allow this item to be used in a
send sale.
“DisallowSend
Sale” itm_item_options.disallow_se
nd_
sale_flag
39. Disallow Special Boolean 5 If true, the system will not

Order Flag allow this item to be special
ordered.
“Disallow
SpecialOrder” itm_item_options.disallow_
special_order_flag
Items & Pricing 3-5

Item Record (ITEM)

40. Item Availability String 30 Determines whether or not an

Code item is available for sale: NA
(Item is not available for sale)
“Item
Availability AVAILABLE
Code”
RECALL (Message is displayed
at sale to indicate the item has
been recalled and is not available
for sale.)
itm_item_options.item_
availability_code
41. No Giveaways Boolean 5 If true, this item may not be

Flag given away free as part of a
promotion.
“NoGiveaways”
itm_item_options.no_giveawa
ys_
flag
42. Not Inventoried Boolean 5 If true, this item will not be

Flag inventoried.
“Not itm_item.not_
Inventoried” inventoried_flag
43. Not Returnable Boolean 5 If true, this item may not be

Flag returned. (e.g. frozen or
chilled merchandise)
“NotReturnable”
itm_item_options.not_
returnable_flag
44. Prompt for Price Boolean 5 If true, the system will prompt
Flag for the unit price.
“PromptFor itm_item_options.prompt_for_
Price” price_flag
45. Prompt for Boolean 5 If true, the system will prompt

Quantity Flag for the item quantity.
Quantity” quantity_flag

Weight Flag for the item's weight.
“PromptFor itm_item.prompt_for_
Weight” weight_flag
47. Serialized Item Boolean 5 If true, this item is serialized.

Flag
itm_item.serialized_
“Serialized item_flag
Item”
48. Special Order Integer Number of lead days required

Lead Days for a special order.
“SpecialOrder itm_item_options.special_orde
LeadDays” r_lead_days

Item Record (ITEM)

49. Substitute Boolean 5 If true, there is a substitute

Available Flag item available for sale within
the retail store.
“Substitute
Available” itm_item_options.substitute_
available_flag
must exist.
must exist.
52. Disallow Work Boolean 5 If true, this item is not eligible

Order Flag to be a work item in a work
order.
“DisallowWork
Order” itm_item_options.disallow_
work_order_flag
53. Min Age Integer Purchaser's minimum age, in

Required years, to be permitted to buy
this item.
“MinAge
Required” itm_item_options.min_age_
required
54. Stock Status String 60 Used to indicate the

purchasing state of the item.
“StockStatus”
The following values are fixed:
RESTRICTED_QTY (will not
allow sale of the item if the
ON_HAND quantity is at 0)
DISCONTINUED
CLEARANCE
In addition to the 3 fixed
values above, customer-
defined values are also
supported.
itm_item_options.stock_status
must exist.
must exist.
must exist.
must exist.
Items & Pricing 3-7

Item Record (ITEM)

59. Exclude From Boolean 1 If true, this item is not

Net Sales included in net sales
calculations.
“ExcludeFrom
NetSales” itm_item_options.exclude_
from_net_sales_flag
70. Disallow Deals Boolean 5 If true, this item does not

Flag qualify for deals.
"DisallowDeals" itm_item_options.disallow_de
als
_flag
71. Disallow Boolean 5 If true, this item does not

Commission qualify for commission.
Flag
itm_item_options.disallow_
"Disallow commission_flag
Commission"
must exist.
73. Initial Sale Qty Decimal 11, 4 The default item sale quantity.
(For example, may be set to 2
"InitialSale
for earrings.)
Quantity"
itm_item_options.initial_sale_
qty
74. Prompt For String 30 The type of customer

Customer prompting used for selling
this item. Valid Values are:
"PromptFor
CUSTOMER_NOT_REQUIRE
Customer"
D (no prompt is displayed),
CUSTOMER_PROMPT_REQ
UIRED (customer must be
assigned to sell this item),
CUSTOMER_PROMPT_OPTI
ONAL (customer prompt
displays, but may be skipped
by the user). Null values are
treated the same as
D.
itm_item_options.prompt_for_
customer
75. Prompt For Boolean 5 A flag indicating whether or

Description Flag not the item description must
be manually entered when
"PromptFor
this item is sold.
Description"
description_flag

Item Record (ITEM)

76. Foodstamp Boolean 5 If true, this item may be

Eligible Flag purchased using foodstamps.
"FoodStamp itm_item_options.foodstamp_
Eligible" eligible_flag
77. Warranty Flag Boolean 5 If true, a warranty plan is

associated with this item.
"Warranty"
itm_item_options.warranty_fl
ag
78. Generic Item Boolean 5 If true, this is a generic item.

Flag Used to gather model
information, or additional
"GenericItem"
information about the item.
itm_item_options.generic_ite
m
_flag
79. Shipping Weight Decimal 12, 3 The weight of a merchandise

item, used by the POS in the
"Shipping
calculation of send sale
Weight"
shipping fees under certain
configurations. The weight is
derived from the SKU
(itm_item.shipping_weight),
or, in the absence of a pre-
configured value, prompted
for and entered by the user.
itm_item_options.shipping_
weight
80. Disposition String 30 The code relating to the way

Code an item will be dispositioned.
This is the damage code for
"Disposition
damage receipts.
Code"
itm_item_options.disposition_
code
81. Disallow Order Boolean 5 If true, this item cannot be

Flag ordered via Locate Order
functionality.
"DisallowOrder"
itm_item_options.disallow_or
der_
flag
82. Dimension String 60 A user-defined code for the

System general dimension structure
an item belongs to.
"Dimension
System" Note: The dimension system
information is stored on the
STYLE level, not on an ITEM
level.
itm_item.dimension_
system
Items & Pricing 3-9

Item Record (ITEM)

83. Dimension1 String 60 The value for the first

"Dimension1" dimension.† (See
“ApplicabilityCondition”)
itm_item.dimension1
84. Dimension2 String 60 The value for the second

dimension.
"Dimension2"
itm_item.dimension2
85. Dimension3 String 60 The value for the third

dimension.
"Dimension3"
itm_item.dimension3

code.
"OrgCode"
default="*"
itm_item_options.org_code

"OrgValue"
default="*"
itm_item_options.org_value
88. Pack Size Decimal 11, 4 The item quantity contained in

a package; often used for safe
"PackSize"
and efficient shipping.
itm_item_options.pack_size
89. Default Source String 60 The source type of the item,

Type used when displaying where
the item is sourced from:
"DefaultSource
STORE, DC and VENDOR
Type"
itm_item_options.default_sour
ce_type
90. Default Source String 60 The source identifier. This

Id value should reference an
existing entry in the loc_rtl_loc
"DefaultSource
table that has the same
Id"
rtl_loc_id as the
default_source_id on the
itm_item table.
itm_item_options.default_sour
ce
_id
91. Disallow Item Boolean 5 If true, the item will not be

Matrix Display displayed in the item grid
(matrix).
“DisallowItemM
atrixDisplay” itm_item.DISALLOW_
MATRIX_DISPLAY_FLAG

Item Record (ITEM)

92. Item Matrix String 20 The button color on the item

Color matrix.
“ItemMatrix itm_item.item_matrix_color
Color”
93. Disallow Rain Boolean 5 If true, a rain check cannot be

Check issued for the item.
“disallowRain itm_item_options.
Check” DISALLOW_RAIN_CHECK
94. Fiscal Item ID String 254 The fiscal item ID.

“FiscalItemId” itm_item_options.fiscal_item_
id
95. Fiscal Item String 254 The fiscal item description.

Description
itm_item_options.fiscal_item_
“FiscalItem description
Description”
96. Selling Group ID String 60 The specific assemblage of

items to which this item
“SellingGroup
belongs. These items are
Id”
regarded as a unit.
itm_item_options.selling_
group_id
97. External System String 60 Record RPM changes system.

“External itm_item_options.external_
System” system
must exist.
99. Tare Value Decimal 11, 4 Value of the tare on the item.
“TareValue” itm_item_options.tare_value
100. Tare Code String 30 Code identifying the units

used for the item tare.
“TareCode”
itm_item_options.tare_unit_
of_measure_code
ApplicabilityCondition
†<Dao name="ItemDimensions">
<ApplicabilityCondition
className="dtv.data2.dataloader.applicability.ValueApplicabilityC
ondition">
<Param key="testValue" value="filePosition=83" />
<Param key="applicableValue" value="" />
<Param key="invert" value="true" />
Items & Pricing 3-11

Item Options Record (ITEM_OPTIONS)
</ApplicabilityCondition>

Contains option configurations for items.
itm_item_options All fields ItemOptions
Item Options Record (ITEM_OPTIONS) (Sheet 1 of 8)


Record”.
2. Record Identifier String 30  “ITEM”

“ItemId”
14. Season Code String 30 * Code denoting the season that

this item is associated with.
“SeasonCode
Dao” *Display only field.
itm_item_options.season_code
15. Vendor String 254 * Source (supplier) of the item.

“VendorIdDao” *Display only field.
itm_item_options.vendor
16. Part Number String 254 * Part number identifying this

item.
“PartNumber”
*Display only field.
itm_item_options.part_
number
17. Current Sale Decimal 17, 6 *No longer used

Price
Current retail price per sale
“CurrentSale unit of the item. This
Price” monetary amount is used as
the basis for deriving retail
price at the point of sale.
itm_item_options.curr_sale_
price


19. Compare at Price Decimal 17, 6 An item reference price that

can be used on the register,
“CompareAt
receipt and shelf label,
Price”
typically to highlight savings.
itm_item_options.compare_at
_price
20. Unit Cost Decimal 17, 6 * Cost for each retail sale unit of
this item.
“UnitCost”
*Display only field, unless a
measuring device such as a
scale or gas pump is used.
itm_item_options.unit_cost
21. Unit of Measure String 30  Code used to specify the units

Code in which a value is being
expressed, or manner in which
“UnitOfMeasure
a measurement has been
Code”
taken. This code relates to the
UCC data element 355.
itm_item_options.unit_of_
measure_code
22. Qty Scale Integer 11  Multiple of the unit of

measure at which this item is
“QtyScale”
sold.
itm_item_options.qty_scale
27. Messages Flag Boolean 5 Indicator that there are

additional messages attached
“Messages”
to this item.
itm_item_options.messages_
flag

identifier for the tax group.
“TaxGroupId”
id
29. Restocking Fee Decimal 17, 6 Fee applied when this item is
returned.
“RestockingFee”
itm_item_options.restocking_
fee
30. Apply Boolean 5 If true, the restocking fee will

Restocking Fee be applied when this item is
Flag returned.
“Apply itm_item_options.apply_
RestockingFee” restocking_fee_flag


31. Attached Items Boolean 5 If true, the system will check

Flag for attached items to be added
to the transaction.
“AttachedItems”
itm_item_options.attached_
items_flag
32. Force Quantity Boolean 5 If true, the system will force

of One Flag the quantity of this item to
always be one.
“ForceQuantity
OfOne” itm_item_options.force_
quantity_of_one_flag
33. Minimum Sale Decimal 11, 4 Minimum quantity of this

single transaction.
“MinimumSale
UnitCount” itm_item_options.min_sale_un
it_count
34. Maximum Sale Decimal 11, 4 The maximum quantity of this

single transaction.
“MaximumSale
UnitCount” itm_item_options.max_sale_u
nit_count

Discounts Flag allow this item to be
discounted.
“Disallow
Discounts” itm_item_options.disallow_
discounts_flag

Layaway Flag allow this item to be added to
a layaway.
“Disallow
Layaway” itm_item_options.disallow_
layaway_flag
37. Disallow Price Boolean 5 If true, the system will not

Change Flag allow the price of this item to
be changed.
“DisallowPrice
Change” itm_item_options.disallow_
price_change_flag
38. Disallow Send Boolean 5 If true, the system will not

Sale Flag allow this item to be used in a
send sale.
“DisallowSend
Sale” itm_item_options.disallow_
send_sale_flag
39. Disallow Special Boolean 5 If true, the system will not

Order Flag allow this item to be special
ordered.
“Disallow
SpecialOrder” itm_item_options.disallow_
special_order_flag


40. Item Availability String 30 Determines whether or not an

Code item is available for sale: NA
(Item is not available for sale)
“Item
Availability AVAILABLE
Code”
RECALL (Message is displayed
at sale to indicate the item has
been recalled and is not available
for sale.)
itm_item_options.item_
availability_code
41. No Giveaways Boolean 5 If true, this item may not be

Flag given away free as part of a
promotion.
“NoGiveaways”
itm_item_options.no_
giveaways_flag
43. Not Returnable Boolean 5 If true, this item may not be

Flag returned. (e.g. frozen or
chilled merchandise)
“NotReturnable”
itm_item_options.not_
returnable_flag
44. Prompt for Price Boolean 5 If true, the system will prompt
Flag for the unit price.
Price” price_flag

Quantity Flag for the item quantity.
Quantity” quantity_flag
48. Special Order Integer Number of lead days required

Lead Days for a special order.
“SpecialOrder itm_item_options.special_
LeadDays” order_lead_days
49. Substitute Boolean 5 If true, there is a substitute

Available Flag item available for sale within
the retail store.
“Substitute
Available” itm_item_options.substitute_
available_flag
52. Disallow Work Boolean 5 If true, this item is not eligible

Order Flag to be a work item in a work
order.
“DisallowWork
Order” itm_item_options.disallow_
work_order_flag


53. Min Age Integer Purchaser's minimum age, in

Required years, to be permitted to buy
this item.
“MinAge
Required” itm_item_options.min_age_
required
54. Stock Status String 60 Used to indicate the

purchasing state of the item.
“StockStatus”
RESTRICTED_QTY (will not
allow sale of the item if the
ON_HAND quantity is at 0)
DISCONTINUED
CLEARANCE
In addition to the 3 fixed
values above, customer-
defined values are also
supported.
itm_item_options.stock_status
must exist.
must exist.
must exist.
must exist.
59. Exclude From Boolean 1 If true, this item is not

Net Sales included in net sales
calculations.
“ExcludeFrom
NetSales” itm_item_options.exclude_
from_net_sales_flag
Note change in file position.
70. Disallow Deals Boolean 5 If true, this item does not

Flag qualify for deals.
"DisallowDeals" itm_item_options.disallow_
deals_flag
71. Disallow Boolean 5 If true, this item does not

Commission qualify for commission.
Flag
"Disallow commission_flag
Commission"


73. Initial Sale Qty Decimal 11, 4 The default item sale quantity.
(For example, may be set to 2
"InitialSale
for earrings.)
Quantity"
itm_item_options.initial_sale_
qty
74. Prompt For String 30 The type of customer

Customer prompting used for selling
this item. Valid Values are:
"PromptFor
Customer"
D (no prompt is displayed),
CUSTOMER_PROMPT_REQ
UIRED (customer must be
assigned to sell this item),
CUSTOMER_PROMPT_OPTI
ONAL (customer prompt
displays, but may be skipped
by the user). Null values are
treated the same as
D.
customer
75. Prompt For Boolean 5 A flag indicating whether or

Description Flag not the item description must
be manually entered when
"PromptFor
this item is sold.
Description"
description_flag
76. Foodstamp Boolean 5 If true, this item may be

Eligible Flag purchased using foodstamps.
"FoodStamp itm_item_options.foodstamp_
Eligible" eligible_flag
77. Warranty Flag Boolean 5 If true, a warranty plan is

associated with this item.
"Warranty"
itm_item_options.warranty_
flag
78. Generic Item Boolean 5 If true, this is a generic item.

Flag Used to gather model
information, or additional
"GenericItem"
information about the item.
itm_item_options.generic_
item_flag


79. Shipping Weight Decimal 12, 3 The weight of a merchandise

item, used by the POS in the
"Shipping
calculation of send sale
Weight"
shipping fees under certain
configurations. The weight is
derived from the SKU
(itm_item.shipping_weight),
or, in the absence of a pre-
configured value, prompted
for and entered by the user.
itm_item_options.shipping_
weight
80. Disposition String 30 The code relating to the way

Code an item will be dispositioned.
This is the damage code for
"Disposition
damage receipts.
Code"
itm_item_options.disposition_
code
81. Disallow Order Boolean 5 If true, this item cannot be

Flag ordered via Locate Order
functionality.
"DisallowOrder"
order_flag
86. Level Code String 30  The organization hierarchy

code.
"LevelCode"
default="*"
itm_item_options.level_code
87. Level Value String 60  The value associated with the

"LevelValue"
default="*"
itm_item_options.level_value
88. Pack Size Decimal 11, 4 The item quantity contained in

a package; often used for safe
"PackSize"
and efficient shipping.
itm_item_options.pack_size
89. Default Source String 60 The source type of the item,

Type used when displaying where
the item is sourced from:
"DefaultSource
STORE, DC and VENDOR
Type"
itm_item_options.default_
source_type


90. Default Source String 60 The source identifier. This

Id value should reference an
existing entry in the loc_rtl_loc
"DefaultSource
table that has the same
Id"
rtl_loc_id as the
default_source_id on the
itm_item table.
itm_item_options.default_
source_id
93. Disallow Rain Boolean 5 If true, a rain check cannot be

Check issued for the item.
“disallowRain itm_item_options.
Check” DISALLOW_RAIN_CHECK
94. Fiscal Item ID String 254 The fiscal item ID.

“FiscalItemId” itm_item_options.fiscal_item_
id
95. Fiscal Item String 254 The fiscal item description.

Description
itm_item_options.fiscal_item_
“FiscalItem description
Description”
96. Selling Group ID String 60 The specific assemblage of

items to which this item
“SellingGroupId
belongs. These items are
”
regarded as a unit.
itm_item_options.selling_
group_id
97. External System String 60 Record RPM changes system.

“ExternalSystem itm_item_options.external_
” system
must exist.
99. Tare Value Decimal 11, 4 Value of the tare on the item.
“TareValue” itm_item_options.tare_value
100. Tare Code String 30 Code identifying the units

used for the item tare.
“TareCode”
itm_item_options.tare_unit_
of_measure_code

Non-Physical Item Record (NON_PHYSICAL_ITEM)

Note: When downloading a NON_PHYSICAL_ITEM record it is not
necessary to also download an ITEM record.
Contains information about the non-physical items.
itm_item 3-55, 70-76, 81-84 Item
itm_non_phys_item 3, 56-58, 83-86 NonPhysicalItem
itm_item_options 59 ItemOptions
Non-Physical Item Record (NON_PHYSICAL_ITEM) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “NON_PHYSICAL_ITEM”
<Field literal="NON_PHYSICAL" name="ItemTypeCode" />

3-55. See “Item Record (ITEM)” for detailed information about fields 3 through 55.
Non-Physical Item Record (NON_PHYSICAL_ITEM) continues with Field 56.

Non-Physical Item Record (NON_PHYSICAL_ITEM) (continued) (Sheet 2 of 3)
Name Comment
56. Non-physical String 30  Code for the type of

Item Type Code nonphysical item. The
“NonPhysical
VOUCHER
ItemTypeCode”
RESTOCKING_FEE
LAYAWAY_SETUP_FEE
LAYAWAY_DEPOSIT
LAYAWAY_PAYMENT
LAYAWAY_DELINQUENCY_
FEE
LAYAWAY_RESTOCKING_
FEE
SP_ORDER_SERVICE_FEE
SP_ORDER_DEPOSIT
SP_ORDER_PAYMENT
SP_ORDER_SHIPPING_FEE
SP_ORDER_RESTOCKING_
FEE
WORK_ORDER
WORK_ORDER_DEPOSIT
SENDSALE_SHIPPING_FEE
CREDIT_PAYMENT
WARRANTY
WARRANTY_GIFT
WARRANTY_RENEWAL
LOYALTY_CARD
AR_PAYMENT
In addition to the fixed values
above, customer-defined
values are also supported.
itm_non_phys_item.
non_phys_item_typcode
57. Non-physical String 30 Code used to further identify

Item Sub-type the type of a non-physical
item. The following values are
“NonPhysical
fixed:
ItemSubtype”
FEE
DEPOSIT
PAYMENT
itm_non_phys_item.
non_phys_item_subtype
58. Display Order Integer  Indicates the order in which

items display in the item list.
“DisplayOrder”
itm_non_phys_item.
display_order
59. Exclude From Boolean 5 If true, this non-physical item

Net Sales Flag will not be attributed as
revenue.
“ExcludeFrom
NetSales” itm_item_options.
exclude_from_net_sales_flag

Non-Physical Item Record (NON_PHYSICAL_ITEM) (continued) (Sheet 3 of 3)
Name Comment
70-76. See “Item Record (ITEM)” for detailed information about fields 70 through 76, and fields
81-82.

code.
"OrgCode"
default="*"
itm_item.org_code

"OrgValue"
default="*"
itm_item.org_value
85. Disallow Item Boolean 5 If true, the item will not be

Matrix Display displayed in the item grid
(matrix).
DisallowItem
MatrixDispla itm_item.DISALLOW_MATRI
y X_DISPLAY_FLAG
86. Item Matrix String 20 The button color on the item

Color matrix.
ItemMatrixCo itm_item.item_matrix_color
lor

Price Update Record (PRICE_UPDATE_2)

Contains pricing information for an item and provides full support for a variable pricing
structure (hierarchy-based pricing). This record defines item prices and attaches them to
a level code and level value. In the “location-based hierarchical pricing” scheme, an
item’s price is determined by consulting one or more key-joined itm_item_prices
records which are themselves selected by consulting the location hierarchy populated by
either the loc_org_hierarchy record or the loc_pricing_hierarchy record.
Dependencies:
There must be an ITEM or NON_PHYSICAL_ITEM record for each Item ID specified in
this file.
itm_item_prices All Fields ItemPrices
Price Update Record (PRICE_UPDATE_2) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “PRICE_UPDATE_2”

"ItemId"
itm_item_prices.item_id
4. Property Code String 60  The identifier for the type of

(PK) price. The following values are
fixed:
"PropertyCode"
REGULAR_PRICE
PROMO_PRICE
itm_item_prices.
property_code

Price Update Record (PRICE_UPDATE_2) (Sheet 2 of 2)
Name Comment
5. Level Code (PK) String 30  Code identifying the level of

the hierarchy, based on the
"LevelCode"
organization structure, needed
to support a variable pricing
structure.
STORE
COMPANY
itm_item_prices.level_
code
6. Level Value (PK) String 60  Unique identifier for the level

of the hierarchy, based on the
"LevelValue"
organization structure.
itm_item_prices.
level_value
7. Price Decimal 17,6  Amount charged for the item

at the point of sale.
"Price"
itm_item_prices.price
8. Effective Date DateTime 23  The date when the price

(PK) becomes effective.
"EffectiveDate" itm_item_prices.
effective_date
9. Expiration Date DateTime 23 The date when the price

expires.
"Expiration
Date" itm_item_prices.
expiration_date
10. Pricing Quantity Decimal 11, 4  Used for pricing as a qualifier

(PK) that determines how many of
Default ‘1’
an item you must purchase in
"Pricing
order to qualify for that price.
Quantity"
itm_item_prices.
price_qty
11. External ID String 60 Records RPM price change ID.

“ExternalId” itm_item_prices.external_id
12. External System String 60 Records RPM price change

system.
“External
System” itm_item_prices.
external_system

Merchandise Hierarchy Record (MERCH_HIER)

Contains information for a specific node on the merchandise hierarchy tree.
itm_merch_hierarchy All Fields MerchandiseHierarchy


Record”.
2. Record Identifier String 30  “MERCH_HIER”
3. Hierarchy Id String 60  Unique identifier for the node.

(PK) For example, “900-W”.
“HierarchyId” itm_merch_hierarchy.
hierarchy_id
4. Parent Id String 60 Identifies the hierarchy value

of the parent node. For
“ParentId”
example “900”.
itm_merch_hierarchy.
parent_id
5. Level Code String 30 Identifies the level of the

hierarchy on which the node is
“LevelCode”
to be found. For example,
“SUBDEPARTMENT”.
level_code
6. Description String 254 A description of the node. For

example, Women’s Clothing.
“Description”
description
7. Sort Order Integer Indicates the order in which

the options are displayed in
“SortOrder”
the list.
sort_order
8. Hidden Boolean 5 Determines whether or not

this code is displayed to the
“Hidden”
user.
False or NULL = the code will
be displayed.
displayed.
hidden_flag



code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value
11. Disallow Matrix Boolean 5 If true, the merchandise

Display hierarchy will not be
displayed in the item matrix
"DisallowItemM
grid.
atrixDisplay"
disallow_matrix_display_flag
12. Item Matrix String 20 The merch hierarchy button

Color color on the item matrix.
"ItemMatrixColo itm_merch_hierarchy.item_ma
r" trix_color

Pricing Hierarchy Record (PRICING_HIER)

Contains information for a specific node on the pricing hierarchy tree.
Note: Clients may use one of two tables to set up the pricing
hierarchy: loc_org_hierarchy or loc_pricing_hierarchy. The two tables
store the same data for the purposes of the price provider. The org
hierarchy is a general-purpose hierarchy table that is able to drive
more functionality in addition to prices, while the pricing hierarchy
table stores less information and is designed only for the price
provider. In the scope of the price provider itself, the two tables are
interchangeable. In fact, their primary keys are identical.
loc_pricing_hierarchy All Fields PricingHierarchy


Record”.
2. Record Identifier String 30  “PRICING_HIER”
3. Pricing Level String 30  Describes type of pricing

Code (PK) node.
“LevelCode” loc_pricing_hierarchy.
level_code
4. Pricing Level String 60  Distinguishes one node in a

Value (PK) hierarchy level from another;
identifying a node amongst its
“LevelValue”
siblings. For example, two
nodes with a level code of
STORE might have level
values of 700 and 800. In this
case, this would be the store
number.
loc_pricing_hierarchy.
level_value
5. Parent Code String 30 The pricing code of the parent

node.
“ParentCode”
parent_code
6. Parent Value String 60 The pricing value of the parent

node.
“ParentValue”
parent_value


7. Description String 254 Text description for the

current node; does not define
“Description”
any data relationships.
description
8. Level Order Integer Defines levels in the hierarchy

tree for sorting purposes.
“LevelOrder”
Records with the same level
code should have the same
level order, and the orders
should increase the further
down the tree you go.
level_order

a list is sorted.
“SortOrder”
sort_order

Item Property (ITEM_PROPERTY)
Item Property (ITEM_PROPERTY)

Contains the property information for items.
itm_item_p All Fields ItemProperty
Item Property Record (ITEM_PROPERTY)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_PROPERTY”
3. Item Id (PK) String 60  The item identifier.

“ItemId” itm_item_p.item_id

itm_item.
“PropertyCode”
itm_item_p.property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
itm_item_p.type

Type=STRING
“StringValue”
itm_item_p.string_value

Type=DATE
“DateValue”
itm_item_p.date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
itm_item_p.decimal_value

Kit Component Record (KIT_COMPONENT)

Identifies the component items that make up a kit.This record associates kit component
items to their parent kit, and defines the quantity of the component item per kit and the
order in which to display the component items.
itm_kit_component All Fields KitComponent
Kit Component Record (KIT_COMPONENT) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “KIT_COMPONENT”
3. Kit Item Id String 60  Item id for the kit item this

component belongs to.
"KitItemId"
itm_kit_component.kit_item_i
d
4. Component Item String 60  Item id for the component

Id item.
"ComponentItem itm_kit_component.
Id" component_item_id
5. Display Order Integer The order in which the

component item should be
"DisplayOrder"
displayed on the receipts.
itm_kit_component.
display_order
6. Quantity Per Kit Integer The quantity of this

component item per kit.
"QuantityPer
Kit" itm_kit_component.
quantity_per_kit
7. Begin Datetime DateTime 23 The date in which the kit

component will start to be
"BeginDatetime"
included in the kit.
itm_kit_component.
begin_datetime
8. EndDatetime DateTime 23 The date in which the kit

component will cease to be
"EndDatetime"
included in the kit.
itm_kit_component.
end_datetime

Kit Component Record (KIT_COMPONENT) (Sheet 2 of 2)
Name Comment

code.
"OrgCode"
default="*"
itm_kit_component.
org_code

"OrgValue"
default="*"
itm_kit_component.
org_value
11. Sequence Integer  The sequence number for the

Number item within the kit.
“Sequence default=1
Number”
itm_kit_component.seq_nbr

Kit Component Property (KIT_COMPONENT_PROPERTY)

Contains the property information for kits.
itm_kit_component_p All Fields KitComponent

Property
Kit Component Property Record (KIT_COMPONENT_PROPERTY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “KIT_COMPONENT_

PROPERTY”
3. Kit Item Id (PK) String 60  The item identifier for the kit.
“KitItemId” itm_kit_component_p.
kit_item_id
4. Component Item String 60  The item identifier for the item

ID (PK) in the kit.
“Component itm_kit_component_p.
ItemId” component_item_id

(PK) associated with the kit
component in
"propertyCode"
itm_kit_component.
itm_kit_component_p.
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
itm_kit_component_p.type

Type=STRING
“StringValue”
string_value

Type=DATE
“DateValue”
date_value

Kit Component Property Record (KIT_COMPONENT_PROPERTY) (Sheet 2 of 2)
Name Comment

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
decimal_value
10. Sequence Integer  The sequence number for the

Number item within the kit.
“Sequence default=1
Number”
itm_kit_component_p.seq_nbr

Item Dimension Type Record (ITEM_DIMENSION_TYPE)

Contains the types of dimensions associated with a dimension system.
itm_item_dimension_type All Fields ItemDimensionType
Item Dimension Type Record (ITEM_DIMENSION_TYPE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  ITEM_DIMENSION_TYPE
3. Dimension String 60  A user-defined code for the

System (PK) generalized dimension
structure an item belongs to.
"Dimension
System" itm_item_dimension_
type.dimension_system
4. Dimension (PK) String 30  The specific code values

belonging to a dimension
"Dimension"
system. For example, COLOR,
SIZE, etc.
itm_item_dimension_
type.dimension
5. Sequence Integer A number that correlates this

dimension type with one of
"Sequence" 1
the values associated with an
2 item in the itm_item table.
3 For example, dimension
COLOR and sequence 1 in this
record means that dimension1
in itm_item for an item using
this dimension system is the
color of that item.
itm_item_dimension_
type.seq

Item Dimension Type Record (ITEM_DIMENSION_TYPE) (Sheet 2 of 2)
Name Comment
6. Sort Order Integer This value determines the

row/column/page order
"SortOrder"
represented in the grid view of
inventories for that style. The
lowest value is the row
dimension, the next-highest
value is the column
dimension, and highest value
is the page dimension.
Also, when selling an item by
style, this value determines
the order in which the system
prompts for dimension values.
If not specified, the order will
be arbitrary; however, the
default will be the way in
which the data was retrieved
from the database.
itm_item_dimension_
type.sort_order
7. Description String 254 [Optional] The text description

for a dimension code used for
"Description"
display. If this description is
not defined, the system
displays the dimension code
value.
itm_item_dimension_
type.description
8. Prompt Message String 254 [Optional] When selling an

item by style, the message
"PromptMessage
displayed to the user when
"
prompting for values for this
dimension type. This value
can be a literal value or a
translation key. If not
specified, a default message
will be used.
itm_item_dimension_
type.prompt_msg

code.
"OrgCode"
default="*"
itm_item_dimension_
type.org_code

"OrgValue"
default="*"
itm_item_dimension_
type.org_value

ITEM DIMENSION VALUE (ITEM_DIMENSION_VALUE)

Contains the values associated with each dimension within a dimension system.
itm_item_dimension_value All Fields ItemDimensionValue
ITEM DIMENSION VALUE (ITEM_DIMENSION_VALUE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  ITEM_DIMENSION_VALUE
3. Dimension String 60  A user-defined code for the

System (PK) generalized dimension
structure an item belongs to.
"Dimension
System" itm_item_dimension
_value.dimension_system
4. Dimension (PK) String 30  The specific code values

belonging to a dimension
"Dimension"
system.
itm_item_dimension
_value.dimension
5. Dimension Value String 60  The specific value associated

(PK) with a dimension.
"Dimension itm_item_dimension
Value" _value.value
6. Sort Order Integer [Optional] In the item grid,

this determines the order in
"SortOrder"
which dimension values
appear. Values sorted in
ascending order appear:
- Top to bottom for rows
- Left to right for columns
- First to last for page
When selling an item by style,
this determines the order in
which dimension values
appear in the prompt list. If
not specified, the order will be
arbitrary; however, the default
will be the way in which the
data was retrieved from the
database.
itm_item_dimension
_value.sort_order

ITEM DIMENSION VALUE (ITEM_DIMENSION_VALUE) (Sheet 2 of 2)
Name Comment
7. Description String 254 [Optional] The text description

of the value code. If this
"Description"
description is not defined, the
system displays the value code
itself.
itm_item_dimension
_value.description

code.
"OrgCode"
default="*"
itm_item_dimension
_value.org_code

"OrgValue"
default="*"
itm_item_dimension
_value.org_value

Item Cross-Reference Record (ITEM_XREF)

Contains information for item lookup by manufacturer's UPC.
Dependencies:
this file.
itm_item_cross_reference All Fields ItemCrossReference
Item Cross-Reference Record (ITEM_XREF) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_XREF”
3. Item ID String 60  Unique item identifier code

for an item. Can be the
“ItemId”
Note: Item ID not required for
deletes.
itm_item_cross_
reference.item_id
4. Manufacturer String 254 Name of the item

manufacturer.
“Manufacturer”
itm_item_cross_
reference.manufacturer
5. Manufacturer String 60  UPC of this item from this

UPC (PK) manufacturer.
“Manufacturer itm_item_cross_
Upc” reference.manufacturer_upc

code.
"OrgCode"
default="*"
itm_item_cross_
reference.org_code

"OrgValue"
default="*"
itm_item_cross_
reference.org_value

Item Cross-Reference Record (ITEM_XREF) (Sheet 2 of 2)
Name Comment
8. Primary Flag Boolean 5  Identifies the Manufacturer's

UPC used on the receipt.
"PrimaryFlag"
There can only be one record
with the Primary Flag set to
True, all others must be false.
The alternate UPC marked as
the primary UPC will be
printed on the receipt. If none
of the alternate UPCs are
marked as the primary UPC,
then the Item Id will be
printed on the receipt.
itm_item_cross_
reference.primary_flag

Item Images Record (ITEM_IMAGES)

Provides support for multiple item images in Xstore.
itm_item_images All Fields ItemImage
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_IMAGES”
3. Item Id (PK) String 60  The item identifier (from the

itm_item table).
“ItemId”
itm_item_images.item_id
4. Feature Id (PK) String 60  Image availability. DEFAULT -

means the image is available
“FeatureId”
on any features/regions.
Values include: DEFAULT,
QUICK_ITEMS, WISH_LIST,
ITEM_RESULT,
PURCHASE_HISTORY
itm_item_images.feature_id

code.
"OrgCode"
default="*"
itm_item_images.org_code

"OrgValue"
default="*"
itm_item_images.org_value
7. Image Url String 254 URL indicating the location of

an image of the item.
“ImageUrl”
itm_item_images.image_url

Item Vendor Record (ITEM_VENDOR)

Contains information about a vendor that can be associated with items.
itm_vendor 3-11, 20-21 Vendor
com_address 3, 12-21 Address
Item Vendor Record (ITEM_VENDOR) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_VENDOR”
3. Vendor ID (PK) String 60  Unique identifier assigned to a

vendor.
“VendorId”
itm_vendor.vendor_id
“AddressId”
itm_vendor.address_id
com_address.address_id
4. Name String 254 The name of the vendor.

“Name” itm_vendor.name
5. Type Code String 30 A code identifying the type of

vendor.
“TypeCode”
itm_vendor.typcode
6. Telephone String 32 Primary telephone number.

“Telephone” itm_vendor.telephone
7. Fax String 32 Primary fax number.

“Fax” itm_vendor.fax
8. Contact String 254 Primary contact person for the

vendor.
“Contact”
itm_vendor.contact
9. Contact String 32 Primary telephone number of

Telephone the primary contact.
"Contact itm_vendor.contact_
Telephone" telephone
10. Buyer String 254 The buyer name associated

with the vendor.
"Buyer"
itm_vendor.buyer

Item Vendor Record (ITEM_VENDOR) (continued) (Sheet 2 of 3)
Name Comment
11. Status String 30 A code indicating the vendor's

current status.
"Status"
itm_vendor.status
12. Address Line 1 String 254 First line of the mailing

address.
"Address1"
com_address.address1
13. Address Line 2 String 254 Second line of the mailing

address.
"Address2"
14. Address Line 3 String 254 Third line of the mailing

address.
"Address3"
15. Address Line 4 String 254 Fourth line of the mailing

address.
"Address4"

address.
"City"
com_address.city
17. State/Province String 254 State/Province component of

(Territory) the mailing address.
"Territory" com_address.territory
18. Postal Code String 254 Postal or ZIP code component

of the mailing address.
"PostalCode"
com_address.postal_code
19. Country String 254 Country component of the

address.
"Country"
com_address.country

code.
"OrgCode"
default="*"
itm_vendor.org_code
com_address.org_code

"OrgValue"
default="*"
itm_vendor.org_value
com_address.org_code

Item Vendor Record (ITEM_VENDOR) (continued) (Sheet 3 of 3)
Name Comment
22. Neighborhood String 254 Neighborhood component of

the address.
"Neighborhood"
com_address.neighborhood

address.
"County"
com_address.county

Item Vendor Property (ITEM_VENDOR_PROPERTY)
Item Vendor Property (ITEM_VENDOR_PROPERTY)

Contains the property information for item vendors.
itm_vendor_p All Fields VendorProperty
Item Vendor Property Record (ITEM_VENDOR_PROPERTY)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_VENDOR_

PROPERTY”
3. Vendor ID (PK) String 60  Identifier for the vendor.

“VendorId” itm_vendor_p.vendor_id

component in itm_vendor.
"propertyCode"
itm_vendor_p.
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
itm_vendor_p.type

Type=STRING
“StringValue”
itm_vendor_p.
string_value

Type=DATE
“DateValue”
itm_vendor_p.
date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
itm_vendor_p.
decimal_value

Price History Record (PRICE_HISTORY_2)

Contains the historical record of the retail-selling unit price at which a given item was
actually sold at the point of sale for a variable pricing structure (hierarchy-based
pricing).
itm_item_prices All Fields ItemPrices
Price History Record (PRICE_HISTORY_2) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “PRICE_HISTORY_2”

"ItemId"
itm_item_prices.item_id
<Field literal="REGULAR_PRICE" name="PropertyCode" />

itm_item_prices.property_code
4. Level Code (PK) String 60  Code identifying the level of

the hierarchy, based on the
"LevelCode"
organization structure, needed
to support a variable pricing
structure.
STORE
COMPANY
itm_item_prices.level_
code
5. Level Value (PK) String 60  Unique identifier for the level

of the hierarchy, based on the
"LevelValue"
organization structure.
itm_item_prices.
level_value
6. Price Decimal 17,6 Amount charged for the item

at the point of sale.
"Price"
itm_item_prices.price

Price History Record (PRICE_HISTORY_2) (Sheet 2 of 2)
Name Comment
7. Effective Date Date 10  The date when the price

(PK) became effective.
"EffectiveDate" itm_item_prices.
effective_date
8. Expiration Date Date 10 The date when the price

expired.
"Expiration
Date" itm_item_prices.
expiration_date
9. Pricing Quantity Decimal 11, 4  Used for pricing as a qualifier

(PK) that determines how many of
an item you must purchase in
"Pricing
order to qualify for that price.
Quantity"
itm_item_prices.
price_qty

Attached Items Record (ATTACHED_ITEMS)

Creates a relationship between items for the purpose of automatically adding an
“attached” item to a transaction when another item is sold.
itm_attached_items All Fields AttachedItems
Attached Items Record (ATTACHED_ITEMS) (Sheet 1 of 2)
Name Comment

specifie Commands for a Data File
d Record”.
2. Record Identifier String 30  “ATTACHED_ITEMS”
3. Sold Item ID String 60  Item ID of the item that was

(PK) added to the sale.
"SoldItemId" itm_attached_items.
sold_item_id
4. Attached Item String 60  Item ID of the item that will

(PK) automatically be added to the
sale.
"AttachedItem
Id" itm_attached_items.
attached_item_id
5. Quantity to Add Decimal 11, 2  Quantity of the attached item

to add to the sale.
"QuantityTo
Add" itm_attached_items.
quantity_to_add
6. Effective Date DateTime 23 Date and time the attachment

and Time becomes effective.
"Begin itm_attached_items.
Datetime" begin_datetime
7. Expiration Date DateTime 23 Date and time the attachment

and Time expires.
"EndDatetime" itm_attached_items.
end_datetime
8. Prompt to Add Boolean 5 If true, the user will be

Flag prompted with a custom
message.
"PromptToAdd"
itm_attached_items.
prompt_to_add_flag
9. Prompt to Add String 254 Translation key for the custom

Message Key message prompt.
"PromptToAdd itm_attached_items.
MsgKey" prompt_to_add_msg_key

Attached Items Record (ATTACHED_ITEMS) (Sheet 2 of 2)
Name Comment
must exist.
11. Association Type String 30 Association type code used to

assign the association.
"LineItem
Association itm_attached_items.
TypeCode" lineitm_assoc_typcode
12. Prompt For Boolean 5 If true, there is a prompt

Return Flag message associated with
returning this attached item.
"PromptFor
Return" itm_attached_items.
prompt_for_return_flag
13. Prompt For String 254 Specifies the translation

Return Msg Key property key for the return
prompt message for when
“PromptFor
prompt_for_return_flag is
ReturnMsgKey”
true.
itm_attached_items.
prompt_for_return_msg_key
14. Level Code String 30  Value for the organization

"LevelCode"
hierarchy tree. Used in
conjunction with Level Value.
itm_attached_items.
level_code
15. Level Value String 60  Value for the organization

level. Used in conjunction
"LevelValue"
with Level Code.
itm_attached_items.
level_value

Item Prompt Property Record (ITEM_PROMPT_PROPERTY)

Allows for the ability to prompt for additional information as an item is sold. The
Prompt Method (field 6) will determine the data entry method. Data captured will be
saved with the transaction line item.
Dependencies:
this file.
itm_item_prompt_properties All Fields ItemPromptProperty
Item Prompt Property Record (ITEM_PROMPT_PROPERTY) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_PROMPT_PROPERTY

”

"ItemId"
itm_item_prompt_
properties.item_id
4. Property Name String 30  The name of the property.

(PK)
itm_item_prompt_
"PropertyCode" properties.property_code
5. Data Required Boolean 5 If true, this information is

required.
"Required"
itm_item_prompt_
properties.required_flag

Name Comment
6. Prompt Method String 30  The following values are fixed:

SIMPLE - Prompts for a single
"PromptMethod
element of unrestricted String
Code"
(This is an un-validated String
entry)
LIST - Prompts the user to
select a single option from a
list of values. For LIST value,
the “code_group” defines the
possible list choices. All the
LIST values will be pulled
from the com_code_value
table.
DATE - Prompts for entry of a
single date value.
NUMERIC - Prompts for a
single piece of numeric
(integer) entry.
BIGDECIMAL - Prompts for a
single piece of decimal
(floating point) entry.
MONEY - Prompts for a single
piece of currency based entry.
MASK - Restrict entry based
on provided mask.
CHAIN - Run the specified
chain. (to get the required
information)
PROMPT_KEY - Gather no
information, but notify the
user of something.
NOTIFY - Displays an
acknowledgement prompt
with a message rather than
capturing any data.
itm_item_prompt_
properties.prompt_mthd_code
7. Prompt Group String 30 The name of the code group

for the options in a multiple
"CodeGroup"
choice list. The code group
must be defined in
com_code_value.code
itm_item_prompt_
properties.code_group
8. Sort Order Integer  Indicates the order in which

the multiple choice options are
"SortOrder"
displayed in the list.
itm_item_prompt_
properties.sort_order
9. Prompt Title Key String 60  Translation key for the prompt

title.
"PromptTitle
Key" itm_item_prompt_
properties.prompt_title_key

Name Comment
10. Prompt Message String 60  Translation key for the prompt

Key String.
"PromptMessage itm_item_prompt_
Key" properties.prompt_msg_key

code.
"OrgCode"
default="*"
itm_item_prompt_
properties.org_code

"OrgValue"
default="*"
itm_item_prompt_

Item Message Record (ITEM_MESSAGE)

Contains information for messages that need to be displayed in relation to items on a
sale.
itm_item_msg All Fields ItemMessage
Item Message Record (ITEM_MESSAGE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_MESSAGE”
3. Message Id (PK) String 60  A unique identifier for the

message.
"messageId"
itm_item_msg.
msg_id
4. Effective Date DateTime 23  The date on which a specific

(PK) item message becomes
operative.
"effectiveDate"
itm_item_msg.
effective_datetime
5. Expiration Date DateTime 23 The date when the item

message can no longer be
"expiration
displayed.
Date"
itm_item_msg.
expr_datetime
6. Message Key String 254  The I18n (translation) key for

the message to be displayed.
"messageKey"
itm_item_msg.
msg_key
7. Title Key String 254 The I18n (translation) key of

the message title.
"titleKey"
itm_item_msg.
title_key
must exist.

Item Message Record (ITEM_MESSAGE) (Sheet 2 of 2)
Name Comment
9. Content Type String 30 The type of content of the

message.
"contentType"
For a title image message,
must contain the value: image/
? where “?” is the image type
(jpg, gif, bmp, jpeg, png,
wbmp)
For a composite message,
must contain the value:
multipart/mixed
itm_item_msg.
content_type

code.
"OrgCode"
default="*"
itm_item_msg.
org_code

"OrgValue"
default="*"
itm_item_msg.
org_value

Item Message Type Record (ITEM_MESSAGE_TYPE)

Specifies the type of transactions for which item messages are displayed.
itm_item_msg_types All Fields ItemMessageTypes
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_MESSAGE_TYPE”

message.
"messageId"
itm_item_msg_types.
msg_id
4. Sale Line Item String 30  Code representing a type of

Type (PK) sale line item (SALE,
RETURN, etc.)
"lineItemType"
itm_item_msg_types.
sale_lineitm_typcode

code.
"OrgCode"
default="*"
itm_item_msg_types.
org_code

"OrgValue"
default="*"
itm_item_msg_types.
org_value

Item Message Cross-Reference Record (ITEM_MESSAGE_XREF)
Item Message Cross-Reference Record

(ITEM_MESSAGE_XREF)
Contains information cross-referencing an item to an item message, allowing a message
to be reused for multiple items.
itm_item_msg_cross_reference All Fields ItemMessageCrossReference
Item Message Cross-Reference Record (ITEM_MESSAGE_XREF)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_MESSAGE_XREF”
3. Item Id (PK) String 60  The retailer's SKU or unique

item identifier for items sold
"itemId"
or returned.
itm_item_msg_cross
_reference.item_id

message.
"messageId"
itm_item_msg_cross
_reference.msg_id

code.
"OrgCode"
default="*"
itm_item_msg_cross
_reference.org_code

"OrgValue"
default="*"
itm_item_msg_cross
_reference.org_value

Item Message Sale Record (ITEM_MESSAGE_SALE)

Contains information used to download a message to be displayed when selling the
item.
itm_item_msg_cross_reference 3,4, 11-12 ItemMessageCrossReference
itm_item_msg 4-8, 10-12 ItemMessage
itm_item_msg_types 4, 11-12 ItemMessageTypes
Item Message Sale Record (ITEM_MESSAGE_SALE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  "ITEM_MESSAGE_SALE"

item identifier for items sold
"itemId"
or returned.
itm_item_msg_cross
_reference.item_id

message.
"messageId"
itm_item_msg_cross
_reference.msg_id
itm_item_msg.msg_id
itm_item_msg_types.
msg_id
5. Effective Date DateTime 23  The date on which a specific

item message became
"effectiveDate"
operative.
itm_item_msg.
effective_datetime
6. Expiration Date DateTime 23 The date when the item

message can no longer be
"expiration
displayed.
Date"
itm_item_msg.
expr_datetime
7. Message Key String 254  The I18n (translation) key for

the message to be displayed.
"messageKey"
itm_item_msg.
msg_key

Item Message Sale Record (ITEM_MESSAGE_SALE) (Sheet 2 of 2)
Name Comment
8. Title Key String 254 The I18n (translation) key of

the message title.
"titleKey"
itm_item_msg.
title_key
must exist.
10. Content Type String 30 The type of content of the

message.
"contentType"
For a title image message,
must contain the value: image/
?
For a composite message,
must contain the value:
multipart/mixed
itm_item_msg.
content_type
<Field literal="SALE" name="lineItemType" />

itm_item_msg_types.sale_lineitm_typcode

code.
"OrgCode"
default="*"
itm_item_msg_cross
_reference.org_code
itm_item_msg.org_code
itm_item_msg_types.
org_code

"OrgValue"
default="*"
itm_item_msg_cross
_reference.org_value
itm_item_msg.
org_value
itm_item_msg_types.
org_value

Item Restriction Record (ITEM_RESTRICTION)

Contains item sale restriction information and identifies an individual restriction to
enforce when attempting to sell the restricted item.
itm_item_restriction All Fields ItemRestriction
Item Restriction Record (ITEM_RESTRICTION) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_RESTRICTION”
3. Restriction String 30  A restriction category for the

Category (PK) item. (For example;
ALCOHOL.) Cross-referenced
"restriction
to the ITEM record.
Category"
itm_item_restriction.
restriction_category
4. Restriction Code String 60  A code for a single restriction

(PK) within the restriction category.
(For example, for the
"restriction
ALCOHOL category,
Code"
restriction codes may include;
minimum seller age,
minimum buyer age,
maximum purchase quantity,
etc.) This value may be tied to
an op chain config entry.
restriction_code
5. Sale Line Item String 30  Code indicating the type of

Type Code (PK) sale item.
“SaleLineItem itm_item_restriction.
TypeCode” sale_lineitm_typecode
6. Property Name String 30  Name of the restriction

(PK) configuration property.
“PropertyName” itm_item_restriction.
property_name
7. Effective Date DateTime 23  Date the restriction becomes

(PK) effective.
“EffectiveDate” itm_item_restriction.
effective_date
8. Expiration Date DateTime 23 Date the restriction expires.

“Expiration itm_item_restriction.
Date” expiration_date

Item Restriction Record (ITEM_RESTRICTION) (Sheet 2 of 2)
Name Comment
9. Boolean Value Boolean 5 Value of the restriction if the

value is boolean.
“BooleanValue”
boolean_value
10. String Value String Value of the restriction if the

value is a string.
“StringValue”
string_value
11. Date Value DateTime 23 Value of the restriction if the

value is a date.
“DateValue”
date_value
12. Decimal Value Decimal Value of the restriction if the

value is a number.
“DecimalValue”
decimal_value
13. On Calendar Boolean 5 Indicates whether the

Flag restriction is included in the
restriction calendar.
“OnCalendar”
on_calendar_flag

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value

Item Restriction Calendar Record (ITEM_RESTRICTION_CALENDAR)
Item Restriction Calendar Record

(ITEM_RESTRICTION_CALENDAR)
Contains information for when a given item restriction is in effect. Time-based restriction
by day of week.
itm_item_restriction_calendar All Fields ItemRestrictionCalendar
Item Restriction Calendar Record (ITEM_RESTRICTION_CALENDAR) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_RESTRICTION_

CALENDAR”
3. Restriction String 30  A restriction category for the

Category (PK) item. (For example;
ALCOHOL.) Cross-referenced
"restriction
to the itm_item table record.
Category"
itm_item_restrict_calendar.
restriction_category
4. Restriction Code String 60  A code for a single restriction

(PK) within the restriction category.
(For example, for the
"restriction
ALCOHOL category,
Code"
restriction codes may include;
minimum seller age,
minimum buyer age,
maximum purchase quantity,
etc.) This value may be tied to
an op chain config entry.
restriction_code
5. Sale Line Item String 30  Code indicating the type of

Type Code (PK) sale item.
“SaleLineItem itm_item_restrict_calendar.
TypeCode” sale_lineitm_typecode
6. Day Code (PK) String 3  A code for the day of the

week.
"dayCode"
"SUN", "MON", "TUE",
"WED", "THU", "FRI", "SAT"
day_code
7. Effective Date DateTime 23  The date the restriction is in

(PK) effect.
"effectiveDate" itm_item_restrict_calendar.
effective_date

Item Restriction Calendar Record (ITEM_RESTRICTION_CALENDAR)
Item Restriction Calendar Record (ITEM_RESTRICTION_CALENDAR) (Sheet 2 of 2)
Name Comment
8. Start Time (PK) DateTime 23  The time of day the restriction

is in effect.
"startTime"
start_time
9. Expiration Date DateTime 23 The date the restriction is no

longer in effect.
"expiration
Date" itm_item_restrict_calendar.
expiration_date
10. End Time DateTime 23 The time of day the restriction

is no longer in effect.
"endTime"
end_time
11. Exemption Flag Boolean 5 If true, the restriction will

override all other records and
“Exemption”
disable an item restriction
which would have been
executed otherwise.
exemption_flag

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value

Item Restriction Mapping Record (ITEM_RESTRICTION_MAPPING)
Item Restriction Mapping Record

(ITEM_RESTRICTION_MAPPING)
Maps restrictions to the merchandise hierarchy levels with which they are associated.
itm_item_restrict_mapping All Fields ItemRestrictionMapping
Item Restriction Mapping Record (ITEM_RESTRICTION_MAPPING)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_RESTRICTION_

MAPPING”
3. Merchandise String 60  Level within the merchandise

Hierarchy Level hierarchy (for example,
(PK) DEPARTMENT or CLASS).
“Merch itm_item_restrict_mapping.
HierarchyLevel” merch_hierarchy_level
4. Merchandise String 60  Identifier for the merchandise

Hierarchy ID hierarchy level.
(PK)
itm_item_restrict_mapping.
“Merch merch_hierarchy_id
HierarchyId”
5. Restriction String 30  The category of the restriction.

Category (PK)
“Restriction restriction_category
Category”
6. Org Code String 30 The organization hierarchy

code.
“OrgCode”
default="*"
org_code
7. Org Value String 60 The value associated with the

“OrgValue”
default="*"
org_value

Substitute Items Record (SUBSTITUTE_ITEMS)

Contains a cross reference of items that may be substituted or offered in place of another
item.
itm_substitute_items All Fields SubstituteItems
Name Comment

Record”.
2. Record Identifier String 30  “SUBSTITUTE_ITEMS”
3. Primary Item Id String 60  The retailer's SKU or unique

(PK) item identifier for the original
item being substituted.
"primaryItemId"
itm_substitute_items.
primary_item_id
4. Substitute Item String 60  The retailer's SKU or unique

Id (PK) item identifier for the
substitute item.
"substitute
ItemId" itm_substitute_items.
substitute_item_id

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value

Refund Proration Record (REFUND_PRORATION)

Contains the parameters required to populate the refund amount proration formula on a
per-item basis.
itm_refund_schedule All Fields RefundSchedule
Refund Proration Record (REFUND_PRORATION) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “REFUND_PRORATION”
3. Item Id (PK) String 60  The item to receive a prorated

refund when returned. From
"ItemId"
itm_item.item_id.
itm_refund_schedule.
item_id
4. Org Code String 30  The location-based hierarchy

level to which this proration
"OrgCode"
schedule is assigned. From
loc_org_hierarchy.org_code
default="*"
org_code
5. Org Value String 60  The location-based hierarchy

level to which this proration
"OrgValue"
schedule is assigned. From
loc_org_hierarchy.
org_value
default="*"
org_value
6. Effective Date DateTime 23  The date/time defining the

(PK) starting effective period for a
given schedule. Note: If
"EffectiveDate"
comparable schedules with
overlapping ranges are
defined, the one with the most
current effective date is
respected.
effective_date

Refund Proration Record (REFUND_PRORATION) (Sheet 2 of 2)
Name Comment
7. Expiration Date DateTime 23 The date/time defining the

ending effective period for a
"Expiration
given schedule.
Date"
expiration_date
8. Maximum Full Integer The maximum number of

Refund Time days/months from the original
date of purchase that this item
"MaximumFull
may be returned and still
RefundTime"
receive a full refund. Note:
The current day/month of
purchase is considered a
return/purchase difference of
zero (0), not one (1).
max_full_refund_time
9. Minimum No Integer The minimum number of

Refund Time days/months from the original
date of purchase after which
"MinimumNo
this item will receive no
RefundTime"
refund when returned.
Note: The current day/month
of purchase is considered a
return/purchase difference of
zero (0), not one (1).
min_no_refund_time

Item Matrix Sort Order Record (ITEM_MATRIX_SORT_ORDER)
Item Matrix Sort Order Record

(ITEM_MATRIX_SORT_ORDER)
Contains information used to maintain item matrix sort order in Xstore; the values are
derived from Xstore Office.
itm_matrix_sort_order All Fields MatrixSortOrder
Item Matrix Sort Order Record (ITEM_MATRIX_SORT_ORDER)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_MATRIX_SORT_ORD

ER”
3. Matrix Sort Type String 60  The sort type.

(PK)
itm_matrix_sort_order.matrix_
"matrixSortType" sort_type
4. Matrix Sort Id String 60  The sort identifier.

(PK)
itm_matrix_sort_order.matrix_
"matrixSortId" sort_id
5. Sort Order Integer The sort order within the

matrix.
"sortOrder"
itm_matrix_sort_order.sort_or
der

code.
"OrgCode"
default="*"
itm_matrix_sort_order.
org_code

"OrgValue"
default="*"
itm_matrix_sort_order.
org_value

Quick Items Record (QUICK_ITEMS)

Contains the item information for the Quick Item tab in Xstore.
itm_quick_items All Fields QuickItem
Name Comment

Record”.
2. Record Identifier String 30  “QUICK_ITEMS”

"ItemId" itm_quick_items.item_id
4. Parent Id String 60 Identifies the item parent

category.
"ParentId"
itm_quick_items.parent_id

code.
"OrgCode"
default="*"
itm_quick_items.org_code

"OrgValue"
default="*"
itm_quick_items.org_value
7. Image Url String 254 Image url for the category or

overridden image url for the
"ImageUrl"
item.
itm_quick_items.image_url
8. Description String 254 Description of the category or

overridden description of the
"Description"
item.
itm_quick_items.description

the items are sorted on the tab.
"SortOrder"
itm_quick_items.sort_order

Item Tax Group (ITEM_TAX_GROUP)
Item Tax Group (ITEM_TAX_GROUP)

Contains the tax group information for items.
itm_item_options All Fields N/A
Item Tax Group Record (ITEM_TAX_GROUP)
Name Comment
1. Action Code String as  “UPDATE”

specified
2. Record Identifier String 30  “ITEM_TAX_GROUP”

4. Level Code (PK) String 30  The organization level code

based on the customer’s store
structure.
itm_item_options.level_code
5. Level value (PK) String 60  The value for the organization

level code.
itm_item_options.level_value
6. Tax Group Id String 60  ID of the tax group.

ids

Item Deal Property (ITEM_DEAL_PROPERTY)

Contains the properties for item deals.
itm_item_deal_prop All Fields ItemDealProperty
Item Deal Property Record (ITEM_DEAL_PROPERTY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_DEAL_PROPERTY”

“ItemId” itm_item_deal_prop.
item_id
4. Item Deal String 30  Identifies the property

Property Code associated with table
(PK) itm_item_deal_prop.
“ItemDeal itm_item_deal_prop.
PropertyCode” property_code
5. This field is not used.
6. Effective Date DateTime  Date the activity is ready for

(PK) service or action.
“EffectiveDate” itm_item_deal_prop.
effective_date
7. ExpirationDate DateTime Expiration date for the deal.

This value is not loaded into
the database.

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
itm_item_deal_prop.type

Type=STRING
“StringValue”
itm_item_deal_prop.string_
value

Type=DATE
“DateValue”
itm_item_deal_prop.date_
value

Item Deal Property Record (ITEM_DEAL_PROPERTY) (Sheet 2 of 2)
Name Comment

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
itm_item_deal_prop.
decimal_value

4
Parties - Customers & Employees
Party Record (PARTY)

Contains information about an individual or firm that exchanges information and/or
goods and services with the store. The PARTY record is the basis for both a Customer
and Employee in Xstore.
crm_party 3-17, 32-33, 36-39, 41-43, 48-52 Party
crm_party_locale_information 3, 20-26, 35, 46-47, 53, 54 PartyLocaleInformation
crm_party_telephone 3, 27-30 PartyTelephone
crm_party_email 3, 31, 40 PartyEmail
Party Record (PARTY) (Sheet 1 of 7)
Name Comment

Record”.
2. Record Identifier String 30  “PARTY”
3. Party ID (PK) BigInt  Unique, automatically

assigned numeric identity for
"PartyId"
a party.
crm_party.party_id
crm_party_locale_
information.party_id
crm_party_telephone.
party_id
crm_party_email.
party_id
4. Customer ID String 60 Unique identification number

assigned to a customer.
"CustomerId"
crm_party.cust_id
Parties - Customers & Employees 4-1

Name Comment
5. Party Type Code String 30 Code for the type of party a

store is dealing with.
"PartyTypeCode"
crm_party.party_typcode
6. Salutation String 30 Title used before a name, such

as Mr., Ms., or Dr.
"Salutation"
crm_party.salutation
7. First Name String 30 A person's first name. In

Western cultures this is the
"FirstName"
given name, in other cultures
it may be the family name.
crm_party.first_name
8. Middle Name String 30 One or more names that are

printed between the first and
"MiddleName"
last names.
crm_party.middle_name
9. Last Name String 30 A person's last name. In

Western cultures this is the
"LastName"
family (or patronymic) name.
In other cultures it may be the
given name.
crm_party.last_name
10. Suffix String 30 Affix used after a name, such

as Sr., Jr., or III.
"Suffix"
crm_party.suffix
11. Gender String 30 Gender type: male or female.

"Gender" crm_party.gender
12. Social Security String 20 Social security number of the

Number customer/employee.
"SocialSecurityN crm_party.social_
br" security_nbr
13. Birth Date Date 10 Customer birth date.

"BirthDate" crm_party.birth_date
14. Anniversary Date 10 Customer wedding

Date anniversary.
"Anniversary crm_party.anniversary_
Date" date

Name Comment
15. Organization String 60 Party organizational name.

Name This is usually only used if the
party is a business.
"Organization
Name" Note: Use the Relate™
"businessName" field rather
than the "orgName" field
when mapping to Xstore's
crm_party.organization
_name field.
crm_party.organization_name
16. Organization String 30 Describes the type of

Type Code organization from a legal
aspect. For example, a
"Organization
company can be private,
TypeCode"
public, or limited liability.
crm_party.organization_
typcode
17. Federal Tax ID String 20 Tax or other number assigned

by a federal government that
"FederalTaxId"
is unique to all organizations
within that federal
government's jurisdiction.
crm_party.federal_tax_id
18. First Name 2 String 60 Second first name for a party.

"FirstName2" crm_party.first_name2
19. Last Name 2 String 60 Second last name for a party.

"LastName2" crm_party.last_name2
20. Address 1 String 254 First line of the mailing

address.
"Address1"
crm_party_locale_
information.address1
21. Address 2 String 254 Second line of the mailing

address.
"Address2"
crm_party_locale_
22. Apartment String 30 Apartment or suite number of

"Apartment"
crm_party_locale_
information.apartment

address.
"City"
crm_party_locale_
information.city

Name Comment
24. State String 30 State component of the

mailing address.
"State"
crm_party_locale_
information.state
25. Postal Code String 20 Postal or ZIP code component

of the mailing address.
"PostalCode"
crm_party_locale_
information.postal_code
26. Country String 254 Country component of an

address. Uses the
"Country"
ISO3661-1 two-character
country code.
crm_party_locale_
information.country
<Field literal="1" name="Sequence" />

crm_party_locale_information.party_locale_seq
<Field literal="1" name="Primary" />
crm_party_locale_information.primary_flag
<Field literal="Home" name="AddressType" />
crm_party_locale_information.address_type
27. Telephone String 32 Primary telephone number.

Number crm_party_telephone.
"Telephone telephone_type = “Home”. †
Number" (See “ApplicabilityCondition”)
<Field literal="Home"
name="TelephoneType" /
>
telephone_number
28. Telephone String 32 Alternate telephone number.

"Telephone telephone_type = “Work”.†
<Field literal="Work"
>
telephone_number

Name Comment

"Telephone telephone_type = “Mobile”.†
<Field
literal="Mobile"
>
telephone_number

"Telephone telephone_type = “WorkFax”.†
<Field
literal="WorkFax"
>
telephone_number
31. Email Address String 254 Customer’s email address.‡

"EmailAddress" (See “ApplicabilityCondition”)
crm_party_email.
email_address
<Field literal="1"
name="Sequence" />
crm_party_email.
email_sequence
<Field literal="1"
name="Primary" />
crm_party_email.
primary_flag
<Field literal="Home"
name="EmailType" />
crm_party_email.
email_type
32. Signup Retail Integer Retail location ID of the store

Location ID in which the customer
information was first
"SignUpRetail
captured.
LocationId"
crm_party.sign_up_
rtl_loc_id
33. Allegiance Retail Integer Retail location ID of the store

Location ID to which the customer shows
the greatest loyalty.
"Allegiance
RetailLocation crm_party.allegiance_rtl_loc_i
Id" d

Name Comment
must exist.
35. Contact Flag Boolean 5 If true, indicates that this

customer can be contacted at
"Contact"
this address.
crm_party_locale_
information.contact_flag
36. Employee ID String 60 * The customer's employee ID if

this customer is also an
"EmployeeId"
employee. If the customer is
not an employee, this value
should be NULL.
*Required for parties that are
also employees.
crm_party.employee_id
37. Commercial Boolean 5 If true, indicates that the party

Customer Flag is a commercial customer.
"Commercial crm_party.commercial_
Customer" customer_flag
38. Picture Uri String 254 The location of the picture file.
“PictureUri” crm_party.picture_uri
39. State Tax Id String 20 A tax or other number

assigned by a state
“StateTaxId”
government that is unique to
all organizations within that
state government’s
jurisdiction.
crm_party.state_tax_id

“Contact”
this email address.
crm_party_email.contact_flag
41. Privacy Card Boolean 5 If true, indicates the privacy

Flag card form has been completed
by this customer.
“PrivacyCard”
crm_party.privacy_card_flag
42. Contact String 30 The preferred method of

Preference contacting the customer:
Home, Work, Mobile or Email.
“ContactPref”
crm_party.contact_pref
43. Void Flag Boolean 5 If true, denotes that this party

record has been voided.
“Void”
crm_party.void_flag

Name Comment

address.
"Address3"
crm_party_locale_

address.
"Address4"
crm_party_locale_
48. Preferred Locale String 30  Stores the Xstore language

code for the customer's
“Preferred Preferred
preferred language.
Locale” Locale is
required crm_party.preferred_
for locale
Employee
Party
records
49. Prospect Flag Boolean 5 If true, indicates the customer

is a prospective customer.
“Prospect”
crm_party.prospect_flag
50. Rent Flag Boolean 5 If true, indicates the customer

name may be rented to other
“Rent”
companies.
crm_party.rent_flag
51. Active Flag Boolean 5 If true, the customer has an

active status based on the
“Active”
retailer’s rules. The system
uses this when queries are
performed to find customers
in the xstore and xcenter
databases.
crm_party.active_flag
52. Email Receipts Boolean 5 If true, receipts are emailed to

Flag customer.
"EmailRcpts" crm_party.email_rcpts_flag

the address.
"Neighborhood"
crm_party_locale_information.
neighborhood

address.
"County"
county

†
<Dao name="PartyTelephone">
ondition">
********value="filePosition=28
‡<Dao name="PartyEmail">
ondition">

Party Email Record (PARTY_EMAIL)

Supports third-party systems that accommodate multiple email addresses.
crm_party_email All Fields PartyEmail
Name Comment

Record”.
2. Record Identifier String 30  “PARTY_EMAIL”
3. Party Id (PK) BigInt  A unique, automatically

assigned identity for an Xstore
"PartyId"
party.
crm_party_email.party_id
4. Email Sequence Integer  Sequence number within the

(PK) table to keep the email records
ordered and unique.
"Sequence"
Default=1
crm_party_email.email_
sequence
5. Email Address String 254 Customer’s email address.

"EmailAddress" crm_party_email.email_
address
6. Primary Flag Boolean 5 If true, the email information

is the primary information as
"Primary"
defined in Relate™ CRM.
crm_party_email.primary_flag

"Contact"
this email address.
crm_party_email.contact_flag
8. Email Type String 20 Code to categorize email

types.
"EmailType"
type
9. Email Format String 20 The preferred format choice

for emails such as "HTML" or
"EmailFormat"
"TEXT".
format

Party Property Record (PARTY_PROPERTY)

Provides download support for party properties; an arbitrary set of key-value
associations for a given party/customer. These pairings are more-or-less customer-
specific, though there are a few that are populated in the base, especially for Relate™
integration.
crm_party_properties All Fields PartyProperty
Name Comment

Record”.
2. Record Identifier String 30  “PARTY_PROPERTY”

assigned identity for a party.
"PartyId"
crm_party_properties.
party_id
4. Property Code String 30  Identifier of the property.

(PK)
"Property property_code
Code"
5. Type String 30  The type of value stored by

this record:
"Type"
STRING
BIGDECIMAL
DATE
BOOLEAN
type
6. String Value String 254 * *Required, based on the Type.

"StringValue" crm_party_properties.
string_value
7. Date Value DateTime 23 * *Required, based on the Type.

"DateValue" crm_party_properties.
date_value
8. Decimal Value Decimal 17,6 * *Required, based on the Type.

If BOOLEAN Type: 1=True
"Decimal
0=False
Value"
decimal_value

Party Telephone Record (PARTY_TELEPHONE)

Contains telephone contact information for a party.
crm_party_telephone All Fields PartyTelephone
Name Comment

Record”.
2. Record Identifier String 30  “PARTY_TELEPHONE”

"PartyId"
party_id
4. Telephone Type String 20  The type of telephone number.

(PK) Possible values include:
"TelephoneType" Home
Work
Mobile
WorkFax
telephone_type
5. Telephone String 32 The party’s telephone number.

Number
"Telephone telephone_number
Number"
6. Contact Flag Boolean 5 If true, indicates that the

customer can be contacted
"Contact" DEFAULT
using this phone number.
=0
contact_flag
7. Primary Flag Boolean 5 If true, the phone number

information is the primary
"Primary" DEFAULT
information as defined in
=0
Relate™ CRM.
primary_flag
8. Contact Type String 20 Information from API whether

this number can be used for
"ContactType"
calling, SMS TEXT, both, etc.
contact_type

Party Id Cross-Reference Record (PARTY_ID_XREF)

Maps an Xstore party ID to an equivalent customer identifier in a third-party application
such as Relate™ or Serenade™.
crm_party_id_xref All Fields PartyIdCrossReference
Name Comment

Record”.
2. Record Identifier String 30  “PARTY_ID_XREF”

assigned identity for an Xstore
"PartyId"
party.
crm_party_id_xref.
party_id
4. Alternate ID String 60  A third-party application

Owner (PK) identifier related to the
AlternateId. For example,
AlternateIdOwn
RELATE, SERENADE, etc.
er
crm_party_id_xref.
alternate_id_owner
5. Alternate ID String 30  The third-party application

identifier number related to
AlternateId
the AlternateIdOwner. For
example, R9999888777, SABC-
123123.
crm_party_id_xref.
alternate_id

Party Cross-Reference Record (PARTY_XREF)

Contains information about type codes defining a potential relationship between two
parties.
crm_party_cross_reference All Fields PartyCrossReference
Name Comment

Record”.
2. Record Identifier String 30  “PARTY_XREF”
3. Parent Party Id BigInt  The parent relationship to the

(PK) party id.
"parentPartyId" crm_party_cross_
reference.parent_party_id
4. Child Party Id BigInt  The child relationship to the

(PK) party id.
"childPartyId" crm_party_cross_
reference.child_party_id
5. Party String 30  A unique retailer-assigned

Relationship code denoting the type of
Type Code (PK) affiliation between two
parties.
"party
Relationship crm_party_cross_reference.
TypeCode" party_relationship_typcode

Party Address Record (PARTY_ADDRESS)

Contains address information for a party.
crm_party_locale_information All Fields PartyLocaleInformation
Party Address Record (PARTY_ADDRESS) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “PARTY_ADDRESS”

"PartyId"
crm_party_locale_
information.party_id
4. Sequence (PK) Integer  A field designed to ensure a

unique primary key to allow
"Sequence"
multiple locales to be attached
to the same party_id.
default="1"
crm_party_locale_
information.party_locale_seq
5. Address 1 String 254 A unique identifier for a

location and mail address.
"Address1"
crm_party_locale_
6. Address 2 String 254 A unique identifier for a

location and mail address.
"Address2"
crm_party_locale_
7. Apartment String 30 The apartment or suite

number component of an
"Apartment"
address.
crm_party_locale_
information.apartment
8. City String 254 The city component of an

address.
"City"
crm_party_locale_
information.city
9. State String 20 The state component of an

address.
"State"
crm_party_locale_
information.state

Party Address Record (PARTY_ADDRESS) (Sheet 2 of 2)
Name Comment
10. Postal Code String 20 The postal code (zip code)

component of an address.
"PostalCode"
crm_party_locale_
information.postal_code
11. Country String 254 The country component of an

address.
"Country"
crm_party_locale_
information.country
12. Primary Flag Boolean 5 If true, the address

information is the primary
"Primary" DEFAULT
information as defined in
=0
Relate™ CRM.
crm_party_locale_
information.primary_flag

“Contact" DEFAULT
this address.
=0
crm_party_locale_
information.contact_flag

address.
"Address3"
crm_party_locale_

address.
"Address4"
crm_party_locale_
17. Address Type String 20 The address category. For

example home, work, etc.
“AddressType”
crm_party_locale_
information.address_type

the address.
"Neighborhood"
neighborhood

address.
"County"
county

Employee Record (EMPLOYEE)

Contains information about an individual that works for a retail store, accepts direction
from the retail store management and satisfies the statutory criteria requiring that
payroll taxes and benefit contributions be paid by the retailer.
Dependencies:
There must be a PARTY record for each Party ID in this file.
hrs_employee All Fields Employee
hrs_employee_password 3 EmployeePassword
(action="INSERT_ONLY")
Employee Record (EMPLOYEE) (Sheet 1 of 5)
Name Comment

Record”.
2. Record Identifier String 30  “EMPLOYEE”
3. Employee ID String 60  Unique number used to

(PK) identify a store employee.
“EmployeeId” hrs_employee.employee
_id
hrs_employee_password.
employee_id
4. Party ID BigInt  ID number of the party that

represents this employee.
"PartyId"
hrs_employee.party_id
5. Active Date Date 10 Date the employee became

active.
"ActiveDate"
hrs_employee.active_date
6. Add Date Date 10 Date the employee was added

to the system.
"AddDate"
hrs_employee.add_date
7. Hire Date Date 10 Date the employee was hired.

"HireDate" hrs_employee.hire_date
8. Terminated Date Date 10 Date the employee was

terminated.
"Terminated
Date" hrs_employee.terminated_dat
e

Name Comment
9. Employee Status String 30  Code denoting employee

Code status. The following values
are fixed:
"EmployeeStatus
Code" T for terminated
A for active
I for inactive
hrs_employee.employee_statc
ode
10. Employee Role String 30 Code denoting the role the

Code employee plays within the
store.
"EmployeeRole
Code" hrs_employee.employee_role_
code
11. Employee Type String 30 A user-defined classification

Code for an employee. (For
example, cashier, salesperson,
"EmployeeType
janitor, etc.)
Code"
hrs_employee.
employee_typcode
12. Employee Group String 30 Identifier for the employee

group that the employee
"EmployeeGrou
belongs to.
p"
hrs_employee.
employee_group_id
13. Department ID String 30 Unique identifier for the

department the employee is
"DepartmentId"
assigned to.
hrs_employee.
department_id
14. Job Title String 254 Employee job title.

"JobTitle" hrs_employee.job_title
15. Employee Pay String 30 Pay status of the employee.

Status (For example; hourly, salaried)
"EmployeePay hrs_employee.employee_pay_
Status" status
16. Base Pay Decimal 17, 6 Employee pay rate.

"BasePay" hrs_employee.base_pay
17. Additional Decimal 17, 6 Dollar amount that should be

Withholdings withheld from pay in addition
to the withholdings required
"Additional
by law.
Withholdings"
hrs_employee.additional_with
holdings

Name Comment
18. Last Review Date 10 Date of employee's last

Date performance review.
"LastReview hrs_employee.last_review_dat
Date" e
19. Next Review Date 10 Date employee's next

Date performance review is due.
"NextReview hrs_employee.next_
Date" review_date
20. Personal Days Decimal 11, 2 Number of personal days an

employee has available.
"PersonalDays"
hrs_employee.personal_
days
21. Personal Days Decimal 11, 2 Number of personal days an

Used employee has used.
"PersonalDays hrs_employee.personal_
Used" days_used
22. Vacation Days Decimal 11, 2 Number of vacation days an

"VacationDays"
hrs_employee.vacation_
days
23. Vacation Days Decimal 11, 2 Number of vacation days an

Used employee has used.
"VacationDays hrs_employee.vacation_
Used" days_used
24. Sick Days Decimal 11, 2 Number of sick days an

"SickDays"
hrs_employee.sick_days
25. Sick Days Used Decimal 11, 2 Number of sick days an

employee has used.
"SickDaysUsed"
hrs_employee.sick_days_used
26. Marital Status String 30 Code denoting an employee's

marital status.
"MaritalStatus"
hrs_employee.marital_
status
27. Spouse Name String 254 Name of employee's spouse.

"SpouseName" hrs_employee.spouse_
name
28. Emergency String 254 Name of the person to be

Contact Name contacted in an emergency.
"EmergencyCont hrs_employee.emergency_con
actName" tact_name

Name Comment
29. Emergency String 32 Phone number of emergency

Contact Phone contact.
"Emergency hrs_employee.emergency_con
ContactPhone" tact_phone
30. Clock In Not Boolean 5 If true, the employee is not

Required Flag required to “clock in” in order
to use the system.
"ClockInNot
Required" hrs_employee.clock_in_
not_req_flag
31. Overtime Boolean 5 If true, the employee is eligible

Eligible Flag for overtime work hours and
compensation.
"Overtime
Eligible" hrs_employee.overtime_
eligible_flag
must exist.
33. Training Status String 30  Code denoting the training

Enum status of the employee. When
in restricted training mode,
"TrainingStatusE
the employee will not be able
num"
to access non-training register/
back office functions. The
EXEMPT
RESTRICTED_TRAINEE
UNRESTRICTED_TRAINEE
hrs_employee.training_
status_enum
34. Primary Group String 60  Primary security group of the

ID employee used to determine
tendering rules.
"PrimaryGroup
Id" hrs_employee.primary_
group
35. Group String UNL  Base 64 encoded group

Membership membership of the employee.
Determines security
"Group
permissions.
MembershipRaw
" hrs_employee.group_
membership
36. Login ID String 60 The user ID an employee will

use when logging in to the
"LoginId"
system.
hrs_employee.login_id

Name Comment
37. Employee Work String 30 A code that represents the

Status current state of an employee
assignment.
"EmployeeWork
Status" hrs_employee.employee_work
_status
<Field literal="Z2XD2xI4rYk" name="Password" />

hrs_employee_password.password

hrs_employee_password.password_seq
<Field literal="1" name="Temporary" />

hrs_employee_password.temp_password_flag
<Field variable="$currentDateTimestamp" name="EffectiveDate" />

hrs_employee_password.effective_date
<Field literal="1" name="Current" />

hrs_employee_password.current_password_flag

Employee Store Record (EMPLOYEE_STORE)

Gives an employee the ability to log on to the Xstore system in the designated store
during the given date range. Without a valid EMPLOYEE_STORE record, an employee
will not be permitted to log on to Xstore.
Dependencies:
There must be an EMPLOYEE record for each Employee ID in this file.
There must be a RETAIL_LOCATION record for each Retail Location ID in this file.
hrs_employee_store All Fields EmployeeStore
Name Comment

Record”.
2. Record Identifier String 30  “EMPLOYEE_STORE”
Field literal="0" name="EmployeeStoreSequence" />

hrs_employee_store.employee_store_seq
3. Employee ID String 60  Unique number used to

"EmployeeId" hrs_employee_store.
employee_id

organization.
"RetailLocationI
d" hrs_employee_store.
rtl_loc_id
5. Begin Date DateTime 23 The date and time the

employee assignment begins.
"BeginDate"
hrs_employee_store.
begin_date
6. End Date DateTime 23 The date and time the

employee assignment ends.
"EndDate"
hrs_employee_store.
end_date
7. Temporary Boolean 5 If true, indicates this is a

Assignment Flag temporary assignment.
"Temporary hrs_employee_store.
Assignment" temp_assignment_flag

Employee Note Record (EMPLOYEE_NOTE)

Contains a collection of comments for an employee.
hrs_employee_notes All Fields EmployeeNote
Name Comment

Record”.
2. Record Identifier String 30  “EMPLOYEE_NOTE”
3. Employee Id String 60  The unique, non-significant

(PK) number used to identify a
store employee. (The
"employeeId"
employee ID of the person the
note is about.)
hrs_employee_notes.
employee_id
4. Note Sequence BigInt  Sequence number within the

(PK) table to keep the employee
notes ordered and unique.
"noteSequence"
hrs_employee_notes.
note_seq
5. Note String UNL The text of the note.

"note" hrs_employee_notes.
note
6. Creator Party Id BigInt The person who made the

note.
"creatorParty
Id" hrs_employee_notes.
creator_party_id
7. Note Time DateTime 23 The date and time the note

Stamp was created.
"noteTimeStamp hrs_employee_notes.
" note_timestamp

Employee Password Record (EMPLOYEE_PASSWORD)

Contains information about an employee’s password.
hrs_employee_password All Fields EmployeePassword
Name Comment

Record”.
2. Record Identifier String 30  “EMPLOYEE_PASSWORD”
3. Employee Id String 60  Unique number used to

"EmployeeId" hrs_employee_password.empl
oyee_id
4. Password String 254 The employee’s password

(encrypted).
"Password"
hrs_employee_password.pass
word
5. Sequence (PK) BigInt  Sequence number within the

table to keep the employee
"Sequence"
passwords ordered and
unique.
hrs_employee_password.pass
word_seq
6. Effective Date DateTime 23  The date and time the

employee password takes
"EffectiveDate"
effect.
hrs_employee_password.effect
ive_date
7. Current Boolean 5  If true, this is the employee’s

Password Flag current password.
"Current" hrs_employee_password.curre
nt_password_flag
8. Temporary Flag Boolean 5  This flag is used to trigger the

password change process the
“Temporary”
next time the user logs into the
system. The “initial”
passwords are downloaded,
but when true, the user is
forced to change his/her
password on the first login.
hrs_employee_password.temp
_password_flag

Employee Task Record (EMPLOYEE_TASK)

Contains information about corporate or store task assignments to be completed by all
store employees, or a specific employee or group of employees.
hrs_employee_task All Fields EmployeeTask
Employee Task Record (EMPLOYEE_TASK) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “EMPLOYEE_TASK”

organization.
"RetailLocationI
d" hrs_employee_task.
rtl_loc_id
4. Task Id (PK) Integer  The unique identifier for the

task.
"TaskId"
hrs_employee_task.
task_id
5. Start Date DateTime 23 The date the task should be

started.
"StartDate"
hrs_employee_task.
start_date
6. End Date DateTime 23 The date the task should be

finished.
"EndDate"
hrs_employee_task.
end_date
7. Type Code String 60 A generic, client-defined code

for the type of task.
"TypeCode"
hrs_employee_task.
typcode
8. Title String 100 A short summary description

of the task.
"Title"
hrs_employee_task.
title
9. Description String MAX A detailed description of the

task.
"Description"
hrs_employee_task.
description

Employee Task Record (EMPLOYEE_TASK) (Sheet 2 of 2)
Name Comment
10. Priority String 20 The task priority: LOW,

MEDIUM, HIGH.
"Priority"
hrs_employee_task.
priority
11. Visibility String 30 Who can see the task: STORE,

EMPLOYEE GROUP,
"Visibility"
EMPLOYEE
hrs_employee_task.
visibility
12. Assignment Id String 60 The identifier for the specific

visibility target: Employee
"AssignmentId"
Group Id or Employee Id. If
targeted to the entire store,
leave blank.
hrs_employee_task.
assignment_id
13. Void Flag Boolean 5 If true, the task has been

deleted.
"Void"
hrs_employee_task.
void_flag
14. Status Code String 20 The task status.

"StatusCode" default="OPEN"
hrs_employee_task.
status_code
<Field literal="0" name="StoreCreated" />

hrs_employee_task.store_created_flag
15. Party ID Integer Party ID for the employee.

"PartyId" hrs_employee_task.
party_id

Employee Task Notes Record (EMPLOYEE_TASK_NOTES)
Employee Task Notes Record (EMPLOYEE_TASK_NOTES)

Contains information about notes associated with corporate or store task assignments.
hrs_employee_task_notes All Fields EmployeeTaskNotes
Employee Task Record (EMPLOYEE_TASK_NOTES)
Name Comment

Record”.
2. Record Identifier String 30  “EMPLOYEE_TASK_NOTES”

organization.
"RetailLocation
Id" hrs_employee_task_
notes.rtl_loc_id
4. Task Id (PK) Integer  The unique identifier for the

task.
"TaskId"
hrs_employee_task_
notes.task_id
5. Note Sequence Integer 23  Sequence number for the note.

"NoteSequence" hrs_employee_task_
notes.note_seq
6. Note String MAX Content of the note.

"Note" hrs_employee_task_
notes.note
7. Creator Party Id Integer Party ID of the employee who

created the note.
"CreatorParty
Id" hrs_employee_task_
notes.creator_party_id
8. Note Time DateTime 23 Time stamp for the note.

Stamp
hrs_employee_task_
"NoteTimeStamp notes.note_timestamp
"

Employee Message Record (EMPLOYEE_MESSAGE)

Contains employee message information.
hrs_employee_message All Fields EmployeeMessage
Employee Message Record (EMPLOYEE_MESSAGE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “EMPLOYEE_MESSAGE”
must exist.
4. Message Id Integer  The unique message identifier.

"MessageId" hrs_employee_message.
message_id
5. Start Date DateTime 23 The date the message is to be

displayed.
"StartDate"
hrs_employee_message.
start_date
6. End Date DateTime 23 The date the message is no

longer displayed.
"EndDate"
end_date
7. Priority String 20 The message priority: LOW,

MEDIUM, HIGH.
"Priority"
priority
8. Content String MAX The message text.

"Content" hrs_employee_message.
content
9. Workstation Boolean 5 If true, the message will be

Specific Flag displayed on a specific
workstation. If false, the
"Workstation
message will be displayed on
Specific"
all workstations.
wkstn_specific_flag

Employee Message Record (EMPLOYEE_MESSAGE) (Sheet 2 of 2)
Name Comment
10. Workstation Id BigInt If wkstn_specific_flag is set to

true, the workstation where
"WorkstationId"
the message is displayed.
wkstn_id
11. Void Flag Boolean 5 If true, the message has been

deleted.
"Void"
hrs_employee_message.void_f
lag
<Field literal="0" name="StoreCreated" />

hrs_employee_message.store_created_flag

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value
14. Message URL String 254 Used to identify a hyperlink

that, when selected, takes the
“MessageURL”
user to the designated website.
message_url

Customer Group Record (CUST_GROUP)

Contains information about a group of customers based on specific demographic and
marketing attributes and properties. Examples include customers over 65 years old,
students, unions, and other associations.
com_code_value All Fields CodeValue
Customer Group Record (CUST_GROUP) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CUST_GROUP”
<Field literal="CUSTOMER_GROUPS" name="Category" />

com_code_value.category
3. Customer Group String 60  Unique identifier assigned to a

ID (PK) customer group category.
"Code" com_code_value.code
must exist.
5. Description String 254 Description of the customer

group category.
"Description"
com_code_value.
description

a list is sorted.
"SortOrder"
com_code_value.
sort_order

“Hidden”
user.
be displayed.
displayed.
com_code_value.
hidden_flag
must exist.
must exist.

Customer Group Record (CUST_GROUP) (Sheet 2 of 2)
Name Comment
10. Rank Integer The rank associated to the

customer group within the
"Rank"
Xstore application.
com_code_value.
rank
11. Image Url String 254 The image location.

"ImageUrl" com_code_value.
image_url

Customer Affiliation Record (CUST_AFFILIATION)

Contains information associating a customer to a customer group.
Dependencies:
There must be a PARTY record for each Party ID in this file.
There must be a CUST_GROUP record for each Customer Group ID in this file.
crm_customer_affiliation All Fields CustomerAffiliation
Name Comment

Record”.
2. Record Identifier String 30  “CUST_AFFILIATION”
3. Customer Group String 60  Unique identifier assigned to a

ID (PK) customer group.
"CustomerGroup crm_customer_affiliation.
Id" cust_group_id
4. Party ID (PK) BigInt  Unique identifier assigned to a

party.
"PartyId"
crm_customer_affiliation.
party_id

Customer Note Record (CUST_NOTE)

Contains a collection of comments for a customer.
crm_customer_notes All Fields CustomerNote
Name Comment

Record”.
2. Record Identifier String 30  “CUST_NOTE”
3. Party ID (PK) BigInt  Unique identifier assigned to a

party (customer).
"PartyId"
crm_customer_notes.
party_id
4. Note Sequence BigInt  Sequence number within the

(PK) table to keep the customer
notes ordered and unique.
"noteSequence"
crm_customer_notes.
note_seq

"note" crm_customer_notes.
note
6. Creator Party Id BigInt The person who made the

note.
"creatorParty
Id" crm_customer_notes.
creator_id
7. Note Time DateTime 23 The date and time the note

Stamp was created.
"noteTimeStamp crm_customer_notes.
" note_timestamp

Customer Merge Record (CUSTOMER_MERGE)

Used to combine two customer records into a single record. Commonly used to support
duplication removal processes that occur in systems outside Xstore.
Dependencies:
Requires two valid, existing customer IDs.
Note: This record is unusual in that it replaces the previous party_id

with the new party_id in many tables. It also deletes old information
where applicable. Tables in which “All Fields” are used are
replacements of party_id. Tables in which only field 4 is used are
deletions of records.
Database Tables Updated Fields
rpt_sale_line All Fields
rpt_trl_sale_lineitm_view All Fields
trl_rtrans All Fields
crm_party_cross_reference All Fields
cat_charge_acct_history All Fields
cat_charge_acct_users All Fields
cat_cust_acct All Fields
cat_cust_acct_journal All Fields
itm_warranty All Fields
itm_warranty_journal All Fields
tax_tax_exemption All Fields
ttr_ar_tndr_lineitm All Fields
crm_customer_affiliation 4
crm_party 4
crm_party_locale_information 4
crm_party_telephone 4
crm_party_properties 4

1. Action Code String as  UPDATE or DELETE

specified
2. Record Identifier String 30  “CUSTOMER_MERGE”
3. Customer ID String 60  NEW customer party id

Unique identifier assigned to
the customer that is receiving
all the customer information.
(New)
4. Customer ID String 60  OLD customer party id

Unique identifier assigned to
the customer that will be no
longer be associated with any
database data. (Old)

Customer Consent Information Record (CUSTOMER_CONSENT_INFO)
Customer Consent Information Record

(CUSTOMER_CONSENT_INFO)
Contains consent information for a customer.
crm_consent_info All Fields CustomerConsentInfo
Customer Consent Information Record (CUSTOMER_CONSENT_INFO)
Name Comment

Record”.
2. Record Identifier String 30  “CUSTOMER_CONSENT_

INFO”
3. Effective Date DateTime 23  Effective date for the consent

(PK) agreement.
"EffectiveDate" crm_consent_info.
effective_date
4. Terms and String 4000 Terms and conditions of the

Conditions consent.
"termsAnd crm_consent_info.
Conditions" terms_and_conditions
5. Consent Text 1 String 4000 First line of text in the consent.

"consent1Text" crm_consent_info.
consent1_text
6. Consent Text 2 String 4000 Second line of text in the

consent.
"consent2Text"
crm_consent_info.
consent2_text
7. Consent Text 3 String 4000 Third line of text in the

consent.
"consent3Text"
crm_consent_info.
consent3_text
7. Consent Text 4 String 4000 Fourth line of text in the

consent.
"consent4Text"
crm_consent_info.
consent4_text
7. Consent Text 5 String 4000 Fifth line of text in the consent.

"consent5Text" crm_consent_info.
consent5_text

Anonymize Customer Record (CUSTOMER_ANONYMIZE)

Used to remove all personal information for a customer.
Dependencies:
Requires one valid, existing party ID for a customer.
Note: This record is unusual in that it removes or nulls data in many

tables. The PartyId field is used to identify the database records that
will be anonymized by this record.
Database Table Updated
crm_party_p
crm_party_email
crm_party_locale_information
crm_party_telephone
crm_customer_notes
cat_delivery_modifier
xom_customer_mod
xom_address_mod
ttr_identity_verification
tax_tax_exemption
cat_charge_acct_users
cat_cust_acct
crm_party
inv_shipment
inv_shipment_address
Anonymize Customers Record (CUSTOMER_ANONYMIZE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CUSTOMER_ANONYMIZE”

Anonymize Customers Record (CUSTOMER_ANONYMIZE) (Sheet 2 of 2)
Name Comment
3. Party ID (PK) BigInt  Party ID for the customer.

"PartyId" crm_party_p.party_id
crm_party_email.party_id
party_id
crm_party_telephone.party_id
crm_customer_notes.party_id
cat_delivery_modifier.
party_id
xom_customer_mod.party_id
xom_address_mod.party_id
ttr_identity_verification.
party_id
tax_tax_exemption.party_id
cat_charge_acct_users.
party_id
cat_cust_acct.party_id
crm_party.party_id
inv_shipment.party_id
inv_shipment_address.
party_id
<Sql sql="DELETE FROM crm_party_p

WHERE organization_id = ? AND party_id = ?">
<Field configParam="getOrganizationId" dataType="Long"/>
<Field filePosition="03" dataType="String"/>
</Sql>
<Sql sql="UPDATE crm_party_email SET email_address = NULL,
email_type = NULL, email_format = NULL, contact_flag = 0 ,
primary_flag = 0 WHERE organization_id = ? AND party_id = ?">
</Sql>
<Sql sql="UPDATE crm_party_locale_information
SET address1 = NULL, address2 = NULL, address3 = NULL,
address4 = NULL ,apartment = NULL, city = NULL, state = NULL,
postal_code = NULL, country = NULL, neighborhood = NULL,
county = NULL, contact_flag = 0, primary_flag = 0,

address_type = NULL
</Sql>
<Sql sql="UPDATE crm_party_telephone
SET telephone_number = NULL, contact_type = NULL ,
contact_flag = 0, primary_flag = 0
</Sql>
<Sql sql="UPDATE crm_customer_notes
SET note = NULL, creator_id = NULL, note_timestamp = NULL
</Sql>
<Sql sql="UPDATE cat_delivery_modifier
SET cat_delivery_modifier.address1 = NULL,
cat_delivery_modifier.address2 = NULL,
cat_delivery_modifier.address3 = NULL ,
cat_delivery_modifier.address4 = NULL,
cat_delivery_modifier.city = NULL,
cat_delivery_modifier.state = NULL,
cat_delivery_modifier.postal_code = NULL ,
cat_delivery_modifier.country = NULL,
cat_delivery_modifier.neighborhood = NULL,
cat_delivery_modifier.county = NULL,
cat_delivery_modifier.telephone1 = NULL ,
cat_delivery_modifier.telephone2 = NULL,
cat_delivery_modifier.apartment = NULL ,
cat_delivery_modifier.first_name = NULL,
cat_delivery_modifier.middle_name = NULL,
cat_delivery_modifier.last_name = NULL ,

cat_delivery_modifier.shipping_method = NULL,
cat_delivery_modifier.tracking_number = NULL,
cat_delivery_modifier.extension = NULL,
cat_delivery_modifier.delivery_date = NULL WHERE
cat_delivery_modifier.organization_id = ? AND
cat_delivery_modifier.cust_acct_id IN
(SELECT cca.cust_acct_id FROM cat_cust_acct cca
WHERE cca.organization_id = ? AND cca.party_id = ?)">
</Sql>
<Sql sql="UPDATE xom_customer_mod
SET xom_customer_mod.first_name = NULL,
xom_customer_mod.last_name = NULL,
xom_customer_mod.telephone1 = NULL ,
xom_customer_mod.telephone2 = NULL,
xom_customer_mod.email_address = NULL,
xom_customer_mod.ORGANIZATION_NAME = NULL,
xom_customer_mod.SALUTATION = NULL ,
xom_customer_mod.MIDDLE_NAME = NULL,
xom_customer_mod.SUFFIX = NULL
WHERE xom_customer_mod.organization_id = ? AND
xom_customer_mod.order_id IN
(SELECT DISTINCT xom.order_id FROM xom_order_mod xom
JOIN trl_rtrans tr
ON xom.organization_id = tr.organization_id
AND xom.rtl_loc_id = tr.rtl_loc_id
AND xom.business_date = tr.business_date
AND xom.wkstn_id = tr.wkstn_id
AND xom.trans_seq = tr.trans_seq
WHERE tr.cust_party_id = ? AND tr.organization_id = ?)">
</Sql>
<Sql sql="UPDATE xom_address_mod

SET xom_address_mod.address1 = NULL,

xom_address_mod.address2 = NULL,
xom_address_mod.address3 = NULL,
xom_address_mod.address4 = NULL ,
xom_address_mod.city = NULL,
xom_address_mod.state = NULL,
xom_address_mod.postal_code = NULL,
xom_address_mod.country = NULL ,
xom_address_mod.apartment = NULL,
xom_address_mod.neighborhood = NULL,
xom_address_mod.county = NULL
WHERE xom_address_mod.organization_id = ?
AND xom_address_mod.order_id IN
(SELECT DISTINCT xom.order_id FROM xom_order_mod xom
JOIN trl_rtrans tr
ON xom.organization_id = tr.organization_id
AND xom.rtl_loc_id = tr.rtl_loc_id
AND xom.business_date = tr.business_date
AND xom.wkstn_id = tr.wkstn_id
AND xom.trans_seq = tr.trans_seq
WHERE tr.cust_party_id = ? AND tr.organization_id = ?)">
</Sql>
<Sql sql="UPDATE ttr_identity_verification
SET id_typcode = NULL, id_nbr = NULL, issuing_authority = NULL
WHERE ttr_identity_verification.organization_id = ?
AND ttr_identity_verification.trans_seq IN
(SELECT tiv.trans_seq FROM ttr_identity_verification tiv
JOIN trl_rtrans tr
ON tiv.organization_id = tr.organization_id
AND tiv.rtl_loc_id = tr.rtl_loc_id
AND tiv.business_date = tr.business_date
AND tiv.wkstn_id = tr.wkstn_id
AND tiv.trans_seq = tr.trans_seq
WHERE tr.organization_id = ? AND tr.cust_party_id = ?)">


</Sql>
<Sql sql="UPDATE tax_tax_exemption
SET cert_nbr = NULL, reascode = NULL, cert_holder_name = NULL,
expiration_date = NULL, cert_state = NULL, notes = NULL,
phone_number = NULL, region = NULL, diplomatic_title = NULL,
cert_holder_first_name = NULL, cert_holder_last_name = NULL
</Sql>
<Sql sql="UPDATE cat_charge_acct_users
SET cat_charge_acct_users.acct_user_name = '*******',
cat_charge_acct_users.acct_user_first_name = NULL ,
cat_charge_acct_users.acct_user_last_name = NULL,
cat_charge_acct_users.primary_contact_flag = 0,
cat_charge_acct_users.effective_date = NULL ,
cat_charge_acct_users.expiration_date = NULL
WHERE cat_charge_acct_users.organization_id = ?
AND cat_charge_acct_users.cust_acct_id IN
WHERE cca.organization_id = ? AND cca.party_id = ?
AND cca.cust_acct_code ='HOUSE_ACCOUNT')">
</Sql>
<Sql sql="UPDATE cat_cust_acct SET first_name = NULL,
last_name = NULL, telephone = NULL, acct_po_nbr = NULL ,
acct_balance = NULL, cust_identity_req_flag = 0,
cust_identity_typcode = NULL, cust_acct_statcode = NULL ,
acct_setup_date = NULL, last_activity_date = NULL
WHERE organization_id = ? AND party_id = ?
AND cust_acct_code ='HOUSE_ACCOUNT'">


</Sql>
<Sql sql="UPDATE cat_acct_note SET entry_timestamp = NULL,
note = NULL WHERE cat_acct_note.organization_id = ? AND
cat_acct_note.cust_acct_id IN
(SELECT cat_cust_acct.cust_acct_id FROM cat_cust_acct
WHERE cat_cust_acct.organization_id = ? AND
cat_cust_acct.party_id = ?)">
</Sql>
<Sql sql="UPDATE cat_charge_acct_history SET acct_user_name =
NULL WHERE cat_charge_acct_history.organization_id = ? AND
cat_charge_acct_history.cust_acct_id IN
JOIN cat_charge_acct_history ccah ON
cca.organization_id = ccah.organization_id AND
cca.cust_acct_code = ccah.cust_acct_code AND
cca.cust_acct_id = ccah.cust_acct_id
WHERE cca.organization_id = ? AND cca.party_id = ?)">
</Sql>
<Sql sql="UPDATE crm_party SET salutation = NULL, first_name =
NULL, middle_name = NULL, last_name = NULL ,first_name2 =
NULL, last_name2 = NULL, suffix = NULL, employee_id = NULL,
gender = NULL, preferred_locale = NULL, birth_date = NULL,
social_security_nbr = NULL, national_tax_id = NULL,
personal_tax_id = NULL, prospect_flag = 0, rent_flag = 0,
privacy_card_flag = 0, contact_pref = NULL,
sign_up_rtl_loc_id = -1, allegiance_rtl_loc_id = -1,
anniversary_date = NULL, organization_typcode = NULL,
organization_name = NULL, commercial_customer_flag = 0,
picture_uri = NULL, void_flag = 1, active_flag = 0,
email_rcpts_flag = 0 WHERE organization_id = ? AND

party_id = ?">
</Sql>
<Sql sql="UPDATE inv_shipment SET destination_name = NULL WHERE
organization_id = ? AND destination_party_id = ?">
</Sql>
<Sql sql="UPDATE inv_shipment_address
SET address1 = NULL, address2 = NULL, address3 = NULL,
address4 = NULL ,apartment = NULL, city = NULL, state = NULL,
postal_code = NULL, country = NULL, neighborhood = NULL,
county = NULL ,telephone1 = NULL, telephone2 = NULL,
telephone3 = NULL, telephone4 = NULL
WHERE organization_id = ? AND invctl_document_id IN
(SELECT DISTINCT ishp.invctl_document_id
FROM inv_shipment ishp WHERE ishp.organization_id = ?
AND ishp.destination_party_id = ?)">
</Sql>
<Sql sql="UPDATE ttr_send_check_tndr_lineitm
SET payable_to_name = NULL, payable_to_address = NULL,
payable_to_city = NULL, payable_to_state = NULL,
payable_to_postal_code = NULL, payable_to_address2 = NULL,
payable_to_address3 = NULL, payable_to_address4 = NULL,
payable_to_apt = NULL, payable_to_country = NULL,
payable_to_neighborhood = NULL, payable_to_county = NULL
WHERE ttr_send_check_tndr_lineitm.organization_id = ? AND
ttr_send_check_tndr_lineitm.trans_seq IN
(SELECT tr.trans_seq FROM trl_rtrans tr JOIN
ttr_send_check_tndr_lineitm tsc ON tr.organization_id =
tsc.organization_id AND tr.rtl_loc_id = tsc.rtl_loc_id AND
tr.business_date = tsc.business_date AND tr.wkstn_id =
tsc.wkstn_id AND tr.trans_seq = tsc.trans_seq WHERE

tr.organization_id = ? AND tr.cust_party_id = ?)">

</Sql>
<Sql sql="UPDATE ttr_ar_tndr_lineitm SET acct_user_id = NULL
WHERE ttr_ar_tndr_lineitm.organization_id = ? AND
ttr_ar_tndr_lineitm.trans_seq IN
ttr_ar_tndr_lineitm tatl ON tr.organization_id =
tatl.organization_id AND tr.rtl_loc_id = tatl.rtl_loc_id
AND tr.business_date = tatl.business_date AND
tr.wkstn_id = tatl.wkstn_id AND tr.trans_seq =
tatl.trans_seq WHERE tr.organization_id = ? AND
tr.cust_party_id = ?)">
</Sql>
<Sql sql="UPDATE trl_ar_sale_lineitm SET acct_user_name = NULL
WHERE trl_ar_sale_lineitm.organization_id = ? AND
trl_ar_sale_lineitm.trans_seq IN
trl_ar_sale_lineitm tatl ON tr.organization_id =
tatl.organization_id AND tr.rtl_loc_id = tatl.rtl_loc_id
AND tr.business_date = tatl.business_date AND tr.wkstn_id =
tatl.wkstn_id AND tr.trans_seq = tatl.trans_seq WHERE
tr.organization_id = ? AND tr.cust_party_id = ?)">
</Sql>
<Sql sql="DELETE FROM civc_invoice_p WHERE
civc_invoice_p.organization_id = ? AND
civc_invoice_p.sequence_id IN
(SELECT ci.sequence_id FROM civc_invoice ci JOIN
civc_invoice_p cip ON ci.organization_id =

cip.organization_id AND ci.rtl_loc_id = cip.rtl_loc_id AND

ci.wkstn_id = cip.wkstn_id AND ci.business_year =
ci.business_year AND ci.sequence_id = cip.sequence_id AND
ci.sequence_nbr = cip.sequence_nbr WHERE
ci.organization_id = ? AND ci.party_id = ?)">
</Sql>

Anonymize Employee Record (EMPLOYEE_ANONYMIZE)

Used to remove all personally identifiable information (PII) for an employee.
Dependencies:
Requires one valid, existing party ID for an employee.
Note: This record is unusual in that it removes or nulls data in many

tables. The PartyId field is used to identify the database records that
will be anonymized by this record.
Database Table Updated
hrs_employee_password
hrs_employee_fingerprint
hrs_employee_answers
hrs_employee_notes
hrs_employee
Anonymize Customers Record (CUSTOMER_ANONYMIZE)
Name Comment

Record”.
2. Record Identifier String 30  “CUSTOMER_ANONYMIZE”
3. Party ID (PK) String 60  Party ID for the customer.

"PartyId" hrs_employee_password.
employee_id
hrs_employee_fingerprint.
employee_id
hrs_employee_answers.
employee_id
hrs_employee_notes.
employee_id
hrs_employee.
employee_id
<Sql sql="DELETE FROM hrs_employee_password

WHERE organization_id = ? AND employee_id IN
(SELECT employee_id FROM hrs_employee
WHERE organization_id = ? AND party_id = ?)">


</Sql>
<Sql sql="DELETE FROM hrs_employee_fingerprint
</Sql>
<Sql sql="DELETE FROM hrs_employee_answers
</Sql>
<Sql sql="UPDATE hrs_employee_notes SET note = NULL,
creator_party_id = NULL, note_timestamp = NULL
</Sql>
<Sql sql="UPDATE hrs_employee SET sick_days_used = NULL,
sick_days = NULL, hire_date = NULL, active_date = NULL,
terminated_date = NULL, job_title = NULL, base_pay = NULL,
add_date = NULL, marital_status = NULL, spouse_name = NULL,
emergency_contact_name = NULL, emergency_contact_phone = NULL,
last_review_date = NULL, next_review_date = NULL,
additional_withholdings = NULL, vacation_days = NULL,
vacation_days_used = NULL, personal_days = NULL,
personal_days_used = NULL, clock_in_not_req_flag = 0,
work_code = NULL, group_membership = NULL, primary_group =

NULL, department_id = NULL, employee_typcode = NULL,

training_status_enum = NULL, locked_out_flag = 0,
locked_out_timestamp = NULL, overtime_eligible_flag = 0,
employee_group_id = NULL, employee_work_status = NULL,
employee_pay_status = NULL, employee_role_code = NULL,
keyed_offline_flag = 0 WHERE organization_id = ? AND
party_id = ?">
</Sql>

5
Inventory
Stock Ledger Record (STOCK_LEDGER)

Used to track current inventory levels for items. This is a unit record of a location inside
a store where a stock item is stored or displayed for sale, and for which an item stock on
hand count and dollar value is maintained.
inv_stock_ledger_acct All Fields StockLedger
Stock Ledger Record (STOCK_LEDGER) (Sheet 1 of 2)
Name Comment

Record”.
Note: When the Action Code
is set to UPDATE, the Unit
Count field is added or
subtracted from the current
bucket.
2. Record Identifier String 30  “STOCK_LEDGER”
3. Retail Location Integer  Unique identifier for the store.

(PK)
inv_stock_ledger_acct.
"RetailLocationI rtl_loc_id
d"

for an item. Can be the
"ItemId"
item_id
Inventory 5-1
Stock Ledger Record (STOCK_LEDGER)
Stock Ledger Record (STOCK_LEDGER) (Sheet 2 of 2)
Name Comment
5. Bucket ID (PK) String 60  Standard inventory bucket.

The following value is fixed:
"BucketId"
ON_HAND
In addition to the fixed value
bucket_id
6. Location ID (PK) String 60  Location of the item within the

store. Typically used for big-
"InvLocationId"
ticket items, such as jewelry.
inv_location_id
must exist.
8. Inventory Value Decimal 17,6 The value of the item.

"Inventory inv_stock_ledger_acct.
Value" inventory_value
9. Unit Count Decimal 14, 4 The number of items in

inventory for the specified
"Unitcount"
store, item, bucket and
location.
unitcount

Inventory Document Record (INV_DOC)

Contains Inventory Document information that is used to depict merchandise flow
through the retail location structure.
inv_invctl_document 3-15, 37-38 InventoryDocument
inv_shipment 3, 5-6, 8, 14, 16-26 Shipment
inv_shipment_address 3, 5-6, 27-35, 41-44 ShipmentAddress
Inventory Document Record (INV_DOC) (Sheet 1 of 6)
Name Comment

Record”.
2. Record Identifier String 30  “INV_DOC”
3. Document Type String 30  Describes the primary type of

Code (PK) the document. The following
values are fixed:
"DocumentType
Code"
SHIPPING
RECEIVING
INVENTORY_COUNT
inv_invctl_document.
document_typcode
inv_shipment.
document_typcode
document_typcode
4. Document String 30 Describes the specific type of

Subtype Code document within the primary
type. The following values are
"Document
fixed:
SubtypeCode"
STORE_TRANSFER
DEFECTIVE_RETURN
REPAIR
RETURN_TO_VENDOR
CALL_BACK
SALE
WORK_ORDER
ASN
SUPPLY_COUNT
PHYSICAL_COUNT
CYCLE_COUNT
SPECIAL_ORDER
document_subtypcode
Inventory 5-3
Name Comment

organization. Typically, stores
"RetailLocationI
are given a unique reference
d"
number.
rtl_loc_id
inv_shipment.rtl_loc_id
rtl_loc_id
6. Document ID String 60  Reference number that

(PK) uniquely identifies the
inventory control document.
"DocumentId"
invctl_document_id
inv_shipment.
invctl_document_id
invctl_document_id
7. Description String 254 A text description of the

"Description"
description
8. Status Code String 30 Current status of the

document. The following
"StatusCode"
values are fixed:
OPEN
IN_PROCESS
CLOSED
status_code
inv_shipment.
shipment_statcode
9. Create Date DateTime 23 Date and time this document

Time was created.
"CreateDate inv_invctl_document.
Time" create_date_timestamp
10. Complete Date DateTime 23 Date and time this document

Time was marked as complete.
"CompleteDate inv_invctl_document.
Time" complete_date_timestamp
11. Last Activity DateTime 23 Date and time of the last

Date activity on this document.
"LastActivity inv_invctl_document.
Date" last_activity_date

Name Comment
12. Originator ID String 60 Identifies the point of origin

for this inventory document.
"OriginatorId"
An originator may be a
program (for automatically
generated documents) or a
person.
originator_id
13. Originator Name String 254 Name of the originator of this

document.
"Originator
Name" inv_invctl_document.
originator_name
14. Record Creation String 30 Code indicating how this

Type record was created. The
"RecordCreation
Type" STORE
HOME_OFFICE
OTHER
record_creation_type
inv_shipment.
15. PO Reference String 254 Reference number that

Number uniquely identifies the
Purchase Order inventory
"PoReference
control document.
Number"
po_ref_nbr
<Field literal="1" name="ShipmentSequence" />

inv_shipment.shipment_seq
16. Expected DateTime 10 Expected delivery date of the

Delivery Date shipment.
"Expected inv_shipment.
DeliveryDate" expected_delivery_date
17. Actual Delivery DateTime 10 Actual delivery date of the

Date shipment.
"ActualDelivery inv_shipment.
Date" actual_delivery_date
18. Expected Ship DateTime 10 Date the shipment is expected

Date to ship.
"ExpectedShip inv_shipment.
Date" expected_ship_date
Inventory 5-5
Name Comment
19. Actual Ship Date DateTime 10 Date the shipment was

actually shipped.
"ActualShip
Date" inv_shipment.
actual_ship_date
20. Shipping Carrier String 254 Identifier indicating the carrier

presenting the bill of lading
"Shipping
for transferring the item.
Carrier"
inv_shipment.
shipping_carrier
21. Tracking String 254 Tracking number, assigned by

Number the carrier, used to track the
progress of this shipment with
"Tracking
the carrier.
Number"
inv_shipment.
tracking_nbr
22. Destination BigInt Party ID of the recipient of this

Party ID shipment.
"Destination inv_shipment.
PartyId" destination_party_id
23. Destination Integer Retail location ID of the

Retail Location recipient of this shipment.
ID
inv_shipment.
"Destination destination_rtl_loc_id
RetailLocation
Id"
24. Destination String 254 Name of the recipient of this

Name shipment.
Name" destination_name

inv_shipment_address.shipment_seq
25. Destination Type String 30 Type of recipient for a

shipment. The following
"Destination
values are fixed:
Type"
PARTY
RETAIL_LOCATION
SERVICE_LOCATION
inv_shipment.
destination_type
26. Destination String 60 Location ID of the recipient for

Service Location a shipment.
ID
inv_shipment.
"Destination destination_service_loc_id
ServiceLocation
Id"

Name Comment
27. Apartment String 30 Apartment field of the

recipient's address.
"Apartment"
apartment
28. City String 254 City of the recipient.

"City" inv_shipment_address.
city
29. State String 20 State or province of the

recipient.
"State"
state
30. Postal Code String 20 Postal code of the recipient.

"PostalCode" inv_shipment_address.
postal_code
31. Country String 254 Country of the recipient.

"Country" inv_shipment_address.
country
32. Telephone 1 String 32 First telephone number of the

recipient.
"Telephone1"
telephone1
33. Telephone 2 String 32 Second telephone number of

the recipient.
"Telephone2"
telephone2
34. Telephone 3 String 32 Third telephone number of the

recipient.
"Telephone3"
telephone3
35. Telephone 4 String 32 Fourth telephone number of

the recipient.
"Telephone4"
telephone4
37. Control Number String 254 The unique identifier for the
packing slip; typically the
"ControlNumber
inventory control document
"
number.
control_number
Inventory 5-7
Name Comment
38. Originator String 60 The address identifier for the

Address Id point of origin for this
"Originator
AddressId" inv_invctl_document.
originator_address_id
41. Address 3 String 254 Third address line of the

recipient.
"Address3"
address3
42. Address 4 String 254 Fourth address line of the

recipient.
"Address4"
address4

the address.
"Neighborhood"
neighborhood

address.
"County"
inv_shipment_address.county

Inventory Document Property Record (INV_DOC_PROPERTY)

Contains information for interface with Xpocket.
inv_invctl_document_properties All Fields InventoryDocumentProperty
Inventory Document Property Record (INV_DOC_PROPERTY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_DOC_PROPERTY”
3. Document Type String 30  Describes the specific task that

Code (PK) this inventory document
supports. (SHIPPING,
DocumentTypeC
RECEIVING)
ode
inv_invctl_document_
properties.document_typcode
must exist.
5. Retail Location Integer  The unique identifier for a

Id (PK) specific retail store within the
organization.
RetailLocationId
properties.rtl_loc_id
6. Inventory String 60  The reference number that

Control uniquely identifies the
Document Id inventory control document.
(PK)
DocumentId properties.invctl_document_id

(PK) associated with the inventory
document. (key/value pair)
PropertyCode
8. Type String 30 The type of value stored by

this record: STRING,
Type
BIGDECIMAL, DATE,
BOOLEAN
properties.type
9. String Value String 254 Required, when the Type is

STRING.
StringValue
properties.string_value
Inventory 5-9
Inventory Document Property Record (INV_DOC_PROPERTY) (Sheet 2 of 2)
Name Comment
10. Date Value DateTime 23 Required, when the Type is

DATE.
DateValue
properties.date_value
11. Decimal Value Decimal 17, 6 Required, when the Type is

BIGDECIMAL. If BOOLEAN
DecimalValue
Type: 1=True 0=False
properties.decimal_value

Carton Record (CARTON)

Defines a carton within an inventory control document.
Dependencies:
There must be an INV_DOC record with the same Document Type, Retail Location ID,
and Document ID.
inv_carton All Fields Carton
Carton Record (CARTON) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CARTON”
3. Document Type String 30  Primary type of the document.

Code (PK)
inv_carton.
"DocumentType document_typcode
Code"
must exist.

"RetailLocationI
d"
number.
inv_carton.rtl_loc_id
6. Inventory String 60  Unique identifier of a

Document ID document.
(PK)
inv_carton.
"DocumentId" invctl_document_id
7. Carton ID (PK) String 60  Unique identifier of a carton

within the document.
"CartonId"
inv_carton.carton_id
8. Carton Status String 30  Status of the carton:

Code OPEN
CLOSED
"CartonStatus
IN_PROCESS
Code"
inv_carton.
carton_statcode
Inventory 5-11
Carton Record (CARTON) (Sheet 2 of 2)
Name Comment
9. Record Creation String 30  Code indicating how this

"RecordCreation
STORE
Type"
HOME_OFFICE
OTHER
inv_carton.
10. Control Number String 254 Unique identifier for a carton

that is recognizable to both the
"ControlNumber
shipper and the receiver.
"
inv_carton.
control_number

Inventory Document Line Item Record (INV_DOC_LINE_ITEM)

Contains information about the inventory items in an inventory document.
Dependencies:
There must be an INV_DOC record with the same Document Type, Retail Location ID,
and Document ID.
inv_invctl_document_lineitm All Fields InventoryDocumentLineItem
Inventory Document Line Item Record (INV_DOC_LINE_ITEM) (Sheet 1 of 4)
Name Comment

Record”.
2. Record Identifier String 30  “INV_DOC_LINE_ITEM”

values are fixed:
"DocumentType
Code"
SHIPPING
RECEIVING
INVENTORY_COUNT
lineitm.document_typcode
must exist.
5. Carton ID String 60 Unique identifier of carton

within document.
“CartonId”
lineitm.carton_id

"RetailLocationI
d"
number.
lineitm.rtl_loc_id
7. Document ID String 60  Reference number that

"DocumentId"
lineitm.invctl_document_id
Inventory 5-13
Name Comment
8. Inventory Integer  Line number within the

Document Line document.
Number (PK)
"InventoryDocu lineitm.invctl_document_line_
mentLineNumbe nbr
r"
9. Status Code String 30  Status of the line item. The

"StatusCode"
PICKED
OPEN
CLOSED
DELIVERED
lineitm.status_code
10. Inventory Item String 60  Unique identifier of the item

ID referred to by this line.
"InventoryItem inv_invctl_document_
Id" lineitm.inventory_item_id
11. Expected Count Decimal 14, 4 Quantity of item that is

expected on the document.
"ExpectedCount"
lineitm.expected_count
12. Unit Count Decimal 14, 4 Actual quantity of items that

has been counted.
"UnitCount"
lineitm.unit_count
must exist.
must exist.
must exist.
16. Original Bucket String 60 Inventory transfers, the

ID original inventory location.
"OriginalBucketI inv_invctl_document_
d" lineitm.original_bucket_id
must exist.

Name Comment
18. Record Creation String 30  Code indicating how this

"RecordCreation
Type" STORE
HOME_OFFICE
OTHER
lineitm.record_creation_type
19. Line Item Type String 30 A code denoting the type of

Code item for the original sale/
return line item. (For example,
"LineItemType
ITEM, SEND_ITEM)
Code"
lineitm.lineitm_typcode
20. Original String 60 Used in the physical counting

Location Id process and identifies the
original item location.
"Original
LocationId" inv_invctl_document_
lineitm.original_loc_id
21. Posted Count Decimal 14, 4 The quantity posted to

inventory.
"PostedCount"
lineitm.posted_count
22. Retail Decimal 17, 6 The retail price of the item.

"Retail" inv_invctl_document_
lineitm.retail
23. Serial Number String 254 A unique code that can be

alpha, numeric, or alpha-
"SerialNumber"
numeric. Used as an identifier.
lineitm.serial_number
24. Model Number String 254 The number assigned to the

item by the manufacturer.
"ModelNumber"
lineitm.model_nbr
25. Control Number String 254 A value that can be used to tag
a document line item.
"ControlNumber
" inv_invctl_document_
lineitm.control_number
26. Unit Cost Decimal 17, 6 For Stock Valuation; the item
unit cost.
"UnitCost"
lineitm.unit_cost
Inventory 5-15
Name Comment
27. Posted Cost Decimal 17, 6 For Stock Valuation; the

posted cost of the item.
"PostedCost"
lineitm.posted_cost

Inventory Valid Destination Record (INV_VALID_DESTINATIONS)
Inventory Valid Destination Record

(INV_VALID_DESTINATIONS)
Contains information for the valid destinations for shipping activities.
Dependencies:
There must be a RETAIL_LOCATION record for each Retail Location ID specified in this
file.
(Note that Destination ID is also generally a valid Retail Location ID.)
inv_valid_destinations All Fields InventoryValidDestinations
Inventory Valid Destination Record (INV_VALID_DESTINATIONS) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_VALID_DESTINATION

S”

values are fixed:
"DocumentType
Code"
SHIPPING
RECEIVING
inv_valid_destinations.
document_typcode
4. Document String 30  Describes the specific type of

(PK) type. The following values are
fixed:
"Document
SubtypeCode" STORE_TRANSFER
DEFECTIVE_RETURN
REPAIR
RETURN_TO_VENDOR
CALL_BACK
SALE
WORK_ORDER
ASN
SUPPLY_COUNT
PHYSICAL_COUNT
CYCLE_COUNT
SPECIAL_ORDER
document_subtypcode
Inventory 5-17
Inventory Valid Destination Record (INV_VALID_DESTINATIONS)
Inventory Valid Destination Record (INV_VALID_DESTINATIONS) (Sheet 2 of 2)
Name Comment

"RetailLocationI
d"
number.
rtl_loc_id
6. Destination Type String 30  Mapping for the activity types.

Enum (PK) The following values are fixed:
"Destination PARTY
TypeEnum" RETAIL_LOCATION
SERVICE_LOCATION
destination_type_enum
7. Destination ID String 60  Unique identifier for a

(PK) destination.
"DestinationId" (Usually a valid Retail
Location ID.)
destination_id
8. Description String 254 Description of the valid

destination.
"Description"
description
9. Sort Order Integer Indicates the order in which

valid destinations are
"SortOrder"
sort_order

Inventory Valid Destinations Property (INV_VALID_DESTINATIONS_PROPERTY)
Inventory Valid Destinations Property

(INV_VALID_DESTINATIONS_PROPERTY)
Contains the property information for the valid shipping destinations.
inv_valid_destinations_p All Fields InventoryValid

DestinationsProperty
Inventory Valid Destinations Property Record (INV_VALID_DESTINATIONS_PROPERTY) (Sheet

1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_VALID_

DESTINATIONS_
PROPERTY”
3. Retail Location Integer  Retail location identifier.

Id (PK)
inv_valid_destinations_p.
“RetailLocation rtl_loc_id
Id”
4. Document Type String 30  Type code for the document..

Code (PK)
“DocumentType document_typcode
Code”
5. Document String 30  Subtype code for the

Subtype Code document.
(PK)
“Document document_subtypcode
SubtypeCode”
6. Destination Type String 30  Type of destination.

(PK)
“Destination destination_type_enum
TypeEnum”
7. Destination ID String 60  ID of the destination.

(PK)
“DestinationId” destination_id

“PropertyCode”
property_code
Inventory 5-19
Inventory Valid Destinations Property (INV_VALID_DESTINATIONS_PROPERTY)
Inventory Valid Destinations Property Record (INV_VALID_DESTINATIONS_PROPERTY) (Sheet

2 of 2)
Name Comment

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
type

Type=STRING
“StringValue”
string_value

Type=DATE
“DateValue”
date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
decimal_value

Inventory Bucket Record (INVENTORY_BUCKET)

Provides download support for the valid inventory buckets for a given store.
inv_bucket All Fields InventoryBucket
Inventory Bucket Record (INVENTORY_BUCKET) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INVENTORY_BUCKET”

organization.
"retailLocationId
" inv_bucket.rtl_loc_id
4. Bucket Id (PK) String 60  Values include: ON_HAND,

LAYAWAY, SPECIAL_ORDER,
"bucketId"
WORK_ORDER,
AT_VENDOR, SOLD,
SHIPPED
inv_bucket.bucket_id
5. Name String 254 A text description for the

bucket.
"name"
inv_bucket.name
6. Function Code String 30 A code that describes the

business activities and
"functionCode"
functions performed in a
specific bucket.
inv_bucket.function_code
Inventory 5-21
Inventory Bucket Record (INVENTORY_BUCKET) (Sheet 2 of 2)
Name Comment
7. Adjustment String 30 A code for the type of

Action inventory adjustment made
for the bucket.
"adjustment
Action" inv_bucket.
adjustment_action
8. Default Location String 60 Used when there is no “sold”

Id bucket location associated
with the “on hand” bucket
"default
location from which an item
LocationId"
was sold.
inv_bucket.
default_location_id
9. System Bucket Boolean 5 Indicates whether or not this

Flag bucket was created by the
home office. If true, this
"systemBucket"
bucket was created by the
home office.
inv_bucket.
system_bucket_flag

Inventory Bucket Property (INVENTORY_BUCKET_PROPERTY)
Inventory Bucket Property

(INVENTORY_BUCKET_PROPERTY)
Contains the property information inventory buckets.
inv_bucket_p All Fields InventoryBucket

Property
Inventory Bucket Property Record (INVENTORY_BUCKET_PROPERTY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INVENTORY_BUCKET_

PROPERTY”

Id (PK)
inv_bucket_p.
Id”
4. Bucket ID (PK) String 60  Identifies the bucket.

“BucketId” inv_bucket_p.
bucket_id

inv_bucket.
“PropertyCode”
inv_bucket_p.
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
inv_bucket_p.
type

Type=STRING
“StringValue”
inv_bucket_p.
string_value

Type=DATE
“DateValue”
inv_bucket_p.
date_value
Inventory 5-23
Inventory Bucket Property (INVENTORY_BUCKET_PROPERTY)
Inventory Bucket Property Record (INVENTORY_BUCKET_PROPERTY) (Sheet 2 of 2)
Name Comment

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
inv_bucket_p.
decimal_value

Inventory Count Record (INV_COUNT)

Contains summary information for the inventory count.
inv_count All Fields InventoryCount
Name Comment

Record”.
2. Record Identifier String 30  “INV_COUNT”

organization.
"retailLocationId
" inv_count.rtl_loc_id
4. Inventory Count String 60  The sequence-based, auto-

Id (PK) generated identifier for the
inventory count.
"inventoryCount
Id" inv_count.inv_count_id
5. Inventory Count String 60  The type of inventory count.

Type Code (PK) CYCLE_COUNT,
SUPPLY_COUNT,
"typeCode"
PHYSICAL_COUNT.
inv_count.
inv_count_typcode
6. Begin Date DateTime 23 The date the count is

supposed to take place.
"beginDate"
inv_count.begin_date
<Field literal="0" name="storeCreated" />

inv_count.store_created_flag
<Field literal="NEW" name="countStatus" />
inv_count.count_status
7. Description String 254 A description for the count.

"description" inv_count.description
Inventory 5-25
Inventory Count Bucket Record (INV_COUNT_BUCKET)

Contains the count status summary information for each bucket in an inventory count.
inv_count_bucket All Fields InventoryCountBucket
Name Comment

Record”.
2. Record Identifier String 30  “INV_COUNT_BUCKET”

organization.
"retailLocationId
" inv_count_bucket.
rtl_loc_id

inventory count.
"inventoryCount
Id" inv_count_bucket.
inv_count_id
must exist.
6. Inventory Bucket String 60  The unique identifier for an

Id (PK) inventory bucket: ON_HAND,
"inventory
WORK_ORDER,
BucketId"
AT_VENDOR, SOLD,
SHIPPED.
inv_count_bucket.
inv_bucket_id
7. Inventory Bucket String 60 A text description for the

Name bucket.
"inventory inv_count_bucket.
BucketName" inv_bucket_name
<Field literal="1" name="countCycle" />

inv_count_bucket.count_cycle
<Field literal="PRELIMINARY" name="bucketStatus" />

inv_count_bucket.bucket_status

Inventory Count Sheet Record (INV_COUNT_SHEET)

Categorizes the items for the count.
inv_count_sheet All Fields InventoryCountSheet
Inventory Count Sheet Record (INV_COUNT_SHEET) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_COUNT_SHEET”

organization.
"retailLocationId
" inv_count_sheet.
rtl_loc_id

inventory count.
"inventoryCount
Id" inv_count_sheet.
inv_count_id
must exist.
6. Count Sheet Integer  An incremental number to

Number (PK) keep the count sheet record
unique.
"countSheet
Number" inv_count_sheet.
count_sheet_nbr
7. Inventory Bucket String 60 The unique identifier for an

Id inventory bucket: ON_HAND,
"inventory
WORK_ORDER,
BucketId"
AT_VENDOR, SOLD,
SHIPPED.
inv_count_sheet.
inv_bucket_id
8. Section Number Integer The section number.

"sectionNumber" inv_count_sheet.
section_nbr
9. Section Id String 60 The identifier for the area

within the store layout to
"sectionId"
which the item belongs.
inv_count_sheet.
section_id
Inventory 5-27
Inventory Count Sheet Record (INV_COUNT_SHEET) (Sheet 2 of 2)
Name Comment
10. Inventory Bucket String 60 A text description for the

Name bucket containing the items on
this sheet.
"inventory
BucketName" inv_count_sheet.
inv_bucket_name

inv_count_sheet.count_cycle
<Field literal="PRELIMINARY" name="sheetStatus" />

inv_count_sheet.sheet_status

Inventory Count Sheet Property (INV_COUNT_SHEET_PROPERTY)
Inventory Count Sheet Property

(INV_COUNT_SHEET_PROPERTY)
Contains the property information for inventory count sheets.
inv_count_sheet_p All Fields InventoryCountSheet

Property
Inventory Count Sheet Property Record (INV_COUNT_SHEET_PROPERTY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_COUNT_SHEET_

PROPERTY”

Id (PK)
inv_count_sheet_p.rtl_loc_id
“RetailLocation
Id”
4. Inventory Count String 60  Identifies the inventory count.

ID (PK)
inv_count_sheet_p.
“InventoryCount inv_count_id
Id”
5. Count Sheet Integer  Identifies the count sheet.

Number (PK)
inv_count_sheet_p.
“CountSheet count_sheet_nbr
Number”

inv_count_sheet.
“PropertyCode”
inv_count_sheet_p.
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
inv_count_sheet_p.type

Type=STRING
“StringValue”
inv_count_sheet_p.
string_value

Type=DATE
“DateValue”
inv_count_sheet_p.date_value
Inventory 5-29
Inventory Count Sheet Property (INV_COUNT_SHEET_PROPERTY)
Inventory Count Sheet Property Record (INV_COUNT_SHEET_PROPERTY) (Sheet 2 of 2)
Name Comment

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
inv_count_sheet_p.
decimal_value

Inventory Count Sheet Line Item Record (INV_COUNT_SHEET_LINEITEM)
Inventory Count Sheet Line Item Record

(INV_COUNT_SHEET_LINEITEM)
Contains the information about the items being counted.
inv_count_sheet_lineitm All Fields InventoryCountSheetLineItem
Inventory Count Sheet Line Item Record (INV_COUNT_SHEET_LINEITEM) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_COUNT_SHEET

_LINEITEM”

organization.
"retailLocationId
" inv_count_sheet_lineitm.
rtl_loc_id

inventory count.
"inventoryCount
Id" inv_count_sheet_lineitm.
inv_count_id
must exist.
6. Count Sheet Integer  The incremental number used

Number (PK) to keep the count sheet record
unique.
"countSheet
Number" inv_count_sheet_lineitm.
count_sheet_nbr
7. Line Item Integer  The incremental number used

Number (PK) to keep the line item record
ordered and unique.
"lineItem
Number" inv_count_sheet_lineitm.
lineitm_nbr
8. Inventory Bucket String 60 The unique identifier for an

Id inventory bucket: ON_HAND,
"inventory
WORK_ORDER,
BucketId"
AT_VENDOR, SOLD,
SHIPPED.
inv_count_sheet_lineitm.
inv_bucket_id
Inventory 5-31
Inventory Count Sheet Line Item Record (INV_COUNT_SHEET_LINEITEM)
Inventory Count Sheet Line Item Record (INV_COUNT_SHEET_LINEITEM) (Sheet 2 of 2)
Name Comment
9. Page Number Integer The count sheet page where

this item appears.
"pageNumber"
page_nbr
10. Item Id String 60 The item identifier.

"itemId" inv_count_sheet_lineitm.
item_id
11. Alternate Id String 60 The parent item identifier, if

applicable.
"alternateId"
alternate_id
12. Description String 254 The item description.

"description" inv_count_sheet_lineitm.
description

inv_count_sheet_lineitm.count_cycle

Inventory Count Sheet Line Item Property (INV_COUNT_SHEET_LINEITEM_PROPERTY)
Inventory Count Sheet Line Item Property

(INV_COUNT_SHEET_LINEITEM_PROPERTY)
Contains the property information for line items in inventory count sheets.
inv_count_sheet_lineitm_p All Fields InventoryCountSheet

LineItemProperty
Inventory Count Sheet Line Item Property Record (INV_COUNT_SHEET_LINEITEM_PROPERTY)

(Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_COUNT_SHEET_

LINEITEM_PROPERTY”

Id (PK)
inv_count_sheet_lineitm_p.
Id”
4. Inventory Count String 60  Identifies the inventory count.

ID (PK)
“InventoryCount inv_count_id
Id”
5. Count Sheet Integer  Identifies the count sheet.

Number (PK)
“CountSheet count_sheet_nbr
Number”
6. Line Item Integer  Line number of the item.

Number (PK)
“LineItem lineitm_nbr
Number”

“PropertyCode”
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
type
Inventory 5-33
Inventory Count Sheet Line Item Property (INV_COUNT_SHEET_LINEITEM_PROPERTY)
Inventory Count Sheet Line Item Property Record (INV_COUNT_SHEET_LINEITEM_PROPERTY)

(Sheet 2 of 2)
Name Comment

Type=STRING
“StringValue”
string_value

Type=DATE
“DateValue”
date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
decimal_value

Inventory Document Line Serial Record (INV_DOC_LINE_SERIAL)
Inventory Document Line Serial Record

(INV_DOC_LINE_SERIAL)
Contains information about serialized items pertaining to the inventory control
document.
inv_invctl_doc_lineserial All Fields InventoryDocumentLineSerial
Inventory Document Line Serial Record (INV_DOC_LINE_SERIAL) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_DOC_LINE_SERIAL”

organization.
"retailLocationId
" inv_invctl_doc_lineserial.
rtl_loc_id

"documentType
RECEIVING, ADJUSTMENT,
Code"
SALE)
inv_invctl_doc_lineserial.
document_typcode
5. Document Id String 60  The reference number that

"documentId"
invctl_document_id
6. Inventory Integer  The inventory control

Document Line document line number
Number (PK) specifies the line number
within the inventory control
"InventoryDocu
document.
mentLineNumbe
r" inv_invctl_doc_lineserial.
invctl_document_line_nbr
7. Serial Line Integer  The line number of the serial

Number (PK) number within the inventory
control document.
"serialLine
Number" inv_invctl_doc_lineserial.
serial_line_nbr
Inventory 5-35
Inventory Document Line Serial Record (INV_DOC_LINE_SERIAL)
Inventory Document Line Serial Record (INV_DOC_LINE_SERIAL) (Sheet 2 of 2)
Name Comment
8. Serial Number String 254 A unique code that can be

alpha, numeric, or alpha-
"serialNumber"
numeric. Used as an identifier.
serial_nbr

Inventory Document Shipment Carton Record (INV_DOC_SHIPMENT_CARTON)
Inventory Document Shipment Carton Record

(INV_DOC_SHIPMENT_CARTON)
Contains carton information for an inventory shipment.
inv_shipment_cartons All Fields ShipmentCarton
Inventory Document Shipment Carton Record (INV_DOC_SHIPMENT_CARTON) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_DOC_SHIPMENT

_CARTON”

organization.
"retailLocationId
" inv_shipment_cartons.
rtl_loc_id

supports.
"documentType
Code" inv_shipment_cartons.
document_typcode

"documentId"
inv_shipment_cartons.
invctl_document_id
6. Shipment Integer  The sequence number within

Sequence (PK) the table to keep the shipment
record ordered and unique.
"shipment
Sequence" inv_shipment_cartons.
shipment_seq
7. Carton Id (PK) String 60  The carton identifier.

"cartonId" inv_shipment_cartons.
carton_id
8. Control Number String 254 The unique identifier for the

carton shipment, typically the
"controlNumber"
inventory control document
number.
control_number
Inventory 5-37
Inventory Document Shipment Carton Record (INV_DOC_SHIPMENT_CARTON)
Inventory Document Shipment Carton Record (INV_DOC_SHIPMENT_CARTON) (Sheet 2 of 2)
Name Comment
9. Tracking String 254 Tracking number assigned by

Number the carrier used to track the
"tracking
the carrier.
Number"
tracking_number
10. Status Code String 30 The current status of the

carton shipment.
"statusCode"
status_code

Inventory Document Shipment Line Item Record (INV_DOC_SHIPMENT_LINEITEM)
Inventory Document Shipment Line Item Record

(INV_DOC_SHIPMENT_LINEITEM)
Contains information linking inventory control document line numbers to an inventory
control document.
inv_shipment_lines All Fields ShipmentLineItem
Inventory Document Shipment Line Item Record (INV_DOC_SHIPMENT_LINEITEM) (Sheet 1 of

2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_DOC_SHIPMENT

_LINEITEM”

organization.
"retailLocationId
" inv_shipment_lines.
rtl_loc_id

supports.
"documentType
Code" inv_shipment_lines.
document_typcode

"documentId"
inv_shipment_lines.
invctl_document_id
6. Shipment Integer  The sequence number within

Sequence (PK) the table to keep the shipment
"shipment
Sequence" inv_shipment_lines.
shipment_seq
7. Line Item Integer  The sequence number within

Sequence (PK) the table to keep the line item
"lineItem
Sequence" inv_shipment_lines.
lineitm_seq
Inventory 5-39
Inventory Document Shipment Line Item Record (INV_DOC_SHIPMENT_LINEITEM)
Inventory Document Shipment Line Item Record (INV_DOC_SHIPMENT_LINEITEM) (Sheet 2 of

2)
Name Comment
8. Inventory Integer  The inventory document line

Document Line number specifies the line
Number number within the inventory
document.
"InventoryDocu
mentLineNumbe inv_shipment_lines.
r" invctl_document_line_nbr
9. Ship Quantity Decimal 11,4 The shipment quantity.

"shipQuantity" inv_shipment_lines.
ship_qty
10. Carton Id String 60 The carton identifier.

"cartonId" inv_shipment_lines.
carton_id
11. Status Code String 30 The current status of the

shipment.
"statusCode"
inv_shipment_lines.
status_code


(INV_DOC_SHIPMENT_LINEITEM_PROPERTY)
Contains the property information for line items within a shipment.
inv_shipment_lines_p All Fields ShipmentLineItem

Property
Inventory Document Shipment Line Item Record Property Record

(INV_DOC_SHIPMENT_LINEITEM_PROPERTY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_DOC_SHIPMENT_

LINEITEM_PROPERTY”

Id (PK)
inv_shipment_lines_p.
Id”
4. Document ID String 60  Identifies the document.

(PK)
“DocumentId” invctl_document_id
5. Document Type String 30  Identifies the type of shipping

Code (PK) document.
“DocumentType inv_shipment_lines_p.
Code” document_typcode
6. Shipment Integer  Sequence number foro the

Sequence (PK) shipment.
“Shipment inv_shipment_lines_p.
Sequence” shipment_seq
7. Line Item Integer  Sequence number for the line

Sequence (PK) item.
“LineItem inv_shipment_lines_p.
Sequence” lineitm_seq

inv_shipment.
“PropertyCode”
property_code
Inventory 5-41
Inventory Document Shipment Line Item Record Property Record

(INV_DOC_SHIPMENT_LINEITEM_PROPERTY) (Sheet 2 of 2)
Name Comment

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
type

Type=STRING
“StringValue”
string_value

Type=DATE
“DateValue”
date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
decimal_value

Inventory Item Account Modifier Record

(INV_ITEM_ACCOUNT_MODIFIER)
Contains information about a customer account and the associated inventory control
document.
inv_item_acct_mod All Fields InventoryItemAccountModifier
Inventory Item Account Modifier Record (INV_ITEM_ACCOUNT_MODIFIER) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_ITEM_ACCOUNT_

MODIFIER”

organization.
"retailLocationId
" inv_item_acct_mod.
rtl_loc_id

supports.
"documentType
Code" inv_item_acct_mod.
document_typcode

"documentId"
inv_item_acct_mod.
invctl_document_id
6. Inventory Integer  The inventory document line

Document Line number that specifies the line
Number number within the inventory
document.
"InventoryDocu
mentLineNumbe inv_item_acct_mod.
r" invctl_document_line_nbr
7. Customer String 30  An identifier for a type of

Account Code customer account. Valid
Values: LAYAWAY, LOYALTY,
"customer
SEND_SALE,
AccountCode"
SPECIAL_ORDER,
WORK_ORDER
inv_item_acct_mod.
cust_acct_code
Inventory 5-43
Inventory Item Account Modifier Record (INV_ITEM_ACCOUNT_MODIFIER) (Sheet 2 of 2)
Name Comment
8. Customer String 60  A unique identifier for a

Account Id customer account. Must be
unique within the Customer
"customer
Account Code.
AccountId"
inv_item_acct_mod.
cust_acct_id

Inventory Location Record (INV_LOCATION)

Contains information about a floor and an area on a floor inside a retail store that is
explicitly identified for tracking inventory, sales activity and other business activities
that are important to measuring a store’s performance.
inv_location All Fields InventoryLocation
Name Comment

Record”.
2. Record Identifier String 30  “INV_LOCATION”

organization.
"retailLocationId
" inv_location.rtl_loc_id
4. Inventory String 60  A unique identifier for a

Location Id (PK) specific inventory location
within the retail enterprise.
"locationId"
inv_location.
inv_location_id
5. Name String 254 The name designated to

identify the location. For
"name"
example, Send Sale items
being held for shipping area.
inv_location.name
6. Active Flag Boolean 5 Indicates whether or not this

location will appear in the list
"active"
of available locations when
selling, shipping, or
transferring an item. If true,
this inventory location will be
available.
inv_location.active_flag
7. System Location Boolean 5 Indicates whether or not this

Flag bucket was created by the
home office. If true, this
"system
inventory location cannot be
Location"
edited.
inv_location.
system_location_flag
Inventory 5-45
Inventory Location Property (INV_LOCATION_PROPERTY)

Contains the property information inventory locations.
inv_location_p All Fields InventoryLocation

Property
Inventory Location Property Record (INV_LOCATION_PROPERTY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_LOCATION_

PROPERTY”

Id (PK)
inv_location_p.
Id”
4. Location ID (PK) String 60  Identifies the inventory

location.
“LocationId”
inv_location_p.
inv_location_id

inv_location.
“PropertyCode”
inv_location_p.
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
inv_location_p.
type

Type=STRING
“StringValue”
inv_location_p.
string_value

Type=DATE
“DateValue”
inv_location_p.
date_value

Inventory Location Property Record (INV_LOCATION_PROPERTY) (Sheet 2 of 2)
Name Comment

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
inv_location_p.
decimal_value
Inventory 5-47
Inventory Location Availability Record (INV_LOCATION_AVAILABILITY)
Inventory Location Availability Record

(INV_LOCATION_AVAILABILITY)
Contains information about the inventory locations available for different functions,
providing the ability to limit access to locations based on functions such as item transfer
and returns.
inv_location_availability All Fields InventoryLocationAvailability
Inventory Location Availability Record (INV_LOCATION_AVAILABILITY)
Name Comment

Record”.

AVAILABILITY”

organization.
"retailLocationId
" inv_location_availability.
rtl_loc_id
4. Location Id (PK) String 60  A unique identifier for a

specific inventory location
"locationId"
inv_location_availability.
location_id
5. Availability String 30  Code representing the

Code (PK) scenario in which this location
is an available source from
"availability
which to move an item.
Code"
(e.g. RETURN,
TRANSFER_FROM, etc.)
availability_code
6. Privilege Type String 30 Privilege required for being

able to use this location for
"privilegeType"
this code. A null value
indicates that the location may
always be used.
privilege_type

Inventory Location Bucket Record (INV_LOCATION_BUCKET)

Contains information associating an inventory bucket to an inventory location. This
supports the ability to specify buckets to be added to a location when a location is
created.
inv_location_bucket All Fields InventoryLocationBucket
Name Comment

Record”.
2. Record Identifier String 30  “INV_LOCATION_BUCKET”

organization.
"retailLocationId
" inv_location_bucket.
rtl_loc_id
4. Location Id (PK) String 60  A unique identifier for a

specific inventory location
"locationId"
inv_location_bucket.
location_id
5. Bucket Id (PK) String 60  The identifier for an inventory

item classification. (From the
"bucketId"
inv_bucket table.)
bucket_id
6. Tracking Method String 30 Indicates the type of items that

are tracked in this bucket;
"tracking
either ALL, NONE, or
Method"
SERIALIZED.
tracking_method
Inventory 5-49
Inventory Location Bucket Property (INV_LOCATION_BUCKET_PROPERTY)
Inventory Location Bucket Property

(INV_LOCATION_BUCKET_PROPERTY)
Contains the property information inventory buckets.
inv_location_bucket_p All Fields InventoryLocation

BucketProperty
Inventory Location Bucket Property Record (INV_LOCATION_BUCKET_PROPERTY) (Sheet 1 of

2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_LOCATION_BUCKET_

PROPERTY”

Id (PK)
inv_location_bucket_p.
Id”
4. Location ID (PK) String 60  Identifies the inventory

location.
“LocationId”
inv_location_id
5. Bucket ID (PK) String 60  Identifies the inventory

location.
“BucketId”
bucket_id

“PropertyCode”
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
type

Type=STRING
“StringValue”
string_value

Inventory Location Bucket Property (INV_LOCATION_BUCKET_PROPERTY)
Inventory Location Bucket Property Record (INV_LOCATION_BUCKET_PROPERTY) (Sheet 2 of

2)
Name Comment

Type=DATE
“DateValue”
date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
decimal_value
Inventory 5-51
Inventory Location Modifier Record (INV_LOCATION_MODIFIER)
Inventory Location Modifier Record

(INV_LOCATION_MODIFIER)
Contains the information required to process all of the details related to inventory
movement during inventory functions. This supports inventory location modifiers for
each line item on a transaction for Document-based functions such as Shipping,
Receiving, and Inventory Adjustment. This information is used to build the inventory
ledger and inventory journal. There are two tables that hold this information; one for
retail transactions (trl_inventory_loc_mod) and one for inventory processes
(inv_inventory_loc_mod).
inv_inventory_loc_mod All Fields DocumentInventoryLocationModifier
Inventory Location Modifier Record (INV_LOCATION_MODIFIER) (Sheet 1 of 2)
Name Comment

Record”.

MODIFIER”

organization.
"retailLocationId
" inv_inventory_loc_mod.
rtl_loc_id

supports.
"documentType
Code" inv_inventory_loc_mod.
document_typcode

"documentId"
inv_inventory_loc_mod.
document_id
6. Document Line Integer  Document line number

Number (PK) identifier from the parent line
item.
“documentLine
Number” inv_inventory_loc_mod.
document_line_nbr
7. Modifier Integer  Numeric identifier to make

Sequence (PK) this modifier unique.
"modifier inv_inventory_loc_mod.
Sequence" mod_seq

Inventory Location Modifier Record (INV_LOCATION_MODIFIER)
Inventory Location Modifier Record (INV_LOCATION_MODIFIER) (Sheet 2 of 2)
Name Comment
8. Serial Number String 254 Serial number for the parent

item of this modifier.
"serialNumber"
serial_nbr
9. Source Location String 60 Inventory location id from

Id which the parent item was
sold, put on layaway, etc.
"sourceLocationI
d" inv_inventory_loc_mod.
source_location_id
10. Source Bucket Id String 60 Inventory bucket id from

which the parent item was
"sourceBucket
sold. For outgoing inventory,
Id"
this should always be
ON_HAND.
source_bucket_id
11. Destination String 60 Inventory location id to which

Location Id the parent item is moving.
"destination inv_inventory_loc_mod.
LocationId" dest_location_id
12. Destination String 60 Inventory bucket id to which

Bucket Id the parent item is moving.
When the item leaves the
"destination
store, this will always be
BucketId"
SHIPPED.
dest_bucket_id
13. Quantity Decimal 11,4 The quantity of the parent

item that will be moved in
"quantity"
accordance with this modifier.
quantity
14. Action Code String 30 The action taken that caused

this modifier to be created.
"actionCode"
This will typically correspond
to the inventory document
type.
action_code
Inventory 5-53
Inventory Serialized Stock Ledger Record

(INV_SERIALIZED_STOCK_LEDGER)
Contains a record of a location inside a store where a serialized stock item is stored or
displayed for sale, and for which a serialized stock item stock on hand count and dollar
value is maintained.
inv_serialized_stock_ledger All Fields SerializedStockLedger
Name Comment

Record”.
2. Record Identifier String 30  “INV_SERIALIZED_STOCK_

LEDGER”

organization.
"retailLocationId
" inv_serialized_stock_ledger.
rtl_loc_id
4. Inventory String 60  A unique identifier for a

Location Id (PK) specific inventory location
"invLocationId"
inv_serialized_stock_ledger.
inv_location_id
5. Bucket Id (PK) String 60  The identifier for an inventory

item classification. (From the
"bucketId"
inv_bucket table.)
bucket_id
6. Item Id (PK) String 60  An identifier that uniquely

identifies an item.
"itemId"
item_id
7. Serial Number String 254  A unique code that can be

(PK) alpha, numeric, or alpha-
numeric, used as an identifier.
"serialNumber"
serial_nbr

Document Note Record (DOCUMENT_NOTE)

Contains information about notes/comments pertaining to the inventory control
document.
inv_document_notes All Fields DocumentNote
Document Note Record (DOCUMENT_NOTE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “DOCUMENT_NOTE”

organization.
"retailLocationId
" inv_document_notes.
rtl_loc_id

Code this inventory document
"documentType
RECEIVING, ADJUSTMENT,
Code"
SALE)
inv_document_notes.
document_typcode

"documentId"
inv_document_notes.
invctl_document_id
6. Note Id (PK) BigInt  The identifier for a note within

a document.
"noteId"
inv_document_notes.
note_id
7. Note Date DateTime 23 The date and time the note

Timestamp was created.
"note inv_document_notes.
Datetimestamp" note_timestamp

"note" inv_document_notes.
note_text
Inventory 5-55
Document Note Record (DOCUMENT_NOTE) (Sheet 2 of 2)
Name Comment
9. Creator Party Id BigInt The party identifier of the

person who created the note.
"creatorParty
Id" inv_document_notes.
creator_party_id

Inventory Shipper Record (INV_SHIPPER)

Contains Shipper information.
inv_shipper All Fields Shipper
Name Comment

Record”.
2. Record Identifier String 30  “INV_SHIPPER”
3. Shipper Id (PK) String 60  The shipper identifier.

"shipperId" inv_shipper.shipper_id
4. Shipper Desc String 254 The shipper description.

"shipperDesc" inv_shipper.
shipper_desc
5. Display Order Integer The shipper display order.

"displayOrder" inv_shipper.
display_order
6. Tracking Boolean 5 Determines whether or not

Number Enabled tracking number functionality
Flag is used.
"trackingNumbe inv_shipper.
rEnabled" tracking_number_flag

code.
"OrgCode"
default="*"
inv_shipper.org_code

"OrgValue"
default="*"
inv_shipper.org_value
Inventory 5-57
Inventory Shipper Method Record (INV_SHIPPER_METHOD)

Contains Shipper Method information.
inv_shipper_method All Fields ShipperMethod
Inventory Shipper Method Record (INV_SHIPPER_METHOD) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_SHIPPER_METHOD”
3. Shipper Method String 60  The shipper method identifier.

Id (PK)
inv_shipper_method.
"shipperMethodI shipper_method_id
d"
4. Shipper Method String 254 The shipper method

Description description.
"shipperMethod inv_shipper_method.
Desc" shipper_method_desc
5. Shipper Id String 60 The shipper identifier.

"shipperId" inv_shipper_method.
shipper_id
6. Domestic Service String 60 The domestic service code.

Code
inv_shipper_method.
""domesticServic domestic_service_code
eCode""
7. International String 60 The international service code.

Service Code
inv_shipper_method.
"intlServiceCode intl_service_code
"
8. Display Order Integer The display order.

"displayOrder" inv_shipper_method.
display_order

code.
"OrgCode"
default="*"
inv_shipper_method.
org_code

Inventory Shipper Method Record (INV_SHIPPER_METHOD) (Sheet 2 of 2)
Name Comment

"OrgValue"
default="*"
inv_shipper_method.
org_value
11. priority Integer Used to set a priority for the

distributed orders - Delivery
"priority"
Orders queue for faster
picking and processing.
inv_shipper_method.
priority
Inventory 5-59
Inventory Document In Record (INV_DOC_IN)

Contains Inventory Document information for replenishment orders.
inv_invctl_document All Fields InventoryDocument
Inventory Document In Record (INV_DOC_IN) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_DOC_IN”

organization.
"RetailLocationI
d" inv_invctl_document.
rtl_loc_id

Code (PK) the document.
"DocumentType inv_invctl_document.
Code" document_typcode
5. Document Id String 60  Reference number that

"DocumentId"
invctl_document_id
6. Create Date DateTime 23 Date and time this document

Time was created.
"CreateDateTime inv_invctl_document.
" create_date_timestamp
7. Complete Date DateTime 23 Date and time this document

Time was marked as complete.
"CompleteDateTi inv_invctl_document.
me" complete_date_timestamp
8. Any value present in this field will be ignored, but the field must exist.
9. Status Code String 30 Current status of the

document. The following
"StatusCode"
values are fixed:
OPEN, SUBMITTED,
CONFIRMED,
ASN_RECEIVED,
PARTIAL_RECEIVING,
CLOSED, CANCELLED
status_code

Inventory Document In Record (INV_DOC_IN) (Sheet 2 of 2)
Name Comment
10. Originator Id String 60 Identifies the point of origin

for this inventory document.
"OriginatorId"
originator_id
11. Document String 30 Describes the specific type of

type.
"DocumentSubty
peCode" inv_invctl_document.
document_subtypcode
12. Originator Name String 254 Name of the originator of this

document.
"OriginatorNam
e" inv_invctl_document.
originator_name
13. Last Activity DateTime 23 Date and time of the last

Date activity on this document.
"LastActivityDat inv_invctl_document.
e" last_activity_date
14. PO Reference String 254 Reference number that

Number uniquely identifies the
Purchase Order inventory
"PoReferenceNu
control document.
mber"
po_ref_nbr

"RecordCreation
Type" STORE, HOME_OFFICE

"Description"
description
17. Control Number String 254 The inventory control

document number.
"ControlNumber
" inv_invctl_document.
control_number
18. Originator String 60 The address identifier for the

Address Id point of origin for this
"OriginatorAddr
essId" inv_invctl_document.
originator_address_id
Inventory 5-61
Inventory Replenishment Document Line Item Record (INV_REP_DOC_LINE_ITEM)
Inventory Replenishment Document Line Item Record

(INV_REP_DOC_LINE_ITEM)
Contains information about the inventory items in an inventory replenishment
document.
inv_rep_document_lineitm All Fields InventoryReplenishmentDocumentLineItem
Inventory Replenishment Document Line Item Record (INV_REP_DOC_LINE_ITEM) (Sheet 1 of

3)
Name Comment

Record”.
2. Record Identifier String 30  “INV_REP_DOC_LINE_

ITEM”

ID retail store within the
organization.
"RetailLocationI
d" inv_rep_document_lineitm.
rtl_loc_id

"DocumentId"
inv_rep_document_lineitm.
invctl_document_id

"DocumentType inv_rep_document_lineitm.
6. Inventory Integer  The line number within the

Document Line inventory control document.
Number (PK)
"InventoryDocu invctl_document_line_nbr
mentLineNumbe
r"
7. Suggested Order Decimal 11,4 The suggested order quantity

Quantity for the item in the inventory
replenishment document.
"SuggestedOrder
Quantity" inv_rep_document_lineitm.
suggested_order_qty
8. Order Quantity Decimal 11,4 The actual order quantity for

the item in the inventory
"OrderQuantity"
order_quantity


3)
Name Comment
9. Confirmed Decimal 11,4 The confirmed order quantity

Quantity for the item in the inventory
"ConfirmedQuan
tity" inv_rep_document_lineitm.
confirmed_quantity
10. Confirmation DateTime 23 The date the order quantity for

Date the item in the inventory
replenishment document was
"ConfirmationDa
confirmed.
te"
confirmation_date
11. Confirmation String 60 The confirmation number.

Number
"ConfirmationN confirmation_number
umber"
12. Ship Via String 254 The shipper method.

"ShipVia" inv_rep_document_lineitm.
ship_via
13. Shipped Decimal 11,4 The item quantity shipped.

Quantity
"ShippedQuantit shipped_quantity
y"
14. Shipped Date DateTime 23 The date the shipment was

shipped.
"ShippedDate"
shipped_date
15. Received Decimal 11,4 The item quantity received.

Quantity
"ReceivedQuanti received_quantity
ty"
16. Received Date DateTime 23 The date the shipment was

received.
"ReceivedDate"
received_date
17. Source Type String 60 The source for the items:

"SourceType" STORE, DC, or VENDOR
source_type
18. Source Id String 60 The source identifier,

"SourceId" inv_rep_document_lineitm.
source_id
Inventory 5-63

3)
Name Comment
19. Source Name String 254 The source name.

"SourceName" inv_rep_document_lineitm.
source_name
20. Parent String 60 The parent document

Document Id identifier.
"ParentDocumen inv_rep_document_lineitm.
tId" parent_document_id

Shipment Record (SHIPMENT)

Contains information about inventory replenishment shipments (carton level).
inv_shipment 3, 5-6, 8, 14-26 Shipment
Shipment Record (SHIPMENT) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “SHIPMENT”

"DocumentType inv_shipment.

organization.
"RetailLocationI
d" inv_shipment.rtl_loc_id

"DocumentId"
inv_shipment.
invctl_document_id

inv_shipment.shipment_seq
8. Shipment Status String 30 Code for the status of the

Code shipment.
“ShipmentStatus inv_shipment.
Code” shipment_statcode

“RecordCreation
Type” STORE, HOME_OFFICE
inv_shipment.
Inventory 5-65
Name Comment
16. Expected DateTime 23 Expected delivery date of the

Delivery Date shipment.
"Expected inv_shipment.
DeliveryDate" expected_delivery_date
17. Actual Delivery DateTime 23 Actual delivery date of the

Date shipment.
"ActualDelivery inv_shipment.
Date" actual_delivery_date
18. Expected Ship DateTime 23 Date the shipment is expected

Date to ship.
"ExpectedShip inv_shipment.
Date" expected_ship_date
19. Actual Ship Date DateTime 23 Date the shipment was

actually shipped.
"ActualShip
Date" inv_shipment.
actual_ship_date
20. Shipping Carrier String 254 Identifier indicating the carrier

presenting the bill of lading
"Shipping
for transferring the item.
Carrier"
inv_shipment.
shipping_carrier
21. Tracking String 254 Tracking number, assigned by

Number the carrier, used to track the
"Tracking
the carrier.
Number"
inv_shipment.
tracking_nbr
22. Destination BigInt Party ID of the recipient of this

Party ID shipment.
PartyId" destination_party_id
23. Destination Integer Retail location ID of the

Retail Location recipient of this shipment.
ID
inv_shipment.
"Destination destination_rtl_loc_id
RetailLocation
Id"
24. Destination String 254 Name of the recipient of this

Name shipment.
Name" destination_name

Name Comment
25. Destination Type String 30 Type of recipient for this

shipment.
"Destination
Type" inv_shipment.
destination_type
26. Destination String 60 Location ID of the recipient for

Service Location this shipment.
ID
inv_shipment.
"Destination destination_service_loc_id
ServiceLocation
Id"
Inventory 5-67
Shipment Property (SHIPMENT_PROPERTY)

Contains the property information for shipments.
inv_shipment_p All Fields ShipmentProperty
Shipment Property Record (SHIPMENT_PROPERTY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “SHIPMENT_PROPERTY”

Id (PK)
inv_shipment_p.
Id”
4. Document Type String 30  Identifies the type of shipping

Code (PK) document.
“DocumentType inv_shipment_p.
Code” document_typcode
5. Shipment Integer  Sequence number foro the

Sequence (PK) shipment.
“Shipment inv_shipment_p.
Sequence” shipment_seq

inv_shipment.
“PropertyCode”
inv_shipment_p.
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
inv_shipment_p.
type

Type=STRING
“StringValue”
inv_shipment_p.
string_value

Type=DATE
“DateValue”
inv_shipment_p.
date_value

Shipment Property Record (SHIPMENT_PROPERTY) (Sheet 2 of 2)
Name Comment

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
inv_shipment_p.
decimal_value
Inventory 5-69
Inventory Cross Reference Record (INV_CROSS_REF)

Contains cross-reference information between replenishment orders and receiving
documents.
inv_cross_ref All Fields InventoryDocumentCrossReference
Inventory Cross Reference Record (INV_CROSS_REF) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_CROSS_REF”

organization.
"RetailLocationI
d" inv_cross_ref.rtl_loc_id

"DocumentId"
inv_cross_ref.
invctl_document_id

"DocumentType inv_cross_ref.
6. Inventory Integer  Line number within the

Document Line document.
Number (PK)
inv_cross_ref.
"InventoryDocu invctl_document_line_nbr
mentLineNumbe
r"
7. Cross Reference Integer Cross-reference to the Org Id.

Organization Id
inv_cross_ref.
"CrossRefOrgani cross_ref_organization_id
zationId"
8. Cross Reference String 60 Cross-reference to the

Document Id Document Id.
"CrossRefDocum inv_cross_ref.
entId" cross_ref_document_id
9. Cross Reference Integer Cross-reference to the line

Line Number number.
"CrossRefLineN inv_cross_ref.
umber" cross_ref_line_number

Inventory Cross Reference Record (INV_CROSS_REF) (Sheet 2 of 2)
Name Comment
10. Cross Reference String 30 Cross-reference to the

Document Type document type code.
Code
inv_cross_ref.
"CrossRefDocum cross_ref_document_typcode
entTypeCode"
11. Cross Reference Integer Cross-reference to the retail

Retail Location location id.
Id
inv_cross_ref.
"CrossRefRetailL cross_ref_rtl_loc_id
ocationId"
Inventory 5-71
Fiscal Year Record (FISCAL_YEAR)

Contains the company's fiscal year information: the year's start and end dates. Used to
support Stock Valuation functionality.
inv_stock_fiscal_year All Fields FiscalYear
Name Comment

Record”.
2. Record Identifier String 30  “FISCAL_YEAR”
3. Fiscal Year (PK) Integer  The fiscal year.

"FiscalYear" inv_stock_fiscal_year.
fiscal_year
4. Start Date DateTime 23 The start date of fiscal year.

“StartDate” inv_stock_fiscal_year.
start_date
5. End Date DateTime 23 The end date of fiscal year.

“EndDate” inv_stock_fiscal_year.
end_date

Inventory Cost Item Yearend Record (INV_CST_ITEM_YEAREND)
Inventory Cost Item Yearend Record

(INV_CST_ITEM_YEAREND)
Contains the end of year item quantity and cost valuation summary. This table must be
populated with data for the previous year. For new retailers with no previous years’
data, a record must be added for the previous year with quantity zero (0). This
information is required to run the Year End Rollup.
inv_cst_item_yearend All Fields InventoryCostItemYearEnd
Inventory Cost Item Yearend Record (INV_CST_ITEM_YEAREND) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “INV_CST_ITEM_YEAREND”
3. Fiscal Year (PK) Integer  The fiscal year.

"FiscalYear" inv_cst_item_yearend.
fiscal_year
4. Retail Location Integer  The retail location identifier.

Id (PK)
inv_cst_item_yearend.
“RetailLocationI rtl_loc_id
d”

“ItemId” inv_cst_item_yearend.item_id
6. WAC Quantity Decimal 14,4 The sum of item received for

Received fiscal year. (WAC)
“WACQuantityR inv_cst_item_yearend.
eceived” wac_qty_rcvd
7. WAC Value Decimal 17,6 The sum of item cost received

Received for fiscal year. (WAC)
“WACValueRece inv_cst_item_yearend.
ived” wac_value_rcvd
8. PWAC Quantity Decimal 14,4 Quantity on-hand at the end

Onhand End of of the fiscal year. (PWAC)
year
“PWACQuantity pwac_qty_onhand_endofyear
OnhandEndofye
ar”
Inventory 5-73
Inventory Cost Item Yearend Record (INV_CST_ITEM_YEAREND)
Inventory Cost Item Yearend Record (INV_CST_ITEM_YEAREND) (Sheet 2 of 2)
Name Comment
9. PWAC Value Decimal 17,6 Value of on-hand at the end of

Onhand End of the fiscal year. (PWAC)
year
“PWACValueOn pwac_value_onhand_
handEndofyear” endofyear

6
Discounts, Coupons, Deals, & Documents
Discount Record (DISCOUNT)

Contains information about the reduction in the selling price that is normally charged as
an expense to the retail store's general ledger. Can be applied by transaction line item or
to the whole transaction. Discounts must be manually applied by the cashier. (This
differs from deals which are automatically applied by the system, requiring no cashier
action.)
dsc_discount All Fields Discount
dsc_discount_group_mapping 3, 27 DiscountGroupMapping
Discount Record (DISCOUNT) (Sheet 1 of 4)
Name Comment

Record”.
2. Record Identifier String 30  “DISCOUNT”
<Field literal="DISCOUNT" name="TypeCode" />

dsc_discount.typcode
3. Discount Code String 60  Code that uniquely identifies

(PK) the discount.
"DiscountCode" dsc_discount.discount_
code
dsc_discount_group_
mapping.discount_code
4. Description String 254 Text description of the

discount.
"Description"
dsc_discount.description
Discounts, Coupons, Deals, & Documents 6-1

Name Comment
5. Application String 30  Code denoting how the

Method Code discount is applied to the sale.
"Application
MethodCode" LINE_ITEM
TRANSACTION
GROUP
dsc_discount.app_mthd_
code
6. Calculation String 30  Code denoting the method

Method Code used to calculate the amount
of the discount. The following
"Calculation
values are fixed:
MethodCode"
AMOUNT
PERCENT
PROMPT_AMOUNT
PROMPT_PERCENT
AUTHORIZE
PROMPT_NEW_PRICE
OUT_THE_DOOR
PROMPT_QTY_NEW_PRICE
BUYX_GETY_PROMPT_
PERCENT
BUYX_GETY_PERCENT
dsc_discount.calculation_mth
d_code
7. Amount Decimal 17, 6 * Amount of the discount.

"Amount" *A value must be specified for
either Discount or Percent.
dsc_discount.discount
8. Percentage Decimal 6, 4 * Percentage of the discount.

"Percent" *A value must be specified for
either Discount or Percent.
dsc_discount.percentage
must exist.
10. Effective Date/ DateTime 23  Date and time the discount is

Time effective.
"Effective dsc_discount.effective_
Datetime" datetime
11. Expiration Date/ DateTime 23 Date and time the discount

Time expires.
"Expiration dsc_discount.expr_
Datetime" datetime
must exist.

Name Comment
13. Exclusive Boolean 5 If true, the system will remove

Discount Flag all other discounts when this
discount is added to an item.
"Exclusive
Discount" dsc_discount.exclusive_
discount_flag
14. Minimum Decimal 17, 6 Minimum item/transaction

Eligible Price price that must exist for the
discount to apply.
"Minimum
EligiblePrice" dsc_discount.min_eligible_pri
ce
15. Maximum Integer Maximum number of times

Transaction this discount may appear on a
Count transaction.
"Maximum dsc_discount.max_trans_count
Transaction
Count"
16. Privilege Type String 60 Privilege that the user must

have in order to apply the
"PrivilegeType"
discount.
dsc_discount.privilege_
type
17. Prompt String 254 Translation key for a message

to be displayed when the
"Prompt"
discount is added to the sale.
dsc_discount.prompt
18. Sound String 254 File name of a sound to be

played when the discount is
"Sound"
added.
dsc_discount.sound
19. This field is not in use. Any value present in this field will be ignored, but the field must
exist.
20. Disallow Change Boolean 5 When true, the referenced

Flag discount's amount and type
cannot be modified once it is
"Disallow
applied (not a prohibition on
Change"
voiding).
dsc_discount.disallow_
change_flag
21. Serialized Boolean 5 If true, this discount has an

Discount Flag associated serial number. (For
example, may be used with
"Serialized
coupon discounts.)
Discount"
dsc_discount.serialized_
discount_flag

Name Comment
22. Taxability Code String 30 "POST_TAX" or "PRE_TAX"/

"DEFAULT"
"Taxability
Code" When "POST_TAX", the tax
will be calculated before the
discount is applied
For any other value, the tax
will be calculated after the
discount is applied.
dsc_discount.taxability_
code
23. Maximum Decimal 17, 6 If the discount is percentage

Discount based, this field will contain
the maximum discount dollar
"MaxDiscount"
amount of this discount.
dsc_discount.max_
discount

the discount list is sorted.
"SortOrder"
dsc_discount.sort_order
25. Max Amount Decimal 17, 6 The maximum amount

allowed when prompted for
"MaxAmount"
an amount off.
dsc_discount.max_amount
26. Max Percentage Decimal 17, 6 The maximum percentage

allowed when prompted for a
"MaxPercentage"
percent off.
dsc_discount.max_percentage

"ConfigElement"
associated with the profile
group and element under
which it was created.
dsc_discount.config_element
dsc_discount_group_mapping
.config_element
<Field literal="DEFAULT" name="CustomerGroupId" />

dsc_discount_group_mapping.cust_group_id

Discount No Groups Record (DISCOUNT_NO_GROUPS)

This record is the same as DISCOUNT, but does not automatically create an eligibility
record for the DEFAULT customer groups.
dsc_discount 3-27 Discount
Name Comment

Record”.
2. Record Identifier String 30  “DISCOUNT_NO_GROUPS”
3-27. See “Discount Record (DISCOUNT)” for detailed information about fields 3 through 27.

Discount Compatibility Record (DISCOUNT_COMPATIBILITY)

Contains information about the relationship between two discounts. By default,
discounts are not compatible. This file defines the discounts that are compatible with
each other and can therefore be applied concurrently. If a relationship exists in this
record for a new discount (Primary Discount Code) being applied to an existing discount
(Compatible Discount Code), both discounts will be applied. If no relationship exists for
a new discount being applied, the first discount will be discarded and the new discount
will be applied.
dsc_discount_compatibility All Fields DiscountCompatability
Name Comment

Record”.
2. Record Identifier String 30  “DISCOUNT_COMPATIBILIT

Y”
3. Primary String 60  Discount code of the discount

Discount Code being applied to the
(PK) transaction (new).
"Primary dsc_discount_
DiscountCode" compatibility.primary_discoun
t_code
4. Compatible String 60  Discount code of the discount

Discount Code already applied to the
(PK) transaction (current).
"Compatable dsc_discount_
DiscountCode" compatibility.compatible_disc
ount_
code

Discount Group Mapping Record (DISCOUNT_GROUP_MAPPING)
Discount Group Mapping Record

(DISCOUNT_GROUP_MAPPING)
Contains information for mapping a discount to a customer group.
dsc_discount_group_mapping All Fields DiscountGroupMapping
Discount Group Mapping Record (DISCOUNT_GROUP_MAPPING)
Name Comment

specifie Commands for a Data File
d Record”.
2. Record Identifier String 30  “DISCOUNT_GROUP_

MAPPING”
3. Discount Code String 60  Unique identifier of a

(PK) discount.
"DiscountCode" dsc_discount_group_
mapping.discount_code
4. Customer Group String 60  Unique identifier of a

"CustomerGroup dsc_discount_group_
Id" mapping.cust_group_id
5. Config Element String 100 u Profile Group Id & Profile

"ConfigElement"
dsc_discount_group_mapping
.config_element

Discount Item Exclusions Record (DISCOUNT_ITEM_EXCLUSIONS)
Discount Item Exclusions Record

(DISCOUNT_ITEM_EXCLUSIONS)
Contains information about items that are excluded from a particular discount.
dsc_discount_item_exclusions All Fields DiscountItemExclusions
Discount Item Exclusions Record (DISCOUNT_ITEM_EXCLUSIONS)
Name Comment

Record”.
2. Record Identifier String 30  “DISCOUNT_ITEM_

EXCLUSIONS”

(PK) discount.
"DiscountCode" dsc_discount_item_
exclusions.discount_code
4. Item ID (PK) String 60  Unique identifier of an item

that is not valid with this
"ItemId"
discount.
dsc_discount_item_
exclusions.item_id

Discount Item Inclusions Record (DISCOUNT_ITEM_INCLUSIONS)
Discount Item Inclusions Record

(DISCOUNT_ITEM_INCLUSIONS)
Contains information about items that are included in a particular discount.
dsc_discount_item_inclusions All Fields DiscountItemInclusions
Discount Item Inclusions Record (DISCOUNT_ITEM_INCLUSIONS)
Name Comment

Record”.
2. Record Identifier String 30  “DISCOUNT_ITEM_

INCLUSIONS”

(PK) discount.
"DiscountCode" dsc_discount_item_
inclusions.discount_code
4. Item ID (PK) String 60  Unique identifier of an item

that is valid with this discount.
"ItemId"
dsc_discount_item_
inclusions.item_id

Discount Type Eligibility Record (DISCOUNT_TYPE_ELIGIBILITY)
Discount Type Eligibility Record

(DISCOUNT_TYPE_ELIGIBILITY)
Contains information about sale line item transaction types that are eligible for a
particular discount.
dsc_discount_type_eligability All Fields DiscountTypeEligibility
Discount Type Eligibility Record (DISCOUNT_TYPE_ELIGIBILITY)
Name Comment

Record”.
2. Record Identifier String 30  “DISCOUNT_TYPE_

ELIGIBILITY”

(PK) discount.
"DiscountCode" dsc_discount_type_
eligibility.discount_code
4. Sale Line Item String 30  Code representing a type of

Type Code (PK) sale line item that is eligible
for a discount. The following
"SaleLineItem
values are fixed:
TypeCode"
SALE
LAYAWAY
ONHOLD
ORDER
PRESALE
SEND_SALE
SPECIAL_ORDER
WORK_ORDER
dsc_discount_type_
eligibility.sale_lineitm_
typcode

"ConfigElement"
dsc_discount_type_
eligibility.config_element

Coupon Cross-Reference Record (COUPON_XREF)

Contains information indicating how a particular coupon should be processed: either
tender or discount. This coupon type relates to manually applied discounts.
dsc_coupon_xref All Fields Coupon
.
Coupon Cross-Reference Record (COUPON_XREF) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “COUPON_XREF”
3. Coupon Serial String 254  Serial number that identifies a

Number (PK) coupon.
"CouponSerial dsc_coupon_xref.coupon_seria
Number" l_nbr
4. Discount Code String 60 * Unique identifier of a

discount.
"DiscountCode"
*A value must be specified for
either Discount Code or
Tender ID.
dsc_coupon_xref.discount_co
de
5. Tender ID String 60 * Unique identifier for a tender.

"TenderId" *A value must be specified for
either Discount Code or
Tender ID.
dsc_coupon_xref.tndr_id
6. Effective Date DateTime 23 Date and time the coupon

reference becomes effective.
"EffectiveDate"
dsc_coupon_xref.effective_dat
e
7. Expiration Date DateTime 23 Date and time the coupon

reference expires.
"Expiration
Date" dsc_coupon_xref.
expiration_date
8. Coupon Type String 60 A code for the type of coupon.

"CouponType" dsc_coupon_xref.coupon_type
9. Serialized Flag Boolean 5 If true, this is a serialized

coupon type.
"Serialized"
dsc_coupon_xref.
serialized_flag

Coupon Cross-Reference Record (COUPON_XREF) (continued) (Sheet 2 of 2)
Name Comment

code.
"OrgCode"
default="*"
dsc_coupon_xref.
org_code

"OrgValue"
default="*"
dsc_coupon_xref.
org_value

Deal Customer Group Mapping Record (DEAL_CUST_GROUPS)
Deal Customer Group Mapping Record

(DEAL_CUST_GROUPS)
Contains information associating a deal with a customer group.
Dependencies:
There must be a corresponding Deal for each Deal ID.
There must be a corresponding Customer Group for each Customer Group ID.
prc_deal_cust_groups All Fields DealCustomerGroups
Deal Customer Group Mapping Record (DEAL_CUST_GROUPS)
Name Comment

Record”.
2. Record Identifier String 30  “DEAL_CUST_GROUPS”
3. Deal ID (PK) String 60  Unique identifier for a deal.

Corresponds to DEAL record,
"DealId"
DealId.
prc_deal_cust_groups.
deal_id
4. Customer Group String 60  Unique identifier for a

"CustomerGroup prc_deal_cust_groups.
Id" cust_group_id

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value

Deal Record (DEAL)
Deal Record (DEAL)

Contains information specific to a Deal.
prc_deal All Fields Deal
Deal Record (DEAL) (Sheet 1 of 6)
Name Comment

Record”.
2. Record Identifier String 30  “DEAL”
3. Deal ID (PK) String 60  Unique identifier for a deal.

"DealId" prc_deal.deal_id
4. Description String 128 Brief description of the deal. In

some cases, this will be used
"Description"
as the line item description in
the transaction on line items to
which the deal applies.
prc_deal.description
exist.
6. Effective Date/ DateTime 23 Date and time on which the

Time deal becomes effective. Used
with "EndDate" to determine
"EffectiveDate"
the calendar dates during
which this deal is effective. If
NULL, the effective date for
the deal is indefinite.
prc_deal.effective_date
7. Expiration Date/ DateTime 23 Date and time on which the

Time deal expires. Used with
"EffectiveDate" to
"EndDate"
determine the calendar dates
during which this deal is
effective. If NULL, the end
date for the deal is indefinite.
prc_deal.end_date

Deal Record (DEAL)
Name Comment
8. Daily Effective DateTime 10 Time each day when the deal

Time becomes effective. Used with
"EndTime" to determine if a
"StartTime"
deal is usable during a
particular time of day on
effective days. (Allows deals
to occur only before, during,
or after a certain time, but on
every day.)
A null value here will result in
a deal which is active from the
beginning of the day.
prc_deal.start_time
9. Daily Expiration DateTime 10 Time each day when the deal

Time expires. Used with
"StartTime" to determine if
"EndTime"
a deal is usable during a
particular time of day on
effective days. (Allows deals
to occur only before, during,
or after a certain time, but on
every day.)
A null value here will result in
a deal which has no expiration
during the day(s) which it is
applicable.
prc_deal.end_time
10. Max Deal Decimal 17,6 Used to place an upper limit

Amount on the amount that the deal
may discount from the
"GenerosityCap"
transaction. A deal with a
generosity cap will never
result in a discount of more
than the cap set here.
If this upper limit is reached at
any point during the
application of the deal, the
deal is applied to the
maximum of this amount.
prc_deal.generosity_cap

Deal Record (DEAL)
Name Comment
11. Maximum Integer Used to place an upper limit

Quantity on the number of times this
deal may apply to the same
"IterationCap"
transaction. In the case of
transaction-wide deals, this
should always be 1. In the case
of item-based deals, this will
indicate the maximum
number of times that a set of
items may be matched in the
transaction. A setting of -1 will
allow for an application to
occur for every matching item
set.
prc_deal.iteration_cap
12. Precedence Integer The arbitration value between

equivalent deals. Used to
"PriorityNudge"
provide an ordering of deals
which have the same effect,
but in which one may be
preferable to the other.
prc_deal.priority_nudge
13. Transaction Decimal 17,6 The minimum, pre-deal total

Minimum amount of the transaction
required for the deal to be
"Minimum
applied.
Subtotal"
prc_deal.subtotal_min
14. Transaction Decimal 17,6 The maximum, pre-deal total

Maximum amount of the transaction
allowed for the deal to be
"Maximum
applied.
Subtotal"
prc_deal.subtotal_max
15. Transaction String 30 The method by which the deal

Method will be applied to the item or
transaction.
"TransAction
Type" This is the type of action to
take on the entire transaction;
this should only be used by
transaction-wide deals, and
deals with a transaction-wide
action set should not have
actions set for any item rules.
SUBSTITUTE
NEW_PRICE
PERCENT_OFF
CURRENCY_OFF
prc_deal.trwide_action

Deal Record (DEAL)
Name Comment
16. Transaction Decimal 17,6 The dollar amount or

Amount percentage to be used when
applying the deal. Used in
"TransAction
combination with the method.
Amount"
This is the amount, or
argument, to apply with the
transaction-wide action. e.g. If
the "TransActionType" is
"PercentOff" this is the
percentage discount which
this deal will apply.
prc_deal.trwide_amount
17. Taxability String 30 Indicates whether the deal

should be applied before or
"Taxability
after tax is applied to the item
Code"
or transaction. Valid values:
"POST_TAX" or "PRE_TAX"/
"DEFAULT"
When "POST_TAX", the tax
will be calculated before the
For any other value, the tax
will be calculated after the
prc_deal.taxability_code
18. Org Code String 30  Used to define the deal

eligibility based on the
"OrgCode"
organization structure. This is
the hierarchy level of the
region for which the deal is
valid (e.g. "STORE",
"DIVISION", "BRANCH").
default="*"
prc_deal.org_code
19. Org Value String 60  Used to define the deal

eligibility based on the
"OrgValue"
organization structure. This
value indicates the location
code of the region for which
the deal is valid.
default="*"
prc_deal.org_value
20. Promotion ID String 60 Unique ID indicating the

promotion associated with the
"PromotionId"
deal.
prc_deal.promotion_id

Deal Record (DEAL)
Name Comment
21. Higher Non- Boolean 5 If true, total amount of the

action Amount trigger item must be greater
Flag than the total discount item
amount. For Buy X, Get Y
"Higher
deals, “X” amount must be
NonactionAmt"
greater than “Y” amount to
get the deal.
prc_deal.higher_
nonaction_amt_flag
22. Exclude Price Boolean 5 If true, items with price

Override Flag changes will not be considered
for the deal. (exclude price
"ExcludePrice
override line items from the
Override"
deal)
prc_deal.exclude_price_
override_flag
23. Exclude Boolean 5 If true, items with applied

Discounted Flag discounts/deals will not be
considered for the deal.
"Exclude
(exclude discounted line items
Discounted"
from the deal)
prc_deal.exclude_
discounted_flag
exist.
25. Targeted Boolean 5 If true, indicates that a deal

applies only to those
"Targeted"
customers whose records
explicitly identify it. If false,
the deal is available to the
general public, regardless of
the customer assigned to the
transaction and in cases where
no customer is assigned at all.
prc_deal.targeted_flag
26. Action Deferred Boolean 5 If true, this is a deferred deal.

For standard deals whose
"Deferred"
actions apply to the current
transaction, this column
should be false. It will be true
when used in conjunction with
features like rebates and
bounceback coupons.
prc_deal.act_deferred

Deal Record (DEAL)
Name Comment
27. Use Week Boolean 5 If true, a deal has a schedule

Schedule represented in the
prc_deal_week table,
"UseWeek
populated by the
Schedule"
DEAL_WEEK record.
prc_deal.week_sched
_flag
28. Consumable Boolean 5 If true, a deal is considered to

be exclusive. If this deal
"Consumable" Default=0
applies, then no other deal can
be applied. Works for
transaction-level deals only.
prc_deal.consumable
29. Sort Order Integer  The deal sort order. Defaults

to 0 (Zero).
“SortOrder”
prc_deal.sort_order
30. Type String 60 Used by the deal engine to

detect specific deals that
"Type"
require special handling.
prc_deal.type
31. Group ID String 60 ID of the deal group to which

the deal belongs.
“GroupId”
prc_deal.group_id

Deal Trigger Record (DEAL_TRIGGER)

Contains information about triggers for deals.
Note: The Trigger Type (Field #4) and the Trigger Value that triggers
the deal (Field #5) are automatically concatenated and separated with a
":" as a single entry in the database column prc_deal_trig.deal_trigger.
Dependencies:
There must be a Deal corresponding to each Deal ID in the record.
prc_deal_trig All Fields DealTrigger
Name Comment

Record”.
2. Record Identifier String 30  “DEAL_TRIGGER”
3. Deal ID String 60  Unique identifier of a deal.

"DealId"
DealId.
prc_deal_trig.deal_id
4. Trigger Type String 60  The type of trigger deal, such

as “CUSTGROUP”.
prc_deal_trig.deal_trigger
5. Trigger Value String 60  The value that will trigger the

deal such as “EMPLOYEE”.

code.
"OrgCode"
default="*"
prc_deal_trig.org_code

"OrgValue"
default="*"
prc_deal_trig.org_value

Deal Trigger Exclude Record (DEAL_TRIGGER_EXCLUDE)

Contains information about trigger exclusions for deals. An exclusionary condition is
represented by a tilde (~) character preceding the value component of the trigger.
Note: Download records can either manually include this character

(field #5 in the DEAL_TRIGGER type) or instead opt for the
DEAL_TRIGGER_EXCLUDE record type. The
DEAL_TRIGGER_EXCLUDE record type is identical to
DEAL_TRIGGER, but inserts the tilde (~) automatically.
Dependencies:
There must be a Deal corresponding to each Deal ID in the record.
prc_deal_trig All Fields DealTrigger
The Trigger Type (Field #4) and the Trigger Value that excludes the deal (Field #5) are
automatically concatenated and separated with a "~" as a single entry in the database
column prc_deal_trig.deal_trigger.
A normal deal_trigger value is in the format:
<trigger_group>:<trigger_data>, e.g. CUSTGROUP:EMPLOYEE
An exclusionary deal_trigger value is in the format:
<trigger_group>:~<trigger_data>, e.g. CUSTGROUP:~EMPLOYEE
Deal Trigger Record (DEAL_TRIGGER_EXCLUDE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “DEAL_TRIGGER_EXCLUDE

”
3. Deal ID String 60  Unique identifier of a deal.

"DealId"
DealId.
prc_deal_trig.deal_id
4. Trigger Type String 60  The type of trigger deal, such

as “CUSTGROUP”.
5. Trigger Value String 60  The value that will exclude the

deal such as “EMPLOYEE”.

Deal Trigger Record (DEAL_TRIGGER_EXCLUDE) (Sheet 2 of 2)
Name Comment

code.
"OrgCode"
default="*"
prc_deal_trig.org_code

"OrgValue"
default="*"
prc_deal_trig.org_value

Deal Rules Record (DEAL_ITEM)

Contains information applying rules to a deal (item matching rules).
Dependencies:
Each Deal ID must correspond to an existing Deal.
prc_deal_item All Fields DealItemAction
Deal Rules Record (DEAL_ITEM) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “DEAL_ITEM”
3. Deal ID (PK) String 60  Unique identifier of a deal.

"DealId"
DealId.
prc_deal_item.deal_id
4. Deal Rule Integer  Defines the order in which the

Number (PK) items are matched during the
execution of the deal engine.
"Ordinal"
This is the ordinal of this item
within the items to be matched
by the deal. Essentially, this
column is a sequence which
resets to 1 for each deal.
prc_deal_item.item_
ordinal

Name Comment
5. Consumable Boolean 5 If true, a deal has item

matching rules which
"Consumable"
consume the items that they
match. (Item consumption is
largely inapplicable to
deferred deals.) Any item
rules in subsequent deals
which could match and
consume the item will be
unable to match an already
consumed item. This allows
deals to exclude each other
based on what items they have
matched.
Note: This flag only affects
the composition of groups
when considering multiple
deals, not multiple
applications of the same deal.
This flag is used to either
allow or prohibit a single item
to serve as a trigger or target
for multiple deals
simultaneously.
prc_deal_item.
consumable
6. Minimum Decimal 17, 4 Minimum quantity of this

Quantity item required to satisfy this
item rule. A MinQty of 0 puts
"MinQty"
no lower bound on the range.
prc_deal_item.qty_min
7. Maximum Decimal 17, 4 Maximum quantity of this

Quantity item required to satisfy this
item rule.
"MaxQty"
prc_deal_item.qty_max
8. Minimum Item Decimal 17,6 Minimum subtotal of items

Total matching this rule required to
satisfy this item rule.
"MinItemTotal"
prc_deal_item.min_item_total
9. Deal Action String 30 Identifies how the deal is

applied. The following values
"ActionType"
are fixed:
SUBSTITUTE
NEW_PRICE
PERCENT_OFF
CURRENCY_OFF
prc_deal_item.deal_
action

Name Comment
10. Action Amount Decimal 17,6 The amount that is applied on

the deal, whether it is a new
"ActionArg"
price, a dollar discount, or a
percentage discount.
prc_deal_item.action_arg
11. Action Amount Decimal 17,4 The total number of items to

Quantity which the action amount will
be applied.
"ActionArgQty"
For example, if a deal on item
A offers 3 items for $10,
ActionArg will be 10, and
ActionArgQty will be 3. If a
deal on item A offers 3 items
for $10 each, ActionArg will
be 10, and ActionArgQty will
be 1.
prc_deal_item.action_arg_qty
exist.
exist.
exist.

code.
"OrgCode"
default="*"
prc_deal_item.org_code

"OrgValue"
default="*"
prc_deal_item.org_value

Deal Item Mapping Record (DEAL_ITEM_TEST)

Contains information mapping a deal to an item or items.
Dependencies:
The Deal ID must correspond to an existing Deal.
prc_deal_field_test All Fields DealFieldTest
Deal Item Mapping Record (DEAL_ITEM_TEST) (Sheet 1 of 6)
Name Comment

Record”.
2. Record Identifier String 30  “DEAL_ITEM_TEST”
3. Deal ID (PK) String 60  Unique identifier of a deal.

"DealId"
DealId.
prc_deal_field_test.
deal_id
4. Deal Item Integer  Unique identifier of a deal-to-

Number (PK) item mapping. Corresponds to
the item ordinal for the rule in
"Ordinal"
which this field match is
incorporated. The ordinal
defines the order in which the
items are matched and
corresponds to the
"Ordinal" field in the
DEAL_ITEM record. (The
DEAL_ITEM record defines
the discounts or actions taken
on the items when the deal is
applied.)
item_ordinal

Name Comment
5. Item Field String 30  Identifies the field in the ITEM

record that is used to
"Field"
determine how the deal
should be applied to an item.
Valid values include: USE (The
typecode of the line item; the
valid value1 entries are:
LAYAWAY, ONHOLD,
ORDER, PRESALE, SALE,
SEND_SALE,
SPECIAL_ORDER, and
WORK_ORDER),
MANUFACTURER (this field
will only work if the item_id is
the item’s UPC, If it is a UPC
—12 or 13 digits— the first six
digits, which define the
manufacturer, will be
compared), QUANTITY (the
quantity in the line item),
PRICE represents the unit
price of the line item,
DEPARTMENT (the
department from which the
item is sold, taken from field:
itm_item.department_id),
SUBDEPARTMENT (the sub-
department from which the
item is sold, taken from field:
itm_item. subdepartment_id),
CLASS (Class of the item,
taken from field:
itm_item.class_id), SUBCLASS
(subclass of the item, taken
from field: itm_item.
subclass_id),
...continued

Name Comment
VENDOR (Vendor/supplier of
the item, taken from field:
itm_item.vendor), SEASON
(Season for which the item is
designed or released, taken
from field:
itm_item.season_code), STYLE
(style of the item, taken from
field:
itm_item.parent_item_id),
SKU (item’s unique identifier,
taken from field:
itm_item.item_id),
ALLOW_DEAL (checks to
verify deals are allowed, it
ensures that the
itm_item.disallow_discount_fl
ag is not set to true, and the
business logic in the register
does not disallow discounts),
ITEM_STOCK_STATUS (the
item’s stock availability, taken
from field:
itm_item.stock_status),
...continued

Name Comment
DIMENSION1 (may be used

for color, size, or other
characteristic, taken from
itm_item_dimension_value
where
itm_item_dimension_type.dim
ension is dimension1),
DIMENSION2 (may be used
where
DIMENSION3 (May be used
where
PRICE_OVERRIDE (this value
is true when a manual price
change has been applied to the
item), DISCOUNTED (this
value is true when a discount
or coupon has been applied to
the item).
ITEM_PROPERTY (property
of the item. The name of the
property to be tested must be
preceded by a ':' (colon)
separator.)
item_field
6. Match Rule String 20  The comparison that will be

used (on the values in Item
"MatchRule"
Field "Field") to determine
whether a deal should be
applied to an item. The
EQUAL
NOT_EQUAL
GREATER
LESS
BETWEEN
match_rule

Name Comment
7. Value 1 String 128  The value that will be used by

the Match Rule to compare
"Value1"
with the values in Item Field
("Field"). If only one value
is needed for the comparison,
the value in this field will be
used.
value1
8. Value 2 String 128 The value that will be used by

the Match Rule to compare
"Value2"
with the values in Item Field
("Field"). If a second value
is needed for the comparison
(e.g. BETWEEN), the value in
this field will be used.
value2
9. Item Condition Integer  Indicates the sequence in

Seq (PK) which two item conditions
with the same
"ItemCondition
"ItemConditionGroup"
Seq"
number are performed. This
ensures a unique primary key
for each record. Used to
support “compound” (i.e.
AND/OR grouped) deals.
Default=”1”
item_condition_seq

Name Comment
10. Item Condition Integer  Allows for a deal to have

Group (PK) several different, individual
tests that are combined to
"ItemCondition
form a test group.
Group"
Each different item condition
group represents a condition
that must be satisfied for the
deal to apply. Different item
condition groups represent
OR logic. Any group that is
satisfied will result in the deal
applying.
Tests that are part of the same
item condition group
represent AND logic. All tests
within an item condition
group must be satisfied in
order for the group to be
satisfied.
For example, if Condition A
and Condition B have a
different value for
"ItemConditionGroup",
the relationship will be
(Condition A OR Condition
B).
If Condition A and Condition
B have the same value for
"ItemConditionGroup",
the relationship will be
Condition A AND Condition
B.
Default=”1”
item_condition_group

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value

Deal Document Cross-Reference Record (DEAL_DOCUMENT_XREF)
Deal Document Cross-Reference Record

(DEAL_DOCUMENT_XREF)
Contains information defining the relationship between a deal and a document
definition.
prc_deal_document_xref All Fields DealDocumentXref
Deal Document Cross-Reference Record (DEAL_DOCUMENT_XREF)
Name Comment

Record”.
2. Record Identifier String 30  “DEAL_DOCUMENT_XREF”
3. Deal Id (PK) String 60  The unique identifier for a

deal.
"dealId"
prc_deal_document_
xref.deal_id
4. Series Id (PK) String 60  An identifier for a specific run

of documents.
"seriesId"
prc_deal_document_
xref.series_id
5. Document Type String 30  Identifier for the type of

(PK) document. (BOUNCEBACK,
THANKYOU, REBATE, etc.)
"documentType"
prc_deal_document_
xref.document_type

code.
"OrgCode"
default="*"
prc_deal_document_
xref.org_code

"OrgValue"
default="*"
prc_deal_document_
xref.org_value

Deal Week Record (DEAL_WEEK)

Contains entries that support applying promotions only on specific days at specific
times.
.
prc_deal_week All Fields DealWeek
Name Comment

Record”.
2. Record Identifier String 30  “DEAL_WEEK”
3. Deal Id (PK) String 60  The unique identifier for a

deal.
"DealId"
prc_deal_week.deal_id
4. Day Code (PK) String 3  The code representing the day

to apply the deal:
"DayCode"
SUN, MON, TUE, WED, THU,
FRI, SAT
prc_deal_week.day_
code
5. Start Time (PK) DateTime 23  The starting time of the deal

for the given day.
"StartTime"
prc_deal_week.start_
time
6. End Time DateTime 23 The ending time of the deal for

the given day.
"EndTime"
prc_deal_week.end_
time

code.
"OrgCode"
default="*"
prc_deal_week.
org_code

"OrgValue"
default="*"
prc_deal_week.
org_value

Free Giftcard Record (FREE_GIFTCARD)

Contains information about a deal in which the customer will receive a free gift card.
prc_deal 3-15, 19-21 Deal
prc_deal_document_xref 3, 16-17, 19-20 DealDocumentXref
doc_document_definition 6-7, 16-17, 19-20 DocumentDefinition
doc_document_def_properties 15-20 DocumentDefinitionProperties
Free Giftcard Record (FREE_GIFTCARD) (Sheet 1 of 5)
Name Comment

Record”.
2. Record Identifier String 30  “FREE_GIFTCARD”
<Field literal="1" name="Deferred" />

3. Free Giftcard String 60  Unique identifier for a free gift

Deal ID (PK) card deal. Corresponds to
DEAL record, DealId.
"DealId"
prc_deal.deal_id
prc_deal_document_xref.
deal_id
4. Description String 128 Brief description of the free

gift card deal.
"Description"
prc_deal.
description
<Field literal="GIFT CARD" name="Description" />

doc_document_definition.description
exist.

Start Redeem free giftcard deal becomes
Date effective. Can also indicate the
date on which the gift card
"EffectiveDate"
will be valid.
prc_deal.effective_date

Name Comment

End Redeem free gift card deal expires. Can
Date also be used to indicate the
date on which the gift card
"EndDate"
will not longer be valid.
prc_deal.end_date
doc_document_definition.start_issue_date (filePosition="06")
doc_document_definition.end_issue_date (filePosition="07")
doc_document_definition.start_redeem_date (filePosition="06")
doc_document_definition.end_redeem_date (filePosition="07")
8. Daily Effective DateTime 10 Time each day when the free

Time gift card deal becomes
effective.
"StartTime"
prc_deal.start_time
9. Daily Expiration DateTime 10 Time each day when the free

Time gift card deal is no longer
effective.
"EndTime"
prc_deal.end_time
10. Max Deal Decimal 17,6 The maximum benefit amount

Amount that can be applied to a
transaction when using the
"GenerosityCap"
free gift card deal.
11. Iteration Cap Integer Used to place an upper limit

on the number of times this
"IterationCap"
free gift card deal may apply
to the same transaction.

"PriorityNudge"

Name Comment
13. Transaction Decimal 17,6 The minimum, pre-deal total

required for the free gift card
"Minimum
deal to be applied.
Subtotal"
14. Transaction String 30 The method by which the free

Method gift card deal will be applied
to the item or transaction. The
"TransAction
Type"
SUBSTITUTE
NEW_PRICE
PERCENT_OFF
CURRENCY_OFF

applying the free gift card
"TransAction
deal. Used in combination
Amount"
with the method.
doc_document_def_properties
.decimal_value if
"DOLLAR_AMOUNT"
PropertyCode
16. Series ID (PK) String 60  Identifier for a series and its

promotional time frame.
"SeriesId"
series_id
doc_document_
definition.series_id
doc_document_def_
properties.series_id

(PK) document that will be
provided as the gift card.
"DocumentType"
document_type
doc_document_
definition.document_type
doc_document_def_
properties.document_type

Name Comment

doc_document_def_properties.doc_seq_nbr
<Field literal="DOLLAR_AMOUNT" name="PropertyCode" />
doc_document_def_properties.property_code
<Field literal="DECIMAL" name="Type" />
doc_document_def_properties.type
<Field filePosition="15" name="DecimalValue" />
doc_document_def_properties.decimal_value

<Field literal="GIFT_CARD_ITEM_ID" name="PropertyCode" />
<Field literal="String" name="Type" />
<Field filePosition="18" name="StringValue" />
doc_document_def_properties.string_value
18. Gift Card ID String 60 Item ID of the gift card.

doc_document_def_
properties.string_value if
"GIFT_CARD_ITEM_ID"
PropertyCode

code.
"OrgCode"
default="*"
prc_deal.org_code
org_code
doc_document_definition.org_
code
.org_code

"OrgValue"
default="*"
prc_deal.org_value
org_value
value
.org_value

Name Comment

the deal belongs.
"GroupId"
prc_deal.group_id
<Field name="SortOrder" literal="0/>

prc_deal.sort_order

Rebate Record (REBATE)

Contains information about a deal in which a customer will receive a rebate.
prc_deal 3-15, 22-24 Deal
prc_deal_document_xref 3, 16-17, 22-23 DealDocumentXref
doc_document_definition 6-7, 16-23 DocumentDefinition
doc_document_def_properties 16-17, 22-23 DocumentDefinitionProperties
Rebate Record (REBATE) (Sheet 1 of 5)
Name Comment

Record”.
2. Record Identifier String 30  “REBATE”
<Field literal="1" name="Deferred" />

3. Rebate Deal ID String 60  Unique identifier for a rebate.

(PK) Corresponds to DEAL record,
DealId.
"DealId"
prc_deal.deal_id
deal_id
4. Description String 128 Brief description of the rebate.

"Description" prc_deal.
description
exist.

Time rebate becomes effective.
"EffectiveDate" prc_deal.effective_date
doc_document_definition.start
_issue_date
doc_document_definition.start
_redeem_date

Rebate Record (REBATE) (continued) (Sheet 2 of 5)
Name Comment

Time rebate expires.
"EndDate" prc_deal.end_date
doc_document_definition.end
_issue_date
doc_document_definition.end
_redeem_date
doc_document_definition.start_issue_date (filePosition="06")
doc_document_definition.end_issue_date (filePosition="07")
doc_document_definition.start_redeem_date (filePosition="06")
doc_document_definition.end_redeem_date (filePosition="07")
8. Daily Effective Time 10 Time each day when the

Time rebate becomes effective.
"StartTime" prc_deal.start_time
9. Daily Expiration Time 10 Time each day when the

Time rebate is no longer effective.
"EndTime" prc_deal.end_time
10. Max Deal Decimal 17,6 The maximum benefit amount

Amount that can be applied to a
transaction when using the
"GenerosityCap"
rebate.
11. Iteration Cap Integer Used to place an upper limit

on the number of times this
"IterationCap"
rebate deal may apply to the
same transaction.

"PriorityNudge"

Name Comment
13. Transaction Decimal 17,6 The minimum, pre-rebate total

required for the rebate to be
"Minimum
applied.
Subtotal"
14. Transaction String 30 The method by which the

Method rebate will be applied to the
item or transaction. The
"TransAction
Type"
SUBSTITUTE
NEW_PRICE
PERCENT_OFF
CURRENCY_OFF

applying the rebate. Used in
"TransAction
combination with the method.
Amount"
16. Series ID (PK) String 60  Identifier for a series and its

promotional time frame.
"SeriesId"
series_id
doc_document_
definition.series_id
doc_document_def_
properties.series_id

document that will be
"DocumentType"
provided for the rebate.
document_type
doc_document_
definition.document_type
doc_document_def_
properties.document_type

<Field literal="SEQUENCE_TYPE" name="PropertyCode" />
<Field literal="STRING" name="Type" />
<Field literal="DOCUMENT_SEQUENCE_NUMBER" name="StringValue" />
doc_document_def_properties.string_value

Name Comment
18. File Name String 60 The file name of the rebate

form to be printed when
"FileName"
issuing a rebate. This is the
location of the pdf file on the
hard drive.
doc_document_definition.
file_name
19. Vendor ID String 60 Unique ID indicating the

vendor associated with the
"VendorId"
rebate. Used for lookups when
reprinting documents.
vendor_id
20. Description String 254 A description of the rebate.

"Description" doc_document_definition.
description
<Field literal="GENERIC_REBATE_RECEIPT" name="ReceiptType" />

doc_document_definition.receipt_type
<Field literal="GENERIC_REBATE_SEGMENT" name="SegmentType" />
doc_document_definition.segment_type
21. Text Code Value String 60 Identifier for the text that will
print on the rebate receipt.
"TextCode
This value is used to retrieve
Value"
text from the com_receipt_text
table; for both receipt type and
segment type. Used from
RcptConfig.xml in a
Textblock to tie in a block of
text from com_receipt_text.
text_code_value

code.
"OrgCode"
default="*"
prc_deal.org_code
org_code
code
.org_code

Name Comment

"OrgValue"
default="*"
prc_deal.org_value
org_value
value
.org_value

the deal belongs.
“GroupId”
prc_deal.group_id
<Field name="SortOrder" literal="0"/>

prc_deal.sort_order

Coupon Deal Record (COUPON_DEAL)

Contains information pertaining to coupon deals.
prc_deal 3-23, 25-27, 29-32 Deal
prc_deal_trig 3, 18-19, 24, DealTrigger
dsc_coupon_xref 6-7, 18-19, 24, 28 Coupon
Coupon Deal Record (COUPON_DEAL) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “COUPON_DEAL”
3-23 See “Deal Record (DEAL)” for detailed information about these fields.
<Field literal="INPUT_COUPON" name="CouponType" />

dsc_coupon_xref.coupon_type
<Field filePosition="06" name="EffectiveDate" />
dsc_coupon_xref.effective_date
<Field filePosition="07" name="ExpirationDate" />
dsc_coupon_xref.expiration_date
24. Coupon Serial String 254  The serial number of the

Number (PK) coupon used to trigger the
deal.
"CouponSerial
Number" prc_deal_trig.deal_
trigger
dsc_coupon_xref.
coupon_serial_nbr
<Field name="Trigger">
- <ValueTranslator
className="dtv.data2.dataloader.valuetranslator.StringConcatTranslator">
<Param key="string.1" value="COUPON:INPUT_COUPON:" />
<Param key="string.2" value="filePosition=24" />
</ValueTranslator>
</Field>
The Trigger Type and the Trigger Value that triggers the deal are automatically
concatenated and separated with a ":" as a single entry in the database column
prc_deal_trig.deal_trigger.
25-27. See “Deal Record (DEAL)” for detailed information about these fields.

Coupon Deal Record (COUPON_DEAL) (Sheet 2 of 2)
Name Comment
28. Serialized Flag Boolean 5 If true, this is a serialized

coupon type.
"Serialized"
dsc_coupon_xref.
serialized_flag
29. Consumable Boolean 5 If true, a deal is considered to

be exclusive. If this deal
"Consumable" Default=0
applies, then no other deal can
be applied. Works for
transaction-level deals only.
prc_deal.consumable
30. Sort Order Integer  The deal sort order. Defaults

to 0 (Zero).
“SortOrder”
prc_deal.sort_order
31. Type String 60 Used by the deal engine to

detect specific deals that
"Type"
require special handling.
prc_deal.type

the deal belongs.
“GroupId”
prc_deal.group_id

Document Record (DOCUMENT)

Defines a document to be collected or issued as part of a sale transaction.
doc_document All Fields Document
Document Record (DOCUMENT) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “DOCUMENT”

(PK) document. (One of
BOUNCE_BACK_COUPON,
"documentType"
REBATE, or GIFT_CARD.)
doc_document.
document_type
4. Series Id (PK) String 60  An identifier for a specific run

of documents. For rebates, this
"seriesId"
is usually the item ID.
doc_document.series_
id
5. Document Id String 60  A unique identifier for a

(PK) document.
"documentId" doc_document.
document_id
6. Document Status String 30 The status of the document.

(Valid Values: ISSUED,
"document
REDEEMED, VOID)
Status"
doc_document.
document_status
7. Issue Date DateTime 23 The date the document is

issued.
"issueDate"
doc_document.issue_
date
8. Effective Date DateTime 23 The date on which the

document became operative.
"effectiveDate"
doc_document.effective_date
9. Expiration Date DateTime 23 The date and time after which

the document is no longer
"expiration
valid.
Date"
doc_document.
expiration_date

Document Record (DOCUMENT) (Sheet 2 of 2)
Name Comment
10. Amount Decimal 17,6 If the document is amount

based, this field will contain
"amount"
the dollar amount.
doc_document.amount
11. Percent Decimal 17,6 If the document is percentage

based, this field will contain
"percent"
the percentage value.
doc_document.
percentage
12. Maximum Decimal 17,6 If the document is percentage

Amount based, this field will contain
the maximum dollar amount
"maxAmount"
of this document.
doc_document.max_
amount

code.
"OrgCode"
default="*"
doc_document.org_code

"OrgValue"
default="*"
doc_document.
org_value

Document Properties Record (DOCUMENT_PROPERTIES)

Contains properties information used for tracking documents such as rain checks. (Price,
quantity, and item ID for rain checks)
doc_document_properties All Fields DocumentProperties
Document Properties Record (DOCUMENT_PROPERTIES) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “DOCUMENT_PROPERTIES”
3. Document Id String 60  An identifier for a specific

(PK) document.
"documentId" doc_document_
properties.document_id

(PK) associated with the document.
(key/value pair)
"propertyCode"
doc_document_
5. Type String 30 The data type. (STRING,

BOOLEAN, DATE,
"type"
BIGDECIMAL)
doc_document_
properties.type
6. String Value String 254 Required, when the Type is

STRING.
"stringValue"
doc_document_
properties.string_value
7. Date Value DateTime 23 Required when the Type is

DATE.
"dateValue"
doc_document_
properties.date_value
8. Decimal Value Decimal 17,6 Required when the Type is

BIGDECIMAL. If BOOLEAN
"decimalValue"
Type: 1=True 0=False
doc_document_
properties.decimal_value

Document Properties Record (DOCUMENT_PROPERTIES) (Sheet 2 of 2)
Name Comment

code.
"OrgCode"
default="*"
doc_document_
properties.org_code

"OrgValue"
default="*"
doc_document_


7
Taxing
Tax Bracket Record (TAX_BRACKET)

Contains tax bracket definitions.
tax_tax_bracket All Fields TaxBracket
Tax Location Record (TAX_LOCATION) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  "TAX_BRACKET"
3. Tax Bracket ID String 60  Tax bracket definition

(PK) identifier.
"TaxBracketId" tax_tax_bracket.
tax_bracket_id
4. Tax Bracket Integer  Tax bracket sequence number.

Sequence
tax_tax_bracket.
Number (PK)
tax_bracket_seq_nbr
"TaxBracket
Sequence"
5. Tax Breakpoint Decimal 17,6 Minimum taxable amount

breakpoint for applying
"TaxBreakpoint"
corresponding tax amount.
tax_tax_bracket.
tax_breakpoint
6. Tax Amount Decimal 17,6 Tax amount to apply.

"TaxAmount" tax_tax_bracket.
tax_amount
Taxing 7-1
Tax Bracket Record (TAX_BRACKET)
Tax Location Record (TAX_LOCATION) (Sheet 2 of 2)
Name Comment

code.
"OrgCode"
default="*"
tax_tax_bracket.org_code

"OrgValue"
default="*"
tax_tax_bracket.org_value

Tax Location Record (TAX_LOCATION)

Contains information about the location in which the tax applies. Multiple stores can be
assigned to a single tax location, simplifying the taxing structure.
tax_tax_loc All Fields TaxLocation
Name Comment

Record”.
2. Record Identifier String 30  “TAX_LOCATION”
3. Tax Location ID String 60  Unique identifier of a tax

(PK) location.
"TaxLocationId" tax_tax_loc.tax_loc_id
4. Name String 254 Name of the tax location.

"Name" tax_tax_loc.name
5. Description String 254 Description of the tax location.

"Description" tax_tax_loc.description

code.
"OrgCode"
default="*"
tax_tax_loc.org_code

"OrgValue"
default="*"
tax_tax_loc.org_value
Taxing 7-3
Tax Retail Location Mapping Record (TAX_RETAIL_LOCATION_MAPPING)
Tax Retail Location Mapping Record

(TAX_RETAIL_LOCATION_MAPPING)
This record cross-references retail locations with tax locations. Used to look up and find
the tax location for a retail location.
Dependencies:
There must be a RETAIL_LOCATION record for each Retail Location ID in this file.
There must be a TAX_LOCATION record for each Tax Location ID in this file.
tax_rtl_loc_tax_mapping All Fields RetailLocationTaxMapping
Tax Retail Location Mapping Record (TAX_RETAIL_LOCATION_MAPPING)
Name Comment

Record”.
2. Record Identifier String 30  “TAX_RETAIL_LOCATION_

MAPPING”

organization.
"RetailLocationI
d" tax_rtl_loc_tax_mapping.
rtl_loc_id

location.
"TaxLocationId"
tax_rtl_loc_tax_mapping.
tax_loc_id

Tax Authority Record (TAX_AUTHORITY)

Contains information about a government authority that levies sales taxes and on whose
behalf the store collects these sales taxes.
tax_tax_authority All Fields TaxAuthority
Tax Authority Record (TAX_AUTHORITY) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “TAX_AUTHORITY”
3. Tax Authority ID String 60  The identifier for a specific tax

(PK) authority that establishes the
tax rate. The tax authority is
"TaxAuthority
normally a government body.
Id"
(For example, National, State,
Province, City: BRX, CLE,
CUY, NY, OH, GST, PST)
tax_tax_authority.
tax_authority_id
4. Name String 254  Name of the tax authority.

"Name" tax_tax_authority.
name
Taxing 7-5
Name Comment
5. Rounding Code String 30  Code that indicates how tax is

to be rounded when
"RoundingCode"
calculated.
HALF_UP - Round to the
nearest neighbor unless
equidistant, then round up.
HALF_DOWN - Round to the
equidistant, then round down.
HALF_EVEN - Round to the
equidistant, then round to
even neighbor. Example; 2.5
rounds to 2 while 3.5 rounds
to 4. Note: This rounding
method results in the least
number of rounding errors
during repeat computations.
CEILING - Round toward
positive infinity. Note: This is
the opposite of FLOOR and
never decreases the calculated
value.
DOWN - Round to the
previous digit; toward zero.
FLOOR - Round down toward
negative infinity. Note: This is
the opposite of CEILING and
never increases the calculated
value.
UP - Round to the next digit;
away from zero.
Note: For positive numbers,
CEILING and UP result in the
same outcome. For negative
numbers, CEILING and
DOWN result in the same
outcome.
tax_tax_authority.
rounding_code
6. Rounding Digits Integer  Number of digits to which

Quantity rounding is to be calculated.
"RoundingDigits tax_tax_authority.
Quantity" rounding_digits_quantity

code.
"OrgCode"
default="*"
tax_tax_authority.org_code

Name Comment

"OrgValue"
default="*"
tax_tax_authority.org_value
Taxing 7-7
Tax Group Record (TAX_GROUP)

Contains information about a group of items for which a tax authority defines tax group
rules.
tax_tax_group All Fields TaxGroup
Name Comment

Record”.
2. Record Identifier String 30  “TAX_GROUP”
3. Tax Group ID String 60  Unique retailer assigned

(PK) identifier for the tax group.
"TaxGroupId" tax_tax_group.tax_group_id
4. Name String 254 Tax group name.

"Name" tax_tax_group.name
5. Description String 254 Description of the tax group.

"Description" tax_tax_group.description

code.
"OrgCode"
default="*"
tax_tax_group.org_code

"OrgValue"
default="*"
tax_tax_group.org_value
8. Tax Code ID String 30 Unique identifier for the tax

code.
"TaxCodeId"
tax_tax_group.tax_code_id

Tax Group Property (TAX_GROUP_PROPERTY)
Tax Group Property (TAX_GROUP_PROPERTY)

Contains property information for tax groups.
tax_tax_group_p All Fields TaxGroupProperty
Tax Group Property Record (TAX_GROUP_PROPERTY)
Name Comment

Record”.
2. Record Identifier String 30  “TAX_GROUP_PROPERTY”
3. Tax Group Id String 60  The tax group identifier.

(PK)
tax_tax_group_p.item_id
“TaxGroupId”

tax_tax_group.
“PropertyCode”
tax_tax_group_p.property_
code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
tax_tax_group_p.type

Type=STRING
“StringValue”
tax_tax_group_p.string_value

Type=DATE
“DateValue”
tax_tax_group_p.date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
tax_tax_group_p.decimal_
value
Taxing 7-9
Tax Group Rule Record (TAX_GROUP_RULE)

Contains information about a rule that indicates how a particular tax is to be applied to a
group of items.
Dependencies:
There must be a TAX_LOCATION record for each Tax Location ID in this file.
There must be a TAX_GROUP record for each Tax Group ID in this file.
tax_tax_group_rule All Fields TaxGroupRule
Tax Group Rule Record (TAX_GROUP_RULE) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “TAX_GROUP_RULE”
3. Tax Location ID String 60  Unique identifier for a tax

(PK) location.
"TaxLocationId" tax_tax_group_rule.
tax_loc_id

"TaxGroupId" tax_tax_group_rule.
tax_group_id
5. Tax Rule Integer  Sequential number for the tax

Sequence rule, denoting the order of
Number (PK) consideration for the tax rules.
"TaxRule tax_tax_group_rule.
Sequence" tax_rule_seq_nbr
6. Name String 254 Name of the tax group rule.

"Name" tax_tax_group_rule.
name
7. Tax Type Code String 30  Code denoting the type of tax

this rule applies. The
"TaxTypeCode"
SALES
VAT
GST
PST
tax_tax_group_rule.
tax_typcode

Name Comment
8. Tax Authority ID String 60  Identifier for a specific tax

authority that establishes the
"TaxAuthority
tax rate. The tax authority is
Id"
normally a government body.
(For example, National, State,
Province, City: BRX, CLE,
CUY, NY, OH, GST, PST)
tax_tax_group_rule.
tax_authority_id
9. Taxed at Trans Boolean 5 If true, this tax will be applied

Level Flag at the transaction level.
"TaxedAtTrans Note: Must be False for
Level" breakpoint taxing.
tax_tax_group_rule.
taxed_at_trans_level_flag
10. Compound Flag Boolean 5 If true, this tax will be

compounded with other taxes.
"Compound"
tax_tax_group_rule.
compound_flag
11. Compound Integer * Sequential number that

Sequence indicates the order in which
Number multiple applicable tax group
rules should be applied.
"Compound
Sequence" *Required only for compound
taxes.
Example: City, County & State
Tax Group Rules are not
compounding - All three rules
will contain zero (or NULL)
for this value.
Example: PST & GST Tax
Group Rules are to be applied
in a compounding fashion
with PST applied first - The
rule for PST will contain 1 for
this value, the rule for GST
will contain 2 for this value.
tax_tax_group_rule.
compound_seq_nbr
12. Description String 254 * This value is usually the same

as Field#6 (Name), unless
"Description"
specified by the customer as
something else.
*Required for customers with
multiple taxes (GST, PST) to
ensure tax descriptions are
displayed on the sale screen.
tax_tax_group_rule.
description
Taxing 7-11
Name Comment

code.
"OrgCode"
default="*"
tax_tax_group_rule.org_code

"OrgValue"
default="*"
tax_tax_group_rule.org_value

Tax Rate Rule Record (TAX_RATE_RULE)

Contains rule information denoting what percentage or dollar amount of tax is applied
to a particular taxable total in a retail transaction.
Dependencies:
There must be a TAX_GROUP_RULE with the same Tax Group ID, Tax Location ID, and
Tax Rule Sequence Number.
tax_tax_rate_rule All Fields TaxRateRule
Tax Rate Rule Record (TAX_RATE_RULE) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “TAX_RATE_RULE”

"TaxGroupId" tax_tax_rate_rule.
tax_group_id
4. Tax Location ID String 60  Unique identifier for the tax

(PK) location.
"TaxLocationId" tax_tax_rate_rule.
tax_loc_id

Sequence rule, denoting the order the
Number (PK) rule should be considered.
"TaxRule tax_tax_rate_rule.
Sequence" tax_rule_seq_nbr
6. Tax Rate Rule Integer  Sequential number for the tax

Sequence (PK) rate rule, denoting the order
the rule should be considered.
"TaxRateRule
Sequence" tax_tax_rate_rule.
tax_rate_rule_seq
7. Tax Rate Min Decimal 17, 6  Minimum amount that may be

Taxable Amount taxed by this rule.
"TaxRateMin tax_tax_rate_rule.
TaxableAmount" tax_rate_min_taxable_amt
8. Tax Rate Max Decimal 17, 6 Maximum amount that may

Taxable Amount be taxed by this rule.
"TaxRateMax tax_tax_rate_rule.
TaxableAmount" tax_rate_max_taxable_amt
Taxing 7-13
Name Comment
9. Amount Decimal 17, 6 * Amount of tax to charge.

either Amount or Percent.
tax_tax_rate_rule.
amt
10. Percent Decimal 8, 6 * Tax rate percentage.

tax_tax_rate_rule.
percentage
11. Break Point Type String 30 Type of breakpoint to use

Code when calculating the tax. The
"BreakPointType
Code" FULL
PART
tax_tax_rate_rule.
breakpoint_typcode
12. Effective Date/ DateTime 23 Date and time the tax rule
Timestamp goes into effect.
"Effective tax_tax_rate_rule.
Datetimestamp" effective_datetime
13. Expiration Date/ DateTime 23 Date and time when the tax
Timestamp rule expires.
"Expiration tax_tax_rate_rule.
Datetimestamp" expr_datetime
14. Daily Start Time DateTime 10 Time each day when the tax
becomes effective.
"DailyStartTime
Dao" Note: Not currently
supported; must be NULL.
tax_tax_rate_rule.
daily_start_time
15. Daily End Time DateTime 10 Time each day when the tax
expires.
"DailyEndTime
tax_tax_rate_rule.
daily_end_time
16. Tax Bracket ID String 60 Tax bracket definition

identifier.
“TaxBracketId”
tax_tax_rate_rule.
tax_bracket_id

Name Comment

code.
"OrgCode"
default="*"
tax_tax_rate_rule.org_code

"OrgValue"
default="*"
tax_tax_rate_rule.org_value
Taxing 7-15
Tax Rate Rule Override Record (TAX_RATE_RULE_OVERRIDE)
Tax Rate Rule Override Record

(TAX_RATE_RULE_OVERRIDE)
Contains information that provides supplementary data regarding tax overrides.
Provides a temporary override of a tax rate rule.
Dependencies:
There must be a TAX_GROUP_RULE with the same Tax Group ID, Tax Location ID, and
Tax Rule Sequence Number.
tax_tax_rate_rule_override All Fields TaxRateRuleOverride
Tax Rate Rule Override Record (TAX_RATE_RULE_OVERRIDE) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “TAX_RATE_RULE_

OVERRIDE”

"TaxGroupId" tax_tax_rate_rule_
override.tax_group_id
4. Tax Location ID String 60  Unique identifier for the tax

(PK) location.
"TaxLocationId" tax_tax_rate_rule_
override.tax_loc_id

Sequence rule, denoting the order the
Number (PK) rule should be considered.
"TaxRule tax_tax_rate_rule_
Sequence" override.tax_rule_seq_nbr
6. Tax Rate Rule Integer  Sequential number for the tax

Sequence (PK) rate rule, denoting the order
the rule should be considered.
"TaxRateRule
Sequence" tax_tax_rate_rule_
override.tax_rate_rule_seq
7. Tax Rate Min Decimal 17, 6  Minimum amount that may be

Taxable Amount taxed by this rule.
"TaxRateMin tax_tax_rate_rule_
TaxableAmount" override.tax_rate_min_taxable
_amt

Name Comment
8. Tax Rate Max Decimal 17, 6 Maximum amount that may

Taxable Amount be taxed by this rule.
"TaxRateMax tax_tax_rate_rule_
TaxableAmount" override.tax_rate_max_taxable
_amt
9. Amount Decimal 17, 6 * Amount of tax to charge.

tax_tax_rate_rule_
override.amt
10. Percent Decimal 8, 6 * Tax rate percentage.

tax_tax_rate_rule_
override.percentage
11. Break Point Type String 30 Type of breakpoint to use

Code when calculating the tax. The
"BreakPointType
Code" FULL
PART
tax_tax_rate_rule_
override.breakpoint_typcode
12. Effective Date/ DateTime 23 Date and time the tax rule
Timestamp goes into effect.
"Effective tax_tax_rate_rule_
Datetimestamp" override.effective_datetime
13. Expiration Date/ DateTime 23 Date and time when the tax
Timestamp rule expires.
"Expiration tax_tax_rate_rule_
Datetimestamp" override.expr_datetime
14. Daily Start Time DateTime 10 Time each day when the tax
becomes effective.
"DailyStartTime
tax_tax_rate_rule_
override.daily_start_time
15. Daily End Time DateTime 10 Time each day when the tax
expires.
"DailyEndTime
tax_tax_rate_rule_
override.daily_end_time
Taxing 7-17
Name Comment
16. Tax Bracket ID String 60 Tax bracket definition

identifier.
“TaxBracketId”
tax_tax_rate_rule_
override.tax_bracket_id

code.
"OrgCode"
default="*"
tax_tax_rate_rule_
override.org_code

"OrgValue"
default="*"
tax_tax_rate_rule_
override.org_value

Tax Postal Code Mapping Record (TAX_POSTAL_CODE_MAPPING)
Tax Postal Code Mapping Record

(TAX_POSTAL_CODE_MAPPING)
This record cross-references postal codes with tax locations. Used to look up and find the
tax location for a postal code.
tax_postal_code_mapping All Fields PostalCodeMapping
Tax Postal Code Mapping Record (TAX_POSTAL_CODE_MAPPING)
Name Comment

Record”.
2. Record Identifier String 30  “TAX_POSTAL_CODE_

MAPPING”
3. Postal Code (PK) String 254  Postal code that maps to the
tax location.
"PostalCode"
tax_postal_code_
mapping.postal_code
4. City (PK) String 254  City that maps to the tax

location.
"City"
tax_postal_code_
mapping.city

(PK) location.
"TaxLocationId" tax_postal_code_
mapping.tax_loc_id
Taxing 7-19
Tax Group Mapping Record (TAX_GROUP_MAPPING)

Maps relationships between store locations/customer groups and tax groups. The item
tax group id can be overridden by the new tax group id based on the information in this
record. This allows overrides by store to preserve the ability to have the same item file be
distributed to all stores with the possibility of different tax group mappings for easier
compliance of certain state sales tax rules, or override of an assigned item tax group
based on membership of a customer group.
Dependencies:
There must be a Customer Group for each Customer Group ID in the table. If Customer
Group ID populated with the value of “ALL”, then the tax group mapping will apply to
every customer group for the given organization/retail location.
There must be a Tax Group for each Tax Group ID in the table.
tax_tax_group_mapping All Fields TaxTaxGroupMapping
Tax Group Mapping Record (TAX_GROUP_MAPPING) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “TAX_GROUP_MAPPING”
3. Retail Location Integer  Identifier for the retail location

ID (PK) associated with this tax group
mapping.
"RtlLocId"
tax_tax_group_mapping.
rtl_loc_id
must exist.
5. Customer Group String 60  Unique identifier for the

"CustomerGroup If populated with the value of
" “ALL”, then the tax group
mapping will apply to every
customer group for the given
organization/retail location.
If populated with a customer
group identifier, only the
customer group will get the
tax override.
customer_group_id

Tax Group Mapping Record (TAX_GROUP_MAPPING) (Sheet 2 of 2)
Name Comment
6. Tax Group String 60  Unique identifier for the tax

ID(PK) group.
"TaxGroupId" tax_tax_group_mapping.
tax_group_id
7. New Tax Group String 60 Overrides the item tax group

ID ID based on the customer
group ID.
"NewTaxGroupI
d" tax_tax_group_mapping.
new_tax_group_id
8. Priority Integer The priority level of the tax

group. Determines the tax to
"Priority"
be applied when a customer
belongs to more than one
customer group.
priority
Taxing 7-21
Tax Exemption Record (TAX_EXEMPTION)

Contains information about a line item modifier to the Tax Line Item component of a
Retail Transaction that provides supplementary data regarding tax exemptions.
tax_tax_exemption All Fields TaxExemption
Tax Exemption Record (TAX_EXEMPTION) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “TAX_EXEMPTION”
3. Tax Exemption String 60  An identifier for the tax

Id (PK) exemption.
"taxExemption tax_tax_exemption.
Id" tax_exemption_id
4. Party Id BigInt A unique, automatically

"partyId"
tax_tax_exemption.
party_id
5. Certificate String 30 The certificate number

Number assigned to a purchaser by a
tax authority exempting the
"certificate
purchaser from tax in that
Nbr"
authority.
tax_tax_exemption.
cert_nbr
6. Reason Code String 30 A retailer-assigned code

denoting why this tax
"reasonCode"
exemption was granted.
tax_tax_exemption.
reascode
7. Certificate String 60 The name of the individual or

Holder Name organization who holds the
tax exemption certificate.
"certificate
HolderName" tax_tax_exemption.
cert_holder_name
8. Certificate String 2 The country where the tax

Country exempt certificate was issued.
"certificate tax_tax_exemption.
Country" cert_country

Tax Exemption Record (TAX_EXEMPTION) (Sheet 2 of 2)
Name Comment
9. Expiration Date DateTime 23 The date the tax exempt

certificate expires.
"expiration
Date" tax_tax_exemption.
expiration_date
10. Certificate State String 30 The state where the tax

exempt certificate was issued.
"certificate
State" tax_tax_exemption.
cert_state
11. Notes String 254 String entered by the user.

"notes" tax_tax_exemption.
notes
12. Address Id String 60 The address identifier for the

tax exemption certificate
"addressId"
holder.
tax_tax_exemption.
address_id
13. Phone Number String 30 The phone number for the

certificate holder.
"phoneNumber"
tax_tax_exemption.
phone_number
14. Region String 30 The store location area. Used

for regionalizing information.
"region"
tax_tax_exemption.
region
15. Diplomatic Title String 60 The diplomatic title for the

certificate holder.
"diplomatic
Title" tax_tax_exemption.
diplomatic_title
16. Certificate String 30 The first name of the

Holder First individual who holds the tax
Name exemption certificate.
"certHolder tax_tax_exemption.
FirstName" cert_holder_first_name
17. Certificate String 30 The last (surname) name of

Holder Last the individual who holds the
Name tax exemption certificate.
"certHolder tax_tax_exemption.
LastName" cert_holder_last_name
Taxing 7-23

8
Accounts, Loyalty & Warranties
Customer Account Properties Record (CUST_ACCT_PROP)

Contains generic properties for a customer account. (The key-value based properties of
the customer account.)
cat_cust_acct_properties All Fields CustomerAccountProperty
Customer Account Properties Record (CUST_ACCT_PROP) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CUST_ACCT_PROP”
3. Customer String 30  Identifier for the type of

Account Code customer account:
(PK)
SPECIAL_ORDER
"CustAccount LAYAWAY
Code" SEND_SALE
LOYALTY
WORK_ORDER
ACCOUNTS_RECEIVABLE
cat_cust_acct_properties.
cust_acct_code
4. Customer String 60  The customer account

Account ID (PK) identifier. Must be unique
within the Customer Account
"CustAccountId"
Code.
cust_acct_id
Accounts, Loyalty & Warranties 8-1

Customer Account Properties Record (CUST_ACCT_PROP)
Customer Account Properties Record (CUST_ACCT_PROP) (Sheet 2 of 2)
Name Comment

(PK) associated with the customer
account. (For example, for AR
"PropertyCode"
account, property codes:
LAST_PAYMENT_DATE,
LAST_PAYMENT_AMOUNT,
LAST_PURCHASE_DATE,
LAST_PURCHASE_AMOUN
T)
property_code
6. Type String 30  The type of value stored by

this record:
"Type"
STRING
BIGDECIMAL
DATE
BOOLEAN
type
7. String Value String 254 * *Required, based on the Type.

"StringValue" cat_cust_acct_properties.
string_value
8. Decimal Value Decimal 17,6 * *Required, based on the Type.

If BOOLEAN Type: 1=True
"DecimalValue"
0=False
decimal_value
9. Date Value DateTime 23 * *Required, based on the Type.

"DateValue" cat_cust_acct_properties.
date_value

Customer Account Card Record (CUST_ACCT_CARD)

Contains information about the card used to identify a customer account.
cat_cust_acct_card 3-6 CustomerLoyaltyCard
cat_cust_loyalty_acct 3, 9-16 CustomerLoyaltyAccount
Customer Account Card Record (CUST_ACCT_CARD) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CUST_ACCT_CARD”
3. Card Number String 256  Unique number identifying

(PK) the card.
"CardNumber" cat_cust_acct_card.
cust_acct_card_nbr
cat_cust_loyalty_acct.
cust_card_nbr
4. Party ID BigInt Unique ID of the party who

owns the card.
"PartyId"
cat_cust_acct_card.
party_id
5. Effective Date DateTime 23 Date on which the card may

first be used.
"EffectiveDate"
cat_cust_acct_card.
effective_date
6. Expiration Date DateTime 23 Date after which the card may

no longer be used.
"Expiration
Date" cat_cust_acct_card.
expr_date
exist.
exist.
9. Account Id String 60  Unique ID of the primary

loyalty account on the card.
"AccountId"
cust_acct_id

Customer Account Card Record (CUST_ACCT_CARD) (Sheet 2 of 2)
Name Comment
10. Loyalty Program String 60 Primary loyalty account's

Id program type.
"LoyaltyProgram cat_cust_loyalty_acct.
Id" loyalty_program_id

Name program name.
Name" loyalty_program_name

Level Id program level type; used by
the Relate™ CRM system.
"LoyaltyProgram
LevelId" cat_cust_loyalty_acct.
loyalty_program_level_id

Level Name program level name.
LevelName" loyalty_program_level_name
14. Effective Date DateTime 23 Date on which primary loyalty

account is first active.
"EffectiveDate"
effective_date
15. Expiration Date DateTime 23 Date after which primary

loyalty account is inactive.
"Expiration
Date" cat_cust_loyalty_acct.
expiration_date
16. Account Balance Decimal 17,6 Current balance for the

primary loyalty account.
"Account
Balance" cat_cust_loyalty_acct.
acct_balance

Customer Charge Account Record (CUST_CHARGE_ACCT)

Contains information about a customer charge account. (For example, Accounts
Receivable account.)
cat_cust_acct 3-12 CustomerAccount
cat_cust_consumer_charge_acct 3-4, 13-16 CustomerConsumerChargeAccount
Customer Charge Account Record (CUST_CHARGE_ACCT) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “CUST_CHARGE_ACCT”

(PK) ACCOUNTS_RECEIVABLE
"CustAccount cat_cust_acct.cust_acct_code
Code"
cat_cust_consumer_
charge_acct.cust_acct_code

"CustAccountId"
Code.
cat_cust_acct.cust_acct_id
cat_cust_consumer_
charge_acct.cust_acct_id
5. Customer String 30 Status for the account: The

Account State following values are fixed:
Code
NEW
"CustAccount OPEN
StateCode" CLOSED
VOID
OVERDUE
DELINQUENT
ABANDONED
REFUNDABLE
INACTIVE
IN_PROGRESS
PENDING
READY_TO_PICKUP
CLOSED_ESCROW
SUSPENDED
CANCELED
cat_cust_acct.cust_acct_statco
de

Name Comment
6. Account Balance Decimal 17,6 Current balance of the

account.
"Account
Balance" cat_cust_acct.acct_
balance
7. Retail Location Integer Unique identifier for a specific

ID retail store within the
organization. This is the store
"RetailLocationI
that “owns” the account.
d"
cat_cust_acct.rtl_loc_id
8. Party ID BigInt The party identifier of the

customer owning the account.
"PartyId"
cat_cust_acct.party_id
9. Customer Boolean 5 If true, customer identity must

Identity be verified.
Required Flag
cat_cust_acct.cust_
"CustIdentity identity_req_flag
Req"
10. Customer String 30 If the Customer Identity

Identity Type Required Flag is true, the type
Code of identity required:
CUSTOMER (only currently
"CustIdentity
supported value)
TypeCode"
cat_cust_acct.cust_
identity_typcode
11. Account Setup DateTime 23 The date and time the account
Date was set up.
"AccountSetup cat_cust_acct.acct_setup_date
Date"
12. Last Activity DateTime 23 The date and time of the last
Date activity on the account.
"LastActivity cat_cust_acct.last_
Date" activity_date
13. Credit Limit Decimal 17,6 The credit limit on the

account.
"CreditLimit"
cat_cust_consumer_
charge_acct.credit_limit
14. PO Required Boolean 5 If true, a Purchase Order

Flag number is required for this
account.
"PoRequired"
cat_cust_consumer_
charge_acct.po_req_flag

Name Comment
15. On Hold Flag Boolean 5 If true, the account is on hold

and cannot be used.
"OnHold"
cat_cust_consumer_
charge_acct.on_hold_flag
16. Corporate Boolean 5 If true, the account is a

Account Flag corporate account type.
"isCorporateAcc cat_cust_consumer_
ount" charge_acct.corporate_account
_flag

Customer Charge Account Users Record (CUST_CHARGE_ACCT_USERS)
Customer Charge Account Users Record

(CUST_CHARGE_ACCT_USERS)
Contains information about the users for a customer charge account.
Note: Changes have been made to this record, fields 5 and 10, for
Xstore version 3.5.1 to provide the ability to look up users by an
identifying value. However, backwards compatibility has been
preserved.
cat_charge_acct_users All Fields ChargeAccountUser
Customer Charge Account Users Record (CUST_CHARGE_ACCT_USERS) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CUST_CHARGE_ACCT_

USERS

"CustAccount cat_charge_acct_
Code" users.cust_acct_code

"CustAccountId"
Code.
cat_charge_acct_
users.cust_acct_id
5. Account User Id String 30  The account user identifier.

(PK)
cat_charge_acct_
"AccountUserId" users.acct_user_id
The DataLoader will limit this
value to the first 30 characters
to avoid truncation errors
which would prevent a row’s
insertion. This will allow
longer names currently sent
down in legacy files to be
processed as before. (See
ValueTranslator below.)
<ValueTranslator className="dtv.data2.dataloader.valuetranslator.MaxLengthTranslator">
<Param key="length" value="30" />
</ValueTranslator>

Customer Charge Account Users Record (CUST_CHARGE_ACCT_USERS)
Customer Charge Account Users Record (CUST_CHARGE_ACCT_USERS) (Sheet 2 of 2)
Name Comment
6. Primary Contact Boolean 5 If true, indicates this person is

Flag the primary contact for the
account.
"Primary
Contact" cat_charge_acct_
users.primary_contact_flag
7. Party ID BigInt Party identifier of the user for

the account.
"PartyId"
cat_charge_acct_
users.party_id
8. Effective Date DateTime 23  The date and time the user can
use the account.
"EffectiveDate"
cat_charge_acct_
users.effective_date
9. Expiration Date DateTime 23 The date and time the user can
no longer use the account.
"Expiration
Date" cat_charge_acct_
users.expiration_date
10. Account User String 254 The account user name will be
Name set to default when no value is
supplied to the (non-
"AccountUser
truncated) value specified in
Name"
field #5. Legacy records not
populating this new field will
therefore behave in the system
as they have before.
(See ValueTranslator
below.)
cat_charge_acct_
users.acct_user_name
<ValueTranslator className="dtv.data2.dataloader.valuetranslator.DefaultValueTranslator">
<Param key="default" value="filePosition=05" />
</ValueTranslator>
11. Account User String 60 The account user’s first name.

First Name
cat_charge_acct_
"AccountUserFir users.acct_user_first_name
stName"
12. Account User String 60 The account user’s last name.

Last Name
cat_charge_acct_
"AccountUserLa users.acct_user_last_name
stName"

Customer Charge Account History Record (CUST_CHARGE_ACCT_HIST)
Customer Charge Account History Record

(CUST_CHARGE_ACCT_HIST)
Contains the historical information about any customer charge account.
cat_charge_acct_history All Fields ChargeAccountHistory
Customer Charge Account History Record (CUST_CHARGE_ACCT_HIST) (Sheet 1 of 2)
Name Comment

Record”.

HIST”

"CustAccount cat_charge_acct_history.
Code" cust_acct_code

"CustAccountId"
Code.
cat_charge_acct_history.
cust_acct_id
5. History BigInt  A unique and ordered

Sequence (PK) identifier for the record.
"HistorySeq" cat_charge_acct_history.
history_seq
6. Activity Type String 30  The type of activity:

"ActivityEnum" PAYMENT
CHARGE
CREDIT ADJUSTMENT
activity_enum
7. Activity Date DateTime  Date the activity took place.

"ActivityDate" cat_charge_acct_history.
activity_date
8. Account User String 254 The name of the account user

Name performing the activity.
"AccountUser cat_charge_acct_history.
Name" acct_user_name

Customer Charge Account History Record (CUST_CHARGE_ACCT_HIST)
Customer Charge Account History Record (CUST_CHARGE_ACCT_HIST) (Sheet 2 of 2)
Name Comment
9. Party ID BigInt The party identifier for the

user performing the activity.
"PartyId"
Represents a customer,
business, employee, etc. in the
system.
party_id
10. Amount Decimal 17,6  The amount of the activity.

"Amt" cat_charge_acct_history.
amt
11. Account Balance Decimal 17,6 The balance of the account

after the activity.
"Account
Balance" cat_charge_acct_history.
acct_balance
12. Retail Location Integer Retail location ID information

ID for the transaction.
"RetailLocationI cat_charge_acct_history.
d" rtl_loc_id
13. Workstation ID BigInt Workstation ID information

for the transaction.
"WorkstationId"
wkstn_id
14. Business Date Date 10 Business date information for

the transaction.
"BusinessDate"
business_date
15. Transaction BigInt Sequence information for the

Sequence transaction.
"Transaction cat_charge_acct_history.
Sequence" trans_seq
16. Line Item Integer The specific line item within a

"Retail cat_charge_acct_history.
TransactionLineI rtrans_lineitm_seq
temSequence"

Customer Charge Account Invoice Record (CUST_CHARGE_ACCT_INVOICE)
Customer Charge Account Invoice Record

(CUST_CHARGE_ACCT_INVOICE)
Contains outstanding invoice information. This record provides users with the ability to
view outstanding invoices and then choose to apply a full or partial payment to any of
those payments due. Used when ShowOutstandingInvoicesForPayment is set to
TRUE in SystemConfig.xml.
cat_charge_acct_invoice All Fields ChargeAccountInvoice
Customer Charge Account Invoice Record (CUST_CHARGE_ACCT_INVOICE) (Sheet 1 of 2)
Name Comment

Record”.

INVOICE”

(PK)
ACCOUNTS_RECEIVABLE
"CustAccount
cat_charge_acct_
Code"
invoice.cust_acct_code

"CustAccountId"
Code.
cat_charge_acct_
invoice.cust_acct_id
5. Invoice Number String 60  A unique identifier for the

(PK) invoice.
"invoiceNumber" cat_charge_acct_
invoice.invoice_number
6. Original Invoice Decimal 17,6 The balance of the invoice

Balance when it was first created.
"original cat_charge_acct_
InvoiceBalance" invoice.original_invoice_balan
ce
7. Invoice Balance Decimal 17,6  The current balance due for

the invoice.
"invoice
Balance" cat_charge_acct_
invoice.invoice_balance
8. Invoice Date DateTime 23 The date and time when the

invoice was created.
"invoiceDate"
cat_charge_acct_
invoice.invoice_date

Customer Charge Account Invoice Record (CUST_CHARGE_ACCT_INVOICE)
Customer Charge Account Invoice Record (CUST_CHARGE_ACCT_INVOICE) (Sheet 2 of 2)
Name Comment
9. Last Activity DateTime 23 The most recent date and time

Date of the most recent changes
made to the invoice.
"lastActivity
Date" cat_charge_acct_
invoice.last_activity_date

Customer Loyalty Account Record (CUST_LOYALTY_ACCT)

Contains information about the customer loyalty account.
cat_cust_loyalty_acct 3-13 CustomerLoyaltyAccount
Customer Loyalty Account Record (CUST_LOYALTY_ACCT) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CUST_LOYALTY_ACCT”

(PK) the card associated with this
loyalty account.
"CardNumber"
cust_card_nbr
4. Account Id (PK) String 60  Unique ID of this loyalty

account.
"AccountId"
cust_acct_id
5. Loyalty Program String 60 Loyalty account's program

Id type.
Id" loyalty_program_id

Name name.
Name" loyalty_program_name

Level Id program level type; used by
the Relate™ CRM system.
"LoyaltyProgram
LevelId" cat_cust_loyalty_acct.
loyalty_program_level_id

Level Name level name.
LevelName" loyalty_program_level_name
9. Effective Date DateTime 23 Date on which this loyalty

account can start
"EffectiveDate"
accumulating points.
effective_date

Customer Loyalty Account Record (CUST_LOYALTY_ACCT) (Sheet 2 of 2)
Name Comment
10. Expiration Date DateTime 23 Date after which this loyalty

account no longer accumulates
"Expiration
points.
Date"
expiration_date
11. Account Balance Decimal 17,6 Current balance for this

loyalty account.
"Account
Balance" cat_cust_loyalty_acct.
acct_balance
12. Escrow Balance Decimal 17,6 The escrow balance for a

loyalty account.
"EscrowBalance"
escrow_balance
13. Bonus Balance Decimal 17,6 The bonus balance for a

loyalty account.
"BonusBalance"
bonus_balance

Customer Award Record (CUST_AWARD)

Contains specific customer award information for a customer loyalty program.
cat_award_acct 3-4 AwardAccount
cat_award_acct_coupon 3-7 AwardAccountCoupon
Name Comment

Record”.
2. Record Identifier String 30  “CUST_AWARD”

(PK) the card associated with this
award account.
"CardNumber"
cat_award_acct.cust_
card_nbr
cat_award_acct_
coupon.cust_card_nbr
4. Account Id (PK) String 60  Unique ID of this award

account.
"AccountId"
cat_award_acct.acct_id
cat_award_acct_
coupon.acct_id
5. Coupon Id String 60  Unique ID of this award

coupon.
"CouponId"
cat_award_acct_
coupon.coupon_id
6. Amount Decimal 17,6 Current monetary balance for

this award coupon.
"Amount"
cat_award_acct_
coupon.amount
7. Expiration Date DateTime 23 Date after which this coupon

may no longer be redeemed.
"Expiration
Date" cat_award_acct_
coupon.expiration_date

Customer Account Note Record (CUST_ACCT_NOTE)

Contains narrative String comments about a customer's account.
cat_acct_note All Fields CustomerAccountNote
Name Comment

Record”.
2. Record Identifier String 30  “CUST_ACCT_NOTE”
3. Customer String 30  An identifier for a type of

Account Code customer account. Valid
(PK) Values:
ACCOUNTS_RECEIVABLE,
"custAccount
CREDIT_PAYMENT,
Code"
LAYAWAY, LOYALTY,
SEND_SALE,
SPECIAL_ORDER,
WORK_ORDER
cat_acct_note.cust_
acct_code

Account Id (PK) customer account; generally
assigned by the home office.
"custAccountId"
Must be unique within the
Customer Account Code.
cat_acct_note.cust_
acct_id
5. Note Sequence Integer  The order in which the notes

(PK) were created for an account.
"noteSequence" cat_acct_note.note_seq
6. Entry DateTime 23 The date and time the note

Timestamp was created.
"entry cat_acct_note.entry_
Timestamp" timestamp
7. Entry Party Id BigInt The party identifier for the

user who created the note.
"entryPartyId"
cat_acct_note.entry_
party_id

"note" cat_acct_note.note

Customer Account Plan Record (CUST_ACCT_PLAN)

Contains information about a plan used in association with an account.
cat_cust_acct_plan All Fields CustomerAccountPlan
Customer Account Plan Record (CUST_ACCT_PLAN) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CUST_ACCT_PLAN”
3. Customer String 30  A unique identifier for a type

Account Code of customer account. (For
(PK) example, same as the tndr_id:
PRIVATE_LABEL)
"custAccount
Code" cat_cust_acct_plan.
cust_acct_code
must exist.
5. Plan Id (PK) String 30  A unique identifier for an

account plan. This number
"planId"
will be sent in auth requests
and stored on the line item.
cat_cust_acct_plan.
plan_id
6. Plan Description String 255 A text description of the type

of account plan. This text will
"plan
be displayed on the plan
Description"
selection list.
cat_cust_acct_plan.
plan_description
7. Effective Date DateTime 23 The date the account plan is

ready for service or action.
"effectiveDate"
cat_cust_acct_plan.
effective_date
8. Expiration Date DateTime 23 The date and time the user can
no longer use the account
"expiration
plan.
Date"
cat_cust_acct_plan.
expiration_date

Customer Account Plan Record (CUST_ACCT_PLAN) (Sheet 2 of 2)
Name Comment
9. Display Order Integer Indicates the order in which

the account plans are
"displayOrder"
cat_cust_acct_plan.
display_order

code.
"OrgCode"
default="*"
cat_cust_acct_plan.
org_code

"OrgValue"
default="*"
cat_cust_acct_plan.
org_value

Warranty Item Record (WARRANTY_ITEM)

A non-merchandise item representing a warranty that can be sold to customers.
itm_item 3- 55, 70-75, 81-83 Item
itm_non_phys_item 3, 56-59 NonPhysicalItem
itm_warranty_item 3, 62-69 WarrantyItem
Warranty Item Record (WARRANTY_ITEM) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “WARRANTY_ITEM”
<Field literal="WARRANTY" name="ItemTypeCode" />

3-55. See “Item Record (ITEM)” for detailed field information about fields 3-55, 70-75, and 81-83.
56-59. See “Non-Physical Item Record (NON_PHYSICAL_ITEM)” for detailed field information.
must exist.
must exist.

Name Comment
62. Pricing Method String 60  Identifies the manner by

Code which the warranty will be
priced, either amount or
"PricingMethod
percentage. The following
Code"
values are fixed:
FIXED_REGULAR - A price
type for warranty plans whose
price is either a fixed amount
or a fixed percentage of the
regular/retail price of the item
to which they are applied.
FIXED_EXTENDED -A price
price is either a fixed amount
or a fixed percentage of the
extended/transactional price
of the item to which they are
applied.
TIERED_REGULAR - A price
price is tiered according to
ranges containing the regular/
retail price of the item to
which they are applied.
TIERED_EXTENDED - A price
price is tiered according to
ranges containing the
extended/transactional price
of the item to which they are
applied.
itm_warranty_item.
pricing_mthd_code
63. Warranty Price Decimal 17,6 The fixed amount to charge

Amount for this warranty item; only
used when
"WarrantyPrice
"PricingMethodCode" is
Amt"
FIXED_REGULAR, or
FIXED_EXTENDED
itm_warranty_item.
warranty_price_amt
64. Warranty Price Decimal 17,6 The percentage of covered

Percentage merchandise item’s price to
charge for this warranty item;
"WarrantyPrice
only used when
Percentage"
"PricingMethodCode" is
FIXED_REGULAR, or
FIXED_EXTENDED
itm_warranty_item.
warranty_price_percentage

Name Comment
65. Warranty Decimal 17,6 The minimum price required

Minimum Price for an item to be valid for the
Amount warranty.
"WarrantyMin itm_warranty_item.
PriceAmt" warranty_min_price_amt
66. Expiration Days Integer The number of days for which

the warranty is valid.
"Expiration
Days" itm_warranty_item.
expiration_days
67. Service Days Integer The number of service days

covered by the warranty plan.
"ServiceDays"
itm_warranty_item.
service_days
must exist.
69. Renewable Flag Boolean 5 If true, the warranty can be

renewed.
"Renewable"
itm_warranty_item.
renewable_flag
70-75, See “Item Record (ITEM)” for detailed information about fields 70-75, and 81.
81

code.
"OrgCode"
default="*"
itm_item.org_code

"OrgValue"
default="*"
itm_item.org_value

Warranty Item Price Record (WARRANTY_ITEM_PRICE)

Contains item warranty pricing information. This is the “tiered” pricing record for
warranty items having a PricingMethodCode of either TIERED_REGULAR or
TIERED_EXTENDED. This allows for finer-grained control over the price of a given
warranty item than does WARRANTY_ITEM by allowing for separate amounts or
percentages to be applied. The amounts or percentages are based on an arbitrary number
of price ranges associated with the merchandise items being covered. Additionally, it
allows an entirely different SKU to be applied to the warranty line item added to a
transaction, based on the range used to derive that line item’s price.
itm_warranty_item_price All Fields WarrantyItemPrice
Warranty Item Price Record (WARRANTY_ITEM_PRICE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “WARRANTY_ITEM_PRICE”
3. Item ID (PK) String 60  Unique identifier for a

warranty item.
"ItemId"
itm_warranty_item_price.
item_id
4. Warranty Price Integer  The sequence order in which

Sequence (PK) the warranty price should be
determined.
"WarrantyPrice
Seq" itm_warranty_item_price.
warranty_price_seq
5. Minimum Item Decimal 17,6 The minimum allowable price

Price Amount for an item to be eligible for
this warranty.
"MinItemPrice
Amt" itm_warranty_item_price.
min_item_price_amt
6. Maximum Item Decimal 17,6 The maximum allowable price

Price Amount for an item to be eligible for
this warranty.
"MaxItemPrice
Amt" itm_warranty_item_price.
max_item_price_amt
7. Price Amount Decimal 17,6 The cost of this warranty.

"PriceAmt" itm_warranty_item_price.
price_amt

Warranty Item Price Record (WARRANTY_ITEM_PRICE) (Sheet 2 of 2)
Name Comment
8. Price Percentage Decimal 6,4 The percentage of the cost of

an item that will be used as
"Price
the price for this warranty.
Percentage"
price_percentage
9. Minimum Price Decimal 17,6 When configured by

Amount percentage, the minimum
amount for this warranty item.
"MinPriceAmt"
min_price_amt
10. Reference Item String 60 The item ID to which this

ID warranty is associated.
"RefItemId" SKUs referenced in
"RefItemId" and not
matching the "ItemId" value
must represent SKUs that are
also fully configured as
warranty items.
(The sole exception is that
“referenced” warranty items
need not appear in any
itm_warranty_item_xref
rows (in that table’s
warranty_item_id column);
only the “root” warranty items
from which “referenced”
warranty items are derived are
subject to that requirement.)
ref_item_id

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value

Warranty Item Cross-Reference Record (WARRANTY_ITEM_XREF)
Warranty Item Cross-Reference Record

(WARRANTY_ITEM_XREF)
Contains the information used to designate the items that a warranty can be applied to.
itm_warranty_item_xref All Fields WarrantyItemCrossReference
Warranty Item Cross-Reference Record (WARRANTY_ITEM_XREF)
Name Comment

Record”.
2. Record Identifier String 30  “WARRANTY_ITEM_XREF”
3. Item ID (PK) String 60  Merchandise item ID.

"ItemId" itm_warranty_item_xref.
item_id
4. Warranty Item String 60  Unique identifier for a

ID (PK) warranty.
"WarrantyItem itm_warranty_item_xref.
Id" warranty_item_id
5. Warranty Type String 60  Identifier for a type of

Code (PK) warranty. (WARRANTY)
"WarrantyType itm_warranty_item_xref.
Code" warranty_typcode

a list is sorted.
"SortOrder"
itm_warranty_item_xref.
sort_order

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value

Warranty Record (WARRANTY)

Normally populated by Xstore in the course of persisting transactions involving
warranties. A single row is maintained for each warranty issued as part of a sale.
itm_warranty All Fields Warranty
Warranty Record (WARRANTY) (Sheet 1 of 6)
Name Comment

Record”.
2. Record Identifier String 30  “WARRANTY”
3. Warranty Type String 60  A code to signify the type of

Code (PK) warranty plan. (From
itm_non_phys_item.
"warrantyType
non_phys_item_typcode)
Code"
itm_warranty.warranty_
typcode
4. Warranty String 30  The warranty identifier

Number (PK) number.
"warrantyNbr" itm_warranty.warranty_
nbr
5. Warranty Plan Id String 60 The identifier naming the

warranty's plan. The plan ID is
"warrantyPlanId
assigned when issued and
Dao"
never changes in the life cycle
of a warranty. (From
itm_warranty_item.item_id)
plan_id
6. Warranty Issue DateTime 23 The date and time on which

Date the warranty was issued.
"warrantyIssue itm_warranty.warranty_
Date" issue_date
7. Warranty DateTime 23 The date and time on which

Expiration Date the warranty's coverage
expires. This warranty will no
"warranty
longer be accepted for return
ExpirationDate"
or as work order coverage.
expiration_date

Name Comment
8. Status Code String 30 A code to indicate the status of

the warranty plan. (OPEN,
"statusCode"
CLOSED, PENDING)
itm_warranty.status_
code
9. Purchase Price Decimal 17, 6 The price paid for the

warranty when issued.
"purchasePrice"
itm_warranty.purchase_
price
10. Customer Id String 60 A unique identifier for the

customer who owns the
"customerId"
warranty. (crm_party.cust_id
associated with this warranty’s
owner)
itm_warranty.cust_id
11. Party Id BigInt A unique identifier for the

party which owns the
"partyIdDao"
warranty. (crm_party.party_id
associated with this warranty’s
owner)
itm_warranty.party_id
12. Certificate String 60 The certificate number

Number assigned to a warranty plan.
"certificate itm_warranty.certificate_nbr
Nbr"
13. Certificate String 254 The name of the vendor/

Company Name company associated with the
warranty and for which the
"certificate
certificate number is relevant.
CompanyName"
itm_warranty.certificate_comp
any_name
14. Warranty Item Id String 60 The identifier naming the

warranty's transactional item.
"warrantyItemId
The warranty item is initially
Dao"
the same as the warranty plan
but may change in response to
SKU-based price adjustments.
(From
itm_warranty_item_price.ref_i
tem_id where appropriate and
non-null; same as
warranty_plan_id otherwise.)
item_id

Name Comment
15. Warranty Line DateTime 23 The calendar date of the

Business Date transaction in which the line
item representing the
"warrantyLine
warranty was created. (From
BusinessDate
trl_rtrans_lineitm.business_
Dao"
date for the warranty line item
representing the issuance of
this warranty.)
line_business_date
16. Warranty Line Integer A unique, retailer-assigned

Retail Location identifier naming the store in
Id which the line item
representing the warranty was
"warrantyLine
created. (From
RtlLocIdDao"
trl_rtrans_lineitm.rtl_loc_id
for the warranty line item
this warranty.)
line_rtl_loc_id
17. Warranty Line BigInt A store-level unique identifier

Workstation Id naming the workstation on
which the line item
"warrantyLine
WkstnIdDao"
created. (From
trl_rtrans_lineitm.wkstn_id for
the warranty line item
this warranty.)
line_wkstn_id
18. Warranty Line BigInt Within the context of a

Transaction business date and
Sequence workstation, a unique, non-
significant, automatically
"warrantyLine
assigned sequential number
TransSeq"
used to identify the
transaction in which the line
item representing the
warranty was created. (From
trl_rtrans_lineitm.trans_seq
for the warranty line item
this warranty.)
line_trans_seq

Name Comment
19. Warranty Line Integer Within the context of a

Transaction Line transaction, a unique, non-
Item Sequence significant, automatically
"warrantyLine
used to identify the line item
TransLineItem
representing the warranty.
SeqDao"
(From
trl_rtrans_lineitm.rtrans_
lineitm_seq for the warranty
line item representing the
issuance of this warranty.)
rtrans_lineitm_seq
20. Covered Item Id String 60 The identifier naming the

covered merchandise's
"coveredItemId
transactional item. (From
Dao"
itm_item.item_id for the
merchandise item covered by
this warranty.)
itm_warranty.covered_
item_id
21. Covered Line DateTime 23 The calendar date of the

Business Date transaction in which the line
item representing the covered
"coveredLine
merchandise was created.
BusinessDate
(From
Dao"
trl_rtrans_lineitm.business_
date for the merchandise line
item covered by this
warranty.)
line_business_date
22. Covered Line Integer A unique, retailer-assigned

Retail Location identifier naming the store in
Id which the line item
"coveredLine
created. (From
RtlLocIdDao"
for the merchandise line item
covered by this warranty.)
line_rtl_loc_id

Name Comment
23. Covered Line BigInt A store-level unique identifier

Workstation Id naming the workstation on
which the line item
"coveredLine
representing the covered
WkstnIdDao"
(From
trl_rtrans_lineitm.wkstn_id for
the line item covered by this
warranty.)
line_wkstn_id
24. Covered Line BigInt Within the context of a

Transaction business date and
Sequence workstation, a unique, non-
significant, automatically
"coveredLine
TransSeqDao"
used to identify the
transaction in which the line
item representing the covered
(From
for the merchandise line item
covered by this warranty.)
line_trans_seq
25. Covered Line Integer Within the context of a

Transaction Line transaction, a unique, non-
Item Sequence significant, automatically
"coveredLine
used to identify the line item
TransLineItem
representing the covered
Seq"
merchandise. (From
trl_rtrans_lineitm.rtrans_
lineitm_seq for the
merchandise line item covered
by this warranty.)
rtrans_lineitm_seq
26. Covered Item DateTime 23 Date the warranted item was

Purchase Date purchased.
"coveredItem itm_warranty.covered_
PurchaseDate" item_purchase_date
27. Covered Item Decimal 17, 6 Price paid for the warranted
Purchase Price item at time of purchase.
"coveredItem itm_warranty.covered_
PurchasePrice" item_purchase_price

Name Comment
28. Covered Item String 254 Store location where the

Purchase warranted item was
Location purchased. (e.g. a store
number or 'OnLine', 'Catalog',
"coveredItem
etc.)
Purchase
Location" itm_warranty.covered_
item_purchase_location

code.
"OrgCode"
default="*"
itm_warranty.org_code

"OrgValue"
default="*"
itm_warranty.org_value

Warranty Property (WARRANTY_PROPERTY)
Warranty Property (WARRANTY_PROPERTY)

Contains the property information for warranties.
itm_warranty_p All Fields WarrantyProperty
Warranty Property Record (WARRANTY_PROPERTY)
Name Comment

Record”.
2. Record Identifier String 30  “WARRANTY_PROPERTY”
3. Warranty String 30  Identifier for the warranty.

Number (PK)
itm_warranty_p.
“WarrantyNbr” warranty_nbr
4. Warranty Type String 60  Type code for the warranty.

Code (PK)
itm_warranty_p.
“WarrantyType warranty_typcode
Code”

component in
"propertyCode"
itm_kit_component.
itm_warranty_p.
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
itm_warranty_p.type

Type=STRING
“StringValue”
itm_warranty_p.
string_value

Type=DATE
“DateValue”
itm_warranty_p.
date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
itm_warranty_p.
decimal_value

Escrow Account Record (ESCROW_ACCT)

Contains information about an escrow account a customer has with the store or
enterprise. An escrow account exists to allow the store to maintain an ongoing record of
monies due to the customer for cancelled customer accounts for which payments have
been made (special orders, layaways).
cat_escrow_acct All Fields EscrowAccount
Escrow Account Record (ESCROW_ACCT) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “ESCROW_ACCT”

Account Id (PK) customer account. Must be
unique within the Customer
"custAccountId"
Account Code. Account
identifier is "E" + customer
number.
cat_escrow_acct.
cust_acct_id
4. Account Balance Decimal 17,6 Total escrow account balance.

"account cat_escrow_acct.
Balance" acct_balance
5. Customer String 30 A code denoting the status of

Account State the customer account. Valid
Code Values: ABANDONED,
CLOSED, DELINQUENT,
"custAccount
IN_PROGRESS, INACTIVE,
StateCode"
NEW, OPEN, OVERDUE,
PENDING,
READY_TO_PICKUP,
REFUNDABLE
cat_escrow_acct.
cust_acct_statcode
6. Account Setup DateTime 23 The date and time the account

Date was set up.
"accountSetup cat_escrow_acct.
Date" acct_setup_date
7. Last Activity DateTime 23 The date and time of the last

Date activity on the account.
"lastActivity cat_escrow_acct.
Date" last_activity_date

Escrow Account Record (ESCROW_ACCT) (Sheet 2 of 2)
Name Comment
8. Party Id BigInt Party identifier of the user for

the account. Represents a
"partyId"
customer, business, employee,
etc. in the system.
cat_escrow_acct.
party_id

9
Work Orders
Customer Work Order Task Record (CWO_TASK)

Contains information for the work order tasks. Work order tasks are non-merchandise
items which represent the work being performed on another item (i.e., alteration, repair,
cleaning) in the Xstore Work Order module.
itm_item 3- 55, 70-72, 81 Item
itm_non_phys_item 3, 56-59 NonPhysicalItem
cwo_task 3, 62-63, 81-83 Task
Customer Work Order Task Record (CWO_TASK) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CWO_TASK”
<Field literal="WORK_ORDER" name="ItemTypeCode" />

3-55. See “Item Record (ITEM)” for detailed field information.
56-59. See “Non-Physical Item Record (NON_PHYSICAL_ITEM)” for detailed field information.
must exist.
must exist.
62. Category Id String 60 The identifier for the work

order category. (For example,
"CategoryId"
WATCH_REPAIR, JEWELRY,
etc.)
cwo_task.category_id
Work Orders 9-1

Customer Work Order Task Record (CWO_TASK)
Customer Work Order Task Record (CWO_TASK) (Sheet 2 of 2)
Name Comment
63. Price Type String 30 A code for the type of pricing

associated with the work
"PriceType"
order category; ACTUAL,
ESTIMATE.
cwo_task.price_type_
enum
70-72, See “Item Record (ITEM)” for detailed information about fields 70-72, 81.
81

code.
"OrgCode"
default="*"
cwo_task.org_code

"OrgValue"
default="*"
cwo_task.org_value

Customer Work Order Category Record (CWO_CATEGORY)

Allows for tasks to be classified into categories.
cwo_work_order_category All Fields WorkOrderCategory
Customer Work Order Category Record (CWO_CATEGORY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CWO_CATEGORY”
3. Category Id (PK) String 60  The identifier for the work

"CategoryId"
WATCH_REPAIR, JEWELRY,
etc.)
cwo_work_order_
category.category_id

the work order category list is
"SortOrder"
sorted.
cwo_work_order_
category.sort_order
5. Description String 254 The text description of the

work order category.
"Description"
cwo_work_order_
category.description
6. Prompt For Price Boolean 5 If true, prompt for a price for

Code Flag this work order category.
"PromptFor cwo_work_order_
PriceCode" category.prompt_for_price_co
de_
flag
7. Maximum Item Decimal 11,4 The maximum number of

Count items that can be added to a
work order account.
"MaxItemCount"
cwo_work_order_
category.max_item_count

code.
"OrgCode"
default="*"
cwo_work_order_
category.org_code
Work Orders 9-3

Customer Work Order Category Record (CWO_CATEGORY) (Sheet 2 of 2)
Name Comment

"OrgValue"
default="*"
cwo_work_order_
category.org_value

Customer Work Order Service Location Record (CWO_SERVICE_LOCATION)
Customer Work Order Service Location Record

(CWO_SERVICE_LOCATION)
Contains information about the service location where the work order task is performed.
cwo_service_loc All Fields ServiceLocation
Customer Work Order Service Location Record (CWO_SERVICE_LOCATION)
Name Comment

Record”.
2. Record Identifier String 30  “CWO_SERVICE_LOCATION

”
must exist.
4. Service Location String 60  The identifier for the work

Id (PK) order service location.
"Service cwo_service_loc.service_
LocationId" loc_id
5. Service Location String 254 The text description for the

Description service location.
"ServiceLoc cwo_service_loc.
Description" description
6. Party Id BigInt A unique identity for an

individual or firm that
"PartyId"
exchanges information and/or
goods and services with the
store.
cwo_service_loc.party_id
7. Address Id String 60 The identifier for the service

location address.
"AddressId"
cwo_service_loc.address_id

code.
"OrgCode"
default="*"
cwo_service_loc.org_code

"OrgValue"
default="*"
cwo_service_loc.
org_value
Work Orders 9-5

Customer Work Order Price Code Record (CWO_PRICE_CODE)
Customer Work Order Price Code Record

(CWO_PRICE_CODE)
Defines price codes that may be used to assign multiple prices to a single work order
task. For example, the same repair task may have multiple prices based on the warranty
purchased.
cwo_price_code All Fields WorkOrderPriceCode
Customer Work Order Price Code Record (CWO_PRICE_CODE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CWO_PRICE_CODE”
3. Price Code (PK) String 30  The code denoting the pricing

for the work order account.
"PriceCode"
(For example, CHARGEABLE,
NO_CHARGE,
FULL_WARRANTY,
PARTIAL_WARRANTY)
cwo_price_code.price_
code

a list is sorted.
"SortOrder"
cwo_price_code.sort_
order

price code.
"Description"
cwo_price_code.
description
6. Prompt For Boolean 5 If true, prompt for a warranty

Warranty number for this price code.
Number Flag
cwo_price_code.prompt_
"PromptFor for_warranty_nbr_flag
WarrantyNumbe
r"

code.
"OrgCode"
default="*"
cwo_price_code.org_code

Customer Work Order Price Code Record (CWO_PRICE_CODE)
Customer Work Order Price Code Record (CWO_PRICE_CODE) (Sheet 2 of 2)
Name Comment

"OrgValue"
default="*"
cwo_price_code.
org_value
Work Orders 9-7

Customer Work Order Pricing Record (CWO_PRICING)

Assigns a price to a work order task for each price code.
cwo_work_order_pricing All Fields WorkOrderPricing
Name Comment

Record”.
2. Record Identifier String 30  “CWO_PRICING”
must exist.
4. Price Code (PK) String 30  The code denoting the pricing

for the work order account.
"PriceCode"
(For example, CHARGEABLE,
NO_CHARGE,
FULL_WARRANTY,
PARTIAL_WARRANTY)
cwo_work_order_pricing.
price_code

item identifier for the work
"ItemId"
order item/task.
item_id
6. Price Decimal 17,6 The dollar amount associated

with the price code item ID.
"Price"
price

code.
"OrgCode"
default="*"
org_code

"OrgValue"
default="*"
org_value


(CWO_CATEGORY_SERVICE_LOCATION)
Contains the service destination, shipping requirement, and lead time information based
on the work order category.
cwo_category_service_loc All Fields CategoryServiceLocation

(CWO_CATEGORY_SERVICE_LOCATION) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “CWO_CATEGORY_

SERVICE_LOCATION”
must exist.
4. Category Id (PK) String 60  The identifier for the work

"categoryId"
WATCH_REPAIR)
cwo_category_service_
loc.category_id
5. Service Location String 60  The identifier for the work

Id (PK) order service location.
"service cwo_category_service_
LocationId" loc.service_loc_id
6. Lead Time Decimal 11,4 The number of lead time units

Quantity required.
"leadTime cwo_category_service_
Quantity" loc.lead_time_qty
7. Lead Time Unit String 30 The time interval relating to

the lead time quantity. (For
"leadTimeUnit"
example, DAY, WEEK,
MONTH)
loc.lead_time_unit_enum
8. Create Shipment Boolean 5 If true, a shipper is created

Flag automatically for this category.
"create cwo_category_service_
Shipment" loc.create_shipment_flag
Work Orders 9-9


(CWO_CATEGORY_SERVICE_LOCATION) (Sheet 2 of 2)
Name Comment

code.
"OrgCode"
default="*"
loc.org_code

"OrgValue"
default="*"
loc.org_value

10
Tenders, Vouchers, & Till Sessions
Tender Record (TENDER)

Contains information about all the forms of payment that are accepted by the retail store
for settling sales and other transactions.
tnd_tndr 3, 4, 10, 16, 46-48 Tender
tnd_tndr_options 3, 7-9, 11, 12, 15, 17-19, 21-40, 42-45, 49 TenderOptions
Tender Record (TENDER) (Sheet 1 of 8)
Name Comment

Record”.
2. Record Identifier String 30  “TENDER”
3. Tender Id (PK) String 60  A code which uniquely

identifies the type of tender.
"TenderId"
tnd_tndr.tndr_id
tnd_tndr_options.tndr_id
4. Tender Typecode String 30 A code denoting a group of

tenders with common
"Tender
characteristics.
Typecode"
tnd_tndr.tndr_typcode
must exist.
must exist.
Tenders, Vouchers, & Till Sessions 10-1

Name Comment
7. Auth Expiration Boolean 5 If true, this type of tender

Date Required requires an authorization
Flag expiration date and it must be
recorded at the time of
"AuthExpiration
settlement. Used to enable
Date
expiration date prompting for
Required"
a major credit tender.
tnd_tndr_options.auth_expr_d
ate_req_flag
8. Auth Method String 30 A code that signifies the

Code authorization method. For
example, checks may be
"AuthMethod
authorized by either a third
Code"
party or by validation against
the customer's drivers license.
(If non-null and the
auth_req_flag is true, then an
authorization is performed
using the settings in
AuthConfig.xml for the
auth_mthd_code.)
tnd_tndr_options.auth_mthd_
code
9. Auth Required Boolean 5 If true, authorization is

Flag required before a specific
tender can be accepted.
"AuthRequired"
tnd_tndr_options.auth_req_fla
g
10. Currency Id String 3  The three-letter ISO currency

"CurrencyId"
etc.
tnd_tndr.currency_id
11. Customer Boolean 5 If true, a customer must be

Association Flag associated with this tender
type.
"Cust
Association" tnd_tndr_options.cust_associa
tion_flag
12. Customer String 30 A code denoting the type of

Identification customer identification
Required Code required. (For example,
DRIVER_LICENSE,
"CustIdReqCode
EMPLOYEE_ID, etc.)
"
tnd_tndr_options.cust_id_req_
code
must exist.
must exist.

Name Comment
15. Customer Boolean 5 If true, the customer must sign

Signature the tender (check) or resultant
Required Flag voucher in the presence of the
employee. Used to enable
"Customer
capturing a signature for a
Signature
credit card (if signature
Required"
capture device is available) or
print a signature line on the
store copy of the receipt (Note:
receipt configuration could
override this.)
tnd_tndr_options.cust_sig_req
_flag

tender type.
"Description"
tnd_tndr.description
17. Default To Boolean 5 If true, the amount due from

Amount Due the customer is shown as a
Flag default value in the focusbar
at tendering.
"DfltToAmount
Due" tnd_tndr_options.dflt_to_amt_
due_flag
18. Endorsement Boolean 5 If true, an endorsement,

Required Flag normally the customer's
signature, is required before a
"Endorsement
specific tender type can be
Required"
accepted. Used to enable
franking a check or voucher.
(gift certificate, store credit,
etc.)
tnd_tndr_options.endorsemen
t_req_flag
19. Include In Type Boolean 5 If true, the tender will be

Count Flag counted as part of its tender
category grouping. If false, the
"IncludeInType
tender will be counted
Count"
separately. (For example, if
Visa, MasterCard, and
Discover were all marked to
be included in a type count
(true), then they would be
counted as a group under the
“Credit Card” tender
category.)
tnd_tndr_options.include_in_t
ype_count_flag
must exist.

Name Comment
21. Magnetic Swipe Boolean 5 If true, the tender type must

Reader Required be inserted into the magnetic
Flag card reader. For example,
credit and debit cards. Used
"MagneticSwipe
with debit cards to disallow
ReaderRequired"
manual entry of the card
number.
tnd_tndr_options.mag_swipe_
reader_req_flag
22. Max Days For Integer The maximum number of

Return days allowed for return of an
item to use this tender type for
"MaxDaysFor
refund. For example, allow a
Return"
credit card refund for a return
within 30 days, but store
credit only after that.
tnd_tndr_options.max_days_f
or_return
23. Min Days For Integer The minimum number of days

Return allowed for return of an item
to use this tender type for
"MinDaysFor
refund.
Return"
tnd_tndr_options.min_days_f
or_return
24. Minimum Decimal 17, 6 The minimum denomination

Denomination amount accepted for this
Amount tender type.
"Minimum tnd_tndr_options.min_denomi
Denomination nation_amt
Amount"
25. Open Cash Boolean 5 If true, the cash drawer opens

Drawer when a specific tender type is
Required Flag offered by the customer. For
example, cash.
"OpenCashDraw
erRequired" tnd_tndr_options.open_cash_
drawer_req_flag
26. Pin Required Boolean 5 If true, the customer must

Flag enter a personal identification
number (PIN) to validate the
"PinRequired"
method of payment. PINs are
normally required for debit
card payments.
tnd_tndr_options.pin_req_flag

Name Comment
27. Populate System Boolean 5 If true, the system counts the

Count Flag tender automatically to
populate the system tender.
"PopulateSystem
Exists in both the tender table
Count"
and tender type code table for
till counting purposes. Which
table is used depends on
whether the system is
configured to count by tender
level or by tender type level.
tnd_tndr_options.populate_sy
stem_count_flag
28. Serial Boolean 5 If true, the serial number of

Identification the tender type must be
Number captured as part of the tender
Required Flag process. Examples include gift
certificates, checks, etc.
"Serial
Identification tnd_tndr_options.serial_id_nb
NbrRequired" r_req_flag
29. Unit Count String 30 A code that signifies the unit

Required Code count type that must be
counted and recorded by the
"UnitCountCode
employee prior to a pickup.
"
(For example,
TOTAL_NORMAL,
DENOMINATION,
TOTAL_SHORT, etc.)
tnd_tndr_options.unit_count_
req_code
30. Suggest Deposit Boolean 5 When true, the user will be

Flag prompted to deposit excess
tender based on the
"Suggest
suggested_deposit_threshold.
Deposit"
tnd_tndr_options.suggest_dep
osit_flag
31. Suggested Decimal 17, 6 The amount after which the

Deposit user should be prompted to
Threshold deposit excess tender. Used to
enable prompts for drawer
"Suggested
pulls when the drawer
Deposit
amount is above this
Threshold"
configured amount.
tnd_tndr_options.suggested_d
eposit_threshold
32. Cash Change Decimal 17, 6 The maximum amount of cash

Limit that can given as change when
this tender is used as payment.
"CashChange
Limit" tnd_tndr_options.cash_change
_limit

Name Comment
33. Change Tender String 60 The id of the tender to be used

Id as change after the cash
change limit has been reached.
"ChangeTender
Id" ISSUE_STORE_CREDIT,
LOCAL_CURRENCY,
ISSUE_XPAY_GIFT_CARD,
etc.
tnd_tndr_options.change_tndr
_id
34. Overtender Boolean 5 If true, the over tender limit

Overridable flag can be overridden.
"Overtender tnd_tndr_options.over_tender
Overridable" _overridable_flag
35. Non Voidable Boolean 5 If true, this tender type cannot

Flag be voided. Used for “draft
capture” tenders like debit
"NonVoidable"
that do not allow reversals.
tnd_tndr_options.non_voidabl
e_flag
36. Close Count Decimal 17, 6 The close count discrepancy

Discrepancy threshold.
Threshold
tnd_tndr_options.close_count_
"CloseCount disc_threshold
Discrepancy
Threshold"
37. Cid Msr Boolean 5 If true, the card ID is required

Required Flag when this card is swiped.
Used to prompt for a credit
"CidMsr
card's CID/CVN/CVV when
Required"
the credit card is read
electronically. The CID is
available to the authorization
process, but is not saved
anywhere except the
encrypted version of
authorization log (auth.enc).
tnd_tndr_options.cid_msr_req
_flag
38. Cid Keyed Boolean 5 If true, the card ID is required

Required Flag when this card is keyed into
the system manually. Used to
"CidKeyed
prompt for a credit card's CID/
Required"
CVN/CVV when the credit
card number is keyed.
tnd_tndr_options.cid_keyed_r
eq_flag

Name Comment
39. Postal Required Boolean 5 If true, a postal code must be

Flag associated with this tender.
Used to prompt for the
"Postal
customer postal code with
Required"
certain credit cards.
Additional code is required
for each authorization engine
to pass the information in
authorization request.
tnd_tndr_options.postal_code
_req_flag
40. Disallow Split Boolean 5 When true, this tender cannot

Tender Flag be used if there are tenders in
the current transaction. Also,
"DisallowSplit
the tender amount entered
Tender"
cannot be less than what is
due on the transaction.
tnd_tndr_options.disallow_spl
it_tndr_flag
41. Not currently used.
42. Post Void Open Boolean 5 If true, open the cash drawer
Cash Drawer each time a post void is
Required Flag performed using this tender.
"PostVoidOpen tnd_tndr_options.post_void_o
CashDrawer pen_drawer_flag
Required"
43. Effective Date DateTime 23 The date the tender is ready

for service or action.
"EffectiveDate"
default=”1970-01-01 00:00:00”
tnd_tndr_options.effective_dat
e
44. Expiration Date DateTime 23 The date when the tender can
no longer be accepted for
"Expiration
service or action.
Date"
default=”3000-01-01 00:00:00”
tnd_tndr_options.expr_date
45. Reporting Group String 30 A code denoting a group of

tenders with common
"Reporting
characteristics that belong to a
Group"
reporting group. For example,
FOREIGN CURRENCY,
TENDER SUMMARY, etc.
tnd_tndr_options.reporting_gr
oup

Name Comment
46. Display Order Integer Indicates the order in which

the tender types are displayed
"DisplayOrder"
in the tender list.
tnd_tndr.display_order
47. Disabled Flag Boolean 5 When set to true, the tender is

disabled.
"Disabled"
tnd_tndr.disabled_flag
48. Flash Sales Integer Represents the order in which

Display Order the tender appears in the
report.
“FlashSalesDispl
ayOrder” tnd_tndr.flash_sales_display_
order
<Field literal="*" name="ConfigElement" />
49. Change Allowed Boolean 5 If true, the tender can be given

When Foreign as change when it is used as a
foreign currency
“ChangeAllowe
dWhenForeign” tnd_tndr_options.change_
allowed_when_foreign
50. AssignCash Boolean 5 If true, a tendering session

DrawerRequired assigned to the networked
cash drawer should be
“AssignCash
assigned to the transaction
Drawer
when this tender is selected,
Required”
even though the cash drawer
may not be required to open.
tnd_tndr_options.assign_
cash_drawer_req_flag
51. PostVoidAssign Boolean 5 If true, a tendering session

CashDrawer assigned to the networked
Required cash drawer should be
assigned to the post void
“PostVoidAssign
CashDrawer
Required”
tnd_tndr_options.post_void_
assign_drawer_flag

Tender Availability Record (TENDER_AVAILABILITY)

Contains information about the availability of a tender type.
tnd_tndr_availability All Fields TenderAvailability
Name Comment

Record”.
2. Record Identifier String 30  “TENDER_AVAILABILITY”

"TenderId"
USD_CURRENCY,
CAD_CURRENCY,
PAYROLL_CHECK,
ACCOUNT_CREDIT,
DEBIT_CARD,
GIFT_CERTIFICATE,
AMERICAN_EXPRESS,
MASTERCARD, etc.
tnd_tndr_availability.
tndr_id
4. Availability String 30  A code to signify the

Code (PK) availability of the tender. Valid
Values include, but are not
"Availability
limited to:
Code"
CHANGE
EXCHANGE
RETURN_WITHOUT_RECEIP
T
RETURN_WITH_RECEIPT
SALE
VOID
tnd_tndr_availability.
availability_code

Tender Denomination Record (TENDER_DENOMINATION)

Specifies the quantitative value of the referenced currency media.
tnd_tndr_denomination All Fields TenderDenomination
Tender Denomination Record (TENDER_DENOMINATION) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “TENDER_DENOMINATION

”

"TenderId"
For example,
USD_CURRENCY,
CAD_CURRENCY,
PAYROLL_CHECK,
ACCOUNT_CREDIT,
DEBIT_CARD,
GIFT_CERTIFICATE,
AMERICAN_EXPRESS,
MASTERCARD, etc.
tnd_tndr_denomination.
tndr_id
4. Denomination Id String 60  An identifier which uniquely

(PK) identifies the quantitative
value of a specific currency,
"Denomination
e.g. DOLLAR, 100_EURO,
Id"
DIME, etc.
denomination_id

denomination type, e.g. Dime,
"Description"
Fifty dollar, etc.
description
6. Value Decimal 17, 6 The numerical quantity that is

assigned to the denomination.
"Value"
For example, Dime=0.100000,
Dollar=1.000000, 20
Dollar=20.000000, etc.
value

Tender Denomination Record (TENDER_DENOMINATION) (Sheet 2 of 2)
Name Comment

the list is sorted.
"SortOrder"
sort_order

Tender Options Record (TENDER_OPTIONS)

Contains the tender flags and settings that can be overridden based on a profile group
element.
tnd_tndr_options All Fields TenderOptions
Tender Options Record (TENDER_OPTIONS) (Sheet 1 of 8)
Name Comment

Record”.
2. Record Identifier String 30  “TENDER_OPTIONS”

"TenderId"
tnd_tndr_options.tndr_id
4. Auth Expiration Boolean 5 If true, this type of tender

Date Required requires an authorization
Flag expiration date and it must be
recorded at the time of
"AuthExpiration
settlement. Used to enable
DateRequired"
expiration date prompting for
a major credit tender.
tnd_tndr_options.auth_expr_d
ate_req_flag
5. Auth Method String 30 A code that signifies the

Code authorization method. For
example, checks may be
"AuthMethod
authorized by either a third
Code"
party or by validation against
the customer's drivers license.
(If non-null and the
auth_req_flag is true, then an
authorization is performed
using the settings in
AuthConfig.xml for the
auth_mthd_code.)
tnd_tndr_options.auth_mthd_
code
6. Auth Required Boolean 5 If true, authorization is

Flag required before a specific
tender can be accepted.
"AuthRequired"
tnd_tndr_options.auth_req_fla
g

Name Comment
7. Customer Boolean 5 If true, a customer must be

Association Flag associated with this tender
type.
"CustAssociation
" tnd_tndr_options.cust_associa
tion_flag
8. Customer String 30 A code denoting the type of

Identification customer identification
Required Code required. (For example,
DRIVER_LICENSE,
"CustIdReqCode
EMPLOYEE_ID, etc.)
"
tnd_tndr_options.cust_id_req_
code
9. Customer Boolean 5 If true, the customer must sign

Signature the tender (check) or resultant
Required Flag voucher in the presence of the
employee. Used to enable
"Customer
capturing a signature for a
Signature
credit card (if signature
Required"
capture device is available) or
print a signature line on the
store copy of the receipt (Note:
receipt configuration could
override this.)
tnd_tndr_options.cust_sig_req
_flag
10. Default To Boolean 5 If true, the amount due from

Amount Due the customer is shown as a
Flag default value in the focusbar
at tendering.
"DfltToAmount
Due" tnd_tndr_options.dflt_to_amt_
due_flag
11. Endorsement Boolean 5 If true, an endorsement,

Required Flag normally the customer's
signature, is required before a
"Endorsement
specific tender type can be
Required"
accepted. Used to enable
franking a check or voucher.
(gift certificate, store credit,
etc.)
tnd_tndr_options.endorsemen
t_req_flag

Name Comment
12. Include In Type Boolean 5 If true, the tender will be

Count Flag counted as part of its tender
category grouping. If false, the
"IncludeInType
tender will be counted
Count"
separately. (For example, if
Visa, MasterCard, and
Discover were all marked to
be included in a type count
(true), then they would be
counted as a group under the
“Credit Card” tender
category.)
tnd_tndr_options.include_in_t
ype_count_flag
13. Magnetic Swipe Boolean 5 If true, the tender type must

Reader Required be inserted into the magnetic
Flag card reader. For example,
credit and debit cards. Used
"MagneticSwipe
with debit cards to disallow
ReaderRequired"
manual entry of the card
number.
tnd_tndr_options.mag_swipe_
reader_req_flag
14. Max Days For Integer The maximum number of

Return days allowed for return of an
item to use this tender type for
"MaxDaysFor
refund. For example, allow a
Return"
credit card refund for a return
within 30 days, but store
credit only after that.
tnd_tndr_options.max_days_f
or_return
15. Min Days For Integer The minimum number of days

Return allowed for return of an item
to use this tender type for
"MinDaysFor
refund.
Return"
tnd_tndr_options.min_days_f
or_return
16. Minimum Decimal 17, 6 The minimum denomination

Denomination amount accepted for this
Amount tender type.
"Minimum tnd_tndr_options.min_denomi
Denomination nation_amt
Amount"
17. Open Cash Boolean 5 If true, the cash drawer opens

Drawer when a specific tender type is
Required Flag offered by the customer. For
example, cash.
"OpenCashDraw
erRequired" tnd_tndr_options.open_cash_
drawer_req_flag

Name Comment
18. Pin Required Boolean 5 If true, the customer must

Flag enter a personal identification
number (PIN) to validate the
"PinRequired"
method of payment. PINs are
normally required for debit
card payments.
tnd_tndr_options.pin_req_flag
19. Populate System Boolean 5 If true, the system counts the

Count Flag tender automatically to
populate the system tender.
"PopulateSystem
Exists in both the tender table
Count"
and tender type code table for
till counting purposes. Which
table is used depends on
whether the system is
configured to count by tender
level or by tender type level.
tnd_tndr_options.populate_sy
stem_count_flag
20. Serial Boolean 5 If true, the serial number of

Identification the tender type must be
Number captured as part of the tender
Required Flag process. Examples include gift
certificates, checks, etc.
"Serial
Identification tnd_tndr_options.serial_id_nb
NbrRequired" r_req_flag

"UnitCountCode
"
(For example,
TOTAL_NORMAL,
DENOMINATION,
TOTAL_SHORT, etc.)
tnd_tndr_options.unit_count_
req_code
22. Suggest Deposit Boolean 5 When true, the user will be

Flag prompted to deposit excess
tender based on the
"Suggest
suggested_deposit_threshold.
Deposit"
tnd_tndr_options.suggest_dep
osit_flag

Name Comment
23. Suggested Decimal 17, 6 The amount after which the

Deposit user should be prompted to
Threshold deposit excess tender. Used to
enable prompts for drawer
"Suggested
pulls when the drawer
Deposit
amount is above this
Threshold"
configured amount.
tnd_tndr_options.suggested_d
eposit_threshold
24. Cash Change Decimal 17, 6 The maximum amount of cash

Limit that can given as change when
this tender is used as payment.
"CashChange
Limit" tnd_tndr_options.cash_change
_limit
25. Change Tender String 60 The id of the tender to be used

Id as change after the cash
change limit has been reached.
"ChangeTender
Id" ISSUE_STORE_CREDIT,
LOCAL_CURRENCY,
ISSUE_XPAY_GIFT_CARD,
etc.
tnd_tndr_options.change_tndr
_id
26. Overtender Boolean 5 If true, the over tender limit

Overridable flag can be overridden.
"Overtender tnd_tndr_options.over_tender
Overridable" _overridable_flag
27. Non Voidable Boolean 5 If true, this tender type cannot

Flag be voided. Used for “draft
capture” tenders like debit
"NonVoidable"
that do not allow reversals.
tnd_tndr_options.non_voidabl
e_flag
28. Close Count Decimal 17, 6 The close count discrepancy

Threshold
tnd_tndr_options.close_count_
"CloseCount disc_threshold
Discrepancy
Threshold"

Name Comment
29. Cid Msr Boolean 5 If true, the card ID is required

Required Flag when this card is swiped.
Used to prompt for a credit
"CidMsr
card's CID/CVN/CVV when
Required"
the credit card is read
electronically. The CID is
available to the authorization
process, but is not saved
anywhere except the
encrypted version of
authorization log (auth.enc).
tnd_tndr_options.cid_msr_req
_flag
30. Cid Keyed Boolean 5 If true, the card ID is required

Required Flag when this card is keyed into
the system manually. Used to
"CidKeyed
prompt for a credit card's CID/
Required"
CVN/CVV when the credit
card number is keyed.
tnd_tndr_options.cid_keyed_r
eq_flag
31. Postal Required Boolean 5 If true, a postal code must be

Flag associated with this tender.
Used to prompt for the
"Postal
customer postal code with
Required"
certain credit cards.
Additional code is required
for each authorization engine
to pass the information in
authorization request.
tnd_tndr_options.postal_code
_req_flag
32. Disallow Split Boolean 5 When true, this tender cannot

Tender Flag be used if there are tenders in
the current transaction. Also,
"DisallowSplit
the tender amount entered
Tender"
cannot be less than what is
due on the transaction.
tnd_tndr_options.disallow_spl
it_tndr_flag
33. Post Void Open Boolean 5 If true, open the cash drawer
Cash Drawer each time a post void is
Required Flag performed using this tender.
"PostVoidOpen tnd_tndr_options.post_void_o
CashDrawer pen_drawer_flag
Required"

Name Comment
34. Effective Date DateTime 23 The date the tender is ready

"EffectiveDate"
default=”1970-01-01 00:00:00”
tnd_tndr_options.effective_dat
e
35. Expiration Date DateTime 23 The date when the tender can
no longer be accepted for
"Expiration
service or action.
Date"
default=”3000-01-01 00:00:00”
tnd_tndr_options.expr_date
36. Reporting Group String 30 A code denoting a group of

tenders with common
"Reporting
characteristics that belong to a
Group"
reporting group. For example,
FOREIGN CURRENCY,
TENDER SUMMARY, etc.
tnd_tndr_options.reporting_gr
oup

"ConfigElement"
tnd_tndr_options.config_elem
ent
38. ChangeAllowed Boolean 5 If true, the tender can be given

WhenForeign as change when it is used as a
foreign currency.
"ChangeAllowed
WhenForeign" tnd_tndr_options.change_allo
wed_when_foreign
39. Fiscal Tender ID String 10 Fiscal identifier for the tender.

“FiscalTenderId” tnd_tndr_options.fiscal_tndr_
id
40. Rounding Mode String 254 Determines the rounding

method used on the tender.
“Rounding
Mode” tnd_tndr_options.rounding_
mode

Name Comment
41. AssignCash Boolean 5 If true, a tendering session

DrawerRequired assigned to the networked
cash drawer should be
“AssignCash
assigned to the transaction
Drawer
Required”
tnd_tndr_options.assign_
cash_drawer_req_flag
42. PostVoidAssign Boolean 5 If true, a tendering session

CashDrawer assigned to the networked
Required cash drawer should be
assigned to the post void
“PostVoidAssign
CashDrawer
Required”
tnd_tndr_options.post_void_
assign_drawer_flag

Tender Type Record (TENDER_TYPE)

Contains information about the tender types.
tnd_tndr_typcode All Fields TenderType
Tender Type Record (TENDER_TYPE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “TENDER_TYPE”
3. Tender Typecode String 30  A code denoting a group of

(PK) tenders with common
characteristics. For example,
"Tender
CREDIT_CARD, CHECK,
Typecode"
VOUCHER, etc.
tnd_tndr_typcode.
tndr_typcode

tender type code. For example,
"Description"
Account, Check, Coupon, etc.
tnd_tndr_typcode.
description

a list is sorted.
"SortOrder"
tnd_tndr_typcode.
sort_order

"UnitCountCode
"
(For example,
TOTAL_NORMAL,
DENOMINATION,
TOTAL_SHORT, etc.)
tnd_tndr_typcode.
unit_count_req_code
7. Close Count Decimal 17,6 The close count discrepancy

Threshold
tnd_tndr_typcode.
"CloseCount close_count_disc_threshold
Discrepancy
Threshold"

Tender Type Record (TENDER_TYPE) (Sheet 2 of 2)
Name Comment

“Hidden”
user.
be displayed.
displayed.
tnd_tndr_typcode.
hidden_flag

Tender User Settings Record (TENDER_USER_SETTINGS)

Contains information about tender limits for a particular employee group on a per
tender basis.
tnd_tndr_user_settings All Fields TenderUserSettings
Tender User Settings Record (TENDER_USER_SETTINGS) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “TENDER_USER_SETTINGS”

"TenderId"
For example,
USD_CURRENCY,
CAD_CURRENCY,
PAYROLL_CHECK,
ACCOUNT_CREDIT,
DEBIT_CARD,
GIFT_CERTIFICATE,
AMERICAN_EXPRESS,
MASTERCARD, etc.
tnd_tndr_user_settings.
tndr_id
4. Group Id (PK) String 60  The identifier for a specific

assemblage of people/objects
"GroupId"
regarded as a unit. (For
example; CASHIER,
EVERYONE, MANAGER)
group_id
5. Usage Code (PK) String 30  A code denoting how the

tenders are to be used. For
"UsageCode"
example, SALE, CHANGE,
RETURN_WITHRECEIPT,
EXCHANGE, etc.
default=”DEFAULT”
usage_code
6. Entry Method String 60  A code denoting the method

Code (PK) to be used to add this tender
to the transaction.
"EntryMethod
Code" default=”DEFAULT”
entry_mthd_code

Name Comment
7. Over Tender Decimal 17,6 The dollar amount that a

Limit tender type may be over
tendered.
"OverTender
Limit" default=”0”
over_tndr_limit
must exist.
must exist.
10. Maximum Decimal 17,6 The maximum amount that

Accept Amount can be accepted for a specific
tender type.
"MaximumAcce
pt default=”99999.99”
Amount"
max_accept_amt
11. Minimum Decimal 17,6 The minimum amount that

Accept Amount can be accepted for a specific
tender type.
"MinimumAccep
t default=”0.01”
Amount"
min_accept_amt
12. Online Floor Decimal 17,6 The value of an individual

Approval tender above which
Amount authorization must be sought
before acceptance. This limit is
"OnlineFloor
normally referred to as the
ApprovalAmoun
floor limit and may vary by
t"
merchandise and store.
default=”0”
online_floor_approval_amt
13. Online Ceiling Decimal 17,6 The maximum amount of an

Approval individual tender type that
Amount can be authorized either in-
house or by a third party. This
"OnlineCeiling
especially applies to checks
ApprovalAmoun
where the check authorization
t"
company sets a ceiling by
retailer.
online_ceiling_approval_amt

Name Comment
14. Offline Floor Decimal 17,6 The value of an individual

Approval tender below which
Amount authorization is not required
when in offline mode.
"OfflineFloor
ApprovalAmoun default=”0”
t"
offline_floor_approval_amt
15. Offline Ceiling Decimal 17,6 The maximum value of an

Approval individual tender that can be
Amount accepted without
authorization when in offline
"OfflineCeilingA
mode.
pprovalAmount"
offline_ceiling_approval_amt
16. Maximum Decimal 17,6 The maximum refund amount

Refund With that can be accepted for a
Receipt Amount specific tender type for a
return with a receipt.
"MaximumRefun
Authorization is required to
d
override.
WithReceipt
Amount" tnd_tndr_user_settings.
max_refund_with_receipt
17. Maximum Decimal 17,6 The maximum refund amount

Refund Without that can be accepted for a
Receipt Amount specific tender type for a
return without a receipt.
"MaximumRefun
Authorization is required to
d
override.
WithoutReceipt
Amount" tnd_tndr_user_settings.
max_refund_wo_receipt

"ConfigElement"
tnd_tndr_user_settings.config
_element

Tender Repository Record (TENDER_REPOSITORY)

Contains information about the types of physical tender containers used in a retail store.
Tender repository generally includes assets, such as store safe(s), tills, etc.
tsn_tndr_repository All Fields TenderRepository
Tender Repository Record (TENDER_REPOSITORY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “TENDER_REPOSITORY”

Id (PK)
tsn_tndr_repository.
"RetailLocationI rtl_loc_id
d"
4. Tender String 60  The unique identifier for the

Repository Id tender repository. (For
(PK) example, Till 001.)
"Tender tsn_tndr_repository.
RepositoryId" tndr_repository_id
must exist.
must exist.

tender repository.
"Description"
description
must exist.
9. Name String 254 The name for the tender

repository. (For example, Store
"Name"
Bank, FifthThirdBank, Till 1,
etc.)
name
10. Not Issuable Boolean 5 If true, till cannot be issued.

Flag
"NotIssuable" not_issuable_flag

Tender Repository Record (TENDER_REPOSITORY) (Sheet 2 of 2)
Name Comment
11. Type Code String 30 A code to denote the type of

tender repository. (For
"TypeCode"
example, Till, Store Bank,
Bank, etc.)
typcode
12. Default BigInt The default workstation

Workstation Id identifier for a till/tender
repository.
"Default
WorkstationId" tsn_tndr_repository.
dflt_wkstn_id

Tender Repository Property (TENDER_REPOSITORY_PROPERTY)
Tender Repository Property

(TENDER_REPOSITORY_PROPERTY)
Contains the properties for tender repositories.
tsn_tndr_repository_p All Fields TenderRepository

Property
Tender Repository Property Record (TENDER_REPOSITORY_PROPERTY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “TENDER_REPOSITORY_

PROPERTY”
3. Retail Location Integer  The tax group identifier.

Id (PK)
tsn_tndr_repository_p.
Id”
4. Tender String 60  Identifies the tender

Repository ID repository.
(PK)
tsn_tndr_repository_p.tndr_
“Tender repository_id
RepositoryId”

“PropertyCode”
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
tsn_tndr_repository_p.type

Type=STRING
“StringValue”
tsn_tndr_repository_p.string_
value

Type=DATE
“DateValue”
tsn_tndr_repository_p.date_
value

Tender Repository Property (TENDER_REPOSITORY_PROPERTY)
Tender Repository Property Record (TENDER_REPOSITORY_PROPERTY) (Sheet 2 of 2)
Name Comment

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
decimal_value

Tender Repository Float Record (TENDER_REPOSITORY_FLOAT)
Tender Repository Float Record

(TENDER_REPOSITORY_FLOAT)
Contains cash float information.
tsn_tndr_repository_float All Fields TenderRepositoryFloat
Tender Repository Float Record (TENDER_REPOSITORY_FLOAT)
Name Comment

Record”.

FLOAT”

Id (PK)
tsn_tndr_repository_float.rtl_l
“RetailLocationI oc_id
d”

“TenderReposito tsn_tndr_repository_float.tndr
ryId” _repository_id
5. Currency Id (PK) String 3  The specific currency for the

float details.
"CurrencyId"
tsn_tndr_repository_float.curr
ency_id
6. Default Cash Decimal 17,6 The configured default cash

Float float. This is used to determine
the details of the cash deposit
"DefaultCashFlo
amount prompt.
at"
tsn_tndr_repository_float.defa
ult_cash_float
7. Last Closing Decimal 17,6 The amount of cash left in the

Cash Amt drawer. This is the actual cash
float from the last register
"LastClosingCas
close.
hAmt"
tsn_tndr_repository_float.last_
closing_amount

Tender Repository Float Property

(TENDER_REPOSITORY_FLOAT_PROPERTY)
Contains the property information for cash float amounts.
tsn_tndr_repository_float_p All Fields TenderRepositoryFloat

Property
Tender Repository Float Property Record (TENDER_REPOSITORY_FLOAT_PROPERTY) (Sheet

1 of 2)
Name Comment

Record”.

FLOAT_PROPERTY”
3. Retail Location Integer  The tax group identifier.

Id (PK)
tsn_tndr_repository_float_p.
Id”
4. Tender String 60  Identifies the tender

Repository ID repository.
(PK)
“Tender tndr_repository_id
RepositoryId”
5. Currency ID String 3  Identifies the currency.

(PK)
“CurrencyId” currency_id

tsn_tndr_repository_float.
“PropertyCode”
property_code

“Type”
STRING, BIGDECIMAL,
DATE, or BOOLEAN.
type

Type=STRING
“StringValue”
string_value

Tender Repository Float Property Record (TENDER_REPOSITORY_FLOAT_PROPERTY) (Sheet

2 of 2)
Name Comment

Type=DATE
“DateValue”
date_value

Type=BIGDECIMAL or
“DecimalValue”
Type=BOOLEAN.
and 0=False.
decimal_value

Tender Repository Status Record (TENDER_REPOSITORY_STATUS)
Tender Repository Status Record

(TENDER_REPOSITORY_STATUS)
Contains information about the types of physical tender containers used in a retail store.
Tender repository generally includes assets, such as store safe(s), tills, etc.
tsn_tndr_repository_status All Fields TenderRepositoryStatus
Tender Repository Status Record (TENDER_REPOSITORY_STATUS)
Name Comment

Record”.
2. Record Identifier String 30  “TENDER_REPOSITORY”

Id (PK)
tsn_tndr_repository_status.
"RetailLocation rtl_loc_id
Id"

"Tender tsn_tndr_repository_status.
RepositoryId" tndr_repository_id
5. Issued Boolean 1 Indicates whether the tender

repository has been issued.
"Issued"
issued_flag
6. ActiveSessionId BigInt If Issued=TRUE, contains the

session ID of the currently
"ActiveSession
active session.
Id"
active_session_id

Voucher Record (VOUCHER)

Contains detail on stored value certificates/cards such as store credits or gift certificates.
The data can be used to validate the balance remaining on the voucher during tendering.
ttr_voucher All Fields Voucher
Voucher Record (VOUCHER) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “VOUCHER”
3. Voucher Type String 30  The type of voucher:

Code (PK)
GIFT_CARD
"VoucherType STORE_CREDIT
Code" MALL_CERTIFICATE
GIFT_CERTIFICATE
MERCHANDISE_CREDIT_
CARD
ttr_voucher.voucher_
typcode
4. Serial Number String 60  The identifier number for the

(PK) voucher.
"SerialNumber" ttr_voucher.serial_nbr
5. Voucher Status String 30  The voucher status.

Code
Fixed value:
"VoucherStatus
VOID
Code"
(Customer-defined values are
also supported.)
ttr_voucher.voucher_
status_code
6. Unspent Balance Decimal 17,6  The amount remaining on the

Amount account.
"UnspentBalance ttr_voucher.unspent_balance_
Amount" amt
7. Face Value Decimal 17,6 The cited value or amount

Amount stated on the voucher.
"FaceValue ttr_voucher.face_
Amount" value_amt

Voucher Record (VOUCHER) (Sheet 2 of 2)
Name Comment
8. Issue Date/ DateTime 23 The date and time the voucher

Timestamp was issued.
"Issue ttr_voucher.issue_
Datetimestamp" datetime
9. Expiration Date DateTime 23 The date and time the voucher

expires.
"Expiration
Date" ttr_voucher.expr_date
10. Effective Date DateTime 23 The date the voucher is ready

“EffectiveDate”
ttr_voucher.effective_date
11. Issue Type Code String 30 The code used to provide

information if this voucher
“IssueTypeCode
was issued as a refund, etc.
”
ttr_voucher.issue_
typcode
12. Currency Id String 3 The three-letter ISO currency

"CurrencyId"
etc.
ttr_voucher.currency_id

Session Record (SESSION)

Contains information about a transient association between an operator and a
workstation that must exist to enable the creation of a retail transaction, or financial
transaction, that involves the receipt, disbursement, pick up, or loan of tender. A session
is created when an operator signs on to a workstation and is terminated when an
operator signs off of a workstation. This entity exists to support tender reconciliation and
accountability at an operator level.
tsn_session All Fields Session
Session Record (SESSION) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “SESSION”

organization.
"RetailLocationI
d" tsn_session.rtl_loc_id
4. Session Id (PK) BigInt  An identifier for a transient

association between an
"SessionId"
operator and a workstation
that must exist to create a
retail transaction or financial
transaction involving the
receipt, disbursement, pickup,
or loan of tender. A session is
created when an operator
signs on to a workstation and
is terminated when an
operator signs off of a
workstation.
tsn_session.session_id
5. Begin Date DateTime 23 The time and date at the start

Timestamp of the session.
"BeginDatetimes tsn_session.begin_datetime
tamp"
6. Business Date Date 10 The calendar date of the

session.
"BusinessDate"
tsn_session.business_date
7. End Date DateTime 23 The time and date at the end

Timestamp of the session.
"EndDatetimesta tsn_session.end_datetime
mp"

Session Record (SESSION) (Sheet 2 of 2)
Name Comment
8. Status Code Text 30 The status code of the session.

For example, BGCOUNT (for
"StatusCode"
beginning count), ASSIGNED,
RECONCILED.
tsn_session.statcode
9. Employee Party BigInt The unique, automatically

Id assigned identity for an
employee party.
“EmployeePartyI
d" tsn_session.employee_party_i
d
10. Tender String 60 The unique identifier for the

example, Till 001, StoreBank,
"TenderReposito
etc.)
ryId"
tsn_session.tndr_repository_id

Session Tender Record (SESSION_TENDER)

Contains a collection of tender-type accumulators by operator-workstation-session for a
tender reconciliation period. This entity is used to support operator-workstation-session
tender accountability.
tsn_session_tndr All Fields SessionTender
Name Comment

Record”.
2. Record Identifier String 30  “SESSION_TENDER”

organization.
"RetailLocationI
d" tsn_session_tndr.rtl_loc_id
4. Session Id (PK) BigInt  The identifier for a transient

association between an
"SessionId"
operator and a workstation
that must exist to create a
retail transaction or financial
transaction involving the
receipt, disbursement, pickup,
or loan of tender.
tsn_session_tndr.session_id
5. Tender Id (PK) Text 60  A code which uniquely

"TenderId"
For example, Check,
MasterCard, VISA, etc.
tsn_session_tndr.tndr_id
6. Media Amount Decimal 17,6 The total monetary amount of

tenders by session.
"MediaAmount"
tsn_session_tndr.actual_media
_amt
7. Media Count Integer The total number of tender

units by session.
"MediaCount"
tsn_session_tndr.actual_media
_count


11
Security
Security Group Record (SEC_GROUP)

The valid security roles for an organization (i.e., MGR, ASST_MGR, CASHIER) for the
purpose of securing POS functions. This does not necessarily map to a list of
organizational titles, as multiple titles may play the same effective role as it pertains to
application security.
sec_groups All Fields Group
Security Group Record (SEC_GROUP) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “SEC_GROUP”
3. Group Id (PK) String 60  The identifier for a specific

assemblage of people/objects
"GroupId"
regarded as a unit.
sec_groups.group_id
4. Description String 254 The text description for the

group identifier.
"Description"
sec_groups.description
5. Bitmap Position Integer  Base 64 encoded group

membership of the employee;
"Bitmap
Bitmap that represents the
Position"
group.
sec_groups.bitmap_
position
6. GroupRank Integer Defines a relative hierarchy

position for a given security
GroupRank
group/role.
sec_groups.group_rank
Security 11-1
Security Group Record (SEC_GROUP)
Security Group Record (SEC_GROUP) (Sheet 2 of 2)
Name Comment

"ConfigElement"
sec_groups.config_element

Security Privilege Record (SEC_PRIVILEGE)

Defines the security level required for access to secured functions/data.
sec_privilege All Fields Privilege
Security Privilege Record (SEC_PRIVILEGE) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “SEC_PRIVILEGE”
3. Privilege Type String 60  A code for the type of

(PK) privilege governed by security.
(For example,
"PrivilegeType"
CHANGE_PRICE,
RELOAD_GIFT_CARD,
VOID_LINE,
PAYROLL_MAINTENANCE,
etc.)
sec_privilege.privilege_
type
4. Authentication Boolean 5 If true, indicates that

Required Flag authentication is required for
this privilege type.
"Authentication
Required" sec_privilege.
authentication_req
must exist.
6. Group String UNL  The code for the association

Membership between an employee and an
Raw employee security group.
"Group default=”AQ==”
MembershipRaw
sec_privilege.group_
"
membership
Security 11-3
Name Comment
7. Second Prompt String 30 Determines whether a second

Settings authorization prompt should
appear. This can be set to one
"SecondPrompt
of the following values:
Settings"
NO_PROMPT - The second
authorization prompt will not
appear.
ANY_EMP_OK - The second
authorization prompt will
appear. Any employee is OK.
REQUIRE_GRP_MEMBERSHI
P - The second authorization
prompt will appear. The
employee ID entered must be
in a certain group.
default=”NO_PROMPT”
sec_privilege.second_
prompt_settings
8. Second Prompt Boolean 5 If true, then the same

Required if Employee ID cannot be used
Different in both prompts.
Employee Flag
"SecondPrompt prompt_req_diff_emp
ReqrDiffEmp"
9. Second Prompt String UNL If the

Group "SecondPromptSettings"
Membership field is set to
Raw “REQUIRE_GRP_
MEMBERSHIP”, then this
"SecondPrompt
field determines the required
GroupMembersh
group membership for the
ipRaw"
second Employee ID.
default=”AA==”
prompt_group_membership
10. Description String 254 The text description for the

security privilege type.
"Description"
sec_privilege.description
11. Overridable Flag Boolean 5 If true, the privilege can be

overridden.
"Overridable"
sec_privilege.
overridable_flag

Name Comment

"ConfigElement"
sec_privilege.config_element
Security 11-5
Security Access Type Record (SEC_ACCESS_TYPE)

Contains information defining specific access privileges to a given resource.
sec_access_types All Fields AclAccessType
Name Comment

Record”.
2. Record Identifier String 30  “SEC_ACCESS_TYPE”
3. Secured Object String 30  Text key for a secured object.

Id (PK) For example,
CUSTOMER_ATTRIBUTES,
"SecuredObject
EMPLOYEE_DATA,
Id"
CUSTOMER_CONTACT_INF
O, etc.
sec_access_types.secured_obje
ct_id
4. Access Type String 30  A code indicating the type of

Code (PK) security access allowed. For
example, CREATE, READ,
"AccessType
UPDATE.
Code"
sec_access_types.access_typco
de
5. Group String UNL  Base 64 encoded group

Membership membership of the employee.
Raw Determines security
permissions.
"Group
MembershipRaw default="AQ=="
"
sec_access_types.group_mem
bership
6. No Access String 30  The access setting for the form

Settings field type. (HIDDEN,
OVERRIDEABLE,
"NoAccess
NOT_OVERRIDABLE)
Settings"
default=”HIDDEN”
sec_access_types.no_
access_settings

Security Access Control List Record (SEC_ACL)

Contains access control list information for form fields.
sec_acl All Fields AccessControlList
Name Comment

Record”.
2. Record Identifier String 30  “SEC_ACL”
3. Secured Object String 30  String key for a secured object.

Id (PK)
sec_acl.secured_object_id
"SecuredObject
Id"
4. Authentication Boolean 5 If true, user authentication is

Required Flag required for this secured
object.
"Authentication
Required" sec_acl.authentication_
req_flag
Security 11-7
Shared Secret Removal (SEC_PASSWORD)
Shared Secret Removal (SEC_PASSWORD)

Deletes all shared secrets used for communications between registers.
sec_pasword All Fields N/A
Name Comment
1. Action Code String as  “DELETE”1

specified
2. Record Identifier String 30  “SEC_PASSWORD”
1.This record only supports the DELETE action.
Important: This record type only supports the DELETE action. When
applied, the sec_password table will be cleared. Once cleared, the
lead register will generate a new key to secure inter-process
communication between the various in-store modules of Oracle Xstore
Point of Service.

12
Payroll, Scheduling & Timecard
Work Code Record (WORK_CODE)

Work codes can be used to identify the type of activity being performed by a system user
while they are clocked in to the system (i.e., Selling, Stock, Inventory, Floor Set).
hrs_work_codes All Fields WorkCodes
Work Code Record (WORK_CODE) (Sheet 1 of 3)
Name Comment

Record”.
2. Record Identifier String 30  “WORK_CODE”
3. Work Code (PK) String 30  The work code.

“WorkCode” hrs_work_codes.work_
code

“Description” hrs_work_codes.
description
5. Sort Order Integer Used to sort codes for display.

“SortOrder” hrs_work_codes.
sort_order
6. Selling Flag Boolean 5 Indicates whether this work

code is used for selling time. If
“Selling”
true, this work code is counted
as selling time.
hrs_work_codes.
selling_flag
Payroll, Scheduling & Timecard 12-1

Name Comment
7. Privilege String 60 Security privilege required to

use the work code.
“Privilege”
hrs_work_codes.
privilege
8. Payroll Category String 30 The payroll category that

hours logged against the work
“Payroll
code will be assigned to.
CategoryString”
hrs_work_codes.
payroll_category
9. Minimum Clock Integer The minimum number of

In Duration minutes that a user must be
clocked in for this work code
"MinimumClock
before the user is allowed to
InDuration"
either clock out or change to a
different work code. This
restriction is not enforced if
this value is NULL or a non-
positive value.
hrs_work_codes.
min_clock_in_duration
10. Minimum Clock Integer The minimum number of

Out Duration minutes that must have
elapsed with a user in a
“MinimumClock
"clocked-out" state before that
OutDuration”
user is permitted to clock back
in with this work code. This
restriction is not enforced if
either this value is NULL or a
non-positive value, or in any
case where the user has not
yet clocked in for the current
system date.
hrs_work_codes.
min_clock_out_duration

“Hidden”
user.
be displayed.
displayed.
hrs_work_codes.
hidden_flag

code.
"OrgCode"
default="*"
hrs_work_codes.
org_code

Name Comment

"OrgValue"
default="*"
hrs_work_codes.
org_value

Payroll Category Record (PAYROLL_CAT)

Payroll categories can be used to group working and non-working hours together within
Payroll Maintenance. Non-working categories can be customized to match organization
time-off and payroll reporting requirements (i.e. Jury Duty, Vacation, PTO).
thr_payroll_category All Fields PayrollCategory
Name Comment

Record”.
2. Record Identifier String 30  “PAYROLL_CAT”
3. Payroll Category String 30  The payroll category.

(PK)
thr_payroll_category.
“Payroll payroll_category
Category”

“Description” thr_payroll_category.
description
5. Sort Order Integer Used to sort codes for display.

“SortOrder” thr_payroll_category.
sort_order
6. Include In Boolean 5 Indicates whether this payroll

Overtime Flag category should be included in
overtime calculations.
“IncludeIn
OverTime” thr_payroll_category.
include_in_overtime_flag
7. Pay Code String 30 The payroll code associated

with the category.
“PayCode”
pay_code
8. Working Boolean 5 Indicates whether this payroll

Category Flag category is used for working
hours. If true, this category is
“Working
included in working hours
Category”
calculations.
working_category_flag

Payroll Note Record (PAYROLL_NOTE)

Contains notes/comments pertaining to payroll activities.
thr_payroll_notes All Fields PayrollNotes
Name Comment

Record”.
2. Record Identifier String 30  “PAYROLL_NOTE”
3. Party Id (PK) BigInt  A unique identity for a party.

"partyId" thr_payroll_notes.
party_id
4. Week Ending Datetime 23  The last date for the payroll

Date (PK) week.
"weekEnding thr_payroll_notes.
Date" week_ending_date
5. Note Sequence BigInt  The sequence number of the

(PK) note.
"noteSeq" thr_payroll_notes.
note_seq
6. Note Text String UNL The text of the note.

"noteText" thr_payroll_notes.
note_text

Schedule Record (SCHEDULE)

Contains employee schedule information.
sch_schedule All Fields Schedule
Schedule Record (SCHEDULE) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “SCHEDULE”

store employee.
"employeeId"
sch_schedule.employee_id
4. Business Date Datetime 23  The calendar date of the

(PK) business day.
"businessDate" sch_schedule.business_date
5. Schedule Seq BigInt  Sequence number within the

(PK) table to keep the employee
schedule ordered and unique.
"scheduleSeq"
sch_schedule.schedule_seq
6. Work Code String 30 The code for a work

String classification group to which
employees are assigned.
"workCode
Possible values are configured
String"
in hrs_work_codes.
sch_schedule.work_
code
7. Start Time Datetime 23 The schedule start time.

"startTime" sch_schedule.start_
time
8. End Time Datetime 23 The schedule end time.

"endTime" sch_schedule.end_time
9. Void Flag Boolean 5 If true, denotes that this

operation has been voided.
"void"
sch_schedule.void_flag
10. Break Duration BigInt The length of a break within

this schedule.
"breakDuration"
sch_schedule.break_
duration

Schedule Record (SCHEDULE) (Sheet 2 of 2)
Name Comment
11. Schedule BigInt Total length of time for this

Duration schedule.
"schedule sch_schedule.schedule_durati
Duration" on

Schedule Employee Timeoff Record (SCHEDULE_EMPLOYEE_TIMEOFF)
Schedule Employee Timeoff Record

(SCHEDULE_EMPLOYEE_TIMEOFF)
Contains employee time-off information.
sch_emp_time_off All Fields EmployeeTimeOff
Schedule Employee Timeoff Record (SCHEDULE_EMPLOYEE_TIMEOFF) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “SCHEDULE_EMPLOYEE_

TIMEOFF”

store employee.
"employeeId"
sch_emp_time_off.
employee_id
4. Time Off Seq BigInt  Sequence number within the

(PK) table to keep the time-off
"timeOffSeq"
sch_emp_time_off.
time_off_seq
5. Start Time Datetime 23 The date and time the

employee time-off session
"startTime"
begins.
sch_emp_time_off.
start_datetime
6. End Time Datetime 23 The date and time the

employee time-off session
"endTime"
ends.
sch_emp_time_off.
end_datetime
7. Reason Code String 30 A code denoting the reason for

the employee time-off session.
"reasonCode"
(For example, VACATION,
PERSONAL, UNAVAILABLE,
etc.)
sch_emp_time_off.
reason_code
8. Void Flag Boolean 5 If true, denotes that this

operation has been voided.
"void"
sch_emp_time_off.
void_flag

Schedule Employee Timeoff Record (SCHEDULE_EMPLOYEE_TIMEOFF)
Schedule Employee Timeoff Record (SCHEDULE_EMPLOYEE_TIMEOFF) (Sheet 2 of 2)
Name Comment
9. Type Code String 30 A code denoting the type of

employee time-off session.
"typeCode"
(For example, FULL_DAY,
HALF_DAY, PART_DAY, etc.)
sch_emp_time_off.
time_off_typcode

Schedule Shift Record (SCHEDULE_SHIFT)

Defines the parameters and other information that identify a particular work shift that
may be assigned to an employee.
sch_shift All Fields Shift
Schedule Shift Record (SCHEDULE_SHIFT) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “SCHEDULE_SHIFT”
3. Shift Id (PK) BigInt  A unique identifier for a shift.

"shiftId" sch_shift.shift_id
4. Name String 60 A brief String identifier for a

shift.
"name"
sch_shift.name
5. Description String 254 A text description of some

aspect of the work shift.
"description"
sch_shift.description
6. Work Code String 30 A code indicating the type of

work the employee will
"workCode"
perform.
sch_shift.work_code
7. Start Time Datetime 23 The shift start time.

"startTime" sch_shift.start_time
8. End Time Datetime 23 The shift end time.

"endTime" sch_shift.end_time
9. Void Flag Boolean 5 True/False indicator of

whether or not the shift has
"void"
been voided.
sch_shift.void_flag
10. Break Duration BigInt Length of time allotted for the

work break.
"breakDuration"
sch_shift.break_
duration

code.
"OrgCode"
default="*"
sch_shift.org_code

Schedule Shift Record (SCHEDULE_SHIFT) (Sheet 2 of 2)
Name Comment

"OrgValue"
default="*"
sch_shift.org_value

Timecard Entry Record (TIMECARD_ENTRY)

Contains timecard entry information.
thr_timecard_entry All Fields TimecardEntry
Timecard Entry Record (TIMECARD_ENTRY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “TIMECARD_ENTRY”
3. Business Date Datetime 23  The business date on which

(PK) the timecard entry occurred.
“BusinessDate” thr_timecard_entry.business_d
ate
4. Retail Location Integer  The retail location at which the

Id (PK) timecard entry occurred.
“RetailLocationI thr_timecard_entry.rtl_loc_id
d”
5. Party Id (PK) BigInt  The party ID for the timecard

entry.
“PartyId”
thr_timecard_entry.party_id
6. Timecard Entry Integer  The unique timecard entry ID.

Id (PK)
thr_timecard_entry.timecard_e
“TimecardEntryI ntry_id
d”
7. Workstation Id BigInt  The register at which the

(PK) timecard entry occurred.
“WorkstationId” thr_timecard_entry.wkstn_id
8. Clock In Date Datetime 23 The date and time for the

Time clock in.
“ClockInDateTi thr_timecard_entry.clock_in_ti
me” mestamp
9. Clock Out Date Datetime 23 The date and Time for the
Time clock out.
“ClockOutDateT thr_timecard_entry.clock_out_
ime” timestamp
10. Work Code String 30 The work code for the

String timecard entry - for regular
sales this should be SL.
“WorkCodeStrin
g” thr_timecard_entry.work_code

Timecard Entry Record (TIMECARD_ENTRY) (Sheet 2 of 2)
Name Comment
11. Open Record Boolean 5 TRUE or FALSE if the

Flag timecard record is still open
(no clock out time).
“OpenRecord”
thr_timecard_entry.open_recor
d_flag
12. Duration BigInt The total timecard entry

duration in seconds.
Duration
thr_timecard_entry.duration
<Field literal="ORIGINAL" name="EntryType" dataType="String" >Default to

ORIGINAL.</Field>
<Field literal="false" name="Delete" dataType="Boolean" >Default to FALSE.</Field>
<Field literal="false" name="PayrollUpdateRequired" dataType="Boolean" >To update into
payroll - default to FALSE.</Field>


13
Thermal Printer Support
Item Label Batch Record (ITEM_LABEL_BATCH)

Contains line batch items that are saved for future printing.
itm_item_label_batch All Fields ItemLabelBatch
Item Label Batch Record (ITEM_LABEL_BATCH) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_LABEL_BATCH”
3. Batch Name (PK) String 30  The name of the batch.

"batchName" itm_item_label_batch.
batch_name

"itemId" itm_item_label_batch.
item_id
5. Stock Label (PK) String 20  The type of label.

"stockLabel" itm_item_label_batch.
stock_label
6. Count Integer  The label count.

"count" itm_item_label_batch.
count

code.
"orgCode"
default="*"
itm_item_label_batch.
org_code
Thermal Printer Support 13-1

Item Label Batch Record (ITEM_LABEL_BATCH)
Item Label Batch Record (ITEM_LABEL_BATCH) (Sheet 2 of 2)
Name Comment

"orgValue"
default="*"
itm_item_label_batch.
org_value

Item Label Property Record (ITEM_LABEL_PROPERTY)

Contains additional item properties related to item configuration.
itm_item_label_properties All Fields ItemLabelProperties
Name Comment

Record”.
2. Record Identifier String 30  “ITEM_LABEL_PROPERTY”

"itemId" itm_item_label_properties.ite
m_id
4. Stock Label String 30 The type of label.

"stockLabel" itm_item_label_properties.stoc
k_label
5. Logo Url String 254 The URL address for the

image.
"logoUrl"
itm_item_label_properties.log
o_url

code.
"orgCode"
default="*"
itm_item_label_properties.org
_code

"orgValue"
default="*"
itm_item_label_properties.org
_value
Thermal Printer Support 13-3


14
Airport Retail Location Support
Airport Record (AIRPORT)

Contains descriptive information about an airport.
com_airport All Airport
Airport Record (AIRPORT)
Name Comment

Record”.
2. Record Identifier String 30  “AIRPORT”
3. Airport Code String 3  Three-letter airport

(PK) identification code.
“AirportCode” com_airport.airport_code
4. Airport Name String 254  Name of the airport.

"AirportName" com_airport.airport_name.
5. Country Code String 2  Two-letter country code for

the airport.
"TaxCalculation
Mode" com_airport.country_code
6. Zone ID String 30  Zone ID for the airport.

“ZoneId” com_airport.zone_id
Airport Retail Location Support 14-1

Airport Zone Record (AIRPORT_ZONE)

Contains zone information.
com_airport_zone All AirportZone
Name Comment

Record”.
2. Record Identifier String 30  “AIRPORT_ZONE”
3. Zone Id (PK) String 30  The source zone Id (e.g.

DOMESTIC, EU, NON_EU).
"zoneId"
com_airport_zone.zone_id
4. Description String 254 The zone description.

"description" com_airport_zone.description
Airport Zone Detail Record (AIRPORT_ZONE_DETAIL)

Contains the tax calculation mode based on the source and destination zones.
com_airport_zone_detail All AirportZoneDetail
Airport Zone Detail Record (AIRPORT_ZONE_DETAIL) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “AIRPORT_ZONE_DETAIL”
3. Zone Id (PK) String 30  The source zone Id.

“ZoneId” com_airport_zone_detail.zone
_id
4. Destination Zone String 30  The destination zone Id.

Id (PK)
com_airport_zone_detail.desti
"DestinationZon nation_zone_id
eId"

Flight Information Record (FLIGHT_INFORMATION)
Airport Zone Detail Record (AIRPORT_ZONE_DETAIL) (Sheet 2 of 2)
Name Comment
5. Tax Calculation String 30 u The tax calculation mode (e.g.

Mode TAX_NORMAL,
PRICE_SPECIAL, TAX_FREE).
"TaxCalculation
Mode" com_airport_zone_detail.tax_c
alculation_mode

Used to store flight search information.
com_flight_info All FlightInformation
Flight Information Record (FLIGHT_INFORMATION) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “FLIGHT_INFORMATION”
3. Scheduled Date Datetime 23  The scheduled date and time

Time (PK) of the flight.
"ScheduledDate com_flight_info.scheduled_da
Time" te_time
4. Flight Number String 30  Unique code assigned to each

(PK) flight.
"FlightNumber" com_flight_info.flight_number
5. Destination String 3  Three-digit code of the

Airport passenger's destination airport
(e.g. CLE), according to the
"Destination
boarding pass.
Airport"
com_flight_info.destination_ai
rport
8. Via 1 Airport String 3 Intermediate airport code.

"Via1Airport" com_flight_info.via_1_airport


Airport Retail Location Support 14-3

Flight Information Record (FLIGHT_INFORMATION) (Sheet 2 of 2)
Name Comment
21. Origin Airport String 3  Airport code for the airport of

origin
"OriginAirport"
com_flight_info.origin_airport

15
Country Pack Information
Tax Free Country Record (TAXFREE_COUNTRY)

Defines country information for retail locations and workstations.
civc_taxfree_country All CivcTaxfreeCountry
Tax Free Country Record (TAXFREE_COUNTRY) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “TAXFREE_COUNTRY”
3. Retail Location Number 10  Unique identifier for the retail

ID (PK) location.
“RetailLocation civc_taxfree_country.
Id” rtl_loc_id
4. Workstation ID String 2  Unique idenfifier for the

(PK) workstation.
"WorkstationId" civc_taxfree_country.wkstn_id
5. ISO Three- String 72  ISO three-number code for the

Number Code country.
(PK)
civc_taxfree_country.
"Iso3NumCode"
iso3num_code
6. ISO Two-Letter String 7 ISO two-letter code for the

Code country.
“Iso2Alpha civc_taxfree_country.iso2alp_
Code” code
7. Name String 8 Name of the country.

"Name” civc_taxfree_country.name
Country Pack Information 15-1

Tax Free Country Record (TAXFREE_COUNTRY)
Tax Free Country Record (TAXFREE_COUNTRY) (Sheet 2 of 2)
Name Comment
8. Phone Prefix String 8 Phone prefix for the country.

"PhonePrefix” civc_taxfree_country.
phone_prefix
9. Passport Code Number 10 Passport code for the country.

"PassportCode” civc_taxfree_country.passport_
code
10. Blocked Flag String 1 If true, tax free invoices are not
permitted.
"BlockedFlag”
civc_taxfree_country.blocked_
flag
11. Void Flag String 1 If true, tax-free invoices can be

voided.
"VoidFlag”
civc_taxfree_country.void_flag

16
Xstore Office Users
DataLoader can be used to load Xstore Office users rather than exclusively managing
Xstore Office users via the web page.
Note: You must install an Xstore Office specific instance of

DataLoader to use this functionality. Running DataLoader against the
Xcenter DB will only work if the Xstore Office tables are in that same
DB. If Xstore Office has its own database, then you will need to install
an instance of DataLoader for that DB.
Note that additional configuration is required, in addition to the normal DataLoader

configuration requirements:
1. Add the following property to system.properties:
dtv.persistence.AbstractPersistenceDefaultsImpl=
dtv.data2.SystemPropertyPersistenceDefaults
2. Comment out any log4j appender that uses "dtv.xst.log4j.DtxAppender" or
"dtv.xst.log4j.DtxDataSourceAppender" as its class in \config\dataloader\log4j.xml
3. Configure DataLoader to point at an Xstore Office database (this is normally done
via the installer).
Note: DataLoader will complain about a missing log4j appender

when it is run, but these complaints can safely be ignored.
Xstore Office Users 16-1

Xstore Office User (XADMIN_USER)

Used to create, update, and delete Xstore Office users with a single org node and a
default password (1234) with an effective date of today.
cfg_user All User
cfg_user_node 3, 8 UserNode
Xstore Office User (XADMIN_USER) (Sheet 1 of 2)
Name Comment

Record”.
2. Record Identifier String 30  “XADMIN_USER”
<Field sysProp="dtv.dataloader.OrganizationId" name="OrganizationId" />

organizationId maps to cfg_user.organization_id
3. User Name (PK) String 30  Username for user.

"userName" cfg_user.user_name
cfg_user_node.user_name
4. First Name String 30  First name of user.

"firstName" cfg_user.first_name
5. Last Name String 30 Last name of user.

“lastName” cfg_user.last_name
6. Role Id String 30 Role for user.

“roleId” cfg_user.role_id
7. Locale String 30 Default locale for user.

“locale” cfg_user.locale
8. Org Scope String 100 Contains org_code:org_value

of the node.
“orgScope”
cfg_user_node.org_scope
cfg_user.org_scope
9. email Address String 254 Email address for Xstore

Office user.
"emailAddress"
cfg_user.email_address

Xstore Office User (XADMIN_USER) (Sheet 2 of 2)
Name Comment
10. directory Type String Defines whether the user

should be authenticated using
"directoryType"
LDAP or Xstore Office internal
authentication mechanism.
Valid Values: INTERNAL,
LDAP
default="INTERNAL"
cfg_user.directory_type
<Sql action="INSERT"
sql="INSERT INTO cfg_user_password (organization_id,
user_name, password, effective_date, create_user_id, create_date)
VALUES (?, ?, ?, ?, ?, ?)">
<Field sysProp="dtv.dataloader.OrganizationId"
dataType="Long" />
<Field filePosition="03" dataType="String" />
<Field literal="gdyb21LQTcIANtvYMT7QVQ==" name="password" /
>
<Field variable="$currentDateTimestamp"
name="effectiveDate" dataType="Date" />
<Field literal="DATALOADER" name="create_user_id" />
<Field variable="$currentDateTimestamp"
name="effectiveDate" dataType="Date" />
</Sql>
<Sql action="DELETE" sql="DELETE FROM cfg_user_password WHERE

organization_id = ? AND user_name = ?" >
dataType="Long" />
<Field filePosition="03" dataType="String" />
</Sql>
Xstore Office Users 16-3

Xstore Office User Node (XADMIN_USER_NODE)

Used to add, delete, and modify organization nodes to an Xstore Office user.
cfg_user_node All XadminUserNode
Name Comment

Record”.
2. Record Identifier String 30  “XADMIN_USER_NODE”
<Field sysProp="dtv.dataloader.OrganizationId" name="OrganizationId" />

organizationId maps to cfg_user_node.organization_id
3. User Name (PK) String 30  Username for user.

"userName" cfg_user_node.user_name
4. Org Scope (PK) String 100  Contains org_code:org_value

of the node.
“orgScope”
cfg_user_node.org_scope

17
Transaction Records
Overview
This optional type of interface can be used to load transactions into Xcenter for various
business reasons, including performing verified returns. This data will typically come
from an e-commerce or order management system.
Transaction Header Record (TRANS_HEADER)

Contains transaction header information describing the unique reference information,
transaction type, status, and other relevant flags.
trn_trans 3-17, 20-24 RetailTransaction
trl_rtrans 3-6, 15-19 RetailTransaction
Transaction Header Record (TRANS_HEADER) (Sheet 1 of 4)
Name
Field # “Field Name” Type Width Required Comment
1. Action Code String as  See “Valid Commands for a

specified Data File Record”.
2. Record Identifier String 30  “TRANS_HEADER”
3. Retail Location Integer  Retail location at which the

Id (PK) transaction occurred.
RetailLocationId trn_trans.rtl_loc_id
trl_rtrans.rtl_loc_id
4. Business Date DateTime 23  Business date on which the

(PK) transaction occurred.
BusinessDate trn_trans.business_date
trl_rtrans.business_date
Transaction Records 17-1

Name
5. Workstation Id BigInt  Workstation at which the

WorkstationId trn_trans.wkstn_id
trl_rtrans.wkstn_id
6. Transaction BigInt  Transaction sequence ID/

Sequence (PK) invoice number.
TransactionSequ trn_trans.trans_seq
ence
trl_rtrans.trans_seq
7. Begin Date DateTime 23  Date & Time that transaction

Timestamp was started.
BeginDate trn_trans.begin_datetime
Timestamp
8. End Date DateTime 23 u Date & Time that transaction

Timestamp was completed.
BeginDate trn_trans.end_datetime
Timestamp
9. Transaction Type String 30 u Code description for the type

Code of transaction:
TransactionType ACCOUNT_LOOKUP
Code BALANCE_INQUIRY
BANKDEPOSIT
CREDIT_APPLICATION
ESCROW
EXCHANGE_RATE
GENERIC
INVENTORY_CONTROL
INVENTORY_SUMMARY_C
OUNT
MOVEMENT_PENDING
NO_SALE
POST_VOID
PRICE_CHANGE
RETAIL_SALE
SESSION_CONTROL
SYSTEM_CLOSE
SYSTEM_OPEN
TENDER_CONTROL
TENDER_EXCHANGE
TILL_CONTROL
TIMECLOCK
TRAINING_MODE_ENTRY
TRAINING_MODE_EXIT
WARRANTY_SERVICE
WORKSTATION_CLOSE
WORKSTATION_COMPLETE
_REM_CLOSE
WORKSTATION_OPEN
WORKSTATION_START_RE
M_CLOSE
trn_trans.trans_typcode

Name
10. Transaction String 30 u Code representing status of

Status Code transaction including:
TransactionStatu CANCEL
sCode CANCEL_ORPHANED
COMPLETE
NEW
RESUME
SUSPEND
VOID
trn_trans.trans_statcode
11. Post Void Flag Boolean 5 u TRUE/FALSE if transaction

was voided.
PostVoid
trn_trans.post_void_flag
12. Session Id BigInt u Till session #.

SessionId trn_trans.session_id
13. Cash Drawer Id String 60 Cash drawer ID that

transaction was tendered.
CashDrawerId
trn_trans.cash_drawer_id
14. Operator Party BigInt The party id for the cashier/

Id operator that was responsible
for this transaction.
OperatorPartyId
trn_trans.operator_party_id
15. Subtotal BigDecim 17,6 u Total of all items, not

al including tax.
Subtotal
trn_trans.subtotal
trl_rtrans.subtotal
16. Tax Amount BigDecim 17,6 u Total tax charged for all line
al items.
TaxAmount
trn_trans.taxtotal
trl_rtrans.taxtotal
17. Total BigDecim 17,6 u Transaction total including all

al items and tax.
Total
trn_trans.total
trl_rtrans.total
18. Customer Party BigInt u Customer party associated

Id with the sale transaction.
customerPartyId trl_rtrans.cust_party_id
19. Tax Exemption String 60 Tax exemption ID if

Id transaction was processed as
exempt.
TaxExemptionId
trl_rtrans.tax_exemption_id

Name
20. Transaction String 30 Reason code for cancelled

Cancelled transactions.
Reason Code
trn_trans.trans_cancel_
Transaction reascode
CancelledReason
Code
21. Fiscal Number String 100 Fiscal number for the

transaction.
FiscalNumber
trn_trans.fiscal_number
22. Device ID String 100 ID for the fiscal device used in

the transaction.
DeviceId
trn_trans.device_id
23. Fiscal Session String 100 Fiscal session number for the
Number transaction.
FiscalSession trn_trans.fiscal_session_
Number number
24. Transaction Date DateTime 23 Date of the transaction.

TransactionDate trn_trans.trans_date
<ValueTranslator
className="dtv.data2.dataloader.valuetranslator.DefaultValueTranslator">
<Param value="filePosition=04" key="default"/>
</ValueTranslator>


<Field literal="dtv.xst.dao.trl.impl.RetailTransaction" name="ClassName"
dataType="String" />
<Field literal="0" name="BeginTimeInt" dataType="Integer" />
<Field literal="false" name="KeyedOffline" dataType="Boolean" />
<Field literal="false" name="GenericStorage" dataType="Boolean" />

Transaction Line Item Record (TRANS_LINE_ITEM)

Contains transaction line information describing items sold and returned.
trl_sale_lineitm 3-7, 10, 14-21 SaleReturnLineItem
trl_rtrans_lineitm 3-9, 11-13 SaleReturnLineItem
Transaction Line Item Record (TRANS_LINE_ITEM) (Sheet 1 of 3)

2. Record Identifier String 30  TRANS_LINE_ITEM

RetailLocationId trl_sale_lineitm.rtl_loc_id
4. Business Date Date  Business date on which the

BusinessDate trl_sale_lineitm.business_date
trl_rtrans_lineitm.business_da
te

WorkstationId trl_sale_lineitm.wkstn_id
trl_rtrans_lineitm.wkstn_id

TransactionSequ trl_sale_lineitm.trans_seq
ence
7. Line Item Integer  Line item sequence. Must be

Sequence (PK) unique for every line
including ITEMS, TENDER,
RetailTransactio
TAX, etc.
nLineItemSeque
nce trl_sale_lineitm.rtrans_lineitm
_seq
trl_rtrans_lineitm.rtrans_lineit
m_seq
8. Line Start Time DateTime Date & Time that line was
started.
BeginDate
Timestamp trl_rtrans_lineitm.begin_date_
timestamp

9. Line End Time DateTime Date & Time that line was
completed.
EndDate
Timestamp trl_rtrans_lineitm.end_date_
timestamp
10. Line Item Type String 30 Code representing type of line:

SALE, RETURN, etc.
SaleReturnLineIt
emTypeCode trl_sale_lineitm.sale_lineitm_t
ypcode
11. Void Flag Boolean 5 TRUE/FALSE if line item was

voided.
Void
trl_rtrans_lineitm.void_flag
12. Void Line String 30 Code that represents why line

Reason Code was voided.
VoidLineItemRe trl_rtrans_lineitm.void_lineitm
asonCode _reascode
13. Currency Id String 3 3 digit ISO Currency code

used for this line.
CurrencyId
trl_rtrans_lineitm.currency_id
14. ItemId String 60 Retailer's SKU or unique

identifier of item sold/
ItemId
returned.
trl_sale_lineitm.item_id
15. SerialNumber String 60 Serial number of the item sold.

SerialNumber trl_sale_lineitm.serial_nbr
16. Quantity BigDecim 11,4 Quantity of the item sold.

al
Quantity trl_sale_lineitm.quantity
17. Unit Price BigDecim 17,6 Price of a single item on the

al line.
UnitPrice
trl_sale_lineitm.unit_price
18. Net Amount BigDecim 17,6 Total price: unit price times
al quantity.
NetAmount
trl_sale_lineitm.net_amt
19. Gross Amount BigDecim 17,6 Total amount: total price plus
al tax.
GrossAmount
trl_sale_lineitm.gross_amt
20. Return Flag Boolean TRUE/FALSE if line item is a

return.
Return
trl_sale_lineitm.return_flag
21. Tax Group ID String 60 ID of the tax group to which

the item belongs.
TaxGroupId
trl_sale_lineitm.tax_group_id



<Field literal="dtv.xst.dao.trl.impl.SaleReturnLineItem" name="className"
<Field literal="ITEM" name="LineItemTypeCode" dataType="String" />
<Field literal="0.0000" name="GrossQuantity" dataType="BigDecimal" />
<Field literal="1" name="taxGroupId" dataType="String" />


<Field filePosition="07" name="TLogSequence" dataType="Integer" />
<Field filePosition="14" name="ExtendedAmount" dataType="BigDecimal" />
<Field filePosition="16" name="NetQuantity" dataType="BigDecimal" />
<Field filePosition="17" name="BaseUnitPrice" dataType="BigDecimal" />
<Field filePosition="17" name="RegularBasePrice" dataType="BigDecimal" />
<Field filePosition="18" name="ExtendedAmount" dataType="BigDecimal" />
<Field filePosition="18" name="BaseExtendedPrice" dataType="BigDecimal" />

Transaction Line Item Tax Record (TRANS_LINE_ITEM_TAX)

Contains tax record(s) linked to transaction sale/return line items.
trl_sale_tax_lineitm ALL SaleTaxModifier
Transaction Line Item Tax Record (TRANS_LINE_ITEM_TAX) (Sheet 1 of 3)
1. Action Code String as  See “Valid Commands for a Data

specified File Record”.
2. Record Identifier String 30  TRANS_LINE_ITEM_TAX

RetailLocationId trl_sale_tax_lineitm.rtl_loc_id

BusinessDate trl_sale_tax_lineitm.business_dat
e

WorkstationId trl_sale_tax_lineitm.wkstn_id
6. Transaction BigInt  Transaction sequence ID/invoice

Sequence (PK) number.
TransactionSequ trl_sale_tax_lineitm.trans_seq
ence
7. Line Item Integer  Line item sequence linked to

Sequence (PK) ITEM record tax is represented
for.
RetailTransactio
nLineItemSeque trl_sale_tax_lineitm.rtrans_lineit
nce m_seq
8. Tax Item Integer  Sequence number for each

Sequence (PK) unique tax type linked to sale
line item.
SaleTaxModifier
Sequence trl_sale_tax_lineitm.sale_tax_line
itm_seq
9. Void Flag Boolean  TRUE/FALSE if line item was

voided.
Void
trl_sale_tax_lineitm.void_flag
10. Taxable Amount BigDecim 17, 6  The taxable amount for which
al tax was calculated.
TaxableAmount
trl_sale_tax_lineitm.taxable_amt

11. Tax Percentage BigDecim 17, 6  The effective tax percentage

al stored as a raw rate. Example:
TaxPercentage
7.5% tax must be specified as
0.075.
trl_sale_tax_lineitm.tax_percenta
ge
12. Tax Amount BigDecim 17, 6  Amount of tax.

al
TaxAmount trl_sale_tax_lineitm.tax_amt
13. Tax Exemption String 60 Tax exemption ID used to

Id exempt part or all of the amount
from tax.
TaxExemptionId
trl_sale_tax_lineitm.tax_exempti
on_id
14. Tax Exempt BigDecim 17, 6 Amount that was exempt from
Amount al tax.
TaxExemptAmo trl_sale_tax_lineitm.tax_exempt_
unt amt
15. Tax Group Id String 60  Tax group of the item taxed.

TaxGroupId trl_sale_tax_lineitm.tax_group_i
d
16. Tax Location Id String 60  Tax location.

TaxLocationId trl_sale_tax_lineitm.tax_loc_id
17. Tax Rule Integer  Tax rule used for this tax.
Sequence
trl_sale_tax_lineitm.tax_rule_seq
TaxRuleSequenc _nbr
e
18. Authority Id String 60  Tax authority charging tax.

AuthorityId trl_sale_tax_lineitm.authority_id
19. Authority Name String 50 Tax authority name.

AuthorityName trl_sale_tax_lineitm.authority_na
me
20. Authority Type String 30 Tax authority type.

Code
trl_sale_tax_lineitm.authority_ty
AuthorityTypeC pe_code
ode
21. Tax Override Boolean TRUE/FALSE if tax was

Flag overridden.
TaxOverride trl_sale_tax_lineitm.tax_override
_flag

22. Tax Override BigDecim 17, 6 The tax amount overridden by

Amount al user.
TaxOverrideAm trl_sale_tax_lineitm.tax_override
ount _amt
23. Tax Override BigDecim 10, 8 The tax percent overridden by

Percent al user.
TaxOverridePerc trl_sale_tax_lineitm.tax_override
entage _percentage
24. Tax Override String 30 The reason code of why tax was
ReasonCode overridden.
TaxOverrideReas trl_sale_tax_lineitm.tax_override
onCode _reascode


<Field filePosition="10" name="RawTaxAmount" dataType="BigDecimal" />
<Field filePosition="11" name="RawTaxPercentage" dataType="BigDecimal" />

Transaction Tax Record (TRANS_TAX)

Contains summary tax record(s) for a transaction by authority.
trl_tax_lineitm 3-7, 13-25 TaxLineItem
trl_rtrans_lineitm 3-12 TaxLineItem
Transaction Tax Record (TRANS_TAX) (Sheet 1 of 3)

2. Record Identifier String 30  TRANS_TAX

RetailLocationId trl_tax_lineitm.rtl_loc_id

BusinessDate trl_tax_lineitm.business_date
te

WorkstationId trl_tax_lineitm.wkstn_id

TransactionSequ trl_tax_lineitm.trans_seq
ence

Retail
TAX, etc.
TransactionLine
ItemSequence trl_tax_lineitm.rtrans_lineitm_
seq
m_seq
started.
BeginDate
timestamp

completed.
EndDate
Timestamp trl_rtrans_lineitm.end_date_
timestamp

voided.
Void

asonCode _reascode
12. Currency Id String 3  3 digit ISO Currency code

used for this line.
CurrencyId
13. Tax Amount BigDecim 17,6  Amount of tax charged.

al
TaxAmount trl_tax_lineitm.tax_amt
14. Tax Percentage BigDecim 8,6  Tax percentage stored as a raw

al rate. Example: 7.5% tax must
TaxPercentage
be specified as 0.075.
trl_tax_lineitm.tax_percentage
15. Taxable Amount BigDecim 17,6  Amount for which tax was
al charged.
TaxableAmount
trl_tax_lineitm.taxable_amt
16. Tax Group Id String 60  Tax group of the items

charged tax.
TaxGroupId
trl_tax_lineitm.tax_group_id
17. Tax Location Id String 60  Tax location at which the tax

accrued.
TaxLocationId
trl_tax_lineitm.tax_loc_id
18. Tax Rule Integer  Tax rule sequence number

Sequence from tax tables.
TaxRuleSequenc trl_tax_lineitm.tax_rule_seq_n
e br
19. Authority Id String 50  Tax authority collecting the

tax.
AuthorityId
trl_tax_lineitm.authority_id
20. Authority Name String 50 Tax authority name.

AuthorityName trl_tax_lineitm.authority_nam
e

21. Authority Type String 30 Tax authority type.

Code
trl_tax_lineitm.authority_type
AuthorityTypeC _code
ode
22. Tax Override Boolean TRUE/FALSE if tax was

Flag overridden.
TaxOverride trl_tax_lineitm.tax_override_fl
ag
23. Tax Override BigDecim 17, 6 The tax amount overridden by

Amount al user.
TaxOverrideAm trl_tax_lineitm.tax_override_a
ount mt
24. Tax Override BigDecim 10, 8 The tax percent overridden by

Percent al user.
TaxOverridePerc trl_tax_lineitm.tax_override_p
entage ercentage
25. Tax Override String 30 The reason code of why tax

ReasonCode was overridden.
TaxOverrideReas trl_tax_lineitm.tax_override_r
onCode eascode


<Field literal="dtv.xst.dao.trl.impl.TaxLineItem" name="className" dataType="String" />
<Field literal="TAX" name="LineItemTypeCode" dataType="String" />


<Field filePosition="07" name="TLogSequence" dataType="Integer" />
<Field filePosition="14" name="RawTaxPercentage" dataType="BigDecimal" />
<Field filePosition="15" name="RawTaxAmount" dataType="BigDecimal" />

Transaction Tender Record (TRANS_LINE_TENDER)

Contains tender line items for transactions.
ttr_tndr_lineitm 3-7, 14-22 TenderLineItem
trl_rtrans_lineitm 3-9, 11-13 TenderLineItem
Transaction Tender Record (TRANS_LINE_TENDER) (Sheet 1 of 3)

2. Record Identifier String 30  TRANS_LINE_TENDER

RetailLocationId ttr_tndr_lineitm.rtl_loc_id

BusinessDate ttr_tndr_lineitm.business_date
te

WorkstationId ttr_tndr_lineitm.wkstn_id

TransactionSequ ttr_tndr_lineitm.trans_seq
ence

RetailTransactio
TAX, etc.
nLineItemSeque
nce ttr_tndr_lineitm.rtrans_lineitm
_seq
m_seq
started.
BeginDate
timestamp

completed.
EndDate
Timestamp trl_rtrans_lineitm.end_date_ti
mestamp
exist.

voided.
Void

asonCode _reascode
13. Currency Id String 3  3 digit ISO Currency code

used for this line.
CurrencyId
14. Tender Id String 60  Name of the tender as it exists

in the tender table.
TenderId
ttr_tndr_lineitm.tndr_id
15. Amount BigDecim 17,6  Amount of tender accepted or

al refunded.
Amount
ttr_tndr_lineitm.amt
16. Serial Number String 254 ID of the tender: used

primarily for vouchers. Do not
SerialNumber
put credit/debit card #s here.
ttr_tndr_lineitm.serial_nbr
17. Tender Status String 30  Either "Tender", "Refund" or

Code "Change" depending on if the
tender was received or issued.
TenderStatusCod
e ttr_tndr_lineitm.tndr_statcode
18. Change Flag Boolean TRUE/FALSE if change was

due.
Change
ttr_tndr_lineitm.change_flag
19. Host Validation Boolean TRUE/FALSE if tender was

Flag validated against an external
agency.
HostValidation
ttr_tndr_lineitm.host_validatio
n_flag
20. Approval Code String 30 Code returned with approval

response.
ApprovalCode
ttr_tndr_lineitm.approval_cod
e

21. Foreign Amount BigDecim 17, 6 Amount submitted in foreign

al currency tender.
ForeignAmount
ttr_tndr_lineitm.foreign_amt
22. Acct User Name String 254 Name of user that performed
the tender (house account
AcctUserName
signers).
ttr_tndr_lineitm.acct_user_na
me


<Field literal="dtv.xst.dao.ttr.impl.TenderLineItem"
name="className" dataType="String" />
<Field literal="TENDER" name="LineItemTypeCode"
<Field literal="false" name="Void" dataType="Boolean" />
<Field literal="false" name="GenericStorage" dataType="Boolean"
/>
<Field literal="false" name="Change" dataType="Boolean" />
<Field literal="false" name="HostValidation" dataType="Boolean"
/>


<Field filePosition="07" name="TLogSequence" dataType="Integer"
/>

Line Item Association Type Code Record (LINE_ITEM_ASSOCIATION_TYPE_CODE)
Line Item Association Type Code Record

(LINE_ITEM_ASSOCIATION_TYPE_CODE)
Contains line item association type codes information.
trl_lineitm_assoc_typcode All Fields LineItemAssociationTypeCode
Line Item Association Type Code Record (LINE_ITEM_ASSOCIATION_TYPE_CODE) (Sheet 1 of

2)
Name Comment

2. Record Identifier String 30  "LINE_ITEM_ASSOCIATION

_TYPE_CODE"
3. line Item String 30  The string value of the line

Association Type item association type code. For
Code (PK) example WARRANTY.
"lineItemAssocia trl_lineitm_assoc_typcode.line
tionTypeCode" itm_assoc_typcode
4. cascade Delete Boolean When true, the child item

flag should be deleted with the
parent item.
"cascadeDelete"
trl_lineitm_assoc_typcode.casc
ade_delete_flag
5. cascade Quantity Boolean u When true, the child item

flag quantity should be updated
with the parent item quantity.
“cascadeQuantit
y” trl_lineitm_assoc_typcode.casc
ade_quantity_flag
6. child Restrict Boolean When true, the child item may

Delete flag not be deleted.
“childRestrictDel trl_lineitm_assoc_typcode.chil
ete” d_restrict_delete_flag

Price flag not have its price changed.
“childRestrictPri trl_lineitm_assoc_typcode.chil
ce” d_restrict_price_flag

Quantity flag not have its quantity changed.
"childRestrictQu trl_lineitm_assoc_typcode.chil
antity" d_restrict_quantity_flag

Line Item Association Type Code Record (LINE_ITEM_ASSOCIATION_TYPE_CODE)
Line Item Association Type Code Record (LINE_ITEM_ASSOCIATION_TYPE_CODE) (Sheet 2 of

2)
Name Comment
9. description String 254 The text description for the

line item association type.
"description"
trl_lineitm_assoc_typcode.des
cription
10. parent Restrict Boolean When true, the parent item

Delete flag may not be deleted.
"parentRestrictD trl_lineitm_assoc_typcode.par
elete" ent_restrict_delete_flag

Price flag may not have its price
changed.
"parentRestrictPr
ice" trl_lineitm_assoc_typcode.par
ent_restrict_price_flag

Quantity flag may not have its quantity
changed.
"parentRestrictQ
uantity" trl_lineitm_assoc_typcode.par
ent_restrict_quantity_flag
13. sort Order Integer Determines the order in which

a list is sorted.
"sortOrder"
trl_lineitm_assoc_typcode.sort
_order

Valid Commands for a Data File Record

Command Description
BEGIN_RUN_SQL† This action behaves identically to the "RUN_SQL" action, but is

executed by the DataLoader BEFORE all other records are processed.
†
This action may not be needed beginning with Xstore version 4.0.
(This action was originally created to get around the DataLoader's lack
of "replacement" functionality in previous Xstore versions.)
DELETE Removes the specified data from the database, if it exists. If the record
to be deleted does not exist, the DELETE will have no effect.
DELETE_BY_ Removes the specified data, only within the specified organization,
ORGANIZATION from the affected table before applying the file records. (*.reo file)
INSERT Indicates this is new data that should be inserted into the database. If
the data to be inserted already exists in the database, the DataLoader
will attempt an update to ensure that the database matches the
information that was sent in the file.
INSERT_ONLY The data will be inserted if it does not already exist. If the data already
exists, no action is taken.
RUN_SQL The Run SQL action type allows for any SQL statement to be executed.
TRUNCATE Deletes all data in the affected table before applying the file records.
(*.rep file)
UPDATE Indicates this record contains existing data that is being modified. If the
record to be modified does not already exist in the database, the
DataLoader will not attempt an INSERT and the update will be neither
effective nor applied.
UPDATE_SELECT Indicates this data should only update database columns referenced by
DataLoader file record fields populated with non-null data. This partial
update feature allows for the update of records without overwriting all
the record's fields.

Transaction Returned Item Journal (TRANS_RETURNED_ITEM_JOURNAL)
Transaction Returned Item Journal

(TRANS_RETURNED_ITEM_JOURNAL)
Contains a link between a return transaction and the original sale.
trl_returned_item_journal 3-14 ReturnedItemJournal
trl_returned_item_count 3-7, 9 ReturnedItemCount

2. Record Identifier String 30  TRANS_RETURNED_ITEM_

JOURNAL

Id (PK) original transaction occurred.
RetailLocationId trl_returned_item_journal.rtl_
loc_id
trl_returned_item_count.rtl_
loc_id

(PK) original transaction occurred.
BusinessDate trl_returned_item_journal.
business_date
trl_returned_item_count.
business_date

(PK) original transaction occurred.
WorkstationId trl_returned_item_journal.
wkstn_id
wkstn_id

Sequence (PK) invoice number for the
original transaction.
TransactionSequ
ence trl_returned_item_journal.
trans_seq
trans_seq

7. Line Item Integer  Line item sequence for the

Sequence (PK) item in the original
transaction. Must be unique
RetailTransactio
for every line including
nLineItemSeque
ITEMS, TENDER, TAX, etc.
nce
trl_returned_item_journal.
rtrans_lineitm_seq
rtrans_lineitm_seq
8. Returned Item Integer  Returned item journal. Must

Journal Sequence be unique for every line .
(PK)
trl_returned_item_journal.
JournalSequence journal_seq
9. Returned Item Integer Number of items returned in

Count the transaction.
ReturnedCount trl_returned_item_count.
returned_count
10. Returned Retail Integer Retail location at which the

Location Id return transaction occurred.
ReturnedRetailL trl_returned_item_journal.
ocationId rtn_rtl_loc_id
11. Returned Date Business date on which the

Business Date return transaction occurred.
ReturnedBusines trl_returned_item_journal.
sDate rtn_wkstn_id
12. Returned BigInt Workstation at which the

Workstation Id return transaction occurred.
ReturnedWorkst trl_returned_item_journal.
ationId rtn_business_date
13. Returned BigInt Transaction sequence ID/

Transaction invoice number for the return
ReturnedTransac trl_returned_item_journal.
tionSequence rtn_trans_seq
14. Returned Line Integer Line item sequence for the

Item Sequence returned item. Must be unique
for every line including
ReturnedRetailTr
ITEMS, TENDER, TAX, etc.
ansactionLineIte
mSequence trl_returned_item_journal.
rtn_rtrans_lineitm_seq


18
DataLoader Commands
Command Description
BEGIN_RUN_SQL† This action behaves identically to the "RUN_SQL" action, but is

executed by the DataLoader BEFORE all other records are processed.
†This action may not be needed beginning with Xstore version 4.0.
(This action was originally created to get around the DataLoader's
lack of "replacement" functionality in previous Xstore versions.)
DELETE Removes the specified data from the database, if it exists. If the
record to be deleted does not exist, the DELETE will have no effect.
DELETE_BY_ Removes the specified data, only within the specified organization,
ORGANIZATION from the affected table before applying the file records. (*.reo file)
INSERT Indicates this is new data that should be inserted into the database. If
the data to be inserted already exists in the database, the DataLoader
will attempt an update to ensure that the database matches the
information that was sent in the file.
INSERT_ONLY The data will be inserted if it does not already exist. If the data
already exists, no action is taken.
RUN_SQL The Run SQL action type allows for any SQL statement to be
executed.
(*.rep file)
UPDATE Indicates this record contains existing data that is being modified. If
the record to be modified does not already exist in the database, the
DataLoader will not attempt an INSERT and the update will be
neither effective nor applied.
UPDATE_SELECT Indicates this data should only update database columns referenced
by DataLoader file record fields populated with non-null data. This
partial update feature allows for the update of records without
overwriting all the record's fields.
Valid Commands for a Data File Record 18-1

DataLoader Commands

19
DataLoader
Overview
The DataLoader application is
responsible for translating flat
data files into database data that
can be used by Xstore Point of
Service. For example, many host
systems can be configured to
export data to a delimited flat file.
Then, that flat file is delivered to
the stores throughout the chain.
Finally, the flat file is read in by
the DataLoader and loaded into
the store databases for use. This is
one option for propagating data
changes (such as prices,
employees, etc.) to all the
databases throughout the
enterprise.
DataLoader 19-1
DataLoader Operation
Starting DataLoader
A dataloader2.bat and a dataloader2.sh script are provided with Xstore Point of
Service builds to launch the DataLoader. Assuming that the DataSourceConfig.xml
and DataLoaderConfig.xml configurations are correct, you should only have to run
the dataloader2 script to launch DataLoader. The main class for launching the
DataLoader is dtv/data2/dataloader/DataLoader.
Note: There is a separate batch file to launch DataLoader for trickle

download purposes named dataloader2-trickle.bat.
Xenvironment will call this file when running in trickle mode.
With dataloader2-trickle.bat, replacement files are skipped
when processing trickle downloads. This prevents replacement files
from processing at times when the store is not closing.
The DataLoader is normally executed by the Xenvironment application, either directly

during the nightly closing process or by its crontab for Trickle Polling. If the DataLoader
is launched and no Data File is present, it will exit without loading any data.
DataLoader Operation Description

DataLoader will apply all qualifying files in the configured download directory. The
README.txt file includes a list of file name patterns to be ignored by the DataLoader
when processing download files in that directory (for example, *.txt, *.doc, and
*.lst).
DataLoader handles file archiving in both store and central installations.
About .lst files

A *.lst file is a text file containing a list of filenames to be loaded.
If the processListFiles parameter value is true, then only the contents of *.lst
files will be considered. If there are no *.lst files, then no files will be loaded.
If false, then files will be loaded as described in this section.
List files will be deleted after the data files have been processed. The data files that were
processed are archived.
DataLoader Execution
When the DataLoader is executed, the following sequence takes place:
1. The DataLoader reads each qualifying file in the folder (or each file listed in the
.lst file if configured for list files). It will interrogate all files that are not excluded
by the file type filter and will only process files that are effective at the time that it is
run. Only those files which either lack an effective date declaration, or which declare
an effective date prior to—or on—the run date will be processed.
2. The DataLoader performs the following processes as it iterates through each file:
a. The DataLoader scans the entire Data File, creating “Split Files”.
* Split Files are a mechanism for sorting and organizing the data without
loading it all into memory (since Data Files are often hundreds of thousands
of lines).

* Split File names are in the form: <dataFilename>.<recordType>.<command>.
Note: For example, download.dat.ITEM.INSERT, or

download.dat.EMPLOYEE.UPDATE.
* Split Files exist only while the DataLoader is executing, not before or after
execution.
b. Once the Split Files are created, the DataLoader will scan through them one at a
time, in the proper order, and load the records.
Records are read and loaded at this point based on the
recordsPerTransaction configuration.
* If a line fails, the entire transaction is retried one record at a time.
* If a record fails individually during this second load, it is written to
failures.dat along with the error that caused it.
c. When the DataLoader has finished loading all the Split Files, it deletes the Split
File.
3. A success.dat file is created if the operation is completed successfully.
DataLoader archives success and failure files in addition to archiving the source files
it processes. These related source/success/failure files are archived to timestamped
folders to ensure their segregation from runs performed at other times. The files
themselves will not be renamed. A DataLoader configuration setting determines
how many days worth of files to archive (both source and result).
4. The Dataloader writes a file with status information about the files that were loaded
to C:\xstore\download directory named summary.ini. Xenvironment can then
process the results and send them to Xstore Office.
For example, the summary.ini file includes the following information about the
loaded files:
[item_images.mnt]
rows=0
failedRows=9
appliedDate=1375392342973
exception.java.lang.NullPointerException=8
DataLoader 19-3
About the failures.dat File

If a line in the data file fails to perform its requested action, DataLoader will place a copy
of that line into a file called failures.dat. The failures.dat file is created by the
DataLoader any time there are errors in a file that it was trying to process. Use this file to
see what is incorrect, and make the corrections manually.
• The failures.dat file will include any failed download records lines, as well as
an error indicating the cause of the failure of those lines.
• An archive copy of the failures.dat file is created with the downloads that were
processed, and the most recent copy is left in the download folder.
• The copy that is left behind in the download folder is deleted prior to processing
new files when the dataloader is run the next time.
Sample failures.dat Line

# Line failed to load due to:
dtv.data2.access.exception.PersistenceException: makePersistent()
exception caught trying to persist dao of type
[dtv.xst.dao.crm.impl.PartyDAO] with id: dtv.xst.dao.crm.PartyId
id value: 1000::null on datasource: Local. Statement: INSERT INTO
crm_party(organization_id, party_id, create_date, create_user_id,
update_date, update_user_id, allegiance_rtl_loc_id, birth_date,
cust_id, employee_id, federal_tax_id, first_name, first_name2,
gender, last_name, last_name2, middle_name, preferred_locale,
organization_name, organization_typcode, party_typcode,
picture_uri, salutation, sign_up_rtl_loc_id, social_security_nbr,
state_tax_id, suffix, void_flag, anniversary_date, prospect_flag,
rent_flag, privacy_card_flag, commercial_customer_flag,
contact_pref) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?,
?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?) Params:
[1000, null, 2011-07-25 16:48:41.93, DATALOADER, 2011-07-25
16:48:41.93, DATALOADER, null, null, null, null, null, null,
null, null, null, null, null, null, null, null, null, null, null,
null, null, null, null, false, null, false, false, false, false,
null]
INSERT,PARTY,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
DataLoader Logging
The DataLoader employs log4j loggers for its logging facility. It also defines special
loggers for reporting load successes and failures to the central office, if so configured.
• Dataloader log4j is typically configured with config/dataloader/log4j.xml.
• INFO level logging should be enabled on the
dtv.data2.dataloader.DataLoader category to log a brief report of the data
load.
• Dataloader will log data lines that fail to load to a log4j category called
DATA_LOADER_FAILURES_APPENDER. This category can be configured to use a
separate appender and log failed lines to a separate file.

DataLoader Data Files
DataLoader Data Files

The DataLoader is designed to adapt flat files of data into relational data that Xstore can
use. These flat files are referred to generically as “data files” within the DataLoader.
The DataLoader treats each line in a data file as a record. Each line in the data file is
divided, by delimiter characters, into individual records.
• The first field in every line is a command field that describes what is to be done with
the record described in the file line.
• The second field in the line is a record type field that describes the data represented
by the record.
• Subsequent fields contain the appropriate data for that record.
Fields are typically delimited by an ASCII character. By default, the field delimiter used
in the data file is auto-detected by DataLoader. There is one delimiter per file, based on
the first record.
The DataLoader refers to each record by its index number. Field position indices are 1-
based, with the command being field 1, the record type being field 2, and the first piece
of actual data being 3, the second piece of actual data being 4, and so on.
Data File Line Example

INSERT|CARTON|RECEIVING|DDS|101|286881|2211343|OPEN|WAREHOUSE
In this example, “INSERT” is the command, indicating that this is new data that should
be inserted. The record type is “CARTON”, indicating that the following data represents
an inventory carton instance. The ‘|’ character is the delimiter that separates the fields.
Replacement File Processing

Replacement file processing provides the ability to deliver a file whose intended
function is to "Replace all the data in the X, Y, and Z tables with all of the data included
in the file." There are two Replacement file types: *.rep (replace) and *.reo (reorganize).
Both of these file types are treated as standard ".mnt" data files, except that each has an
additional set of operations.
Replacement File Types:
• *.rep ("replace")—Delete all data in the affected table before applying the file records
(i.e. "TRUNCATE TABLE x").
• *.reo ("reorganize")—Delete all data in the affected table having the organization id
matching any of the file's records ("i.e. DELETE FROM x WHERE organization_id =
?"). This file type provides support for maintaining data for multiple "organizations"
in a shared Xcenter database.
DataLoader will process files according to the following order, without regard to file
format:
1. All effective .rep files sorted in ascending order by file name
2. All other effective files sorted in ascending order by file name
DataLoader 19-5
Replacement File Processing
*.rep (replace) Files

The Replacement feature includes a DataLoader operation: TRUNCATE, which
truncates all records from the database table associated with the data model parameter.
The form of the operation is: TRUNCATE<delimiter><data model>, i.e.
"TRUNCATE|ITEM_MESSAGE" will remove all records in the itm_item_msg table of
the Xstore database.
Example
*.rep files imply a TRUNCATE operation for each data model with a DataLoader
operation within the replacement file. If a *.rep file has ten insert commands, half of
which are for the ITEM model and half for the ITEM_MESSAGE model, then both the
itm_item and itm_item_msg tables will have all their records deleted before any of the
insert commands are executed.
Note: When viewing the log file, a .rep file will contain one truncate
line for every data type represented in the contents.
For example, if a .rep file with 6 lines is processed, the log will show
that 7 lines were processed; all of the lines plus a truncate line.
*.reo (reorganize) Files

The Reorganization feature includes a DataLoader operation:
DELETE_BY_ORGANIZATION. This operation is similar to the TRUNCATE operation,
except that an organization id must be provided as a parameter to the operation, and
only records within the specified organization will be deleted from the table.
The form of the operation is: DELETE_BY_ORGANIZATION<delimiter><data
model><delimiter><organization id>, i.e.
"DELETE_BY_ORGANIZATION|ITEM_MESSAGE|1000" would remove all records in
the itm_item_msg table of the Xstore database with an organization_id of 1000.
Note: *.reo files imply a DELETE_BY_ORGANIZATION operation

for each data model with a data loader operation within the
replacement file. The organization that has its records deleted is
defined in the DataLoaderConfig.xml file by the "OrganizationId"
parameter. If a *.reo file has ten insert commands, half of which are for
the ITEM model and half for the ITEM_MESSAGE model, then both
the itm_item and itm_item_msg tables will have all their records
deleted before any of the insert commands are executed.
Replacement File Types Processing Comparison

• *.rep first truncates the tables to be populated by the file, eliminating data spanning
multiple organization IDs if such data is present.
All files not meeting this pattern will be interpreted as *.mnt (maintenance) files and
processed accordingly.
• *.reo only deletes records for the pre-configured organization ID, and leaves the
others unchanged.


Command Description
DELETE Removes the specified data from the database, if it exists. If the record to
be deleted does not exist, the DELETE will have no effect.
DELETE_BY_ Removes the specified data, only within the specified organization, from
ORGANIZATION the affected table before applying the file records. (*.reo file)
INSERT Indicates this is new data that should be inserted into the database. If the
data to be inserted already exists in the database, the DataLoader will
attempt an update to ensure that the database matches the information
that was sent in the file.
INSERT_ONLY The data will be inserted if it does not already exist. If the data already
exists, no action is taken.
RUN_SQL The Run SQL action type allows for any SQL statement to be executed.
(*.rep file)
UPDATE Indicates this record contains existing data that is being modified. If the
record to be modified does not already exist in the database, the
DataLoader will not attempt an INSERT and the update will be neither
effective nor applied.
UPDATE_SELECT Indicates this data should only update database columns referenced by
DataLoader file record fields populated with non-null data. This partial
update feature allows for the update of records without overwriting all
the record's fields.
The DataLoader loads records based on the order in which they are defined in the
DataLoaderConfig.xml. The order in which these action types are declared is
important. It dictates the order in which the DataLoader processes records grouped by
action type. The records are then sorted by their command (or action type).
This list shows the full ordered set of actions:
1. ACTION_TRUNCATE
2. ACTION_DELETE_BY_ORGANIZATION
3. ACTION_DELETE
4. ACTION_INSERT
5. ACTION_UPDATE
6. ACTION_UPDATE_SELECT
7. ACTION_RUN_SQL
8. ACTION_INSERT_ONLY
About the “UPDATE” and “UPDATE_SELECT” Action Types

Records with a type of "UPDATE" are interpreted as an update to every column
supported by the corresponding record type/DAO mapping in
DataLoaderConfig.xml. Using the UPDATE command, if you wanted to update a
given item's "description" field but leave all other fields unchanged, the file record must
DataLoader 19-7
be explicitly populated with the item's pre-existing, non-description values. This is an

undesirable restriction for both bloat and maintenance reasons.
For this reason, the UPDATE_SELECT operation was added.
This partial update feature allows for the update of records without overwriting all the
record's fields. UPDATE_SELECT will not write a blank value to the corresponding field
of its data model operand. A primary key must be provided for proper record
identification.
For example, the following data loader line:
"UPDATE_SELECT|ITEM_MESSAGE|999||||||image/png"
will update the itm_item_msg record with primary key 999 and only change the
content_type field with the new value "image/png."
Note: Additional pipes (delimiter) must be added to offset the fields

that are not to be changed.
About the “RUN_SQL” Action Type

The Run SQL action type allows for any SQL statement to be executed. This record can
be used to perform data manipulations that cannot be accommodated via standard
interfaces by providing the ability to run a SQL script that is inside a download.mnt
file. The format of the file line is simply the “RUN_SQL” constant, followed by a proper
delimiter, then a valid SQL statement.
Run SQL Record (RUN_SQL)
1. Action Code Text as  RUN_SQL

specified
2. SQL Statement Text  The SQL statement to be

executed.
To run SQL statements from download.mnt, the row in the file must be similar to the
following:
RUN_SQL|update loc_rtl_loc set region = 27
Note: When processing a download file with a RUN_SQL Action

Type row, the RUN_SQL statement must be only 1 line in the
download.mnt file to run correctly.

Header and Comments
Header and Comments

An optional header can be specified as the first line of a Data File. (It cannot exist in
another location in the file). The header provides information describing the content of
the download file, and is in an XML format.
The XML header supports both the specification of a line count and a dataload id. The
line count represents the number of records to be processed in the file. It does not
include the header and/or comment lines. If the actual processed line count does not
match the header specified line count, an exception will be logged. The DataLoader
*may* not process a file in which the line count does not match the contents of the file.
This is determined by the setting of the “continueIfLineCountInvalid” parameter
in the DataLoaderConfig.xml file.
XML Header
Each file contains an XML header line that will dictate when and where the file is
delivered.
Line Count
The line_count attribute is used to indicate how many lines of data are in the file (not
including the header). If it is not present, the DataLoader will not validate total line
count when loading the file, but will still load the file.
Download Id
The download_id attribute is used to identify the download and is used in logging to
separate the processing of one download file from another. The download id, when
present, is included in the logging messages while this file is being processed. (These
logging messages may be replicated to Xcenter to provide corporate visibility for the
processing of download files.)
Application Date
The application_date attribute is used to determine the date on which the file will be
deployed. If the application date attribute is not present, the date that the file is picked
up will be used which means the file will be deployed on the same day.
Target Org Node

The target_org_node attribute is used to determine to what org node or store collection
the file will be deployed. Its format is <org code>:<org value> (e.g. STORE:102) or
<CollectionName> (e.g. My Collection). If the target org node attribute is not
present, *:* will be used which means the file will be delivered to all stores in the
organization.
Deployment Name
If the deployment_name field is populated, the value will be used as the name for the
deployment, otherwise the auto-suggestion name will be used.
Download Time
The download_time attribute is used to indicate when the file will be downloaded.
Possible values are "IMMEDIATE" and "STORE_CLOSE".
- If a deployment is scheduled for immediate download, Xenvironment will begin
to download the file immediately.
DataLoader 19-9
DataLoader Configuration
- If a deployment is scheduled for download during the store close,

Xenvironment will wait until the nightly closing process is initiated to begin
downloading the file.
- If download_time is not present, the deployment will be scheduled with
"STORE_CLOSE".
Apply Immediately
The apply_immediately attribute is used to indicate when the file will be applied.
Possible values are true and false.
- If set to true, the file is loaded immediately.
- If set to false, the file is scheduled to be applied during the closing process.
- If "apply_immediately" is not present, the deployment will be scheduled with
"false".
Note: See the Xstore Office User Guide for more information.
Example: Dataloader header for file created by Xstore Office. All

DataLoader files created by Xstore Office will have this header.
<Header line_count="3" download_id="configurator::7::72::0"
application_date="2013-05-26" target_org_node="STORE:102"
deployment_name="specified_name" download_time="IMMEDIATE"
apply_immediately="true" />
Example: Dataloader header for file not created by Xstore Office

<Header line_count=”1100” download_id=”holiday_item_2020”
application_date=”2020-01-01” />
At the heart of the DataLoader is its configuration. The DataLoader configuration file
(DataLoaderConfig.xml) maps fields from the flat file to fields on Java data objects
which can then be persisted to the database via Xstore’s persistence framework (DTX).
The DTX object information can be found in the Java Doc:
• Table name,
• Java field name,
• Database name,
• or use existing maps for reference
Any modification or transformation of the data that is required will be specified in this
configuration file. Also, SQL statements can be placed in the configuration file in order
to load the data in an appropriate fashion.

DataLoaderConfig.xml
<DataLoaderConfig xmlns:xs="http://www.w3.org/2001/XMLSchema-
instance" xs:noNamespaceSchemaLocation="DataLoaderConfig.xsd">
<Parameter name="DataFileLocation" value="./download"/>
<Parameter name="OrganizationId"
value="${dtv.location.organizationId}"/>
<Parameter name="DataSource" value="Local"/>
<Parameter name="recordsPerTransaction" value="100"/>
<Parameter name="continueIfLineCountInvalid" value="true"/>
<Parameter name="archivePath" value="./download/archive"/>
<Parameter name="archiveDays" value="30"/>
<Parameter name="characterEncoding" value="ISO-8859-1"/>
<Parameter name="processListFiles" value="false"/>
The following table lists and describes the header parameters for
DataLoaderConfig.xml.
Parameter Description
DataFileLocation Specifies from where to read the datafile. This can be an absolute
path pointing to a file (e.g. “c:/xstore/download/download.dat”) or
can point to a directory (“c:/xstore/download/”). If the
DataFileLocation property is set to a directory, the DataLoader
will scan that directory for files with a .lst extension. Each .lst file
found should contain absolute or relative paths to actual data
files to load.
OrganizationId The integer organization ID to use for populating org ID. This is
the value that will be used for the sysProp references in
DataSource Specifies the DataSource (from DataSourceConfig.xml)

where the data will be loaded. Typically, this has a value such as
“Local” in order to load data to the local register's database.
recordsPerTransaction Defines how many records the DataLoader will attempt to

persist as one database transaction. This value can be adjusted
for performance. A higher value typically improves performance
until memory restrictions come into play.
If a failure occurs during a transaction, the DataLoader will
attempt to load the records in the transaction one at a time in
order to isolate a bad piece of data and continue the load to the
best of its ability.
continueIfLineCountInvalid Defines whether or not the DataLoader will process a data file
whose “expected line count sum” fails. (i.e., the LINE_COUNT
specified in the header does not match the actual number of
lines in the file)
archivePath Defines the directory location where data files will be moved
and archived after processing.
DataLoader 19-11
Parameter Description
archiveDays Defines the number of days that archived folders should be kept.
Note that this is date and time relevant, not just date. One day is
a 24-hour period based on the run date. For example, assume
that archiveDays is set to 1. Data Loader is run at 3:00 PM on 04/
25 and then at 9:00 AM on 04/26. The archive folders from the
04/25 run will not be deleted. Then Data Loader is run at 5:00
PM on 04/26. The 04/25 run is then more than one 24-hour
period before the current one, so the archive folders from 04/25
will be deleted.
characterEncoding Defines the character encoding for files. Value is ISO-8859-1

(This value can be changed.)
processListFiles If the value is "true", then only the contents of *.lst files will be
considered. If there are no *.lst files, then no files will be loaded.
If "false", then files will be loaded as per the functionality
described in “DataLoader Operation Description”.
The value is "false" by default.
Note: List files will be deleted after the data files have been
processed. The data files that were processed are archived.
Note: The field delimiter used in the data file is auto-detected by

DataLoader.

DataLoaderConfig.xml Record Definition

<RecordType name="STOCK_LEDGER">
<Dao name="StockLedger" action="INSERT">
name="OrganizationId"/>
<Field filePosition="03" name="RetailLocationId"/>
<Field filePosition="04" name="ItemId"/>
<Field filePosition="05" name="BucketId"/>
<Field filePosition="06" name="InvLocationId"/>
<Field filePosition="08" name="InventoryValue"/>
<Field filePosition="09" name="Unitcount"/>
</Dao>
<Sql sql="UPDATE inv_stock_ledger_acct
SET unitcount = unitcount + ?
WHERE organization_id = ?
AND rtl_loc_id = ?
AND item_id = ?
AND bucket_id = ?
AND inv_location_id = ? " action="UPDATE">
<Field filePosition="09" dataType="BigDecimal"/>
dataType="Long"/>
<Field filePosition="03" dataType="Long"/>
<Field filePosition="06" dataType="String"
default="DEFAULT"/>
</Sql>
</RecordType>
Element/Attribute Description
RecordType Defines the name of this record type. All record types in a Data File must
correspond to a mapping in the DataLoaderConfig.xml. When a Data
File is downloaded that contains multiple record types, the records are
loaded in the order that they are defined in the
Dao Defines a Data Access Object to map this data to. The cardinality for Daos
on a record type is 0..*. No Daos would be acceptable if at least 1 SQL
statement is present for the record type.
DataLoader 19-13
DataLoaderConfig.xml Value Translation
Element/Attribute Description (continued)
Sql Defines an arbitrary SQL statement to run for this record type. The
cardinality for SQL statements is also 0..* and no SQL statements are
required if there is at least 1 Dao present.
Field Maps data either to a Dao field or to a SQL statement place holder.
sysProp Instructs the DataLoader to use the value of this system property for the
value of this field.
filePosition Instructs the DataLoader to retrieve data from the specified field position
in the data file for the value of this field.
literal Instructs the DataLoader to use the literal data that follows for the value
of this field.
variable Instructs the DataLoader to use some current state of the system as the
value for this field. Currently, $currentDateTimestamp and $currentDate are
available.
name The name of the field to map this data to. This is only applicable for Daos.
dataType The data type (String, Integer, BigDecimal, Long, Date, etc.) of this field.
This is only required for fields in a SQL statement.

Often, data downloaded in the Data File must be translated/transformed into a different
form to be understood by Xstore.
Example Value Translator Usage: StringConcatTranslator

<RecordType name="DEAL_TRIGGER">
<Dao name="DealTrigger">
<Field filePosition="03" name="DealId"/>
<Field name="Trigger">
<ValueTranslator
className="dtv.data2.dataloader.valuetranslator.StringConcatTrans
lator">
<Param key="string.1" value="filePosition=04"/>
<Param key="string.2" value=":"/>
<Param key="string.3" value="filePosition=05"/>
</ValueTranslator>
</Field>
<Field filePosition="06" name="OrgCode"/>
<Field filePosition="07" name="OrgValue"/>
</Dao>
</RecordType>

In the example above, strings are concatenated together to form the value for the field.
The key=”string.1”, key=”string.2”, and key=”string.3” define the order of the strings,
value=”filePosition=04” and value=”filePosition=05” define the field position in the data
file, and value=”:” is the literal value.
Sample database value for DEAL_TRIGGER example:
Any implementation of dtv/data2/dataloader/valuetranslator/

IValueTranslator can be specified as a value translator for a field. Each
implementation of that interface defines what set of parameters it requires to function.
Some value translators do not require any parameters to function.
Below are some examples of IValueTranslator implementations:
Value Translator
Description Parameters
BooleanInverterTranslator
Interprets the data as a boolean value and inverts it. key=true/false value=truth
Truth values include several defaults but are value/false value. Adds to a list
configurable. This translator returns either 0 or 1 to of values to interpret as true and
represent the boolean value after inversion. Users may false.
specify multiple keys for true/false. This translator
key=null value=true/false.
maintains an internal list of truth values and simply
Specifies whether a null value
adds the parameters to it. Useful in cases where the
should be considered true or
input data and the schema have the same flag, but
false before inversion.
inverted. e.g. “allow discounts” v. “disallow
discounts”.
ConditionalValueTranslator
Transforms the data conditionally based on what data key=if: value=then: (1..*, an
is presented. If no “else:” parameter is specified and the “if…then” condition)
presented data does not find a match, the data will be
key=else: value=then: (0..1, an
returned as it was originally presented.
“else” default value)
OptionalStringConcatTranslator
Concatenates any number of strings together to form key=SEPARATOR

the value for the field. This operates similar to the value=separator string to insert
StringConcatTranslator with two important differences. between the other strings.
First, there is an optional separator between values.
key=DEFAULT value=default
Second, strings are optional. If a value is null or empty,
string to output if the final string
it does not concatenate it. String parameters are
from concatenation is empty.
inserted in key order, e.g. String.1, String.2, etc. Users
Defaults to the empty string.
may specify any substring after the “string.” part, but
keep in mind that they are ordered by the natural sort key=STRING.XYZ where XYZ is
order of the java.lang.String class. Useful for cases any value. value=String to
where input data specifies multiple fields and the concatenate. This string may be a
schema needs to merge them together. literal, file position, etc.
DataLoader 19-15
Value Translator
Description Parameters
SqlQueryTranslator
Performs a SQL query against the database to retrieve key=sql, value=select item_id…
the value to use for this field. If the query returns null, (1..1 the sql query to execute)
then the nullValue parameter value is used for the
key=sql.field.xx
value. If no nullValue is specified and the query returns
value=filePosition=yy (0..*,
null, then the original value from the data file is used.
where xx if the 1 based index of
the sql placeholder and yy is a
field index in the data file. A
literal, variable, or sysProp could
also be used for the value)
StringConcatTranslator
Concatenates any number of strings together to form key=string.xx

the value for the field. Strings that go into the value=filePosition=yy (1..*,
concatenation could be any combination of filePosition, where xx = is a 1=based index
literal, sysProp, or variable values. value defining the order of the
string, and yy is the field
position in the data file.
StringMapReplaceTranslator
Maps input strings to output strings. The input string key=PreserveNotFound

must match completely, and it only performs one map value=true/false whether to
replacement before stopping. If the input is not found preserve input values if not
in the map, either blank it out or leave it as is. Useful found in the map or to set them
for translating code values. to the empty string.
key=Split value=arbitrary string
that specifies where to split key/
value pairs in the mapping.
Defaults to double colon, "::".
Must occur before any map
entries that rely on its value.
key=Mapping value=string.
Specifies a map entry. The value
is a key/value pair delimited by
the “Split” string specified
earlier.
StringReplaceTranslator
Performs a “search and replace” on the current field key=searchFor value=xx (1..1,
value. where xx is an arbitrary string)
key=replaceWith value=yy (1..1,
where yy is the string to replace
xx with)
ZeroToNullTranslator
Translates any form of 0 (e.g. “0”, “00000”, “0.00”) to No parameters required

NULL.

Failure Reporting
Dao and Sql Statement Applicability

Each Dao and Sql statement that is specified for Record Type can be conditionally
activated based on the contents of the data being presented.
For example, a Record Type may map to two Daos, but it may be desirable to utilize the
second Dao only if the value at field position 3 is “RECEIVING”.
. . .
<Dao name=”Shipment”>
className="dtv.data2...ValueApplicabilityCondition">
<Param key="testValue" value="filePosition=03"/>
<Param key="applicable.if.1" value="RECEIVING"/>
<Field literal="1" name="ShipmentSequence"/>
Any implementation of dtv/data2/dataloader/applicability/
IApplicabilityCondition can be used for an applicability condition. As with Value
Translators, an implementation of IApplicabilityCondition decides what parameters it
requires to operate.
Applicability Condition Description Parameters
ValueApplicabilityCondition Causes this Dao/Sql key=testValue value=filePosition=xx

statement to only be (1..1, specifies the value to test)
applicable if the test
key=applicable.if.xx
value is found in the
value=someValue (1..*, where xx is
“applicable.if.xx” list.
the one-based index of the condition
and someValue is either another
filePosition, literal, sysProp, or value)
(Note: in the example above,
“RECEIVING” is assumed to be a
literal since it is not filePosition=,
sysProp, etc.)
Failure Reporting
When a file is deployed from Xstore Office to Xstore Point of Service and processed by
the DataLoader, Dataloader will report errors to Xstore Office through the event logging
facility. A DataLoader error (DATALOADER_ERROR) is reported in the “Updates”
category in the Xstore Office Support Dashboard.
Note: DataLoader will only return errors to Xstore Office for files
deployed from Xstore Office.
DataLoader 19-17
Failure Reporting

A
Change History
Version 17.0
Chapter Change
System Codes & Values Added REASON_CODE_PROPERTY Record.

Added DEVICE_CONFIG Record.
Items & Pricing ITEM_DEAL_PROPERTY Record:

• Changed target to itm_item_deal_prop table from
itm_item_deal_prop_p table
Parties - Customers & Added CUSTOMER_CONSENT_INFO Record.

Employees
Added CUSTOMER_ANONYMIZE Record.
Added EMPLOYEE_ANONYMIZE Record.
FREE_GIFTCARD Record:
• Added GroupId field.
• Added SortOrder field.
REBATE Record:
• Added GroupId field
• Added SortOrder field
COUPON_DEAL Record
• Added GroupId field.
Tenders, Vouchers, & Added TENDER_REPOSITORY_STATUS Record.

Till Sessions
Country Packs Removed PAF_ADDRESS_MUNI, PAF_CARD_NETWORK,

PAF_NFE_TRANS_TYPE, PAF_NFE_TRANS_TYPE_PROPERTY,
PAF_NFE_TRANS_TYPE_USE, PAF_NFE_TRANS_TAX, and
PAF_NFE_TAX_CST records.
Entire document In all fields where a string identifies the type of value stored by the
record, changed DECIMAL to BIGDECIMAL.
Change History A-1

Version 16.0.0.1, Revision 03
Chapter Change
Transaction Records TRANS_HEADER Record:

• Changed BeginDatetimestamp to BeginDateTimestamp
• Added FiscalNumber field.
• Added DeviceId field.
• Added FiscalSessionNumber field.
• Added TransactionDate field.
• Added <ValueTranslator
className="dtv.data2.dataloader.valuetranslator.DefaultValueTra
nslator">
TRANS_LINE_ITEM Record:
TRANS_TAX Record:
TRANS_LINE_TENDER Record:
Airside Stores & Tax- Removed database tables and Dataloader records and referred reader
Free Transactions to Database Dictionary and Host Interface Guide.

Chapter Change
Inventory INV_DOC Record - Added valid values to Destination Type field.
Discounts, Coupons, DEAL Record - Added GroupId field.

Deals, & Documents
Airport Retail Location FLIGHT_INFORMATION Record - Added Origin Airport field.

Support Corrected field length to 3 for Destination Airport, Via 1 Airport, Via
2 Airport, and Via 3 Airport.
Transaction Records TRANS_LINE_ITEM Record - Added Tax Group ID field.
DataLoader Updated “Failure Reporting” section.

Chapter Change
Items & Pricing ITEM_TAX_GROUP Record - Added Tax Group Id field.
A-2 Host Interface Guide

Version 16.0.0.1
Version 16.0.0.1
Chapter Change
Send Us Your Changed name of Oracle Retail Xstore for Grocery User Guide to Oracle
Comments Retail Xstore Point-of-Service, Lane Checkout User Interface User Guide.
Version 16.0, Revision 02

Chapter Change
Taxing TAX_GROUP Record - Added Tax Code ID field.
Version 16.0
Chapter Change
System Codes and RETAIL_LOCATION Record:

Values
• Removed “ZoneId” field.
• Added “AirportCode” field.
Items and Pricing ITEM Record:

• Removed “RestrictionCategory” field.
• Added “ExcludeFromNetSales” field.
• Removed “TareTypeCode” field.
• Added “TareValue” field
• Added “TareUnitOfMeasureCode” field.
ITEM_OPTIONS Record:
• Removed “RestrictionCategory” field.
• Added “ExcludeFromNetSales” field.
• Removed “TareTypeCode” field.
• Added “TareValue” field
• Added “TareUnitOfMeasureCode” field.
Discounts, Coupons, DISCOUNT_TYPE_ELIGIBILITY

Deals, & Documents
• Corrected list of possible values for Sale Line Item Type Code.
DEAL_ITEM_TEST
• Corrected list of possible values for Item Field
Change History A-3

Chapter Change
Tenders Vouchers and TENDER Record:

Till Sessions
• Added “AssignCashDrawerRequired” field.
• Added “PostVoidAssignCashDrawerRequired” field.
TENDER_OPTIONS Record:
• Added “FiscalTenderId” field.
• Added “RoundingMode” field.
• Added “AssignCashDrawerRequired” field.
• Added “PostVoidAssignCashDrawerRequired” field.
Airport Retail Location FLIGHT_INFORMATION Record:

Support
• Removed “DestinationCountry” field.
• Removed “DestinationEUcode” field.
• Removed “Via1Country” field.
• Removed “Via1EuCode” field.
• Removed “FinalFlightEUCode” field.
• Removed “ExpirationDate” field.
• Removed “DestinationAirportName” field.
• Removed “EmployeeFlag” field.
Removed AIRPORT_ZONE_MAPPING Record.

Chapter Change
Items and Pricing ITEM Record - Changed Qty Scale to a Decimal Type.
ITEM_OPTIONS Record - Changed Qty Scale to a Decimal Type.

Chapter Change
Items and Pricing Reorganized order of records.
Entire Document General proofreading and corrections.
A-4 Host Interface Guide

Xstorepos 170 Hig PDF

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Xstorepos 170 Hig PDF

Hochgeladen von

Copyright:

Verfügbare Formate

Oracle® Retail Xstore Point of Service

Host Interface Guide

2 System Codes & Values..................................................................2-1

3 Items & Pricing.................................................................................3-1

4 Parties - Customers & Employees .................................................4-1

6 Discounts, Coupons, Deals, & Documents ...................................6-1

8 Accounts, Loyalty & Warranties.....................................................8-1

9 Work Orders .....................................................................................9-1

12 Payroll, Scheduling & Timecard...................................................12-1

13 Thermal Printer Support ...............................................................13-1

14 Airport Retail Location Support ...................................................14-1

16 Xstore Office Users .......................................................................16-1

17 Transaction Records .....................................................................17-1

18 Valid Commands for a Data File Record .....................................18-1

A Change History ............................................................................... A-1

Send your comments to us using the electronic mail address: retail-doc_us@oracle.com

Access to Oracle Support

• Xstore Point-of-Service Services Guide

Review Patch Documentation

Oracle Retail Documentation on the Oracle Technology

The following information is intended for programmers and implementation personnel

How this Document is Organized

1-2 Host Interface Guide

Action Codes & Record Identifiers

1-4 Host Interface Guide

Fixed Sequence Components - Base Xstore Point of Service

Sequence Type Context Old New Change

EMPLOYEE Create Employee 14 14 [3/-1]: workstationId

Party Create Customer 14 14 [3/-1]: workstationId

Voucher 14 14 [3/-1]: workstationId

GIFT_CERTIFICATE Sell Gift 10 12 [4/+1]: retailLocationId

STORE_CREDIT Issue Store 11 13 [4/+1]: retailLocationId

GIFT_CARD 14 14 [3/-1]: workstationId

MERCHANDISE_ 14 14 [3/-1]: workstationId

TAX_EXEMPTION 14 13 [3/-1]: workstationId

Xstore Point of Service International Support

Column Data Types: varchar or nvarchar

1-6 Host Interface Guide

Organization Hierarchy Record (ORG_HIER)

Database Table Updated Fields Dao name

loc_org_hierarchy All Fields OrgHierarchy

Organization Hierarchy Record (ORG_HIER) (Sheet 1 of 2)

Field # Name Type Width Required Comment

1. Action Code String as  See Chapter 18, “Valid

2. Record Identifier String 30  “ORG_HIER”

3. Level Code String 30  The level code based on the

4. Level Value String 60  The value for the level code.

5. Parent Code String 30 The parent code of this current

System Codes & Values 2-1

Organization Hierarchy Record (ORG_HIER) (Sheet 2 of 2)

Field # Name Type Width Required Comment

6. Parent Value String 60 The parent value of this current

7. Level Manager String 254 The name of the person

8. Description String 254 A description of the node.

9. Level Order Integer The order of current hierarchy.

10. Sort Order Integer Determines the order in which a

11. Inactive flag Boolean 5 If true, the org hierarchy is

2-2 Host Interface Guide

Retail Location Record (RETAIL_LOCATION)

Database Table Updated Fields Dao name

loc_rtl_loc All Fields RetailLocation

Retail Location Record (RETAIL_LOCATION) (Sheet 1 of 4)

Field # Name Type Width Required Comment