XML File Creation using Wrapper Functio in EnterpriseOne

Purpose of Document

Purpose of this document is to provide an example of XML creation through B0000201 (XERCES XML Wrapper Functions).

Note that this example may not be the best practice in parsing an XML file for outbound and JD Edwards EnterpriseOne does not have any standard UBE which transforms into XML format file.

• What is XML?
• What is Parsers?
• What is Xerces?
• Reference
• Business functions to parse in EnterpriseOne
  • B0000201 - CreateXMLDocumentXercesWrapper (Create XML Document Xerces Wrapper Function)
  • B0000201 - AddXMLAttributeXercesWrapper (Add XML Attribute Xerces Wrapper)
    • B0000201 - AddXMLElementStringXercesWrapper (Add XML Element String Xerces Wrapper)
    • B0000201 - AddXMLElementDateXercesWrapper (Add XML Element Date Xerces Wrapper)
    • B0000201 - AddXMLElementMathXercesWrapper (Add XML Element Math Numeric Xerces Wrapper)
    • B0000201 - AddXMLElementCharXercesWrapper  (Add XML Element Character Xerces Wrapper)
    • B0000201 - AddXMLElementUTimeXercesWrapper  (Add XML Element UTC Xerces Wrapper)
  • B0000201 - FreeXMLElementXercesWrapper (Free XML Element Xerces Wrapper)
  • B0000201 - WriteXMLDocumentXercesWrapper (Write XML Document Xerces Wrapper)
• Example of XML output
• How to implement (Example of code)
• Relation between output and BSFNs
• Considerations

This document is to provide one example for XML transformation for outbound.

XML (Extensible Markup Language):

• XML is text based markup language.
• XML is more than html because html only deals with presentation and carries no information about the data itself.

Parsers: function reference here is based on DOM (Document Object Model ) parser - Tree Structure based API:

•     The Dom parser implements the dom api and it creates a DOM tree in memory for an XML document
•     compared with SAX (Simple API For XML ) parser - Event Based API

Generally, DOM parser is used when,

• Document needs to be Manipulated
• Transforming the document back and forth
• Working with small XML files

         The parser has a drawback of higher consumption of memory/cache because string/text values are being stored in memory in order to manipulate it

What is Xerces?
Xerces is Apache's collection of software libraries for parsing, validating, serializing and manipulating XML. The library implements a number of standard APIs for XML parsing, including DOM, SAX and SAX2. The implementation is available in Java, C++ and Perl programming languages. Refer to external link for detail: http://xerces.apache.org/xerces2-j/

Before you proceed, refer to the Oracle Documentation (Oracle Technical Network)
http://www.oracle.com/technetwork/index.html
    |-- Documentation (http://www.oracle.com/technetwork/indexes/documentation/index.html)
          |-- JD Edwards EnterpriseOne (http://www.oracle.com/technetwork/documentation/jdedent-098169.html)
                |-- JD Edwards EnterpriseOne Tools Documentation (http://docs.oracle.com/cd/E24705_01/index.htm)
                      |-- EnterpriseOne Tools Interoperability Reference Implementations Guide (http://docs.oracle.com/cd/E24705_01/doc.91/e24253/toc.htm)
                               |-- XML Transformation (http://docs.oracle.com/cd/E24705_01/doc.91/e24253/understnd_xml_transform.htm#g8d6ab57f7cedeaac_ef90c_10a77c8e3f7__6f80)

Business Function for parsing SQL format file to XML file format:

Business Function:
B0000201 - CreateXMLDocumentXercesWrapper (Create XML Document Xerces Wrapper Function)

• • Purpose: This business function initializes XML document information.
  • Parameter:
  • • Data Structure: D0000201A - Create XML Document Xerces Wrapper

• • Detail routine:
    •     idReturn =IB0000201_CreateXmlDocument(&hXmlDoc,lpDS->szDocumentName,&hDocElement);  /*Creating empty Xml Document*/
    •           |---  xrcsStatus = XRCS_initEngine();
    •           |---  xrcsStatus = XRCS_createEmptyDocument(hXmlDocument); /*Create the XML Document in memory*/
    •           |---  xrcsStatus = XRCS_createElement(*hXmlDocument, szDocumentName, hDocElement); /*create document element*/
    •           |---  xrcsStatus = XRCS_setDocumentElement(*hXmlDocument,*hDocElement);  /*Add document element*/
  • Error:
  • • "B0501250 - Failed to create XML document"

B0000201 - AddXMLAttributeXercesWrapper (Add XML Attribute Xerces Wrapper)

• • Purpose: To add an attribute of the document
  • Parameter:
  • • Data Structure: D0000201B - Add XML Attribute Xerces Wrapper

• • Detail routine:
    • idReturn = IB0000201_AddXmlAttribute(hXmlDoc,hElement,lpDS->szAttributeName,lpDS->szAttributeValue);  /*Adding attribute */
    •           |--- xrcsStatus = XRCS_createAttribute(hXmlDocument, szAttributeName, szAttributeValue, &hAttribute);  /*Create the XML attribute and attach it to specified element. */
    •           |--- xrcsStatus = XRCS_appendAttribute(hElement, hAttribute);
    •           |--- XRCS_freeAttribute(hAttribute);
  • Error:
  • • "B0000201 - Failed to Add XML attribute to XML document"
    • "B0000201 - Failed to add XML attribute"
    <Internal_Only>

    • • Support Test - R03012D2  PO - process Tab:  Path= c:\

      • Run the report locally and it will generate XML in c root.
      • To add custom attributes in your XML, add "AddXMLAttributeXercesWrapper" in your initialize Section
      • 0026 Add XML Attribute Xerces Wrapper
                VA rpt_hXMLDocument_GENLNG -> BF hXMLDocument
                VA rpt_hDocumentElement_GENLNG -> BF hElement
                "xmlns:msxsl" -> BF szAttributeName
                "urn:schemas-microsoft-com:xsl" -> BF szAttributeValue

      The output is:

    • <?xml version="1.0" encoding="utf-8" ?>
      - <R03012D2 xmlns:msxsl="urn:schemas-microsoft-com:xsl">
    </Internal_Only>

B0000201 - AddXMLElementStringXercesWrapper (Add XML Element String Xerces Wrapper)

• • Purpose: To parse JDE string values to XML format file
  • Parameter:
  • • Data Structure: D0000201C - Add XML Element String Xerces Wrapper

• • Detail Routine:
    •  idReturn = IB0000201_AddXmlElement(hXmlDoc, lpDS->cFreeElementFlag, hParentElement, &hNewElement,  lpDS->szElementName, lpDS->szElementString, lpDS->cCreateEmptyElementFlag); /*Adding Xml Element*/
    •           |--- xrcsStatus = XRCS_createElement(hXmlDocument, szElementName, &hElement);  /*Create new XML element node. */
    •           |--- xrcsStatus = XRCS_setElementText(hElement, szElementText);  /* Add Text */
    •           |--- xrcsStatus = XRCS_appendChildElement(hParentElement, hElement); /* Add Child Element */
    •           |--- xrcsStatus = XRCS_appendChildElement(hParentElement, hElement);  /* Add child element to parent */
    •           |--- (Optional) XRCS_freeElement(hElement);  /* If requested, free the new element; otherwise store it. */
  • Error:
  • • "B0000201 - Failed to Add XML element to XML document"
    • "B0501250 - Failed to add XML element"

B0000201 - AddXMLElementDateXercesWrapper (Add XML Element Date Xerces Wrapper)

• • Purpose: To parse JDEDATE to XML Date based on DateFormatMask
  • Parameter:
  • • Data Structure: D0000201D - Add XML Element Date Xerces Wrapper

• • Detail Routine:
    • FormatDate (szElementText, &lpDS->jdElementDate, lpDS->szDateFormatMask);         /* Convert the date passed in to a string */
    • idReturn = IB0000201_AddXmlElement(hXmlDoc, lpDS->cFreeElementFlag, hParentElement, &hNewElement,  lpDS->szElementName, szElementText, lpDS->cCreateEmptyElementFlag);          /*Adding Xml Element*/
    •           |--- Refer D0000201C
  • Error:
  • • "B0000201 - Failed to Add XML element to XML document"

B0000201 - AddXMLElementMathXercesWrapper (Add XML Element Math Numeric Xerces Wrapper)

• • Purpose: To parse MATH_NUMERIC to XML document
  • Parameter:
  • • Data Structure: D0000201E - Add XML Element Math Xerces Wrapper

• • Detail Routine:
    • FormatMathNumeric(szElementText, &lpDS->mnElementMathNumeric);         /* Convert the math_numeric passed in to a string */
    • idReturn = IB0000201_AddXmlElement(hXmlDoc, lpDS->cFreeElementFlag, hParentElement, &hNewElement,  lpDS->szElementName, szElementText, lpDS->cCreateEmptyElementFlag);         /* Adding Xml Element*/
  • Error:
  • • "B0000201 - Failed to Add XML element to XML document"

B0000201 - AddXMLElementCharXercesWrapper  (Add XML Element Character Xerces Wrapper)

• • Purpose: Parse JCHAR (character) to XML element
  • Parameter:
  • • Data Structure: D0000201F - Add XML Element Character Xerces Wrapper

• • Detail Routine:
    • szElementText[0] = lpDS->cElementCharacter;         /* Assign character value to string */
    • idReturn = IB0000201_AddXmlElement(hXmlDoc, lpDS->cFreeElementFlag, hParentElement, &hNewElement,  lpDS->szElementName, szElementText, lpDS->cCreateEmptyElementFlag);         /*Adding Xml Element*/
  • Error:
  • • "B0000201 - Failed to Add XML element to XML document"

B0000201 - FreeXMLElementXercesWrapper (Free XML Element Xerces Wrapper)

• • Purpose: To free pointer used
  • Parameter:
  • • Data Struture: D0000201G - Free XML Element Xerces Wrapper

• • Detail Routine:
    • hXmlElement =(XRCS_hElement)jdeRemoveDataPtr(hUser,(unsigned long)lpDS->hElement);         /* retrieve the element pointer */
    • idReturn =IB0000201_FreeXmlElement(hXmlElement);          /*Call internal To free element*/
  • Error:
  • • "B0501250 - Failed to Free XML Element"

B0000201 - WriteXMLDocumentXercesWrapper (Write XML Document Xerces Wrapper )

• • Purpose: To write XML document to the path you have specified
  • Parameter:
  • • Data Structure: D0000201H - Write XML Document Xerces Wrapper

• • Detail Routine:
    • hXmlDoc =(XRCS_hElement)jdeRemoveDataPtr(hUser,(unsigned long)lpDS->hXMLDocument);  /* Retrieveing Xml Document handle */
    • idReturn = IB0000201_WriteXmlToFile(hXmlDoc, lpDS->szFilePathandName);
    •           |--- ((hXmlDocument != NULL) && (!IsStringBlank(szXmlPath)))     /*Check required parameters*/
    •           |--- xrcsStatus = XRCS_serializeDocumentToFileWithEncoding_putDoubleQuotes(hXmlDocument, szXmlPath, _J("UTF-8"), 1);   /*Write XML to file, indicate UTF-8 encoding and use double quotes for attributes*/     
    •           |--- xrcsStatus = XRCS_terminateEngine();     /* Shut down XML parser */
  • Error:
  • • "B0000201 - Failed to Write to XML document"
    • "B0000201 - Failed to write XML to file"
    • "B0000201 - Failed to terminate XML parser"
    • "B0000201 - Invalid parameters passed to IB0501250_WriteXmlToFile"

B0000210 - AddXMLElementUTCXercesWrapper (Add XML Element UTC Xerces Wrapper)

• • Purpose: To parse JDEUTime to XML format file (Not In Use)
  • Parameter:
  • • Data Structure: D0000201I - Add XML Element UTC Xerces Wrapper

• • Detail Routine:
    • jdeUTime_Get(&lpDS->szUTime, &yr, &mo, &day, &hr, &min, &sec, JDEUTIME_UTC_ZERO_STANDARD);   /* Convert the UTC using zero time zone */
    • Convert Year to String (szYear)
    • Convert Month to String (szMonth)
    • Convert Day to String (szDay)
    • Convert Hour to String (szHour)
    • Convert Minute to String (szMinute)
    • Convert Second to String (szSecond)
    • Format Output String szYear-szMonth-szDayTszHour:szMinute:szSecond-00:00 (e.g., 2013-12-31T12:59:59-00:00)
    • idReturn = IB0000201_AddXmlElement(hXmlDoc, lpDS->cFreeElementFlag, hParentElement, &hNewElement,  lpDS->szElementName, szElementText, lpDS->cCreateEmptyElementFlag);         /*Adding Xml Element*/
    •           |--- Refer above
  • Error:
  • • "B0000201 - Failed to Add XML element to XML document"

B0000201 - AddXMLElementUTimeXercesWrapper  (Add XML Element UTC Xerces Wrapper)

• • Purpose: This function parses JDEUTime class to XML format file which calls API jdeUTime_FormatEx().
  • Parameter:
  • • Data Structure: D0000201J - Add XML Element UTime Xerces Wrapper

• • Detail Routine:
    • jdeUTime_FormatEx(szFormattedText, &lpDS->szUTime, lpDS->szDateFormatMask, lpDS->szTimeFormat, lpDS->szTimeZoneFormat); /* Convert the UTC using both date mask, time format, and time zone */
    • idReturn = IB0000201_AddXmlElement(hXmlDoc, lpDS->cFreeElementFlag, hParentElement, &hNewElement,  lpDS->szElementName, szFormattedText, lpDS->cCreateEmptyElementFlag);         /*Adding Xml Element*/
  • Error:
  • • "B0000201 - Failed to Add XML element to XML document"

Example of XML output <R55XML01_021713_192832.xml>

  <?xml version="1.0" encoding="utf-8" ?>
-<R55XML01xmlns="http://www.schemas.e1.oracle.com">
    -<customer syncmode="0">
          <Environment>PD910</Environment>
          <AddressNumber>4242</AddressNumber>
          <Company>00000</Company>
          <BeginningEffectiveDate>02/17/2013</BeginningEffectiveDate>
          <PersonCorporationCode>A</PersonCorporationCode>
          <DateEntered>01/01/1970 10:00:00AM (UTC+10:00)</DateEntered>
        </customer>
    -<customer syncmode="0">
          <Environment>PD910</Environment>
          <AddressNumber>4242</AddressNumber>
          <Company>00001</Company>
          <BeginningEffectiveDate>02/17/2013</BeginningEffectiveDate>
          <PersonCorporationCode>C</PersonCorporationCode>
          <DateEntered>07/25/2012 05:44:24PM (UTC+10:00)</DateEntered>
        </customer>
  </R55XML01>

Possible Implemenation:
Refer to attached file.

1. (Optional) Create Processing Option template to indicate Path to write output file (e.g., \\DeploymentServer\XMLOutbound\Test\ ). This enables you to set output path dynamically
2. Associate Processing option to report template
3. Associate Business View (source data) to pull. For this example, custom business view based on F03012
(Now you implement detail routine)
4. Create (at least) 4 global variable which are to be used from initialization of variables to termination
    For example,
     rpt_hXMLDocument_GENLNG
     rpt_hDocumentElement_GENLNG
     rpt_hParentElement_GENLNG
     rpt_szFileName_DL01

(Initialize Section) which initializes once

(Do Section) which calls below routine row by row based on business view you have associated

(End Section)

Relation between BSFN and output
Refer below,

Considerations:

• Information provided is for example only and is not supported by Oracle.
• Basic transformation can be done by 3rd party software related to your Java Application Server

<Internal_Only>

We do not have business function for Inbound XML though it appears we can convert XML file line by line through conversion tool. 

JD Edwards EnterpriseOne Tools Interoperability Guide
    9 Understanding XML Transaction

</Internal_Only>