29
Fri, Nov
0 New Articles

RPG Academy: Building Your Own Functions

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

The previous TechTips were about procedures, so it's now time to move to the next stop of our OPM-to-ILE journey: the functions. Read on to find out more!

 

This TechTip will cover the basics of functions and provide a simple example. Functions can make your work much easier by increasing your code's readability, flexibility, and modularity. You've probably already used a built-in function (BIF) or two, such as %EOF or %Found. These are great tools that simplify our work, increase code readability, and allow us to write shorter pieces of more flexible code.

 

BIFs are great, but do you know you can build your own functions? Just think about the possibilities! It's quite an easy task, actually, because functions are very similar to the procedures discussed on the previous TechTips. The main difference is that a function returns some sort of value. Not in a parameter, like an OPM program or an ILE procedure would do, but in the call itself, like a BIF does.

 

If you're a regular reader of this series, you should be familiar with the inventory scenario I've been using since the first TechTip. If you're not, I really recommend that you start there and make your way back to this one! The "Check if item exists in inventory" procedure, discussed in the previous TechTip, could be easily transformed into a function, thus providing a great example to start with. The idea behind this procedure is that several programs need to know if an item is in stock in order to do something with it. From the procedure's point of view, it really doesn't matter what; its objective is simply checking if an item exists in the inventory. For the other programs, however, it's not that simple: they need to call the procedure, check its output parameters, and then perform whatever operation they need to perform. If we transform this procedure into a function that returns *On or *Off, it can be used directly in an IF statement. Something like this:

 

IF Check_Item_Exists_In_Inventory(Item_ID: Item_Quantity : Item_Unit_Price) = *On Then (do something)

 

Now let's turn this into RPG: procedure and function names should be short but understandable, as I explained in the fourth TechTip of the series, so a more suitable name for our function would be ChkItmInInv (notice the capitalization; each abbreviated word starts with a capital letter). This makes it easier to read and understand, even though there are some letters missing. This function takes the Item ID as a parameter, so it should be named P_ItmID. It returns the Item Quantity and Unit Price, so let's shorten their names to P_ItmQty and P_ItmUnPrc. Again, shorter but understandable. The code would remain basically the same: read the inventory master file using the Item ID parameter as key and return the quantity and unit price found in the respective output parametersjust like an OPM program would do. The big difference is that we can now return an indicator (or any other kind of value, really) to help the calling program decide if and how to use the output parameters without having to check them! Let's say we'd return *On if the item was found and *Off otherwise. Our function's code would look something like this:

 

*-------------------------------------------------------------------------*

*   Check if an Item exists in inventory      

*-------------------------------------------------------------------------*

P ChkItmInInv     B                   EXPORT                        

D                 PI             N                            

D P_ItmId                       50                                  

D P_ItmQty                     10 0                                

D P_ItmUnPrc                   11 2                              

C*                                                                  

C* The function's code goes here

C*

C* Because this is a function,

C* a RETURN statement is required

C* so we need some logic to determine what to return

C                   If       P_ItmQty > *Zeros    

C                   Return   *On

C                   Else

C                   Return   *Off

C                   EndIf

C*                                          

P ChkItmInInv     E                                

 

There are a couple differences here, and the first one is very subtle: notice that there's an "N" in the "PI" line? That doesn't exist in a procedure's interface. This definition is what determines that is a function (because it returns something) and, in this particular case, defines that the returned value is of the "N" typean indicator. Somewhere in the code, usually near the end of it, there's some logic to determine the value to be returned, and the op code RETURN is used to return that value. This detail is what allows us to do this:

 

C* Check if Item exists in the inventory before update

C                   If       ChkItmInInv(P_ItmID   :

C                                         P_ItmQty :

C                                         P_ItmPrice) = *On

C* The item exists, do something with it

C                   ExSr     Some_SR

C                  EndIf

 

If you remove the two differences I explained before, ChkItmInInv goes back to being a procedure and you would call it with CallP, just as I explained a couple of TechTips ago. This is a simple (perhaps too simple) example, but it serves the purpose. You can create functions to encapsulate complex financial formulas that you use in several programs, or to hide some business logic in order to increase a program's readability, or a million other things.

 

Let me finish with some suggestions: there's a lack of string-formatting BIFs, so you could start there, by creating your own functions to:

  • Capitalize Every Word In A Sentence
  • TURN EVERY WORD INTO UPPERCASE
  • or into lowercase
  • jsut jblume teh ltteres a bit (just jumble the letters a bit)

 

It's good practice (and a bit of fun too!).

 

In the next RPG Academy TechTip, I'll continue to talk about functions, because there's a lot more to be said. Until next time!

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

$

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: