28
Thu, Nov
0 New Articles

Don't Mix Override Metaphors

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

When I was working on OS/400 V2R3 early-ship, I noticed that IBM had snuck in a new parameter to the OVRDBF. I'm not sure if this parameter was added on V2R2 or V2R3 as I had already moved to V2R3 by the time I noticed it. The new parameter, OVRSCOPE (override scope), added versatility to the override command. I remember that, back on System/38, we sorely wanted a way to call a CL program, perform an override, and then return to the caller while retaining that override.

The OVRSCOPE parameter gives us that capability with the *JOB option. This option causes the override to stick around long after the program that issued the override has ended and long after the activation group in which the program was running has been destroyed.

I've regularly advocated that people use OVRSCOPE(*JOB) when issuing an override from an ILE program object. If you're running in an activation group or running in a program that is running in the default activation group (which may have been called by an ILE program in another activation group), then the easiest way to ensure that the override is applied is to use OVRSCOPE(*JOB).

At least, that's what I thought until today. Today, I was working on a bug in one of my CGI programs, and like the Fer de Lance snake in the Belize jungle, the OVRSCOPE(*JOB) jumped out of nowhere and bit me. The biggest pain was that it didn't occur regularly. In one case, it wouldn't occur at all, and in another, it occurred sporadically, but once it did, it was there to stay.

At first, following my usual thought process, I blamed myself; I thought I was doing something wrong. I looked at the code in my program, but it was pretty straightforward.

The program is a new CGI program (actually a server-side include) that displays a weekly tip on my Web site. When I create a new source member in the QHTMLSRC source file, the SSI program instantly displays that source member on the RPGIV.com Web site as the "Quick Tip" item.

It works great, uses no CGI library, and is a very effective way for me to instantly update the Web site with a new tip whenever I think of one.

The problem was that on one of the Web pages, the tip would show up correctly for a while, and then suddenly for no obvious reason, it would display the raw HTML used by another CGI program, which happened to be one of my example CGI programs on the Web site. Visitors to my site can run these sample programs directly on my system to see how they work. Then they can view the source code behind it. The program that displays source code is named VIEWSRC.

VIEWSRCE was written on V4R2 and uses the OVRDBF command to override QHTMLSRC to the specific source file, library, and member name. I instinctively included the OVRSCOPE(*JOB) parameter to insure the override stuck around for any subprogram calls. This program has been running for years and years without a glitch.

The new SSI program was written on V5R4 and compiled to TGTRLS(V5R2M0), which unfortunately is the earliest you can specify for TGTRLS once you move to V5R4.

The VIEWSRC program, being written on V4R2, had to utilize a call to QCMDEXC to perform an OVRDBF, whereas the new program, written for V5R2, uses the EXTFILE and EXTMBR keywords to control which file/member is open and displayed. The EXTFILE and EXTMBR keywords avoid issuing an override and instead open the file/member directly. This cool feature eliminates at least 80% of the reasons I had been using the OVRDBF command.

So I have a V4R2 program running as a CGI program periodically and a V5R2 program running as an SSI program on every page view. After a while, the SSI program displays garbage. Hmmm. What could be the problem?

Enter OVRSCOPE(*JOB).

No, it wasn't a bug in the Apache Web server, it wasn't a bug with EXTFILE, and it wasn't an ILE problem (although I thought that was the issue). Instead, the problem was that I mixed deprecated techniques with contemporary techniques.

Picture this: Program A is called. Program A is compiled with ACTGRP(*NEW). In program A, a call to QCMDEXC overrides file X to file X in QGPL and the member to member Y, as follows:

OVRDBF FILE(X) MBR(Y) TOFILE(QGPL/X) OVRSCOPE(*JOB)

Program A runs fine and returns. The temporary activation group created by ILE is automatically destroyed by ILE. (This last point is interesting but irrelevant to the problem).

Program B is called in the same job. Program B uses EXTFILE and EXTMBR keywords as follows:

     FX         IF   E             DISK    EXTFILE(myFile) USROPN                      
     F                                     EXTMBR(myMbr)
     F                                    
     D myFile          S             21A
     D myMbr           S             10A

      /free
         myFile = 'QGPL/X';
         myMbr  = 'Z';
         open X;
      /end-free

File X is redirected to file X in QGPL, and the member being used is 'Z'. Here comes the problem. Since the previous call to Program A left a lingering OVRDBF to file X, member Y lying around, that override is still in effect and applies even though I'm directly opening a different member. Thus, the program opens the file and member pointed to by the (completely unrelated) override, not the file and member I expected.

The fun part is that if Program B runs first, it works. If it runs first, second, third, etc., it works. But as soon as Program A is called in that same job, bam!

Obviously, the designers of the OVRSCOPE parameter couldn't know that the RPG IV team would add EXTFILE and EXTMBR years later. After all, OVRSCOPE appeared in V2R3, and EXTFILE/EXTMBR didn't show up until V5R1.

My big mistakes were twofold:

First, I used OVRSCOPE(*JOB) blindly in my old code, assuming that if I needed a subsequent override someplace else, I would simply issue another override with OVRSCOPE(*JOB) as well, and everything would be fine.

But then technology changed. The EXTFILE and EXTMBR keywords were introduced, and I started to use them heavily. After all, I was the original advocate of these keywords even before RPG IV was announced.

Next, where I made my big mistake was not thinking about OVRSCOPE(*JOB). I have been teaching/advocating the use of OVRSCOPE(*JOB) almost as a catchall for mixed ILE/non-ILE environments for years. With pre-V5R1 RPG IV programs and CL, this was an OK approach.

Usually when I write code, I try to think about the future enhancements that may come into play and design/engineer things accordingly. But I suppose I can get lazy sometimes, and in this case it was obvious.

So, if I could time travel back to an era when IBM customers had a way to ask for new features (we used to call them "requirements" at IBM user group conferences in the 1980s and 1990s), I would ask IBM to add a new option to the OVRSCOPE parameter of the OVRDBF command.

This new option, OVRSCOPE(*ACTGRPJOB), would issue an override that behaves just like OVRSCOPE(*JOB) except that when the activation group in which the override has been issued is destroyed, the override itself will also be deleted.

This feature would also help when a RCLACTGRP command is issued (the overrides will also be deleted) or when a program runs with ACTGRP(*NEW). When these programs end, their activation group is destroyed; thus, the override would also be deleted.

The moral of the story is, stop using OVRSCOPE(*JOB) unless you mean it. Let OVRDBF default to OVRSCOPE(*ACTGRPDFN). Otherwise, use OVRSCOPE(*JOB), but remember to issue a corresponding DLTOVR when you are finished with it. Otherwise, you may have a "learning experience."

Bob Cozzi is a programmer/consultant, writer/author, and software developer of the RPG xTools, a popular add-on subprocedure library for RPG IV. His book The Modern RPG Language has been the most widely used RPG programming book for nearly two decades. He, along with others, speaks at and runs the highly popular RPG World conference for RPG programmers.

BOB COZZI

Bob Cozzi is a programmer/consultant, writer/author, and software developer. His popular RPG xTools add-on subprocedure library for RPG IV is fast becoming a standard with RPG developers. His book The Modern RPG Language has been the most widely used RPG programming book for more than a decade. He, along with others, speaks at and produces the highly popular RPG World conference for RPG programmers.


MC Press books written by Robert Cozzi available now on the MC Press Bookstore.

RPG TnT RPG TnT
Get this jam-packed resource of quick, easy-to-implement RPG tips!
List Price $65.00

Now On Sale

The Modern RPG IV Language The Modern RPG IV Language
Cozzi on everything RPG! What more could you want?
List Price $99.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: