EdifactEnvelopeSettings Class

The Edifact agreement envelope settings.

All required parameters must be populated in order to send to Azure.

Constructor

EdifactEnvelopeSettings(*, apply_delimiter_string_advice: bool, create_grouping_segments: bool, enable_default_group_headers: bool, interchange_control_number_lower_bound: int, interchange_control_number_upper_bound: int, rollover_interchange_control_number: bool, group_control_number_lower_bound: int, group_control_number_upper_bound: int, rollover_group_control_number: bool, overwrite_existing_transaction_set_control_number: bool, transaction_set_control_number_lower_bound: int, transaction_set_control_number_upper_bound: int, rollover_transaction_set_control_number: bool, is_test_interchange: bool, group_association_assigned_code: str | None = None, communication_agreement_id: str | None = None, recipient_reference_password_value: str | None = None, recipient_reference_password_qualifier: str | None = None, application_reference_id: str | None = None, processing_priority_code: str | None = None, interchange_control_number_prefix: str | None = None, interchange_control_number_suffix: str | None = None, sender_reverse_routing_address: str | None = None, receiver_reverse_routing_address: str | None = None, functional_group_id: str | None = None, group_controlling_agency_code: str | None = None, group_message_version: str | None = None, group_message_release: str | None = None, group_control_number_prefix: str | None = None, group_control_number_suffix: str | None = None, group_application_receiver_qualifier: str | None = None, group_application_receiver_id: str | None = None, group_application_sender_qualifier: str | None = None, group_application_sender_id: str | None = None, group_application_password: str | None = None, transaction_set_control_number_prefix: str | None = None, transaction_set_control_number_suffix: str | None = None, sender_internal_identification: str | None = None, sender_internal_sub_identification: str | None = None, receiver_internal_identification: str | None = None, receiver_internal_sub_identification: str | None = None, **kwargs)

Keyword-Only Parameters

Name	Description
group_association_assigned_code	str The group association assigned code. Default value: None
communication_agreement_id	str The communication agreement id. Default value: None
apply_delimiter_string_advice	bool Required. The value indicating whether to apply delimiter string advice.
create_grouping_segments	bool Required. The value indicating whether to create grouping segments.
enable_default_group_headers	bool Required. The value indicating whether to enable default group headers.
recipient_reference_password_value	str The recipient reference password value. Default value: None
recipient_reference_password_qualifier	str The recipient reference password qualifier. Default value: None
application_reference_id	str The application reference id. Default value: None
processing_priority_code	str The processing priority code. Default value: None
interchange_control_number_lower_bound	<xref:long> Required. The interchange control number lower bound.
interchange_control_number_upper_bound	<xref:long> Required. The interchange control number upper bound.
rollover_interchange_control_number	bool Required. The value indicating whether to rollover interchange control number.
interchange_control_number_prefix	str The interchange control number prefix. Default value: None
interchange_control_number_suffix	str The interchange control number suffix. Default value: None
sender_reverse_routing_address	str The sender reverse routing address. Default value: None
receiver_reverse_routing_address	str The receiver reverse routing address. Default value: None
functional_group_id	str The functional group id. Default value: None
group_controlling_agency_code	str The group controlling agency code. Default value: None
group_message_version	str The group message version. Default value: None
group_message_release	str The group message release. Default value: None
group_control_number_lower_bound	<xref:long> Required. The group control number lower bound.
group_control_number_upper_bound	<xref:long> Required. The group control number upper bound.
rollover_group_control_number	bool Required. The value indicating whether to rollover group control number.
group_control_number_prefix	str The group control number prefix. Default value: None
group_control_number_suffix	str The group control number suffix. Default value: None
group_application_receiver_qualifier	str The group application receiver qualifier. Default value: None
group_application_receiver_id	str The group application receiver id. Default value: None
group_application_sender_qualifier	str The group application sender qualifier. Default value: None
group_application_sender_id	str The group application sender id. Default value: None
group_application_password	str The group application password. Default value: None
overwrite_existing_transaction_set_control_number	bool Required. The value indicating whether to overwrite existing transaction set control number.
transaction_set_control_number_prefix	str The transaction set control number prefix. Default value: None
transaction_set_control_number_suffix	str The transaction set control number suffix. Default value: None
transaction_set_control_number_lower_bound	<xref:long> Required. The transaction set control number lower bound.
transaction_set_control_number_upper_bound	<xref:long> Required. The transaction set control number upper bound.
rollover_transaction_set_control_number	bool Required. The value indicating whether to rollover transaction set control number.
is_test_interchange	bool Required. The value indicating whether the message is a test interchange.
sender_internal_identification	str The sender internal identification. Default value: None
sender_internal_sub_identification	str The sender internal sub identification. Default value: None
receiver_internal_identification	str The receiver internal identification. Default value: None
receiver_internal_sub_identification	str The receiver internal sub identification. Default value: None

Variables

Name	Description
group_association_assigned_code	str The group association assigned code.
communication_agreement_id	str The communication agreement id.
apply_delimiter_string_advice	bool Required. The value indicating whether to apply delimiter string advice.
create_grouping_segments	bool Required. The value indicating whether to create grouping segments.
enable_default_group_headers	bool Required. The value indicating whether to enable default group headers.
recipient_reference_password_value	str The recipient reference password value.
recipient_reference_password_qualifier	str The recipient reference password qualifier.
application_reference_id	str The application reference id.
processing_priority_code	str The processing priority code.
interchange_control_number_lower_bound	<xref:long> Required. The interchange control number lower bound.
interchange_control_number_upper_bound	<xref:long> Required. The interchange control number upper bound.
rollover_interchange_control_number	bool Required. The value indicating whether to rollover interchange control number.
interchange_control_number_prefix	str The interchange control number prefix.
interchange_control_number_suffix	str The interchange control number suffix.
sender_reverse_routing_address	str The sender reverse routing address.
receiver_reverse_routing_address	str The receiver reverse routing address.
functional_group_id	str The functional group id.
group_controlling_agency_code	str The group controlling agency code.
group_message_version	str The group message version.
group_message_release	str The group message release.
group_control_number_lower_bound	<xref:long> Required. The group control number lower bound.
group_control_number_upper_bound	<xref:long> Required. The group control number upper bound.
rollover_group_control_number	bool Required. The value indicating whether to rollover group control number.
group_control_number_prefix	str The group control number prefix.
group_control_number_suffix	str The group control number suffix.
group_application_receiver_qualifier	str The group application receiver qualifier.
group_application_receiver_id	str The group application receiver id.
group_application_sender_qualifier	str The group application sender qualifier.
group_application_sender_id	str The group application sender id.
group_application_password	str The group application password.
overwrite_existing_transaction_set_control_number	bool Required. The value indicating whether to overwrite existing transaction set control number.
transaction_set_control_number_prefix	str The transaction set control number prefix.
transaction_set_control_number_suffix	str The transaction set control number suffix.
transaction_set_control_number_lower_bound	<xref:long> Required. The transaction set control number lower bound.
transaction_set_control_number_upper_bound	<xref:long> Required. The transaction set control number upper bound.
rollover_transaction_set_control_number	bool Required. The value indicating whether to rollover transaction set control number.
is_test_interchange	bool Required. The value indicating whether the message is a test interchange.
sender_internal_identification	str The sender internal identification.
sender_internal_sub_identification	str The sender internal sub identification.
receiver_internal_identification	str The receiver internal identification.
receiver_internal_sub_identification	str The receiver internal sub identification.

Feedback

Was this page helpful?

Share via

EdifactEnvelopeSettings Class

Constructor

Keyword-Only Parameters

Variables

Feedback