EDIFACTWriter Class

Properties   Methods   Events   Configuration Settings   Errors  

The EDIFACTWriter class is optimized for EDIFACT documents, providing a simple way to create EDIFACT documents.

Syntax

class ipworksedi.EDIFACTWriter

Remarks

The class allows you to create a document from scratch. The class allows you to create an EDI document one segment at a time. Here's how a document would normally be created:

1. Call load_schema to load the necessary schemas for the transactions that will be used.
2. Specify where to write the output document by setting the output_file property or set_output_stream method, or set neither and check the output_data property.
3. Create a new interchange start segment using the start_interchange_header method and set its properties using write_element_string and write_component_string.
4. To write a basic element value to the current location, call the write_element_string method. For complex element values, there are two possibilities, elements which are split into components, and elements which repeat. To write these complex element values, use the start_element and end_element methods, with write_component_string and repeat_element methods for writing the values. (Examples available below).
5. Create a new functional group using start_functional_group_header and set its properties using write_element_string and write_component_string.
6. Create a new transaction using start_transaction_header and set the properties for the header segment.
7. Write all the data for the transaction by creating new data segments using start_segment and providing the path of the segment to create using the schema names of the loops and segments, like /N1Loop1/N1.
8. Once you are done with the segment, call end_segment.
9. Once you are done with the transaction, call create_transaction_footer.
10. Once you are done with the functional group, call create_functional_group_footer.
11. Once the interchange is complete, call create_interchange_footer.

Example EDIFACTWriter Code:

EDIWriter1.StartInterchangeHeader("D98B");
//Complex Element, two components
EDIWriter1.StartElement();
EDIWriter1.WriteComponentString("UNOB");
EDIWriter1.WriteComponentString("1");
EDIWriter1.EndElement();
//Skip a value for this element
EDIWriter1.SkipElement();
//Basic element
EDIWriter1.WriteElementString("7654323");
...
EDIWriter1.StartFunctionalGroupHeader();
...
EDIWriter1.StartTransactionHeader("APERAK");
//Complex Element, repeated element
EDIWriter1.StartElement();
EDIWriter1.WriteComponentString("UNH1");
EDIWriter1.RepeatElement();
EDIWriter1.WriteComponentString("UNH2");
EDIWriter1.EndElement();
...
//Segment and its data
EDIWriter1.StartSegment("BGM");
EDIWriter1.StartElement();
EDIWriter1.WriteComponentString("C00");
EDIWriter1.EndElement();
EDIWriter1.StartElement();
EDIWriter1.WriteComponentString("C10601");
EDIWriter1.EndElement();
EDIWriter1.EndSegment();
...
CreateTransactionFooter();
CreateFunctionalGroupFooter();
CreateInterchangeFooter();