I20 Goods In Error
- Status
-
Version 1.0 published 17.03.2023
- Approval
- Comment
- Assumption
-
_
1. Stakeholder
Role | Application | Responsible |
---|---|---|
Communication |
Integration Layer |
Bernd Ledig |
Leading App |
||
InterfaceOwner |
FLASH |
Konstantin Volke |
Producer |
KR1 |
Matthias Fraass |
Consumer |
FLASH |
Konstatin Volke |
2. Business Context
Im Rahmen der automatischen Kollierfassung in Haldensleben werden über diese Schnittstelle die Fehler beim Wareneingang übermittelt
3. Informationflow
Partner | Direction | FINE-Service | Topic/API | Description | Status |
---|---|---|---|---|---|
WMS:KR1 |
send |
INBOUND |
goodsinerror |
ProductDataService |
ready |
FLASH |
receive |
INBOUND |
goodsinerror |
ProductDataService |
ready |
4. Interface
4.1. Direction WMS to FINE and FINE to WMS
4.1.1. Header
This interface uses the Service Header
Special expresion for this interface:
Fieldname | Expresion |
---|---|
context |
GOODS_IN_ERROR |
eventType |
INSERT, UPDATE, DELETE |
4.1.2. Datamodel
Property | Type | Description |
---|---|---|
(Root) |
object |
|
eventId* |
string (uuid) |
The uniq eventId |
traceId* |
string (uuid) |
The uniq traceId |
spanId |
string |
The eventId of previous record or batchId |
eventTime* |
string (date-time) |
Time of occurrence of the event |
version* |
The number of version schema |
|
context |
string |
The context / business case |
eventType* |
string (enum) |
The type of operation Any of: [
"INSERT",
"UPDATE",
"DELETE"
] |
metaData* |
object |
additional meta information |
senderSystem* |
string (enum) |
system Any of: [
"KR1_SHF",
"KR1_HHSTR",
"WMSX_SON",
"WMSX_AKU",
"KMOTION_ILO",
"KMOTION_GHM",
"COBRA",
"LSAS",
"IDEEFIX",
"OBS",
"RESY",
"LDH",
"RETAILSCHICHT",
"BUBE",
"FINE_INBOUND"
] |
data* |
object |
|
location* |
string (enum) |
warehouse locations Any of: [
"ANSBACH",
"LOEHNE",
"LANGENSELBOLD",
"MOSINA",
"OHRDRUF",
"HALDENSLEBEN",
"HALDENSLEBEN_RT",
"SUEDHAFEN",
"SONNEFELD",
"ALTENKUNSTADT",
"WEIDEN",
"KRACANY",
"ILOWA",
"ILOWA_RT",
"ILOWA_RSS",
"GERNSHEIM",
"ERFURT",
"HAMBURG_RT",
"OTELFINGEN_RT",
"KRIMICE_RT",
"STAHLAVY_RT",
"OHRDRUF_RT",
"LOEHNE_RT",
"LANGENSELBOLD_RT",
"LODZ_1_RT",
"LODZ_2_RT",
"BERGHEIM_RT",
"ALTENKUNSTADT_RT",
"LISTERHILLS_RT",
"SUEDHAFEN_RT",
"PILSEN_RT",
"HAMBURG_SC",
"LOEHNE_SC",
"SCHWABHAUSEN_SC",
"HALDENSLEBEN_RSS",
"ALTENKUNSTADT_RSS",
"LOEHNE_RSS",
"OHRDRUF_RSS",
"LANGENSELBOLD_RSS",
"LOEHNE_CP"
] |
goodsInErrorId* |
string |
techn. key of this error that occurred during goods in of a particular storage handling unit |
storageHandlingUnitId* |
string |
techn. key of the storage handling unit that is subject to this very error |
error* |
string (enum) |
business key of the error type - as presented to the WMS users Any of: [
"E1_PACKAGE",
"E2_WEIGHT",
"E3_NO_LABEL",
"E4_2D_OCR_FAIL",
"E5_MASTER_DATA_MISSING",
"E6_PROD_DATA_MISSING",
"E7_SUPPL_DATA_MISSING",
"E8_NO_GOODSIN_MATCH",
"E9_MANUAL_HANDLING",
"E10_BAD_IMAGE",
"E11_GOODSIN_MISSING"
] |
errorCode* |
string |
human-readable (prosaic) version of error |
errorState* |
string (enum) |
current state of the error - created or resolved Any of: [
"CREATED",
"RESOLVED"
] |
errorTime* |
string (date-time) |
time when the error received its current state |
4.1.3. Enumeration
Field: error type
Meta Value |
Description |
Short Value |
E1_PACKAGE |
Abweichler Norm |
|
E2_WEIGHT |
Abweichler Gewicht |
|
E3_NO_LABEL |
kein 2D und Vorkleber verborgen |
|
E4_2D_OCR_FAIL |
kein 2D und OCR nicht erfolgreich |
|
E5_MASTER_DATA_MISSING |
Artikelnr./-größe im KR1 Artikelstamm und im Lieferantenstamm nicht bekannt |
|
E6_PROD_DATA_MISSING |
Artikelnr./-gröee im KR1 Artikelstamm nicht bekannt, aber im Lieferantenstamm bekannt |
|
E7_SUPPL_DATA_MISSING |
Artikelnr./-größe im KR1 Artikelstamm bekannt, aber nicht im Lieferantenstamm bekannt |
|
E8_NO_GOODSIN_MATCH |
Artikel nicht zu einer Sendungsnr. zuzuordnen |
|
E9_MANUAL_HANDLING |
NER-Kennzeichnung |
|
E10_BAD_IMAGE |
Foto nicht lesbar |
|
E11_GOODSIN_MISSING |
Keine Sendungszuordnung möglich |
4.1.4. Example
{
"eventId": "f4675429-bf86-4aee-995d-9ee260f800d8",
"traceId": "f4675429-bf86-4aee-995d-9ee260f800d8",
"eventTime": "2023-03-10T09:10:16.529+01:00",
"version": "1.0",
"context": "GOODS_IN_ERROR",
"eventType": "INSERT",
"metaData": {
"senderSystem": "KR1_HHSTR"
},
"data": {
"location": "HALDENSLEBEN",
"goodsInErrorId": "956921",
"storageHandlingUnitId": "91751080",
"error": "E9_MANUAL_HANDLING",
"errorCode": "NER-Kennzeichnung",
"errorState": "CREATED",
"errorTime": "2023-03-08T09:45:58.000+01:00"
}
}
4.1.5. Schema
Version | Number | File | Published on | Changes |
---|---|---|---|---|
current version |
1.0 |
17.03.2023 |
||
previous version |
||||
coming version |
{
"$schema": "http://json-schema.org/draft-07/schema",
"$comment": "Schema for Goods In Errors.",
"$id": "https://doc.fine.gcp.osp-dev.de/registry/Inbound/GoodsInErrorWms.v1.0.schema.json",
"type": "object",
"properties": {
"eventId": {
"type": "string",
"format": "uuid",
"title": "The uniq eventId",
"description": "Global uniq Id",
"examples": [
"00ce536f-923a-42f4-8128-be118faf1d87"
]
},
"traceId": {
"type": "string",
"format": "uuid",
"title": "The uniq traceId",
"description": "Global uniq Id for tracing the flow of events",
"examples": [
"00ce536f-923a-42f4-8138-33418faf1342"
]
},
"spanId": {
"type": "string",
"title": "The eventId of previous record or batchId",
"description": "Optionally, if this record (event) is one of a sequence of records and the order is important, then here is the id of the previous record (event), recommended as uuid, Special usecases can be specify for some interfaces",
"examples": [
"00ce536f-923a-42f4-5463-32a41877b3c2"
]
},
"eventTime": {
"type": "string",
"format": "date-time",
"title": "Time of occurrence of the event",
"description": "Time at which this record(event) was technically generated in RFC3339 format. Strongly recommended: in UTC time.",
"examples": [
"2016-04-16T16:06:05.000+02:00"
]
},
"version": {
"title": "The number of version schema",
"description": "Number of version of this data structure. Only required if no $schema is specified!",
"oneOf": [
{
"type": "string",
"pattern": "\\d+\\.\\d{1,2}",
"examples": [
"1.01",
"01.02"
]
},
{
"type": "integer",
"examples": [
1,
2
]
}
]
},
"context": {
"type": "string",
"title": "The context / business case",
"description": "The context specified here means the business domain.",
"examples": [
"returnsprocessing",
"storageLocation"
]
},
"eventType": {
"type": "string",
"title": "The type of operation",
"description": "INSERT events will usually signal a new error (with data.errorState CREATED); UPDATE events are usually issued when an error gets RESOLVED; and DELETE events occur when an error is subject to housekeeping/deletion from the WMS database",
"examples": [
"INSERT",
"UPDATE",
"DELETE"
],
"enum": [
"INSERT",
"UPDATE",
"DELETE"
]
},
"metaData": {
"type": "object",
"title": "additional meta information",
"description": "optional, can be used with different characteristics for technical data per interface",
"properties": {
"senderSystem": {
"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/system.v1.schema.json"
}
},
"required": [
"senderSystem"
]
},
"data": {
"type": "object",
"properties": {
"location": {
"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/warehouselocations.v1.schema.json"
},
"goodsInErrorId": {
"type": "string",
"description": "techn. key of this error that occurred during goods in of a particular storage handling unit",
"examples": [
"218530844"
]
},
"storageHandlingUnitId": {
"type": "string",
"description": "techn. key of the storage handling unit that is subject to this very error",
"examples": [
"218530844"
]
},
"error": {
"type": "string",
"description": "business key of the error type - as presented to the WMS users",
"examples": [
"E2_WEIGHT"
],
"enum": [
"E1_PACKAGE",
"E2_WEIGHT",
"E3_NO_LABEL",
"E4_2D_OCR_FAIL",
"E5_MASTER_DATA_MISSING",
"E6_PROD_DATA_MISSING",
"E7_SUPPL_DATA_MISSING",
"E8_NO_GOODSIN_MATCH",
"E9_MANUAL_HANDLING",
"E10_BAD_IMAGE",
"E11_GOODSIN_MISSING"
]
},
"errorCode": {
"type": "string",
"description": "human-readable (prosaic) version of error",
"examples": [
"Abweichler Gewicht"
]
},
"errorState": {
"type": "string",
"description": "current state of the error - created or resolved",
"examples": [
"CREATED"
],
"enum": [
"CREATED",
"RESOLVED"
]
},
"errorTime": {
"type": "string",
"format": "date-time",
"description": "time when the error received its current state",
"examples": [
"2016-04-16T16:06:05.000+02:00"
]
}
},
"required": [
"location",
"goodsInErrorId",
"storageHandlingUnitId",
"error",
"errorCode",
"errorState",
"errorTime"
]
}
},
"required": [
"eventId",
"traceId",
"eventTime",
"version",
"eventType",
"metaData",
"data"
]
}