Fri, Jul
4 New Articles

Practical CL: MONMSG and Beyond

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

MONMSG is a powerful tool, but sometimes even MONMSG needs a little extra help, and here's an example.


One of the great features of the System/38 was the Control Program Facility, or CPF. And one of the coolest things about CPF was the fact that any command you could enter from the command line could also be compiled in a program. This is different from interactively reading a script file, which is nice in its own way but isn't exactly the same thing. Scripts need more attention, especially in error handling; typically, an error causes some kind of alert to pop up on an operator's console, and then they have to decide how to deal with it. Compiled CL, on the other hand, not only understood errors but provided a very powerful tool to handle them, the MONMSG command.


OCL to CL: Losing a Letter, Gaining a World of Functionality

Running a CL program is just the best of all worlds. It allows you to cleanly separate your environmental issues (things like library lists and output queues) from your business logic. This practice allows business programmers to focus on the business issues and not worry about operations. This was really important during the first heyday of the midrange computer back in the late '70s and early '80s, when service bureaus were one of the primary users of midrange systems. As a service bureau, you could write one application and then effectively lease it to multiple clients by simply changing the data files. Midrange computers made this relatively simple, but originally it required scripts. The earliest were OCL scripts, and OCL statements were not exactly pretty. If you recognize the following statement, you might be an old System/36 programmer:


// IFF ?L'99,1'?/Y INI001


// BLDFILE ?WS?IVWORK,D,R,1000,120,,,,,DFILE


Yeah, I bet that brings back memories! Or maybe nightmares; if so, I apologize. But the point is that those commands are not compiled; they are read by an interpreter and parsed and executed on the fly. Typos aren't caught, and changes are fraught with peril. The next step in the evolution of the IBM midrange was the ability to take all those commands and then compile them as a program that, like any other program, could be debugged and stepped through, with variables and conditional code and everything. Today's CL has almost all the trappings of a modern compiled language, including extensive support of structured code. But at its heart, CL is still an operations language.


MONMSG: Handling Those Pesky Exceptions

And that's no more apparent than in how CL handles error messages. CL has a special opcode called MONMSG. MONMSG is so cool that it has two distinct operating modes.


One mode is when a MONMSG is placed after another command. If you put a MONMSG directly after a command, it can check for any errors and execute more commands. One of the great features of CL is that you can direct output of commands to database files and then access those files. A simple case is to process all the members in a file. The DSPFD command allows you to create a list of members, but what if the file doesn't exist? Well, if you don't have any MONMSG, the program will generate a CPF3012 exception (the CPF prefix should be familiar), the job will halt and go into MSGW state, and the operator will see a message in the QSYSOPR message queue. Now if this is a fatal error, you may want that to occur. But let's say that this is a situation where the file may not exist, and if it doesn't, you just want to continue. You can put a MONMSG CPF3012 after the command, and the message will be ignored and the job will continue on. You might want to let someone know, so you could put in the body of the MONMSG command a SNDUSRMSG to alert them:





The second mode is invoked when you define MONMSG as the first executable instruction in your CL program. At that point, the MONMSG becomes generic to all commands in the program, and if any commands generate an error, the MONMSG will attempt to process it. I know I'm not telling you anything new, but I'm laying the groundwork. In fact, there are many more cool things about MONMSG, but that's really not what we're going after here. I want to do a deep dive into a very specific situation.


The situation is simple: some commands give you very specific error messages, and some commands are much more generic. The DSPFD command, as an example, can report over 20 different CPF messages. Other commands are more generic. The CALL command, for instance, returns only a handful. How can that be? Are there that many more errors that can occur in DSPFD? Not really. Instead, what happens with the call command is that many of the errors are reported as a diagnostic prior to the final exception message. If you do a CALL to a program that doesn't exist, you get two messages: a CPD0170, which says that the program is not found, followed by the very generic CPF0001 "Error in command" message. If the library you attempt to call from doesn't exist, you get a CPD0028 error, again followed by the CPF0001. This has pros and cons; it means you can simply monitor for the CPF0001 command and you'll get notified regardless of the underlying error. For a CALL command, that's probably the best solution because no matter why you couldn't call the program, the fact that you couldn't is probably a fatal error. But sometimes that's not the case.



I recently had to write some code that would add directory entries to the System Distribution Directory. I wanted to run through a file, add the directory entry if it didn't exist, change it if it did exist, and report any errors that occurred. I also wanted to specifically report cases in which either the user profile didn't exist or the user was already enrolled but not with the correct address (there's a long backstory on the second situation; the short version is that these were primarily users that had been added long ago).


So like I would normally do, I started executing the command from the command line to determine the errors that could occur so that I could write MONMSG statements in my CL program. This looked to be very easy, until I realized something. Any failure in ADDDIRE returned a CPF9082 message that simply said directory entry not added. Similarly, CHGDIRE always returned CPF9083. What made this particularly difficult is that there was no easy command to check for an existing directory entry, so I had to attempt the ADDDIRE, and then, if I got an error saying the entry existed, go on to do a CHGDIRE. This could get ugly!


Enter the RCVMSG command. RCVMSG allows you to go back into the joblog and get previous messages. In this case, the immediately previous error message would give me detail on which error occurred. CPD9893 says the user and address is already in the directory (so go to the change). CPD9891 tells me the user profile is already enrolled, but under a different address. CPF2204 indicates the user profile isn't valid. So with a little work I can return a meaningful error code to the caller.



Figure 1: This is the code to add or update a directory entry.


Now this particular code may not be the most intuitive and straightforward, but it does a good job of illustrating all the features of MONMSG. First, my code at the top defines generic exception monitors. If CPF9082 occurs, this is an ADDDIRE error, and I need to go get the previous message to determine what to do. CPF9083 is a CHGDIRE error, and I want to do the same thing. Any other error goes to OTHERERROR and returns a generic error message (this normally occurs only when the user profile is more than eight characters long; directory entry user names must be no more than eight characters).


The magic then is in the GETDIAG section. It goes out and gets the previous message, which is the one that really identifies the error. If it's CPD8983, then it means this really was an ADDDIRE and that the entry already exists, so go attempt to change it. CPD8981 and CPF2204 set specific error codes. If a specific error code is set, the program returns it. Otherwise, the code drops through to the OTHERERROR section to return the generic error message.


I think this really shows off the capabilities of the MONMSG. I hope it helps you take a look at your CL programs and really think about how best to handle error conditions.


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



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: