17
Fri, May
7 New Articles

RPG Academy: More on Procedures: The Dos and Don'ts and Other Interesting Things

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

The previous TechTip of this series introduced the concept of procedures, along with a simple example. This one will explain when you should (and shouldn't) create a procedure and reveal some pitfalls you need to avoid.

 

Let's start with a quick recap: procedures are "subroutines with parameters" that can exist outside the program that is calling them. For that to happen, the calling program needs to know how to use the procedure. This critical piece of information is supplied by a prototype definition (similar to the *Entry PList of a program). It's a good practice to use a separate source member to store the prototype definitions because they will be used in more than one program.

 

The next big question is when to create a procedure. How should an OPM program's subroutines be transformed into procedures? Should the procedures be exact copies of the subroutines?

 

Well, to answer these questions (and many others the readers have been asking me), let's try to rationalize the concept of a procedure: it's supposed to be reusable and work together with other procedures, like building blocks, to create modular solutions to the challenges today's RPG programmers face. This implies that the procedures should be small and simple so that they can be used in as many situations as possible. They should also be compatible with other procedures; in other words, they should be independent and, within reason, self-sufficient.

 

Our example since the first TechTip of the series (and slightly modified in the previous TechTip) has been the inventory programs scenario depicted in Figure 1:

 

050214RafaelFigure1

Figure 1: This is the evolved OPM scenario.

 

Here we have two main programs, A and B, which manage the inventory master file in different ways. While A imports inventory items from a cargo manifest CSV file, B handles the user inventory management via screen interaction. They both call some external programs, identified here as BR1, BR2…BRx. These last programs are the perfect candidates for procedures, but here is where you need to be careful. If the idea is to build something that you can reuse, you need to keep it as simple as possible.

 

050214RafaelFigure2

Figure 2: BR2 is transformed into a module with several procedures.

 

Figure 2 depicts a scenario in which BR2 is transformed into procedures. Imagine that program BR2 has a subroutine, among others, that checks whether an item already exists in stock, and it also updates the inventory. When BR2 was turned into a module, it was split into several procedures. As I explained in the previous TechTip, a module can have one or more procedures. BR2's subroutine "Check if item exists in inventory and update it" became procedures "Check if item exists in inventory" and "Update inventory" because there will be some situations in which only one of these two operations will need to be performed; somewhere in program A or B you might have a piece of code that checks if an item exists in inventory but doesn't update it or vice versa.

 

Procedures should also be compatible with one another: if you have several procedures that might be used together, they should share some common parameters or some sort of key to be able to access the data they'll be performing operations on. Let's say that program B needs to remove an item from inventory. It will first call the "check if item exists in inventory" procedure that spawned from BR2 and then it will call the "update inventory" procedure. These two procedures might have existed as a subroutine in BR2, but when they were transformed into procedures they became independent from one another. However, they need to share the Item ID as a key so that they can work together.

 

Finally, procedures should be, within reason, self-sufficient. In other words, a procedure should be able to perform whatever operation it needs to perform without calling other procedures. Of course, there will be situations in which this is simply not possible (hence the "within reason" I used before), but you should try to minimize them. How? Well, having procedures that perform a simple and well-delimited operation, like the two examples presented before, is a way. This is important because when you are compiling your code you might run into a "the chicken or the egg" situation: you need to recompile module X (which I've explained how to do in the third TechTip of this series), but this module has a procedure that uses another procedure or function from module Z. If module Z also uses something module X uses, you won't be able to recompile either of them! Also keep in mind the aforementioned need for simplicity and reusability; if your procedures are small and self-contained, they will be easier to understand and use over and over again instead of writing new (or duplicated) code.

 

A final note: you may or may not have noticed that the "Update inventory" procedure in Figure 2 is not the same color as the other procedures. If fact, it's the same color as the "Database Operations" subroutines in Figure 1. This was not by chance: I'll give you a detailed explanation later, but procedure "Update inventory" shouldn't be in module BR_INV because it's a database operation procedure and BR_INV is a business rules module. Updating the inventory is definitely not a business rule; it depends on one or more business rules, but it's not a business rule, so it shouldn't be there. For the moment, let's keep it simple. I'll come back to this detail later on this series and explain where it belongs and why in more depth.

 

The next installment of the RPG Academy Series will be about functions! I hope you're enjoying this series and, as usual, if you have any questions, suggestions, or doubts feel free to contact me!

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

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

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: