25
Mon, Nov
1 New Articles

Practical RPG: Looping with BIFs

RPG
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

Learn what the built-in functions %FOUND and %EOF are and how to use them to loop through files.

 

One of the most common business tasks is to loop through a file and process records. While many variations of code can be used for this particular task, over the years the community has tended toward a few basic techniques. This is a common occurrence in programmingso much so, in fact, that the idea has been codified into the concept of a design pattern. The book Design Patterns: Elements of Reusable Object-Oriented Software has sold over a half million copies worldwide. In this article, we'll review the common pattern of processing records in a file sequentially.

The Old Indicator Method

First off, when I say "sequentially" I don't necessarily mean the strict sense of reading through the file in relative record sequence; it could also (and usually does) mean in some sort of keyed order. For keyed record, that means using the SETLL and READE opcodes. In the days of indicators, we came up with a rather clever technique that allowed us to read through the file using just a few instructions. You'll probably recognize this code:

 

C  CUSTNO       CHAIN     ORDHDRL1                          90    

C  *IN90         DOWEQ   *OFF          

 *

C  OHSTAT       IFEQ     GOODVALUE

C               EXSR     PROCESS                                  

C               ENDIF

 *

C  CUSTNO       READE     ORDHDRL1                          90

C                ENDDO                                              

 

