04
Mon, Nov
5 New Articles

Practical RPG: Replace PSSR and INFSR with MONITOR

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

MONITOR takes RPG into the next level of error detection, and this article introduces one of the most useful aspects of this new opcode.

RPG has come a long way since the H1 halt indicator. Back in the day, you issued a halt when a program encountered a completely unexpected condition--usually application errors such as a master record not found or a divide by zero, although fatal errors could also include programs not found or files full. The current height of technology is to use the Program Error Subroutine (PSSR) to handle unexpected errors, but this article will show you an even cleaner and easier way to handle errors: the MONITOR opcode.

Using PSSR and INFSR

Using the PSSR is simple enough; you just declare a subroutine named *PSSR (the asterisk is required), and all unhandled program-level errors will trigger a call to that subroutine. Note that I said "unhandled"; errors specifically handled in the code by using an error indicator or an error extension to the operation code (e.g., CALLP(E)) will not cause transfer to the PSSR. But other program errors invoke the PSSR.

 

Note that file errors do not automatically go to the *PSSR routine. Instead, you must specify a file-error subroutine (INFSR) for the file. This is done at the file level, specifying an error routine for each file. In an effort to consolidate error processing, you may also see code in which the program status subroutine is also used to handle file errors, so the INFSR is routed to the program status using the following keyword on the file specification: INFSR(*PSSR).

 

For me, the biggest weakness in the PSSR concept is its poor handling of nested errors. If an error occurs inside of a PSSR, it will invoke the PSSR again, recursively. So unless you have a bunch of code in place to detect the nested failure, your program will go into a hard loop. It doesn't help that this approach also requires non-intuitive and somewhat inconsistent syntax.

Enter the Monitor

The MONITOR opcode removes a lot of the ills of the PSSR/INFSR construct. Let's revisit my error code from a previous article:

 

    // Special monitor logic.

    //   This will trigger a dump for any internal error.

    monitor;

      exsr mainline;

    on-error;

      dump;

    endmon;

    *inlr = *on;

 

This is the mainline of every new production program I write. The actual program logic is then coded in the subroutine mainline.  The code above is the simplest version; if any error is encountered, the program dumps itself and then returns. If this were a report program in the middle of a jobstream, the job would continue running, but you'd see a dump instead of this report (or in addition to a partial version of the report).

 

And while this is a very simplistic version, it's actually perfectly fine for situations that don't need a lot of error-handling--for example, if this were an ad hoc report that the user was going to look at immediately anyway. However, I think we can agree that even the simplest report could use a little more robust error-handling. At the minimum, I suggest writing a simple CL program that can be called right after dumping the program to send a message back to the user or to the system operator.

 

One of the benefits of the monitor concept is that it handles nested errors. If for some reason the CL program bombs (or doesn't exist), you'll get a standard escape message and the job will go into MSGW status. Not perfect, but I think it's a reasonable response to a fatal error in your fatal-error-handling routine, and in any event it's better than an infinite loop.

Variation on the Error-Handling Theme

Other variations exist. If your program is already set up with a return-code field, you could always set that field to indicate that an internal error has occurred before returning to the caller. On the other hand, some errors may indeed be so bad that you want to halt the job; you can do that by sending an escape message to the calling program.

 

At the far end of the spectrum, you can even have different responses for different errors. The on-error clause allows you to identify a specific error code; it makes the monitor work very much like a case statement for errors. Here's an example:

 

       monitor;

         exsr mainline;

       on-error 1217;

         callp halt('File ORDER not found - check library list.');

       on-error *FILE;

         dump;

         callp halt('File error occurred - check dump.');

       on-error;

         dump;

         callp info('Program error occurred - check dump.');

       endmon;

       *inlr = *on;

 

In this situation, the monitor checks for three different situations. First, it checks specifically for a file-not-found error (error 1217). If that's the case, it halts the jobstream because the likely problem is a bad library list, and other programs may fail as well. The call to the external procedure halt will send an escape message to put the job into a message wait state. Next, it looks for any file errors. Again, it halts on those errors because it indicates that there are serious environmental issues. However, since this could be any file error (as indicated by the special value *FILE for the error number), it dumps the program and directs the user to the dump. Similarly, on a program error, the user is directed to a dump, but since program errors are most often logic problems, this type of error triggers an informational message (by calling info rather than halt), which notifies the user but allows the job to continue.

 

So that's the short version of the monitor opcode. I hope I'll get a chance to revisit it in more detail in a later article.

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: