IPWorks EDI 2020 Python Edition

Questions / Feedback?

on_warning Event

Fires whenever a validation warning is encountered.

Syntax

class X12WriterWarningEventParams(object):
  @property
  def warn_code() -> int: ...
  @property
  def message() -> str: ...
  @property
  def segment_number() -> int: ...
  @property
  def segment_tag() -> str: ...
  @property
  def segment_error_code() -> str: ...
  @property
  def element_error_code() -> str: ...
  @property
  def element_position() -> int: ...

# In class X12Writer:
@property
def on_warning() -> Callable[[X12WriterWarningEventParams], None]: ...
@on_warning.setter
def on_warning(event_hook: Callable[[X12WriterWarningEventParams], None]) -> None: ...

Remarks

The on_warning event will fire if a validation error is encountered when writing a new segment to the output document. The WarnCode parameter contains the type of warning encountered. Message is a textual description of the problem. SegmentNumber is the index of the segment where the problem was found.

0 The component is not required but is present.
1 Invalid segment count.
2 Invalid transaction count.
3 Invalid group count.
4 Invalid interchange control number.
5 Invalid group control number.
6 Invalid transaction control number.
10 A required data element is missing.
11 Invalid field length.
12 Invalid field value.
13 A required component is missing.
14 The data element is not defined but is present.
30 Required segment is missing.
31 Required loop is missing.
32 Occurrences exceeds the schema defined limit.
33 Occurrences is less than the schema defined minimum.
40 Paired rule validation failed, the pair of elements must be present.
41 At least one of element is required, see message for list of elements.
42 Exclusion validation failed, only one of the elements can be present.
43 Conditional rule validation failed.
44 List conditional rule validation failed.
45 First then none validation failed. The presence of an element requires that other specific elements must not be present.
46 Only one or none of the elements can be present.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 Python Edition - Version 20.0 [Build 8162]