Skip to content

SerialUpdatedEvent

EventType: SERIAL_UPDATEDDomain: serial Broker subject: progress.notification.serial

Updates a serial's code, form data fields, or release status. Can selectively clear data from specific phases and optionally un-release a previously released serial.

Trigger

Triggered by: POST /event (universal event dispatcher)

Dispatched via POST /event in backend/api/endpoints/traceability.py with event_type: SERIAL_UPDATED. Also spawned as a child event by BatchCompletedEvent when step form data captured during batch completion needs to be written to associated serials.

Preconditions

  • Serial exists with key info.serial_key

State Changes (Transaction)

Collections: Inherited from BaseSerialEvent.get_tx_collections()

  • Serial updated: code, data (merge or phase-clear), released cleared if unrelease is true

Side Effects (post_processing)

Inherits post_processing() from BaseSerialEvent:

  • Publishes to progress.notification.serial

InfoModel Fields

FieldTypeDescription
serial_keystrArangoDB key of the serial to update
serial_codeProcessedSerialCode | NoneNew code to assign
serial_datalist[SerialFormFieldValue] | NoneForm field data updates
remove_data_from_phaseslist[str] | NonePhase keys whose data should be cleared
unreleasebool | NoneIf true, clears the released timestamp

None.

Source

SerialUpdatedEvent on GitHub

Released under the Apache 2.0 License.