I21 Quality Inspection
- Status
-
Version 1.0 published 05.04.2023
- Approval
- Comment
- Assumption
-
_
1. Stakeholder
Role | Application | Responsible |
---|---|---|
Communication |
Integration Layer |
Bernd Ledig |
Leading App |
||
InterfaceOwner |
FLASH |
Konstantin Volke |
Producer |
Babelfish |
Michael Hahne |
Consumer |
FLASH |
Konstatin Volke |
2. Business Context
Im Rahmen der Warenprüfungen werden über diese Schnittstelle die Informationen zu einem Prüfauftrag übermittelt.
3. Informationflow
Partner | Direction | FINE-Service | Topic/API | Description | Status |
---|---|---|---|---|---|
LIGIS |
send |
INBOUND |
qualityinspection |
ProductDataService |
in progress |
FLASH |
receive |
INBOUND |
qualityinspection |
ProductDataService |
in progress |
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 |
QUALITY_INSPECTION |
eventType |
QUALITYORDER_START, QUALITYORDER_CANCELATION, SECONDSAMPLE_REQUESTED, SECONDSAMPLE_RECEIVED, CLAIM_SEND, CLAIM_RECEIVED, CLAIM_APPROVED, QUALITYORDER_CREATED, QUALITYORDER_END, QUALITYORDER_START_BREAK, QUALITYORDER_END_BREAK, QUALITYORDER_ABORT |
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 |
Time of occurrence of the event |
version* |
The number of version schema |
|
context |
string |
The context / business case |
eventType* |
string |
The concrete type = kind of record(event) |
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"
] |
businessProcessUnit |
string |
businessProcessUnit |
inspectionId* |
string |
Quality Order ID |
testAccuracy |
Test accuracy |
|
testAccuracyHierarchy |
Test Accuracy Hierarchy |
|
inspectionResultCode |
Inspection Result Code |
|
faultCode |
array |
Fault Codes |
(Array item) |
string |
|
quantityFault |
object |
|
value |
integer |
the quantity for this item size/order |
unit |
string (enum) |
unit Any of: [
"GRAM",
"KILOGRAM",
"CUBIC_METER",
"METER",
"LITER",
"PIECES"
] |
quantityInspection |
object |
|
value |
integer |
the quantity for this item size/order |
unit |
string (enum) |
unit Any of: [
"GRAM",
"KILOGRAM",
"CUBIC_METER",
"METER",
"LITER",
"PIECES"
] |
quantityDelivery |
object |
|
value |
integer |
the quantity for this item size/order |
unit |
string (enum) |
unit Any of: [
"GRAM",
"KILOGRAM",
"CUBIC_METER",
"METER",
"LITER",
"PIECES"
] |
processTime* |
string (date-time) |
processtime |
product |
object |
|
erpProductId |
string |
Erp product Id Maximum Length: 50 |
supplier |
object |
|
id |
string |
¨ |
goodsIn |
object |
|
id |
string |
eindeutige Kennzeichnung der Wareneingang-Kopfdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInId möglich. |
positionId |
string |
eindeutige Kennzeichnung der Wareneingang-Positionsdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInPositionId möglich. |
4.1.3. Enumeration
Field: businessProcessUnit
Meta Value |
Description |
Short Value |
Deko |
||
Hartware |
||
Textil |
||
Schmuck |
||
Schuhe |
||
UNKNOWN |
4.1.4. Example
//include::QualiyInsepction.v1.0_sampleMessage.json[]
4.1.5. Schema
Version | Number | File | Published on | Changes |
---|---|---|---|---|
current version |
1.0 |
05.04.2023 |
||
previous version |
||||
coming version |
{
"$schema": "http://json-schema.org/draft-07/schema",
"$comment": "Schema for QualityInspection 1.0",
"$id": "https://doc.fine.gcp.osp-dev.de/registry/Inbound/QualityInspection.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",
"title": "Time of occurrence of the event",
"description": "Time at which this record(event) was technically generated in RFC3339 format.",
"examples": [
"2022-03-22T09:52:00.000+01: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}",
"maxLength": 6,
"examples": ["1.01", "01.02"]
},
{
"type": "integer",
"minimum": 1,
"maximum": 99999,
"examples": [1, 2]
}
]
},
"context": {
"type": "string",
"title": "The context / business case",
"description": "The context specified here means the business domain.",
"examples": [
"QUALITY_INSPECTION"
]
},
"eventType": {
"type": "string",
"title": "The concrete type = kind of record(event)",
"description": "This attribute is to be used if the data set can have more than one characteristic. E.g. goods delivery start or goods delivery end. The possible values are to be co-ordinated here as Enum between the partners.",
"examples": ["QUALITYORDER_START", "QUALITYORDER_CANCELATION","SECONDSAMPLE_REQUESTED","SECONDSAMPLE_RECEIVED","CLAIM_SEND",
"CLAIM_RECEIVED","CLAIM_APPROVED","QUALITYORDER_CREATED","QUALITYORDER_END","QUALITYORDER_START_BREAK","QUALITYORDER_END_BREAK","QUALITYORDER_ABORT"]
},
"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",
"description": "Goods Inspection Location"
},
"businessProcessUnit": {
"description": "Goods Inspection Team",
"type": "string",
"title": "businessProcessUnit",
"ENUM":["Deko","Hartware","Textil","Schmuck","Schuhe","UNKNOWN"]
},
"inspectionId": {
"description": "QualityorderID (technical code)",
"type": "string",
"title": "Quality Order ID",
"examples":["1234"]
},
"testAccuracy": {
"description": "Test accuracy",
"typeCode": "string",
"title": "Test accuracy",
"example": ["keine Prüfung","normal prüfen","reduziert prüfen"]
},
"testAccuracyHierarchy": {
"description": "Einteil- bzw. Vollprüfung",
"typeCode": "string",
"title": "Test Accuracy Hierarchy",
"example": ["Einteilprüfung","Vollprüfung"]
},
"inspectionResultCode": {
"description": "Inspection Result Code",
"typeCode": "string",
"title": "Inspection Result Code",
"example": ["100","102","105"]
},
"faultCode":{
"description": "list of errorCodes",
"type":"array",
"title": "Fault Codes",
"items": {
"type": "string",
"example": ["150","151"]
}
},
"quantityFault": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "the quantity for this item size/order"
},
"unit": {
"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/unit.v1.schema.json"
}
}
},
"quantityInspection": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "the quantity for this item size/order"
},
"unit": {
"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/unit.v1.schema.json"
}
}
},
"quantityDelivery": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "the quantity for this item size/order"
},
"unit": {
"$ref": "https://doc.fine.gcp.osp-dev.de/registry/MetaData/unit.v1.schema.json"
}
}
},
"processTime": {
"description": "Process Time",
"type": "string",
"format": "date-time",
"title": "processtime" ,
"examples":["2022-03-22T09:52:00.000+01:00"]
},
"product": {
"type": "object",
"properties": {
"erpProductId": {
"description": "FINE-LSAS ERP Product Identifier.",
"type": "string",
"maxLength": 50,
"title": "Erp product Id",
"examples": ["45896254"]
}
}
},
"supplier": {
"type": "object",
"properties": {
"id": {
"description": "Supplier ID",
"type": "string",
"title": "¨",
"examples":["123"]
}
}
},
"goodsIn": {
"type": "object",
"properties": {
"id": {
"description": "eindeutige Kennzeichnung der Wareneingang-Kopfdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInId möglich.",
"type": "string",
"title": "",
"examples":["123"]
},
"positionId": {
"description": "eindeutige Kennzeichnung der Wareneingang-Positionsdaten. Weitere Details des Wareneingangs sind über die Verknüpfung dieser ID mit inbound.goodsInPositionId möglich.",
"type": "string",
"title": "",
"examples":["4"]
}
}
}
},
"required": [
"location",
"inspectionId",
"processTime",
"erpProductId"
]
}
},
"required": [
"eventId",
"traceId",
"eventTime",
"version",
"eventType",
"data"
]
}