The loop is conditioned on an indicatorin this case, indicator 90. Both the CHAIN and the READE set that indicator on: the CHAIN if no record is found, and the READE if no more records match the key. If you've coded a database loop in RPG, you've almost certainly used this technique. The only tricky part is remembering where to put the indicator: for the CHAIN it's positions 71 and 72 while for the READE it's positions 74 and 75 (that's for RPG IV; the positions are different for RPG III, but the same concept applies).

Replacing Indicators with BIFs

When I teach people how to modernize their RPG code, one of the first goals is to remove all indicators. I do this through a number of techniques, the two primary ones being to use INDARA and INDDS to get rid of workstation indicators and using built-in functions (BIFs) to replace indicators. This article will focus specifically on replacing database I/O indicators with BIFs and explaining how that affects your code.

 

Converting the code example above to RPG /free involves not only changing the formatting of the code but also removing the indicators; RPG /free doesn't support either left-handed conditioning indicators or resulting indicators on operation codes. The RPG /free equivalent of the code looks like this:

 

setll CUSTNO ORDHDRL1;

reade CUSTNO ORDHDRL1;

 

dow not %eof(ORDHDRL1);                

 

  if (OHSTAT = goodValue);           

   exsr process;                    

  endif;                                

                    

reade CUSTNO ORDHDRL1;

 

enddo;  

 

You can see that, except for the indicators, the code is essentially unchanged, although one significant difference may jump out at you: instead of the initial CHAIN, I instead use the SETLL/READE combination. That's because of the BIFs. CHAIN uses the %FOUND BIF to report its results: either it finds a record or it doesn't. READE, on the other hand, uses the %EOF BIF. It's awkward and potentially problematic to try to test both BIFs in the DOW loop. However, being savvy RPG programmers, we know that CHAIN is equivalent to SETLL/READE, so by replacing the CHAIN with the SETLL/READE pair, we can test the %EOF BIF and the do loop is complete.

A More Complete Pattern

While the code above solves the initial task of removing the indicators, the loop still has some structural issues, most of which arise from the READE being at the bottom of the loop. In this case, the code to skip a record is very simple: it's a single test. But in some cases, that code can become very complex. When that happens, the loop gets difficult because you have to make sure to have all of your test cases nested properly so that, at the end of all the tests, you drop down to the READE to get the next record. Another problem that gets me occasionally is that there are two physically separate READE statements, one before the loop and one at the end. Once in a while, I'll modify one of the READE statements and forget to modify the other one, and all kinds of programming hilarity will ensue!

 

In addition to avoiding those pitfalls, an all-purpose looping pattern will have several other features. A good pattern will:

  1. 1.Handle a no-records condition.
  2. 2.Support complex tests to skip records.
  3. 3.Allow a maximum record count.

 

After coding several billion different database loops in my career, I've finally settled on the following loop. I use a variation on this code for nearly every database loop I write these days. In the past, I often reverted back to code like that shown in the second example, but nowadays if the processing logic is simple enough to code in that kind of loop, it's more often than not code that can be just as easily written with SQL.

 

The code below is the complete code pattern, with checks to handle no records, to leave the loop, and to skip records.

 

 

setll CUSTNO ORDHDRL1;                   

if not %equal(ORDHDRL1);                

  // No records                         

  leavesr;                               

endif;                                  

                                         

dou done;                               

                                         

  // Get next record, leave at EOF      

  reade CUSTNO ORDHDRL1;                

  if %eof(ORDHDRL1);                    

    leave;                              

  endif;                                

                                         

  // Check for conditions to skip record

  if (OHSTAT = badValue);           

    iter;                               

  endif;                                

                                         

  // Otherwise, process the order

  exsr processOrder;                    

                    

  // Check for number of records

count += 1;

  if (count >= maxRecords);           

    leave;                               

  endif;                                

                     

enddo;  

 

 

The very first thing you'll note is that I have a routine to check for no records. I execute a SETLL followed by checking the result of the %EQUAL BIF. %EQUAL returns true if one or more records are found and false if no records match the key. Note the LEAVESR; that implies that this particular load code is encapsulated in a subroutine. If it were in a procedure, I'd use a RETURN opcode. And in either case, I'd probably do some other logic to somehow indicate to the user that no records were found. This skeleton is just meant to show you that it's very easy to check for a no-record scenario.

 

The next thing you'll see is DOU DONE. The assumption here is that DONE is a named indicator that is always false. I wish there were a more elegant form of "do forever" in RPG (like DOW *ON), but this is what we have today. What this does is loop indefinitely until you explicitly leave the loop via a LEAVE instruction.

 

I immediately follow this with a READE. I test the results of the READE via the %EOF BIF; if it returns true, then I've run out of record, so I exit the loop using LEAVE. Otherwise, I continue on. At this point, I can execute as much conditioning logic as I need to test whether this record should be processed or skipped. Because the READE is at the top of the loop, any time I encounter a condition that will cause the record to be skipped, I simply execute the ITER opcode, which jumps to the top of the loop. Simple and easy.

 

Having passed the tests, I process the record. Again, this example uses EXSR rather than calling a procedure; BIFs are today's topic, not ILE. Finally, you'll notice that I increment the count, and if I've read enough records, I leave the loop.

 

Some variation of this pattern handles nearly all of my database looping requirements. Continuing the READE from the current position in the file takes a little more effort, but nothing all that difficult. Hopefully, this code will help you in your programming and even provide some inspiration for your own design patterns.

Joe Pluta

Joe Pluta is the founder and chief architect of Pluta Brothers Design, Inc. He has been extending the IBM midrange since the days of the IBM System/3. Joe uses WebSphere extensively, especially as the base for PSC/400, the only product that can move your legacy systems to the Web using simple green-screen commands. He has written several books, including Developing Web 2.0 Applications with EGL for IBM i, E-Deployment: The Fastest Path to the Web, Eclipse: Step by Step, and WDSC: Step by Step. Joe performs onsite mentoring and speaks at user groups around the country. You can reach him at This email address is being protected from spambots. You need JavaScript enabled to view it..


MC Press books written by Joe Pluta available now on the MC Press Bookstore.

Developing Web 2.0 Applications with EGL for IBM i Developing Web 2.0 Applications with EGL for IBM i
Joe Pluta introduces you to EGL Rich UI and IBM’s Rational Developer for the IBM i platform.
List Price $39.95

Now On Sale

WDSC: Step by Step WDSC: Step by Step
Discover incredibly powerful WDSC with this easy-to-understand yet thorough introduction.
List Price $74.95

Now On Sale

Eclipse: Step by Step Eclipse: Step by Step
Quickly get up to speed and productivity using Eclipse.
List Price $59.00

Now On Sale

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: