# Patent

## Title
Methods and apparatus for creating markup language documents

## Abstract

A method for generating markup language documents, e.g., XML documents, uses a code generator that creates programs configured to create dynamic XML documents at run time, avoiding many of the complexities arising from the use of conventional “XML GENERATE” statements. In one embodiment, this process involves (1) creating a template document using a markup language, wherein the template document includes a set of tags associated with the markup language documents; (2) parsing the template document to determine a working storage structure corresponding to the tags in the template document; and (3) generating an application program in the programming language (e.g., COBOL), wherein the application program includes a definition of the working storage structure, and is configured to generate, during run-time, a markup language document corresponding to the original template document.

## Background
CROSS REFERENCE TO RELATED APPLICATIONS
This application is a continuation of U.S. application Ser. No. 10/906,020 entitled “Methods and Apparatus for Creating Markup Language Documents” filed on Jan. 31, 2005. The '020 application claims priority to, and the benefit of, U.S. Provisional Application Ser. No. 60/587,702, filed Jul. 14, 2004, and entitled “System and Method to Facilitate Creating Dynamic XML Documents in COBOL.” Both of which are hereby incorporated by reference.


FIELD OF THE INVENTION
The present invention generally relates to the generation and processing of markup-language documents (e.g., extensible markup language (XML) documents) using traditional procedural programming languages (e.g., COBOL and the like).
BACKGROUND OF THE INVENTION
Many organizations have discovered that the cost, effort, and risk to replace older legacy systems with modern software and database systems are overwhelming. Rather, many organizations continue to place an emphasis on supporting legacy systems by bridging gaps between old and new computing technologies, wherein bridging the gap often includes modification of existing legacy data and programming languages.
COBOL is one such programming language. Despite the existence of modern, object-oriented programming languages and Internet-based applications, COBOL will likely remain a vital part of many organizations' computing centers. Traditional COBOL, however, lacks some of the flexibility of modern languages, such as the ability to read extensible markup language (XML) documents.
XML resembles Hypertext Markup Language (HTML) in appearance and structure; however, XML is functionally different: HTML specifies how to display data, while XML is used to describe data. Accordingly, XML has provided developers with a means for displaying different types of data in a consistent manner. Generally, a developer may create formatting instructions within a data type definition (DTD) file. When a data type is defined, a developer need only add an XML tag within an HTML document which corresponds to a tag in the DTD.
Because COBOL is a legacy programming language, it must often be retrofitted to support various functionality relating to newer computing technologies. Technologies such as XML were not designed with older computing technologies such as COBOL in mind. Modifying the language or creating add-on products most often results in extra layers of sophistication and complexity for the developer. One such example is “XML GENERATE,” which is a function included within IBM® Enterprise COBOL. While XML GENERATE provides an effective means to generate and process various types of XML, the generated XML is limited by the input data structure of the COBOL code both in it's structure and in tag names. Further, it typically requires the creation of complex COBOL structures that mimic XML data structures. Enhancing this generated XML to bring it to an installation XML standard requires further processing of this XML.
SUMMARY OF THE INVENTION
In general, the invention provides a method for facilitating the generation of markup language documents, e.g., XML documents, through the use of a code generator that creates programs configured to create dynamic XML documents at run time, while minimizing or avoiding many of the prior art complexities. In one embodiment, the method of the present invention involves (1) creating a sample document using the markup language, wherein the sample document includes a set of tags associated with the markup language documents; (2) parsing the sample document to determine a working storage structure corresponding to the tags in the sample document; and (3) generating an application program in the programming language (e.g., COBOL), wherein the application program is configured to generate, during run-time, the markup language documents corresponding to the working storage structure.



BRIEF DESCRIPTION OF THE DRAWINGS
A more complete understanding of the present invention may be derived by referring to the detailed description when considered in connection with the Figures, where like reference numbers refer to similar elements throughout the Figures, and:
FIG. 1 is a schematic overview of an exemplary system in accordance with the present invention;
FIG. 2 illustrates exemplary run-time processing of an exemplary XML message;
FIG. 3 illustrates an exemplary user interface to the XML Generation tool;
FIG. 4 depicts an exemplary method of the steps a programmer would take to utilize the present invention;
FIG. 5 is an exemplary list of XML events and XML texts triggered by the XML Parse statement;
FIG. 6 is an exemplary XML document used to detail what the associated generated COBOL copybook would resemble;
FIGS. 7A and 7B show an exemplary COBOL data structure generated for the exemplary XML document detailed in FIG. 6;
FIG. 8 depicts an exemplary code generation method;
FIG. 9 depicts an exemplary compression method; and
FIGS. 10A-C show an exemplary COBOL procedure division for generating an XML document including the associated linkage section that a calling program uses for passing parameters to this generated API.



DETAILED DESCRIPTION
The following description is of exemplary embodiments of the invention only, and is not intended to limit the scope, applicability or configuration of the invention in any way. Rather, the following description is intended to provide a convenient illustration for implementing various embodiments of the invention. As will become apparent, various changes may be made in the function and arrangement of the elements described in these embodiments without departing from the scope of the invention.
FIG. 1 shows an overview of an exemplary process that a programmer would take to use the invention. As shown, in an exemplary embodiment, an XML template Document 102 is fed into the XML GEN tool 110, which may be controlled via a suitable user interface 120. The XML GEN tool 110 then creates a suitable COBOL copybook 130, which is then used to create an intermediate COBOL reply application programming interface (API) 140 and a final XML COBOL Reply API 150. The latter may then be used to create XML documents corresponding in structure to that of document 102.
FIG. 2 illustrates run-time processing of an exemplary XML document by a COBOL program (servicing process) using the API from FIG. 1 150. As shown, the COBOL program 202 receives an input message (210), then extracts the input data from the XML message (212). After the application logic section (214), the dynamic input variables are populated (216).
The procedure (218) then calls the appropriate XML code 230 (the generated code from FIG. 1, item150), wherein the creation process is covered in detail below. The API (which in the illustrated embodiment is named “xxxxxXMO”), includes previously-created working storage section 232, linkage section 234, and procedure division 236 used to generate the XML code. Finally, the resulting XML document is sent to the output destination (220).
Referring now to FIG. 4, an overview of an exemplary method will now be described, and a more detailed description is provided thereafter. Initially, in step 402, a template XML document is created which includes substantially all possible tags, both optional and mandatory, that are likely to be encountered in the particular context. The tags may be populated, for example, with sample values that represent the maximum length of the tag and may be repeated to represent multiple occurrences. Any tags that are not dynamic in nature can be omitted; i.e., any static data is automatically returned. Alternatively, using a user interface, the developer can adjust the field lengths and array sizes as desired. In the illustrated embodiment, the system uses the maximum lengths.
The various tags used in XML documents are known in the art, and are covered in a variety of language specifications and developer publications. See, e.g., Elliotte Harold, XML: Extensible Markup Language (IDG, 1998), which is hereby incorporated by reference.
With momentary reference to FIG. 3, a typical user interface may appear as shown, including a region 302 for selecting the appropriate XML file, a region 304 for specifying the name and attributes of the output source file, and various options 306 for generating and editing the appropriate copybooks and API code. It will be appreciated that a variety of user interfaces may be employed, and that the illustrated interface is not intended to be limiting.
Referring once again to FIG. 4, in step 404, the template XML document is fed into the XML GEN tool. This may be completed, for example, via the user interface just described, or may be completed automatically. Steps 406 through 414 all occur in the XML Gen tool.
In steps 406-408, the XML Gen tool then reads records from the template XML document and creates a corresponding XML string. A suitable parsing statement is then used to parse the XML string, e.g., the IBM COBOL “XML Parse” statement (step 410). For a description of the IBM COBOL “XML Parse” statement, see, e.g., IBM Enterprise COBOL Language Reference, Version 3, Release 3, Third Ed. (February 2004), which is hereby incorporated by reference.
Next, in step 412, the XML Gen tool intercepts the various XML events, and generates the XML COBOL working storage structure that is used later. The various XML events that are intercepted are described in further detail below.
In step 414, the system generates suitable COBOL procedure division statements (e.g., program code) to fill each tag or attribute with a corresponding value received from the fixed format input of the linkage section. This may be completed, for example, using ISPF edit macros and static code snippets. With the program code generated in step 414, subsequent XML documents may be processed as described above in conjunction with FIG. 2.
Having thus given on overview of the illustrated method, a detailed discussion of the various procedures will now be discussed. In steps 410 and 412, the system parses the XML by intercepting various XML events and generating the corresponding COBOL working storage structure.
In step 410, the XML is suitably parsed such that each event of ‘START-OF-ELEMENT’, and ‘ATTRIBUTE-NAME’ are used to generate a filler field with the appropriate length to have a value clause of the element name or attribute name. Similarly, each event of CONTENT-CHARACTERS and CONTENT-CHARACTER will generate a COBOL variable with appropriate length. The group tags are given COBOL variable names of GRP-xxxx, the tags that have content are given variable names of XML-xxxx with appropriate length, and the attribute tags are given variable names of ATR-xxxx with appropriate length, where xxxx represents the tag name or attribute name. Empty CONTENT-CHARACTERS are ignored. In a preferred embodiment, the template XML represents all possible tag values.
With respect to the naming conventions described above, it will be appreciated that any suitable convention and combination of characters may be used, and that variable names given above are merely examples, and are in no way limiting.
The START-OF-CDATA-SECTION and END-OF-CDATA-SECTION events preferably generate COBOL filler fields with corresponding value clauses to represent CDATA For general information related to CDATA and other such items, see, e.g., Elliotte Harold, XML: Extensible Markup Language (1998). Similarly, the END-OF-EVENT generates closing filler fields that represent closing tags such as ‘>’. Additional standard XML events that are intercepted include:

    ‘START-OF-DOCUMENT’
    ‘VERSION-INFORMATION’
    ‘ENCODING-DECLARATION’
    ‘STANDALONE-DECLARATION’
    ‘DOCUMENT-TYPE-DECLARATION’
    ‘COMMENT’
    ‘PROCESSING-INSTRUCTION-TARGET’
    ‘PROCESSING-INSTRUCTION-DATA’
    ‘END-OF-DOCUMENT’
    ‘EXCEPTION’


If there is a parsing error that is not fatal, i.e. where the XML error code is either between 49 and 100, or between 299 and 500, in one embodiment, the system ignores the error and continues parsing the XML.
FIG. 6 depicts a sample XML document and FIG. 5 depicts the sequence of XML events and XML texts triggered by the XML Parse statement for the XML.
As mentioned above, an exemplary COBOL copybook generator program is developed to parse the XML and intercept the events described above in order to create the corresponding COBOL data structure. FIGS. 7A and 7B show the exemplary COBOL data structure generated from the sample XML shown in FIG. 6.
For example, the chart below shows the XML events and the corresponding Cobol copybook statements created for the tag <MsgExpireTime>3000</MsgExpireTime> of line 5 in FIG. 6.














Cobol statement line#


XML Event
XML Text
from FIG. 7A, 7B







START-OF-ELEMENT
MsgExpireTime
Line 0049, 0050,




0051, 0052, 0053


CONTENT-CHARACTERS
3000
Line 0054, 0055


END-OF-ELEMENT
MsgExpireTime
Line 0056, 0057









FIG. 8 further details item 414 of FIG. 4 and depicts a method of generating the final COBOL program given the data structure previously determined (item 412 of FIG. 4). This step may be performed using a series of edit macros (e.g., ISPF edit macros), but may also be performed using other methods as well. The complete procedure division statements generated for the XML in FIG. 6 are shown in FIG. 10.
Initially, in step 802, an edit macro examines the copybook and identifies repeating groups. The repeated occurrences are deleted and the number of occurrences are reflected in the array size by the OCCURS clause. As described above, the user may adjust the field lengths and array sizes using, for example, the aforementioned user interface.
Next, in step 804, all variable names from the data structure (copybook) that start with XML-, GRP-, and ATR- are identified and a linkage section is constructed (step 806). The variables in the linkage section are configured to reflect the COBOL copybook both in name and hierarchy. The names are prefixed, in the illustrated embodiment, using LS- to represent linkage variables.
In step 808, procedure division statements are generated for each linkage variable. The caller of this module preferably populates the linkage variables before calling this module. Procedure division statements are created to move each linkage variable into the corresponding XML Cobol copybook variable. In the case of arrays, all occurrences are preferably populated.
In step 810, a generic code is appended to compress the XML copybook such that fields represent the actual length of the field. The generic code moves each input XML character to output XML area; however, the leading spaces in the content of each element are truncated in the output XML.
To assist this compression logic, which is shown in FIG. 9 and FIG. 10, a non-blank index is maintained that points to the last non-blank character populated in the output XML. Whenever the character ‘<’ that triggers the start of a new element is found, the output position is adjusted to the last non-blank character. More particularly, referring to FIG. 9, the system starts with the input XML string (step 602). After initializing indexes (step 604), the system increments the input index I (step 606). If I>N (where N is the total number of characters in the XML document before compression) (step 610), the system sends the compressed output XML (step 608); if not, then the system continues with step 612 and tests whether the input character is “<”. If so, the output pointer is set to the last non-blank pointer (step 614); if not, the output index, j, is incremented, and the input character is moved to the output character (step 616). If the output character is not ‘ ’ (blank), then the index K is set to the output index, and processing continues with step 606. If the output character is ‘ ’, then processing also continues with step 606, without setting the index K.
For example, the XML tag:

    
    
        “<tag1> test of tag 1 to delete leading spaces <tag1>”
    
    


