11
Mon, Nov
6 New Articles

Using APIs to Extend RPG: The CEE APIs

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

RPG is a fantastic language for business calculations, but sometimes it needs a little help with the more esoteric computations, and that's where APIs come in.

 

I recently had an opportunity to program some electrical formulas (or do you say formulae?). This took me out of my normal comfort zone of traditional business mathematics and made me hearken back to my days of algebra and trigonometry. While I couldn't have done this in RPG III, it is possible in RPG IV—even using the traditional fixed-format technique. And if you're willing to stretch a bit and use ILE concepts, it's actually quite easy to do arbitrarily complex mathematical calculations in RPG IV and especially in free-format RPG. All you need is a good set of mathematical APIs, and as it turns out, the IBM i provides you with not one, but two distinct sets of APIs that can be used for the purpose: the CEE APIs and the C Runtime APIs. This article will cover the CEE APIs, and I'll follow up with the C Runtime APIs in a second article.

Why Two Sets of APIs?

I don't know the definitive answer to that question, but I can tell you the primary difference between the two and the real-world implications. CEE APIs use bidirectional parameters. They are more like traditional called programs in the sense that the calling program uses a parameter list with some input and some output parameters. The input parameters are used in the computation, and the result is returned via the output parameters. Let's take the example of calculating a logarithm. You would need one input parameter and one output parameter. The input parameter would be the number for which you need the logarithm (say, 100), and the output parameter would return the logarithm of 100 (which would be 2).

 

The C Runtime APIs work a bit differently. They are ILE procedures and expect one or more input parameters (basically the same parameters as the corresponding CEE APIs), but they return the result as the return value of the procedure. This is a more natural technique for non-RPG programmers; it's the style used in C programming, which is where the C Runtime APIs come from. The QC2LE binding directory includes service programs that expose various C APIs available on the IBM i. So that means that unless you're comfortable with ILE, you won't be using the C Runtime APIs. But I'll cover that aspect in more detail in the follow-up article.

Today's Lesson: The CEE APIs

Today I'll demonstrate the CEE APIs. Let me start with a simple exercise. I want to compute an arbitrary value: I want to raise the cosine of a value to the power of its log. That is, I want to compute cos(x) to the log(x) power. This particular equation is not likely to be something you would see in the real world, but it will illustrate the main points of the CEE APIs. In order to execute this equation, in addition to some standard prototypes, I need just a few lines of code. Let me get the prototypes out of the way first:

 

     d CEESDLG1        pr                  extproc('CEESDLG1')

     d   input                        8F   const

     d   output                       8F

     d   error                       12    options(*omit)

    

     d CEESDCOS        pr                  extproc('CEESDCOS')

     d   input                        8F   const

     d   output                       8F

     d   error                       12    options(*omit)

    

     d CEESDXPD        pr                  extproc('CEESDXPD')

     d   input1                       8F   const

     d   input2                       8F   const

     d   output                       8F

     d   error                       12    options(*omit)

 

The prototypes are very similar. All start with CEES, all take two or three floating point parameters, and all have an error parameter with options(*omit) specified. You may have noticed that all of these APIs start with CEESD; the D happens to denote the type of the parameter. The CEE APIs are very flexible in that versions exist for various data types, typically integer and floating point of both single and double precision as appropriate (for example, floating point numbers aren't supported when calculating factorials). You can see which APIs are available for which data types here. The CEE APIs even have a set of functions for performing complex math functions on imaginary numbers. It is very easy to switch between the various data types: change CEESDLG1 to CEESSLG1, and you can now pass in single-precision floating point numbers (type 4F in RPG) instead of double-precision.

 

This flexibility also extends to error handling. You can either test for various error conditions using the error feedback area or you can omit that parameter. If you omit the parameter (and this means using the *OMIT keyword on the call as opposed to not passing the parameter at all), then any error conditions (divide by zero, overflow, etc.) will generate an exception message. You can see the exceptions here.

 

Now that we have a basic introduction to the CEE APIs, let's take a look at the actual code. It's quite straightforward. First, define the work variables.

 

     d x               s              8F

     d result          s              8F

     d cosx            s              8F

     d lg1x            s              8F

 

Then, use either fixed-format or free-form RPG calculations to call the APIs:

 

     c                   callp     CEESDCOS( x: cosx: *OMIT)

     c                   callp     CEESDLG1( x: lg1x: *OMIT)

     c                   callp     CEESDXPD( cosx: lg1x: result: *OMIT)

    

(or)

 

       CEESDCOS( x: cosx: *OMIT);

       CEESDLG1( x: lg1x: *OMIT);

       CEESDXPD( cosx: lg1x: result: *OMIT);

 

Note that I need to define four variables in total. The variables x and result are of course the beginning and ending values, but cosx and lg1x are the intermediate values needed to execute the computation. Since each CEE API must return its value in a bidirectional output parameter, this is the best that you're going to be able to do (unless you further wrap each CEE API in your own procedure). But the calls are simple, and because I'm omitting the error parameter, the code is very clean. The downside of omitting the error feedback parameter is that any bad data will raise an exception, but I'll leave error checking to you.

Deciding When to Use the CEE APIs

So how do you decide between the CEE APIs and the C Runtime APIs? Well, a lot depends on what the program is supposed to do. The CEE APIs provide a lot more than mathematical functions. You can see the categories in the Infocenter. In addition to the mathematical functions, the APIs include condition handling (including the indispensable CEEHDLR API), activation group control, program handling, and storage management, among others. If you find yourself already using some of these APIs, then you may want to also use CEE APIs for mathematical functions for consistency. The CEE APIs also provide a finer-grained control over your exception handling.

 

If, on the other hand, your program is entirely mathematical in nature and you want to be able to write really simple and readable code, you might want to consider the C Runtime APIs. Thanks to the way those APIs are designed, you can use them to write the same code like this:

 

       result = pow( log(x): cos(x));

 

I'll show you how that works in the follow-up article.

as/400, os/400, iseries, system i, i5/os, ibm i, power systems, 6.1, 7.1, V7, V6R1


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: