Verträge / AddressPatch
Adresse Patch
AddressPatch · com.nexoware.connect.events
- Aggregat
- Address · State AddressState
- Topic
- address.patch je Mandant mit Präfix, z. B.
<mandant>.address.patch - Key
- AddressUuid
- Nachrichtenart
- Patch — ausdrückliche Teiländerungen, zusammengeführt vom Zusammenführungsdienst
- Schreiber
- c-entron Webservice (centron) , NEXOWARE.ERP (nexoware-erp)
- Retention
- 30 Tage
- Fassung
- Version 1 (neueste)
- Schema-ID
- 56
Patch-Pfad
- Pflicht bei Anlage
- AccountUuid, AddressKind, IsActive, IsDefault
- Fix nach Anlage
- AccountUuid
Kanonischer Vertrag, Version 1: Teilaenderung einer Adresse (ADR-0023 Punkt 3). Alle Patches einer Adresse laufen ueber dieses eine Topic mit Key = AddressUuid; der Zusammenfuehrungsdienst wendet sie in Kafka-Reihenfolge an und veroeffentlicht den State auf address.state. Semantik: Pfad nicht in ChangedFields -> unveraendert (Wert in Data wird ignoriert); Pfad in ChangedFields mit Wert -> setzen; mit null -> leeren, sofern die Einheit im State nullable ist. Die Maske ist Pflicht, ohne Wildcard. Die Anlage einer Adresse braucht AccountUuid, AddressKind, IsActive und IsDefault (requiredOnCreate); AccountUuid setzt nur der anlegende Patch (fixedAfterCreate). Ein ungueltiger Patch wird als Ganzes abgelehnt. Fachliche Anforderungen: docs/contracts/address.md.
Fassungen
Felder
-
EventId ↗ extern: EventId uuidBeim ersten Enqueue in die Outbox erzeugt, bei jeder Wiederholung identisch. Grundlage der fachlichen Deduplizierung.
-
AddressUuid Key uuidObjektidentitaet; muss dem Message-Key entsprechen.
-
Mode enum(CHANGE|INITIAL_LOAD)
-
ChangedFields Liste string[]Feldmaske: Pfade der geaenderten Einheiten, z. B. Street, City. Jeder Pfad nennt genau eine Einheit des State.
-
Data AddressPatchData
11 Felder von
AddressPatchData-
Default:
nullNur bei Anlage; danach lehnt der Dienst einen CHANGE mit diesem Pfad ab (FIXED_AFTER_CREATE). -
AddressKind optional intDefault:
null -
Street optional stringDefault:
null -
Zip optional stringDefault:
null -
City optional stringDefault:
null -
PostOfficeBox optional stringDefault:
null -
Department optional stringDefault:
null -
Default:
null -
BookKeepingNumber optional intDefault:
null -
IsActive optional booleanDefault:
null -
IsDefault optional booleanDefault:
null
-
-
ChangedByUuid optional ↗ extern: ChangedBy uuidDefault:
nullUUID des aendernden Mitarbeiters (Employee); null, wenn unbekannt. Audit. -
ChangedAt timestampZeitpunkt der Aenderung als UTC-Instant. Audit, kein Konfliktentscheider - es entscheidet die Kafka-Reihenfolge.
Referenziert von
- Ansprechpartner
ContactPersonPatch.Data.AccountAddressUuid - Ansprechpartner
ContactPersonState.AccountAddressUuid - Shop-Bestellung
EsOrderState.DeliveryAddress.AddressUuid - Web-Konto
WebAccountState.AccountAddressUuid
Rohfassung
Schema dieser Fassung (Avro)
{
"type": "record",
"name": "AddressPatch",
"namespace": "com.nexoware.connect.events",
"doc": "Kanonischer Vertrag, Version 1: Teilaenderung einer Adresse (ADR-0023 Punkt 3). Alle Patches einer Adresse laufen ueber dieses eine Topic mit Key = AddressUuid; der Zusammenfuehrungsdienst wendet sie in Kafka-Reihenfolge an und veroeffentlicht den State auf address.state. Semantik: Pfad nicht in ChangedFields -> unveraendert (Wert in Data wird ignoriert); Pfad in ChangedFields mit Wert -> setzen; mit null -> leeren, sofern die Einheit im State nullable ist. Die Maske ist Pflicht, ohne Wildcard. Die Anlage einer Adresse braucht AccountUuid, AddressKind, IsActive und IsDefault (requiredOnCreate); AccountUuid setzt nur der anlegende Patch (fixedAfterCreate). Ein ungueltiger Patch wird als Ganzes abgelehnt. Fachliche Anforderungen: docs/contracts/address.md.",
"fields": [
{
"name": "EventId",
"type": {
"type": "string",
"logicalType": "uuid"
},
"doc": "Beim ersten Enqueue in die Outbox erzeugt, bei jeder Wiederholung identisch. Grundlage der fachlichen Deduplizierung."
},
{
"name": "AddressUuid",
"type": {
"type": "string",
"logicalType": "uuid"
},
"doc": "Objektidentitaet; muss dem Message-Key entsprechen."
},
{
"name": "Mode",
"type": {
"type": "enum",
"name": "PatchMode",
"doc": "CHANGE: lokal autorisierte Aenderung, LWW je Einheit nach Kafka-Reihenfolge. INITIAL_LOAD: Erstbefuellung beim Anschluss eines Produkts - setzt eine Einheit nur, wenn sie noch nie geschrieben wurde; ueberschreibt nie einen vorhandenen oder ausdruecklich geleerten Wert. Bewusst ohne Enum-Default: ein unbekannter kuenftiger Modus darf nicht still als CHANGE gelesen werden.",
"symbols": [
"CHANGE",
"INITIAL_LOAD"
]
}
},
{
"name": "ChangedFields",
"type": {
"type": "array",
"items": "string"
},
"doc": "Feldmaske: Pfade der geaenderten Einheiten, z. B. Street, City. Jeder Pfad nennt genau eine Einheit des State."
},
{
"name": "Data",
"type": {
"type": "record",
"name": "AddressPatchData",
"doc": "Typisierte Werte. Alle Felder optional, damit ein Producer ausserhalb der Maske nichts erfinden muss; ob null erlaubt ist, entscheidet der State-Vertrag.",
"fields": [
{
"name": "AccountUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"doc": "Nur bei Anlage; danach lehnt der Dienst einen CHANGE mit diesem Pfad ab (FIXED_AFTER_CREATE).",
"default": null
},
{
"name": "AddressKind",
"type": [
"null",
"int"
],
"default": null
},
{
"name": "Street",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "Zip",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "City",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "PostOfficeBox",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "Department",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "CountryUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"default": null
},
{
"name": "BookKeepingNumber",
"type": [
"null",
"int"
],
"default": null
},
{
"name": "IsActive",
"type": [
"null",
"boolean"
],
"default": null
},
{
"name": "IsDefault",
"type": [
"null",
"boolean"
],
"default": null
}
]
}
},
{
"name": "ChangedByUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"doc": "UUID des aendernden Mitarbeiters (Employee); null, wenn unbekannt. Audit.",
"default": null
},
{
"name": "ChangedAt",
"type": {
"type": "long",
"logicalType": "timestamp-millis"
},
"doc": "Zeitpunkt der Aenderung als UTC-Instant. Audit, kein Konfliktentscheider - es entscheidet die Kafka-Reihenfolge."
}
],
"aggregate": "Address",
"label": "Adresse",
"topic": "address.patch",
"key": "AddressUuid",
"cleanupPolicy": "delete",
"retentionMs": 2592000000,
"partitions": 1,
"writers": [
"centron",
"nexoware-erp"
],
"requiredOnCreate": [
"AccountUuid",
"AddressKind",
"IsActive",
"IsDefault"
],
"fixedAfterCreate": [
"AccountUuid"
]
}