in the input XML will be moved to output XML as:

    
    
        “<tag1> test of tag 1 to delete leading spaces</tag1>”.
    
    


The present invention may take the form of an entirely software embodiment, an entirely hardware embodiment, or an embodiment combining aspects of both software and hardware. Furthermore, the present invention may take the form of a computer program product on a computer-readable storage medium having computer-readable program code means embodied in the storage medium. Any suitable computer-readable storage medium may be utilized, including hard disks, CD-ROM, optical storage devices, magnetic storage devices, and/or the like.
For the sake of brevity, conventional data networking, application development and other functional aspects of the systems (and components of the individual operating components of the systems) may not have been described in detail herein. Furthermore, the connecting lines shown in the various figures contained herein are intended to represent exemplary functional relationships and/or physical couplings between the various elements. It should be noted that many alternative or additional functional relationships or physical connections may be present in a practical system. The various system components discussed herein may include one or more of the following: a host server or other computing systems including a processor for processing digital data; a memory coupled to the processor for storing digital data; an input digitizer coupled to the processor for inputting digital data; an application program stored in the memory and accessible by the processor for directing processing of digital data by the processor; a display device coupled to the processor and memory for displaying information derived from digital data processed by the processor; and a plurality of databases. Various databases used herein may include: client data; merchant data; financial institution data; and/or like data useful in the operation of the present invention. As those skilled in the art will appreciate, user computer may include an operating system (e.g., Windows NT, 95/98/2000, OS2, UNIX, Linux, Solaris, MacOS, etc.) as well as various conventional support software and drivers typically associated with computers. The computer may include any suitable personal computer, network computer, workstation, minicomputer, mainframe or the like. User computer can be in a home or business environment with access to a network. In an exemplary embodiment, access is through a network or the Internet through a commercially-available web-browser software package.
Any networks used in connection with the present invention (i.e., in the context of a distributed software/hardware system) shall include any electronic communications means which incorporates both hardware and software components of such. Communication among the parties in accordance with the present invention may be accomplished through any suitable communication channels, such as, for example, a telephone network, an extranet, an intranet, Internet, point of interaction device (point of sale device, personal digital assistant, cellular phone, kiosk, etc.), online communications, satellite communications, off-line communications, wireless communications, transponder communications, local area network (LAN), wide area network (WAN), networked or linked devices, keyboard, mouse and/or any suitable communication or data input modality. Moreover, although the invention is frequently described herein as being implemented with TCP/IP communications protocols, the invention may also be implemented using IPX, Appletalk, IP-6, NetBIOS, OSI or any number of existing or future protocols. If the network is in the nature of a public network, such as the Internet, it may be advantageous to presume the network to be insecure and open to eavesdroppers. Specific information related to the protocols, standards, and application software utilized in connection with the Internet is generally known to those skilled in the art and, as such, need not be detailed herein. See, for example, Dilip Naik, Internet Standards and Protocols (1998); Java 2 Complete, various authors, (Sybex 1999); Deborah Ray and Eric Ray, Mastering HTML 4.0 (1997); and Loshin, TCP/IP Clearly Explained (1997) and David Gourley and Brian Totty, HTTP, The Definitive Guide (2002), the contents of which are hereby incorporated by reference.
The various system components may be independently, separately or collectively suitably coupled to the network via data links which includes, for example, a connection to an Internet Service Provider (ISP) over the local loop as is typically used in connection with standard modem communication, cable modem, Dish networks, ISDN, Digital Subscriber Line (DSL), or various wireless communication methods, see, e.g., Gilbert Held, Understanding Data Communications (1996), which is hereby incorporated by reference. It is noted that the network may be implemented as other types of networks, such as an interactive television (ITV) network. Moreover, the system contemplates the use, sale or distribution of any goods, services or information over any network having similar functionality described herein.
Many of the communications, inputs, storage, databases or displays discussed herein may be facilitated through a website having web pages. The term “web page” as it is used herein is not meant to limit the type of documents and applications that might be used to interact with the user. For example, a typical website might include, in addition to standard HTML documents, various forms, Java applets, JavaScript, active server pages (ASP), common gateway interface scripts (CGI), extensible markup language (XML), dynamic HTML, cascading style sheets (CSS), helper applications, plug-ins, and the like.
It should be understood that the detailed description and specific examples, indicating exemplary embodiments of the present invention, are given for purposes of illustration only and not as limitations. Many changes and modifications within the scope of the instant invention may be made without departing from the spirit thereof, and the invention includes all such modifications. For example, while the present invention has been described in the context of COBOL, the general framework described herein may be used in conjunction with a number of other legacy software languages, e.g., Fortran, PL1, Pascal, and the like. Corresponding structures, materials, acts, and equivalents of all elements in the claims below are intended to include any structure, material, or acts for performing the functions in combination with other claim elements as specifically claimed. The scope of the invention should be determined by the appended claims and their legal equivalents, rather than by the examples given above.

