IPWorks EDI 2020 Python Edition

Questions / Feedback?

on_end_functional_group Event

Fires whenever a control segment is read that marks the end of an interchange.

Syntax

class VDATranslatorEndFunctionalGroupEventParams(object):
  @property
  def tag() -> str: ...
  @property
  def control_number() -> str: ...
  @property
  def count() -> int: ...
  @property
  def full_segment() -> str: ...

# In class VDATranslator:
@property
def on_end_functional_group() -> Callable[[VDATranslatorEndFunctionalGroupEventParams], None]: ...
@on_end_functional_group.setter
def on_end_functional_group(event_hook: Callable[[VDATranslatorEndFunctionalGroupEventParams], None]) -> None: ...

Remarks

The on_end_functional_group event will fire when a control segment marking the end of a functional group is read. The Tag parameter contains the tag of the segment, such as GE. ControlNumber contains the control number associated with the segment, and links this event with the corresponding on_start_functional_group event. Count contains the value of the count element included in the closing segment, which identifies the number of transactions in a functional group.

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