NCR Silver 2-Way Interface
Last Updated 6/13/2023
Overview
With NCR Silver we have a 2-way integration that works with both NCR Silver Essentials and NCR Silver Pro. Yellow Dog Inventory can both pull sales and item codes as well as push in new or changed items via NCR Silver’s API.
Sync Approach
Yellow Dog uses a SyncwithMicroServices to pull sales and item codes from NCR and push in new or changed items via the NCR API.
Sync Frequency
By default the microservices sync to push and pull data is scheduled to run hourly. Additional configuration options are available upon request.
Configuration
Prior to the start of your implementation, let the Yellow Dog team know if items already exists in NCR Silver as this will impact and potentially change our implementation approach.
For installations that have multiple stores in Yellow Dog, a single store will need to be selected to Push Items. Sales can be pulled into Yellow Dog for multiple stores or single stores.
Item and Tax Categories need to be configured in NCR prior to pushing in items.
This integration supports multiple NCR Square instances connected to a single Yellow Dog Database.
Requirements
Client
If the Yellow Dog database is not hosted by Yellow Dog Software, there may be additional firewall rules or port configurations necessary to facilitate communication. In order to exchange information with the NCR Silver API an internet connection will be needed.
POS Partner
The POS partner will need to provide the ClientID, Client Secret and any Tax Categories.
Yellow Dog
Yellow Dog requires the following:
Yellow Dog database version 370 or higher
A list of all Store Codes matched to the corresponding location in Yellow Dog
For sites with multiple location/stores in Yellow Dog, Yellow Dog will need to know what store to use for the Pushing of items.
Data Exchange and Mapping
Sales Data
Yellow Dog receives the following sales information:
| NCR Silver Field | Yellow Dog Field |
|---|---|
| Ticket # | TransactionNumber |
| Date Time | CheckClosed |
| Barcode | SKU |
| Name | Item |
| Unit Price | Item Retail |
| Line Discount / Ticket Discount | Discount |
| Item Discounts / Ticket Discounts | Discount Description |
| Quantity Sold | Quantity |
| User ID | Employee Number |
| Operator Name | Employee Name |
| Station | Register Name |
Each time the sync runs we look at the transactions for the past 7 days to ensure all sales are accounted for. This can be configure based on integration needs.
Item Data
The following item details are sent to NCR Silver:
| NCR Silver Field | Yellow Dog Field (Single/Matrix) | Created First In NCR Silver |
|---|---|---|
| Name (required) | POS Description 1 / Matrix Descripiton | |
| Online Name | Web Properties Title, else POS Description 1 / MAtrix Web Properties Title, else Matrix Description/ | |
| Description | Description | |
| Retail Price | Default Price | |
| Cost | Default Vendor Price | |
| Barcode (required) | UPC1, else SKU | |
| Tags | Web Properties Tags / Matrix Web Properties Tags | |
| Item Category Name | Item Interface - NCR Category / Primary Matrix Item Interface - NCR Category | X |
| Tax Category Name | Item Interface - NCR Tax Category / Primary Matrix Item's Interface - NCR Tax Category | X |
| Is Sellable | Item Interface - NCR Is Sellable / Primary Matrix Item's Interface - NCR Is Sellable | |
| Is Available Online | Web Properties - Send to Web / Matrix Web Properties - Send to Web | |
| Variation | Matrix Item Dimensions 1 and 2 |
Note: If any of the item Properties change in Yellow Dog, we will repush all the item properties.
System Codes
The code data we receive includes:
| NCR Silver Field | Yellow Dog Field |
|---|---|
| Item Category Name | Interface - NCR Category |
| Item Tax Category | Interface - NCR Tax Category |
| Is Sellable | Interface - NCR Is Sellable |
Workflows - Where Performed
| Workflow | Yellow Dog Inventory | NCR Silver |
|---|---|---|
| Create Retail POS Items | Done Only in Yellow Dog | |
| Create Stadium Stand POS Items | Done Only in Yellow Dog | |
| Create Restaurant POS Items | Could be Done in Yellow Dog | Typically Done in NCR Silver |
| Modifer Creation | Done Only in NCR Silver | |
| Modifer Assignment to Items | Done Only in NCR Silver | |
| Screen Placement for Items | Done Only in NCR Silver | |
| Discount Setup | Done Only in NCR Silver | |
| Discount Assignment | YDI can auto-assign NCR Silver Catergories which may control some discounting | Item specific discounting done in NCR Silver |
| Tax Setup | Done Only in NCR Silver | |
| Tax Assignment | YDI can assign Categories to the Item or Level (All Items in a Level will Inherit | |
| Category Setup | Done Only in NCR Silver | |
| Category Assignment | YDI can assign Categories to the Item or Level (All Items in a Level will Inherit) |
Actions in Yellow Dog Inventory - Result in NCR Silver
| Yellow Dog Inventory Action | NCR Silver Result |
|---|---|
| Item Edited In Anyway and Saved | All the item properties are re-applied to NCR Silver. |
| Item Changed to Not Available to Store in YDI | TBD |
| Item Inactivated | TBD |
| Item Removed | TBD |
| Level Is Changed | Change occurs if item inherits new Category or Tax codes from level in YD |
| Item has POSDescription 1, Publish set to "Yes" and POS Available set to "True" | Item Created |
| Publish set to "No" | Item will not be created in NCR Silver |
| POS available set to "False" | The item will not push to NCR Silver |
| Uncheck Availability to One Store; Item still available to other Stores | No change will occur unless it is the store desginated to push items |
| Uncheck Availbility for All Stores | TBD | On Hand changed in Yellow Dog | No change in NCR Silver, on hands updates not supported |
Actions done in NCR Silver - Result in Yellow Dog Inventory
| NCR Silver Action | Yellow Dog Inventory Result |
|---|---|
| Item Returned | On hand increased based on return quantity; treated separately from sale |
| Item Voided | No change in Yellow Dog, transactions are not updated in NCR Silver when voided. |
| Previous Check Voided | No change in Yellow Dog, transactions are not updated in NCR Silver when voided. |
| User Created item in NCR Silver, not in YD | None. If item is created in YD with same SKU, it can be matched by the sync and will then be updated in NCR based on what is in YD |
| Change Item in NCR Silver, not in YD | Overwrite items in NCR Silver the next time YD makes a change to the item in our system |
| Item is Sold in NCR Silver that is removed in YD | Sale is processed and assigned to the item as normal; Item in YD will be un-removed because on hand changed |
| Item sold in NCR Silver that is inactive in YD | Sale is processed and assigned to the item as normal |
| Menu Item Sold at POS | Populates in YD POS Item Mapping |
| Menu Item Created at POS | Does not populate in Yellow Dog until Sold |
| Modifier Sold at POS | Populates in YD POS Item Mapping |
| Modifier created at POS | Does not populate in Yellow Dog until Sold |
Additional Information
Limitations
Voids do not update transactions in NCR Silver’s API, therefore they are not handled in Yellow Dog.
Split checks and shared items can have rounding issues when itemized discounts are calculated.
NCR Silver supports a single barcode per item.
Only one store in Yellow Dog can be configured to Push items if pushing into multiple stores in NCR Silver. All items must be made available and configured at the chosen store.
The integration does not support pushing on hands to NCR Silver
NCR’s Item Name has a limitation of 50 characters max and does not allow duplicate names.
NCR has a limitation of UPC length of 20.
NCR does not support varying prices within a matrix item.
Yellow Dog “Merge” ability is not supported with this integration due to how items are pushed.
