08
Tue, Oct
2 New Articles

%Handling XML-INTO Problems

RPG
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times
The %HANDLER BIF associates a user-defined handler procedure with the parser, allowing you to parse the XML document in pieces.

 

In the first article in this series, we looked at the basics of the XML support added to the RPG IV in V5R4. In this second article, we will continue those explorations and look at some of the additional features of the XML-INTO opcode.

 

As noted previously, RPG's current size limits can cause problems. For example, we use arrays to map repeating elements in the XML document, but RPG arrays are limited to a maximum of 32,767 elements. What if the document we wish to process contains 35,000 repeated elements? Such a structure simply cannot be defined in RPG. Luckily, IBM's RPG compiler team anticipated this need and provided a means whereby the document can be processed in pieces. The key to unlocking this particular door is the BIF %HANDLER, which associates a user-defined handler procedure with the parserlanguage , thereby allowing us to parse the XML document in pieces. The underlying mechanism that is used is a methodology known as "call-back processing." If this technique is unfamiliar territory for you, I suggest that you read this article's companion article in this issue, "Call-Back Processing: A Brief Introduction" before continuing.

 

For the purposes of my example, I am making the assumption that the XML document we are processing can contain a large number of Category elements—too many to be accommodated within RPG's limits—and therefore we must process the document one Category at a time.

 

Let's start our investigation of this example by looking at the differences in the way the XML-INTO opcode (I) is specified. The first thing you will notice is that instead of specifying the name of the variable to be filled, we specify the BIF %HANDLER. It is the parameters to this BIF that will ultimately identify the variable to be filled.

 

 

(I) XML-INTO %Handler(ProcessCategory: categoryCount)

 

%XML(XML_Source: 'case=any doc=file allowmissing=yes +

 

path=Products/Category');

 

 

The BIF takes two parameters. The first is the name of the prototype of the handler procedure: ProcessCategory. As each "piece" of the XML document is parsed, this procedure will be "called back" to process the data extracted. We will look at the details of the prototype in a few minutes. The second parameter is known as the communications area. It can be any type of data you like: a simple variable, an array, a data structure…anything. Its purpose is to allow parameters to be passed indirectly from the main line code—via the XML parser—to the handler procedure. In my example, the handler procedure is in the same program as the mainline code and therefore could have accessed the mainline's global variables. But the handler could have been in a service program and would therefore have no access to such data. I am using the communications area as a means of obtaining a count of the total number of product categories in the document. This is useful as the XML elements variable in the PSDS is not populated when using %HANDLER. Instead, as you will see in a minute, a count of the number of elements processed is passed to the handler each time it is called.

 

Before we move on to the prototype for the handler, there is one more change to XML-INTO that we need to address. Notice that the %XML BIF now includes the path= option. It is a requirement of using %HANDLER that a path be supplied to direct the parser to the correct starting point in the XML document.

 

Let's look at the prototype (J). The parameters passed to the handler follow a standard pattern:

 

(J) D ProcessCategory...

 

D Pr 10i 0

 

D categoryCount 5i 0

 

(K) D category LikeDS(categoryDS) Dim(1)

 

D Const

 

D elements 10i 0 Value

 

 

The first parameter (categoryCount) is the communications area, and its definition is therefore up to you.

 

The second (K) identifies the variable (category) that the parser will fill before calling the handler. In other words it is the -INTO variable. This parameter has two additional requirements:

 

· It must be specified as an array, even if, as in this case, it contains only a single element.

 

· And it must be specified as a read-only parameter (i.e., by using the CONST keyword).

 

 

The third and final parameter (elements) is a count of the number of array elements filled this time. In this program, we will ignore it as it will never contain a value other than 1 since our -INTO variable is defined as DIM(1). It provides a similar function to the PSDS variable XML elements. It must be defined as a four-byte integer (10i) passed by VALUE.

 

The handler's return value must also be defined as a four-byte integer (10i). It is used to communicate between your procedure and the parser. We'll see how this is used in a moment.

 

Now that we have studied the prototype, it is time to look at the actual handler subprocedure itself and see how the parameters are used.

 

The first thing we do (L) is to increment the categoryCount variable passed as the communications area. We then proceed to loop through the product entries in the category DS that we received as the second parameter. Since there is a variable number of products in each category, we need to test the product code for blanks in order to determine the end of the list (M).

 

 

Dsply ('Category ' + category(1).description);

 

 

(L) categoryCount += 1;

 

 

For p = 1 to %Elem(category.product);

 

 

(M) If category(1).product(p).code = *Blanks;

 

Leave; // Exit once blank product code entry located

 

Else;

 

// Process the current product entry

 

Dsply ('Product: ' + category(1).product(p).description);

 

EndIf;

 

 

EndFor;

 

 

// p will always be 1 greater than real count so reduce for display

 

Dsply (%Char(p - 1) + ' products found');

 

 

(N) Return 0;

 

Once all of the products in Category have been processed, we simply return control to the parser. You can see this at (N). Note that a return value of 0 (zero) informs the parser to continue processing. Any non-zero value would cause the parser to abort, and control would then be returned to the first operation following the XML-INTO.

 

The handler procedure will be called repeatedly until the parser determines that there is no more data to process, and at that point, control is returned to the operation following the XML-INTO that started the whole process. At this point (O), we simply display the count of the number of Categories accumulated in the categoryCount variable.

 

 

(O) Dsply ('Total of ' + %Char(categoryCount) + ' Categories processed');

 

That's really all there is to it. Particularly for those of you who are unfamiliar with call-back processing, the best way to get a handle on how this all works is to step through the program in debug mode. Notice that once you hit the Return op-code in the handler (N), you will simply leap back up to the top of the handler procedure—or at least that is the way it will appear to you. In reality, control has returned to the parser, and it has in turn called your handling procedure once again. But the parser is not debuggable code, so the debugger simply zips past it.

 

While the coding of XML-INTO with %HANDLER may seem complex at first, rest assured that this is mostly a question of familiarity. Once you have coded one or two of them, you quickly realize that they are all pretty much the same.

 

Next time, we'll look at XML-INTO's little brother, XML-SAX.

 

(Author's note: You can find the complete source code for this article here.)

Jon Paris and Susan Gantner

Jon Paris's IBM midrange career started when he fell in love with the System/38 while working as a consultant. This love affair ultimately led him to joining IBM.

 

In 1987, Jon was hired by the IBM Toronto Laboratory to work on the S/36 and S/38 COBOL compilers. Subsequently, Jon became involved with the AS/400 and in particular COBOL/400.

 

In early 1989, Jon was transferred to the Languages Architecture and Planning Group, with particular responsibility for the COBOL and RPG languages. There, he played a major role in the definition of the new RPG IV language and in promoting its use with IBM Business Partners and users. He was also heavily involved in producing educational and other support materials and services related to other AS/400 programming languages and development tools, such as CODE/400 and VisualAge for RPG.

 

Jon left IBM in 1998 to focus on developing and delivering education focused on enhancing AS/400 and iSeries application development skills.

 

Susan Gantner's career has spanned over 30 years in the field of application development. She began as a programmer, developing applications for corporations in Atlanta, Georgia, and working with a variety of hardware and software platforms. She joined IBM in 1985 and quickly developed a close association with the Rochester laboratory during the development of the AS/400 system. She worked in Rochester, Minnesota, for five years in the AS/400 Technical Support Center. She later moved to the IBM Toronto Software Laboratory to provide technical support for programming languages and AD tools on the AS/400 and iSeries.

 

Susan left IBM in 1999 to devote more time to teaching and consulting. She co-authored one of the most popular System i Redbooks ever, Who Knew You Could Do That with RPG IV? She and partner Jon Paris make up Partner400, a consulting company focused on education and mentoring services related to application modernization. Susan is also part of System i Developer, a consortium of top educators on System i technology who produce the RPG & DB2 Summit events. Its members include Jon Paris, Paul Tuohy, Skip Marchesani, and Susan Gantner.

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: