Data Interface Requirements
Below are some of the core data interfaces that are needed to drive Claret
Master Data
Finished Good Items
Field | Data Type | Description | Example | Required? |
---|---|---|---|---|
Parent Item Name | String (255 character max) | Unique identifier for parent item (if this item is not in the top level of the hierarchy) | 123A | |
Name | String (255 character max) | Unique identifier for the item | 123ABC | |
Description | String (255 character max) | Text to further explain the item. This is not unique. | ZAM Apps NV CS |
Work in Process (WIP) Items
Field | Data Type | Description | Example | Required? |
---|---|---|---|---|
Parent Item Name | String (255 character max) | Unique identifier for parent item (if this item is not in the top level of the hierarchy) | 123A | |
Parent Item Current Vintage | String (255 character max) | Year of the current vintage for the bulk item | 2021 | |
Name | String (255 character max) | Unique identifier for the item | 123ABC | |
Description | String (255 character max) | Text to further explain the item. This is not unique. | ZAM Apps NV CS | |
Routings.Name | String (255 character max) | Name of routing if the routing interface (below) is being used. One of this 'Routing' column and 'Age on Release' column is required | Cabernet Sauvignon Standard Routing | |
Age on Release | Integer | Duration, in months, of the aging profile for the bulk wine | 12 | |
Age Start Date | Date | The start date for aging | 2024-03-01 |
Crop Items
Field | Data Type | Description | Example | Required? |
---|---|---|---|---|
Parent Item Name | String (255 character max) | Unique identifier for parent item (if this item is not in the top level of the hierarchy) | CAB | |
Name | String (255 character max) | Unique identifier for the item | CAB-A | |
Description | String (255 character max) | Text to further explain the item. This is not unique. | A Grade Cabernet Sauvignon |
Customer Groups
Field | Data type | Description | Example | Required |
---|---|---|---|---|
Parent Customer Group Name | String (255 character max) | Unique identifier for parent customer group (if this item is not in the top level of the customer group hierarchy) | 789X | |
Name | String (255 character max) | Unique identifier for the customer group | 789XYZ | |
Description | String (255 character max) | Text to further explain the customer group. This is not unique. | Jane’s Liquor |
Locations
Field | Data type | Description | Example | Required |
---|---|---|---|---|
Name | String (255 character max) | Unique identifier for the location | 456WHS | |
Description | String (255 character max) | Text to further explain the location. This is not unique. | ZAM Warehouse |
Item @ Locations
Field | Data type | Description | Example | Required |
---|---|---|---|---|
Items.Name | String (255 character max) | This is the unique name used in the Items table | 123ABC | |
Locations.Name | String (255 character max) | This is the unique name used in the Locations table | 456WHS |
Item @ Customer Groups
Field | Data type | Description | Example | Required |
---|---|---|---|---|
Items.Name | String (255 character max) | This is the unique name used in the Items table | 123ABC | |
Customer Groups.Name | String (255 character max) | This is the unique name used in the Customer Groups table | 789XYZ |
Routings
Field | Data type | Description | Example | Required |
---|---|---|---|---|
Routing Name | String (255 character max) | Unique identifier for the routing | Cabernet Sauvignon Standard Routing | |
Routing Description | String (255 character max) | Text to further explain the routing. This is not unique. | Standard aging profile for Cabernet Sauvignon | |
Time in Barrel | Integer | Number, in months, of time spent in barrel for this profile | 6 | |
Time in Tank | Integer | Number, in months, of time spent in tank for this profile | ||
Time in Bottle | Integer | Number, in months, of time spent in bottle for this profile | 6 |
Recipes
Field | Data Type | Description | Example | Required? |
---|---|---|---|---|
Items.Name as Recipe Header | String (255 character max) | Unique identifier, from the Items table, that the recipe is for | 123A | |
Locations.Name | String (255 character max) | This is the unique name used in the Locations table. Only required if recipes are to be location specific (for example with crops) | 456WHS | |
Yield Quantity | Decimal (8,2) | The yield amount for the recipe | 1.00 | |
Yield UOM | String (255 character max) | Unit of measure that this yield represents. Note: Claret has a list of UOMs to choose from. | 9LE Case | |
Items.Name as Ingredient | String (255 character max) | Unique identifier, from the Items table, for the ingredient of the recipe. (If there is more than one ingredient another row of data will be required) | ZAMNVCS21 | |
Quantity | Decimal (12,4) | Quantity of the ingredient in the recipe | 0.2 | |
UOM | String (255 character max) | Unit of measure that this quantity represents. Note: Claret has a list of UOMs to choose from. | Ton | |
Convert to UOM | String (255 character max) | Unit of measure that this quantity should be converted to (if required). Note: Claret has a list of UOMs to choose from. | Gallon | |
Conversion Factor | Decimal (8,2) | If 'Convert to UOM' is populated, the conversion factor to make this conversion | 3 | |
Waste Factor | Decimal (12,4) | The % of waste lost during conversion | 1.00% |
Transactional Data
Sales
This contains sales history, sales forecasts and any other sales projection data.
Field | Data type | Description | Example | Required |
---|---|---|---|---|
Items.Name | String (255 character max) | This is the unique name used in the Items table | 123ABC | |
Customer Groups.Name | String (255 character max) | This is the unique name used in the Customer Groups table | 789XYZ | |
Sell Date | Date | The date when this sale took place(in the case of historical sales) or when the sale will take place(forecasted sales) | 2023-01-01 | |
Timing Interval | String (255 character max) | Timing interval that the Sell Date represents. Note: Claret has a list of Timing Intervals to choose from. | month | |
Quantity | Decimal (16,4) | The sales quantity that this record represents | 100 | |
UOM | String (255 character max) | Unit of measure that this quantity represents. Note: Claret has a list of UOMs to choose from. | 9LE Case | |
Sale Type | String (255 character max) | Identifies what kind of sales data this row represents (e.g. “Budget”,“History”, etc.). Note: Claret has a list of Sale Types that are user-defined. | Forecast |
Inventory: Bulk wine
Field | Data type | Description | Example | Required |
---|---|---|---|---|
Items.Name | String (255 character max) | This is the Intended Use or Program of the bulk wine | ZAMNVCS21 | |
Locations.Name | String (255 character max) | Location where the inventory is located. | ZAM-WINERY | |
Bin | String (255 character max) | The identifier for where the bulk wine is located within the location(e.g. Tank 123, Barrel Group ABC, etc.) | Tank 123 | |
Location area | String (255 character max) | Section of the winery. Usually to help group the bins (tanks). For instance, “Northeast Tank Group”. | Northeast Tank Group | |
Lot | String (255 character max) | Unique lot code for the bulk wine | LOT.123.ABC | |
Quantity | Decimal (16,4) | The amount of inventory. | 100000 | |
UOM | String (255 character max) | Unit of measure that this quantity represents (e.g. “Gallon”,“Liter”,etc.). Note: Claret has a list of UOMs to choose from. | Gallon | |
Fill Date | Date | The date this bin (tank/vessel)was filled with this wine. | 2021-09-15 |
Inventory: Finished goods
Note: Same data fields as Bulk Wine inventory
Items.Name | String (255character max) | This is the non-vintage item (e.g.“Bonanza”) | 123ABC | |
Locations.Name | String (255character max) | Storage location | 456WHS | |
Bin | String (255character max) | Not necessary | Generic FG Bin | |
Location area | String (255character max) | Not necessary | Generic FG Area | |
Lot | String (255character max) | Not necessary | Generic lot | |
Quantity | Decimal (16,4) | The amount of inventory | 1000 | |
UOM | String (255character max) | Unit of measure that this quantity represents. Note: Claret has a list of UOMs to choose from. | 9LE Case | |
Fill Date | Date | When was this inventory stored. We can assume this to be the date of when we pulled the inventory. | 2023-01-01 |
Supply Plan
Field | Data type | Description | Example | Required |
---|---|---|---|---|
Items.Name | String (255 character max) | This is the unique name used in the Items table | 123ABC | |
Locations.Name | String (255 character max) | This is the unique name used in the Locations table (only required if the Supply Type has a category of 'items-locations' within Claret | ZAM-WINERY | |
Date | Date | The date when this supply is planned for (or, historically, when the supply occurred) | 2023-01-01 | |
Timing Interval | String (255 character max) | Timing interval that the Date represents. Note: Claret has a list of Timing Intervals to choose from. | month | |
Quantity | Decimal (16,4) | The quantity that this supply plan record represents | 100 | |
UOM | String (255 character max) | Unit of measure that this quantity represents. Note: Claret has a list of UOMs to choose from. | Gallons | |
Supply Type | String (255 character max) | Identifies what kind of supply data this row represents (e.g. Make Plan, Crop Supply Plan, etc.). Note: Claret has a list of Supply Types that are user-defined. | Make Plan |
Last updated