## Claims

1. A method for obtaining computer-generated markup language documents using a programming language, the method including:
parsing, by a computer-based system for obtaining computer-generated markup language documents, a template document to determine a working storage structure corresponding to a plurality of tags, wherein the template document includes the plurality of tags; and
generating, by the computer-based system and in the programming language, an application protocol interlace (API),
wherein the API generates a markup language document during run-time, wherein the API generates a corresponding set of data elements corresponding to the working storage structure, and wherein the API includes a definition of the working storage structure including a plurality of API variables, code for each tag that participates in an array, and code configured to compress the data elements by truncating leading spaces in each data element, and wherein a dimension of the array can be adjusted in response to receiving input from a user interface.

2. The method of claim 1 , further including populating, by the computer-based system, each of the plurality of tags with a value.

3. The method of claim 1, further including populating, by the computer-based system, one of the plurality of tags with a maximum tag length value.

4. The method of claim 1, wherein the programming language is COBOL.

5. The method of claim 1, wherein the markup language is XML.

6. The method of claim 1, further including:
extracting input data from a input message markup language document to create extracted input data;
using the extracted input data in an application program, wherein the application program is written in the programming language; and
generating markup language documents by use of the API.

7. The method of claim 6, further including receiving the input message markup language document.

8. The method of claim 1, further including creating, using a markup language, the template document including the plurality of tags.

9. A tangible computer-readable storage medium having stored thereon a plurality of instructions, when executed by a computer-based system for obtaining computer-generated markup language documents using a programming language, perform operations comprising:
parsing, by the computer based system, a template document to determine a working storage structure corresponding to a plurality of tags, wherein the template document includes the plurality of tags; and
generating, by the computer based system, an API in the programming language,
wherein the API generates a markup language document during run-time, wherein the API generates a corresponding set of data elements corresponding to the working storage structure, and wherein the API includes a definition of the working storage structure including a plurality of API variables, code for each tag that participates in an array, and code configured to compress the data elements by truncating leading spaces in each data element, and wherein a dimension of the array can be adjusted in response to receiving input from a user interface.

10. A computer-based system comprising:
a network interface communicating with a memory;
the memory communicating with a processor for obtaining computer-generated markup language documents using a programming language; and
the processor, when executing a computer program, is configured to:
parse, by the processor, a template document to determine a working storage structure corresponding to a plurality of tags, wherein the template document includes the plurality of tags; and
generate, by the processor, an API in the programming language,
wherein the API generates a markup language document during run-time, wherein the API generates a corresponding set of data elements corresponding to the working storage structure, and wherein the API includes a definition of the working storage structure including a plurality of API variables, code for each tag that participates in an array, and code configured to compress the data elements by truncating leading spaces in each data element, and wherein a dimension of the array can be adjusted in response to receiving input from a user interface.

11. The system of claim 10, further configured to populate each of the plurality of tags with a value.

12. The system of claim 10, further configured to populate one of the plurality of tags with a maximum tag length value.

13. The system of claim 10, wherein the programming language is COBOL.

14. The system of claim 10, wherein the markup language is XML.

15. The system of claim 10, further configured to:
extract input data from a input message markup language document to create extracted input data;
use the extracted input data in an application program, wherein the application program is written in the programming language; and
generate markup language documents by use of the API.

16. The system of claim 15, further configured to receive the input message markup language document.

17. The system of claim 10, further configured to create, using a markup language, the template document including the plurality of tags.