Thu, Dec
5 New Articles

ILE RPG Prototyping Primer

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

Get to know ILE RPG’s prototype structure—essential knowledge for anyone getting used to ILE’s modular approach

by David Shirey

Editor's Note: This article is excerpted from chapter 15 of 21st Century RPG: /Free, ILE, and MVC, by David Shirey.

Prototyping is a term that describes how modules are accessed within the ILE environment. The word prototype also refers to a particular D-spec structure that is required to support this call or access.

As a result, “prototype” can function as both a verb and a noun. It can be the process of calling another module as well as the specific data structures required to do that call.

And by modules, I do not mean *MODULES, the formal object type that is the output of the CRTRPGMOD command, but just any code structure, be it a program or a sub-procedure or whatever. In the old OPM world, we might have referred to this as a “call.” You can use prototypes to access (or call) RPG programs, sub-procedures, CL, C, Cobol, and even Java classes.

So far, we have seen examples of how to prototype with both the CALLP and the function call-return values combo.

You can even use prototypes to call OPM positional programs. That is, if you have an old program with an *ENTRY opcode, you can call it from an ILE program using prototyping in the ILE program. Of course, what you should do is rewrite the old program, but whatever. But now, let’s get into some detail.

What Is a Prototype?

A prototype is a set of special D-specs with a declaration type of either PR or PI.

We will get to the differences between those two in a minute. What’s important to remember now is that the prototype structure is just a new type of D-spec. In fact, if you go back to the /Free control option statements in the last chapter, we even had specific operators for the PR and PI D-specs (dcl-pr and dcl-pi).

Prototypes are not P-specs. Those are also used in ILE but are different and simply delineate the beginning and end of a sub-procedure. Prototypes are D-specs. P-specs are not D-specs.

The prototype structures will be found in both the calling and the called program and will look something like this:



PR and PI

As we said a moment ago, there are two types of prototype D-specs.

The PR D-spec is the “prototype” D-spec. It is in the calling and the called program.

The PI D-spec is the “procedure interface” D-spec. It is in the called program only.

You will want to remember those names because we will be using them frequently as we go forward.

PR Details

The PR (prototype) D-spec will appear in both the calling and the called program. Have I mentioned that before?

The good thing about the PR in the calling program is that it makes it very clear what parms belong to what call (because each call to a different module will have its own unique PR D-spec).

On the other hand, the PR does not actually define the fields to the program (yep, they have to be defined separately somewhere else in the program). How weird is that?

Because the PR does not formally define the fields to the program, every subfield that is going to be passed will have two representations in the calling program: one in the PR D-spec and one where the field is actually defined (in a file or another D-spec). The names of the two field representations have to be the same (otherwise it wouldn’t be defined in the PR field, would it?). Similarly, the field types must be the same. What doesn’t have to match are the field lengths. Go figure. We will talk more in the next chapter about what to do if the lengths are not the same.

When ILE first came out and I read some of the early articles, I actually drew the conclusion that using the PR formed some sort of magical bond between the calling and the called program, so that when you did the compile it would recognize any parm differences on the call rather than just blowing up when you ran it. That is not the case.

What those articles were actually referring to was that you could set up the PR as a copybook and then use the copybook in both the calling and the called program. This gives you the same PR in both, and since the compile of the called program will identify differences between the PR and PI D-specs (that is, generate an error on the compile), it becomes impossible to have parameter mismatches between your calling and the called program.

PI Details

The PI (procedure interface) D-spec is where the actual parameters are defined; it is used in receiving those parameters into the called program. As a result, the subfields on the PI do not actually have to be defined in the called program; the PI does it for you. Ain’t that sweet?

The PI is found only in the called program. Since the called program has both a PR and a PI D-spec, the compiler will compare the two specs. The field names of the corresponding fields do not have to match, but if they don’t, the one in the PR D-spec must be defined elsewhere in the program. The field types and lengths do have to match, however, as do any keywords. In other words, in the called program, the PR and PI D-specs must be identical (except for that name thing). But you want them to be identical, otherwise you are just trolling for trouble.

Subfields on the Prototype

A prototype does not have to have subfields (parameters) associated with it.


There is nothing wrong with calling a program or sub-procedure and not passing any subfields (like the example above), but you still need to define a prototype structure (it just won’t have any subfields associated with the PR/PI D-spec).

Most of the time, however, you are going to be passing parms into your called program, and with subfields, the prototype would look like this:


D   PRDNO             15

D   MSG1               60

And please remember that if you are on a release of RPG that supports the control statements, then you could set things up that way rather than using D-specs. That is, the above spec example would look like this with control statements.

dcl-pr   VAL_PRDNO;

   PRDNO     Char(15);

   MSG1     Char(60);



More PR and PI

There are some interesting relationships involving the size and type of the fields in both the PR and the PI.

OK, fine, I’ll say it. For prototyping, size matters. There, are you happy? Bunch of sickos.

For one thing, in the called program where we have both a PR and a PI, the subfields must match size- and type-wise in both D-specs. So, if you have parms that are 10,0 and 3 in the PR, they have to be the same parms in the PI. That is, within the calling program.

Strangely enough, the names of the two fields whose lengths must match do not have to be the same. That is, it could be Field1 in the PR and Field11 in the PI. But at the same time, remember that if they are different (and I have no idea why you would want to do that, doesn’t sound like a good idea), then you have to have the field from the PR D-spec defined somewhere else because the differently named field in the PI won’t be backing it up. Know what I mean? Just make them the same, and don’t go looking for trouble.

On the other hand, if you are in the calling program and you have a PR that has two parms, 10,0 and 3, then the actual fields in that program where those two fields are defined can have different lengths. I know, so weird. There are rules about just how different they can be, but I want to hold off on discussing that until the next chapter because I just like to put off unpleasant things.

And if that isn’t weird enough, the lengths and types of the PR subfields in the calling program do not have to match the length and type of the subfields in the called program. That is, the compiles will work fine. There may be problems when you run the program, so it is not something that I recommend, but the system won’t stop you. And, it is even possible that if you are passing large amounts of data, like if you are processing XML documents, you might want the lengths to be different.

And I guess that’s the basics of prototyping. But I know what you are probably wondering right now.

Why are both a PR and a PI required? They look essentially identical, except for the R and the I. And we already saw that the PR is primarily documentation. So why do we need both? And the answer is simple.


Yep, that’s it. Just because. Because that’s the way it is. Because that’s the way IBM designed it. Because if you don’t do it that way, it won’t work. In a nutshell, it’s because that’s the way we say it is, and there ain’t nothing you can do about it because you don’t really know who “we” are. So there!

But, as I said above, it is a story that is evolving, and so in 7.1 there are some types of programs where the prototype (that is, PR D-spec) may be left off in the called program. Those are cases where the program being called is an exit program or one that calls a command, one that is not called by another RPG program (although it can be called by a PHP or another language script), and where the sub-procedures being called are not “exported” from the program. We will talk more about exporting later. Just keep in mind that this is not a wholesale removal of the need for PR; it’s just making it optional in certain circumstances. And also remember that is only for 7.1 and above.

Now It’s Your Turn

Before continuing, are you at a point where you really feel comfortable with prototypes?

We have actually gone over the information a number of times, but feeling comfortable with the prototype structure is key to feeling comfortable with ILE. So, if you don’t feel comfortable with it, take a moment and ask yourself why? Was it the explanation? Not clear enough? Too repetitious? Or maybe you are just dumb? I am not talking here about confused or a little distracted, but just flat out butt-dumb? Might be good to just admit it. I know that works for me. Takes the pressure off, you know.

Either way, you might possibly want to reread the section above. I realize that if you are really confused that may not help much, but—it’s the best I can do. Good luck.

David Shirey

David Shirey is president of Shirey Consulting Services, providing technical and business consulting services for the IBM i world. Among the services provided are IBM i technical support, including application design and programming services, ERP installation and support, and EDI setup and maintenance. With experience in a wide range of industries (food and beverage to electronics to hard manufacturing to drugs--the legal kind--to medical devices to fulfillment houses) and a wide range of business sizes served (from very large, like Fresh Express, to much smaller, like Labconco), SCS has the knowledge and experience to assist with your technical or business issues. You may contact Dave by email at This email address is being protected from spambots. You need JavaScript enabled to view it. or by phone at (616) 304-2466.

MC Press books written by David Shirey available now on the MC Press Bookstore.

21st Century RPG: /Free, ILE, and MVC 21st Century RPG: /Free, ILE, and MVC
Boost your productivity, modernize your applications, and upgrade your skills with these powerful coding methods.
List Price $69.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: