Sun, Sep
3 New Articles

RPG Academy: Debug Done Right - Introducing the ILE Debugger

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


Have you met the “new” ILE Debugger? Forget ISDB. The future of debug is here.

It’s really hard to write a complete and complex piece of code without a bug or two, so you’re probably no stranger to the Interactive Source Debugger (ISDB) that has served RPG programmers since V3R1. Now that you’re moving into the brave new world of ILE, it’s also time to upgrade your debugging skills. In this subseries, you’ll learn what you need to know to turn your time-consuming pains with ISDB into something more pleasant and efficient with ILE debugger.

The Interactive Source Debugger Versus the ILE Debugger

ISDB is an old tool. As I said before, it dates all the way back to V3R1, launched in 1994. It has a lot of limitations, forcing RPG programmers to include one or more forms of DIY debugging—things like sending messages when a certain routine is executed, writing useless (except for debug purposes) log records, and other inventive ways to overcome ISDB’s shortcomings. I’m sure you know at least a few of these limitations, but let’s go over the list and see how the new debugger compares to the old one:

  • As the name implies, ISDB only lets you debug interactive programs, whereas ILE debugger also allows you to debug programs running in batch. (You’ll see how later in this series.)
  • As you start working with ILE objects, you’ll see that ISDB is not able to handle them, while the new debugger can, well, debug both OPM and ILE programs.
  • One of the main criticisms about ISDB is that it consumes a lot of resources without the expected output from that consumption—it’s a rather slow tool. The ILE debugger is the exact opposite: It’s really fast and has low overhead.
  • Navigating in an ISDB session is complicated. It gets better with practice, but it’s clunky and not very intuitive. The new tool allows a much smoother navigation through simple commands and function keys that are flexible and easy to use.

This is why you should leave ISDB behind and embrace the new ILE debugger as soon as possible. Let me show you how to do it, step by step, starting with preparing your programs for the best possible debug experience.

Getting to Know the Different Debugging Views

It all starts when you compile your code. In ILE’s case, this means the CRTRPGMOD command, discussed way back in the beginning of the RPG Academy TechTip series. In that article, you learned that the DBGVIEW parameter was important and that you should, by default, use the *SOURCE keyword. Now that you know a little more about ILE, it’s time to learn about the other options available. I’ll provide a little more information about *SOURCE in a moment, and you’ll see that it’s not always the best option.

Let me begin with the lowest level of debug view: *STMT. This keyword simply allows you to display variables’ contents and set breakpoints at the statements’ locations using a compiler listing—no source is displayed in the debug screen. To obtain a compiler listing, you should specify OUPUT(*PRINT) in the CRTRPGMOD command. Note that a compiler listing is not exactly the same as you see in your source member. Even if your shop needs to debug programs in your customer’s production environments, and you think that using *STMT is the only way to have debuggable programs that don’t reveal your source code, don’t jump to conclusions. Hiding source in plain (debug) view is something I’ll talk about later. Figure 1 shows the Display Module screen for a module compiled with this keyword. Let me take a moment to apologize for the fixed-format code you’ll see, but I used a piece of code that wasn’t totally “modern” from the “BIF Up Your Code” subseries to illustrate this set of TechTips about the ILE debugger.

RPG Academy: Debug Done Right - Introducing the ILE Debugger - Figure 1

Figure 1: The Display Module screen for a module compiled with DBGVIEW (*STMT)

The *SOURCE keyword gives you source-level debug information, allowing you to display and reference a module’s source during the debug session rather than rely on a piece of paper (the compiler listing) with the statement numbers, which is, in a nutshell, what the *STMT keyword forces you to do. This option lets you see the actual statements being executed, just like they were written in your source member, and navigate through the source code while executing debug operations. Figure 2 shows an example of a Display Module screen for a module compiled with DBGVIEW(*SOURCE).

RPG Academy: Debug Done Right - Introducing the ILE Debugger - Figure 2

Figure 2: The Display Module screen for a module compiled with DBGVIEW(*SOURCE)

This view produces a slightly larger object than the *STMT keyword. It’s an improvement, but you still can’t see the sources of the copy members included in the source code using the /COPY or /INCLUDE statements. Instead, what you get is the /COPY or /INCLUDE statement as you wrote it in the original source, shown in Figure 3.

RPG Academy: Debug Done Right - Introducing the ILE Debugger - Figure 3

Figure 3: Copy members are not shown in the Display Module screen for a DBGVIEW(*SOURCE)-compiled module

These copy members typically contain prototype definitions for the procedures, but they can also hold definitions for variable and constant fields. It’s really annoying when you’re debugging something and you just can’t figure out where a variable comes from. (Admittedly, it gets easier if you use the appropriate prefixes, as discussed a few TechTips ago, but it’s still annoying not to see all the code that’s being executed.) In addition, only a reference to the source is stored with the object. Basically, only the source member, source file, and library names are stored. This keeps the object from growing significantly in size, but the source must not change and must not be renamed or moved. If you change the source, it will no longer match the object’s original source, and if you rename or move the source (which will happen if you use different sets of libraries for your development, quality assurance, and production environments), the debugger won’t be able to locate it.

If you need to see the copy members, then you need to use *COPY. This view lets you see the actual expanded code produced by copy members, rather than simply seeing a /COPY or /INCLUDE statement during the debug session. Note that using this keyword causes a slight increase in object size, when compared with the *SOURCE keyword.

More to Come

That’s all the space I have this time around! In the next RPG Academy TechTip, I’ll continue to discuss the debug views that the ILE Debugger has and share some advice on how to choose the most appropriate. Until then, feel free to share your ideas, comments, questions on the Comments section or in the usual LinkedIn groups where my articles usually pop up.

Rafael Victoria-Pereira

Rafael Victória-Pereira has more than 20 years of IBM i experience as a programmer, analyst, and manager. Over that period, he has been an active voice in the IBM i community, encouraging and helping programmers transition to ILE and free-format RPG. Rafael has written more than 100 technical articles about topics ranging from interfaces (the topic for his first book, Flexible Input, Dazzling Output with IBM i) to modern RPG and SQL in his popular RPG Academy and SQL 101 series on mcpressonline.com and in his books Evolve Your RPG Coding and SQL for IBM i: A Database Modernization Guide. Rafael writes in an easy-to-read, practical style that is highly popular with his audience of IBM technology professionals.

Rafael is the Deputy IT Director - Infrastructures and Services at the Luis Simões Group in Portugal. His areas of expertise include programming in the IBM i native languages (RPG, CL, and DB2 SQL) and in "modern" programming languages, such as Java, C#, and Python, as well as project management and consultancy.

MC Press books written by Rafael Victória-Pereira available now on the MC Press Bookstore.

Evolve Your RPG Coding: Move from OPM to ILE...and Beyond Evolve Your RPG Coding: Move from OPM to ILE...and Beyond
Transition to modern RPG programming with this step-by-step guide through ILE and free-format RPG, SQL, and modernization techniques.
List Price $79.95

Now On Sale

Flexible Input, Dazzling Output with IBM i Flexible Input, Dazzling Output with IBM i
Uncover easier, more flexible ways to get data into your system, plus some methods for exporting and presenting the vital business data it contains.
List Price $79.95

Now On Sale

SQL for IBM i: A Database Modernization Guide SQL for IBM i: A Database Modernization Guide
Learn how to use SQL’s capabilities to modernize and enhance your IBM i database.
List Price $79.95

Now On Sale



Support MC Press Online

$0.00 Raised:

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: