Notifier: Goods Delivery update

Functional documentation for the Aiden WMS goods delivery / order document update mapper (inbound).

This document describes what happens after the mapper is installed: how a WMS document status update is written back to SAP Business One (B1) as a PATCH on the related B1 document. It is intended for end-users and functional consultants.

1. Overview

This is a minimal status-sync integration. It does not create deliveries, issues, returns, or lines. It only patches a status UDF on an existing B1 document.

What gets updated

Which B1 document is patched?

The Service Layer endpoint is built at runtime from WMS custom fields:

PATCH {cf_objectType}({cf_externalId})

Example: customFields.cf_objectType = ProductionOrders and cf_externalId = 13501 →

PATCH ProductionOrders(13501)

with body:

{ "U_AEN_WMS_STATUS": "Closed" }

2. What the mapper uses as input

2.1 Message shapes

The integration accepts two payload shapes:

After split (if any), each unit is treated as one WMS document with at least:

• status — WMS status string

• customFields.cf_objectType — B1 entity set / object collection name

• customFields.cf_externalId — B1 document key (typically DocEntry)

Other WMS fields (documentId, baseType, business partner, lines, etc.) may be present on the message but are not mapped into the B1 PATCH body.

2.2 Correlation / monitoring

There is no separate B1 GET enrichment step in this project.

3. Business behavior

3.1 Split multi-document messages

If the Kafka payload contains $.documents:

1. The route logs that an array of documents was received.

2. Each document is processed independently through the mapper.

3. Each document produces its own Kafka outbound message with its own PATCH endpoint.

If documents is absent, the whole body is one document.

3.2 Status mapping

Examples from project scenarios:

Any status string WMS sends is written as-is. Consultants should align allowed WMS statuses with what B1 users expect on the UDF.

3.3 Dynamic PATCH endpoint

Before publish, Camel sets:

Consultant impact:

• cf_objectType must match a real B1 Service Layer collection (plural entity set name).

• cf_externalId must be the correct B1 key (usually DocEntry) for that document.

• Wrong values patch the wrong document or fail the Service Layer call.

• These fields are not produced by MapForce; they are read only in the Camel route for headers.

3.4 What is intentionally not done

• No line, batch, serial, package, or expense mapping

• No creation of new B1 documents (PATCH only)

• No warehouse master or BOM logic

• No status translation table in MapForce

4. Field mapping tables

Columns: B1 target field | WMS / source input | What happens | Notes

4.1 PATCH body (MapForce)

4.2 PATCH routing (Camel — not in MapForce body)

4.3 Not mapped (examples)

Although the output schema lists a full B1 document shape, the following are not written by this mapper (non-exhaustive):

5. Value translations (reference)

5.1 Status

No closed/open prefix stripping and no valuemap in this project.

5.2 Endpoint pattern

5.3 Message handling

6. What is not mapped / important omissions

7. End-to-end expectation (happy path)

1. WMS updates an order/document status (or closes documents on a pick list).

2. Integration receives Kafka message (single document or documents[]).

3. For each document:

   • Map status → { "U_AEN_WMS_STATUS": "<status>" }

   • PATCH cf_objectType(cf_externalId) on B1

4. B1 document shows the latest WMS status on UDF U_AEN_WMS_STATUS.

8. Example (from project scenarios)

8.1 Multi-document style (scenario_files/1_mainRoute)

Input (excerpt):

Expected output body:

{ "U_AEN_WMS_STATUS": "Closed" }

Expected PATCH endpoint: ProductionOrders(13502)

8.2 Single document (scenario_files/2_single_message)

Input (excerpt):

Expected output body:

{ "U_AEN_WMS_STATUS": "Closed" }

Expected PATCH endpoint: ProductionOrders(13501)

8.3 MapForce sample (inputExample.json)

(Endpoint still depends on cf_objectType / cf_externalId on the runtime message; the tiny MapForce example only demonstrates the status field.)

9. Implementation checklist for consultants

1. Ensure every WMS document carries customFields.cf_objectType (correct B1 collection name).

2. Ensure customFields.cf_externalId is the B1 DocEntry (or key) of the document to update.

3. Align WMS status values with reporting/UDF expectations in B1.

4. Remember this flow only updates U_AEN_WMS_STATUS — it does not post goods movements.

5. For pick-list messages, confirm each entry under documents[] has its own custom fields and status.

6. Do not expect line-level or inventory side effects from this mapper.

10. Source artifacts (for reference)

Generated from the mapping definition and integration behavior in this project. If the MapForce mapping or routing changes, this document should be reviewed and updated.

Maintaining this document

For the original documentation intent, when to update, source-of-truth checklist, and a ready-made refresh prompt, see README.md and the repository AGENTS.md.