Supply Lens

How do I change the details on a document?

Edit a Document

Correct a Document in Supply Lens, check your changes as a patch, and send the corrected version on.

About 4 min

When one Document arrives with a mistake, such as a discontinued SKU or a wrong date, you can correct it in Supply Lens instead of asking for it to be sent again.

Before you start

  • Check the Document's status. It's easiest to edit while it's Ready, before anything has been sent. If you expect to edit a kind of Document often, consider setting its Mapping to manual so Documents wait at Ready.
  • If the same mistake keeps happening, fix the cause (the product setup, the source system or the Mapping) rather than editing every Document.

Already Complete?

If the Document is already Complete, its target data exists. You'll need to set that target data to Cancelled before you can reprocess the edited Document, or the duplicate fail-safe will stop the corrected version being sent.

Steps

  1. Open the Document you want to edit.
  2. Click the three dots on the right and click the pencil Edit button.
  3. Change the details in the document editor: for example a line's SKU, prices, dates, notes, payment terms or shipment tracking.
  4. Optionally, click SHOW PATCH in the top-right to see a list of your changes. Check it holds only the changes you meant to make.
  5. Click SAVE.
  6. Send it on:
    • If it was Ready, process it with its Mapping.
    • If it was Complete, cancel the existing target data, then reprocess the Document.

SHOW PATCH shows each change in JSON form: what was done (op), where (path) and the new value. For example:

[
  { "op": "replace", "path": "/documentReferences/order/time", "value": "11:50:00" },
  { "op": "replace", "path": "/documentReferences/order/offset", "value": "01:00:00" }
]

Check it worked

The Document shows your changes. Once processed, its status is Complete and the links menu shows new target data for the system you expected.

If something goes wrong

  • The corrected version isn't sent. The original target data is probably still live. Cancel it and reprocess. See Resend a Document.
  • The receiving system already has the original. Before resending, check whether it will treat a second copy as an update or a duplicate. If in doubt, correct the record there directly, or ask the Support Team.