02
Sat, Nov
2 New Articles

Practical RPG: Processing Stream Files, Part 1

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

We've all had to process a folder full of files from a PC or a UNIX machine; today we learn how to do it programmatically.

If you're like me, you strongly believe that the IBM i is the best choice as your business integration hub. It talks just about any language, can handle any kind of data, and has unparalleled reliability. In fact, it's a prefect interpreter between other systems in your infrastructure. One of the things that IBM has focused on over the years is a fantastic capability to support stream files. Whether it's the UNIX-like capabilities of QShell, the stream file capabilities of commands like CPYFRMIMPF, or the ability to write C programs to directly access the files, there isn't a stream file requirement that can't be met by the IBM i.

Let's Start at the Top

So let's start at the top. One of the most basic things you'll ever have to do is to read through a folder and process the files within it. Like so many things on the IBM i, you have a number of ways of doing this. Which one you use depends entirely on the business problem at hand. For example, if all you want is a list of file names, you can just use QShell. You can actually use the ls command to list a folder directly into a database member. The technique isn't elegant, but it is simple and functional, properties I appreciate greatly. But if you're going to have to do anything other than just stuff the name of the file into another command, you'll probably want to dig into the IFS functions.

In my case, I'm using some code that I've developed, modified, redeveloped, forgotten, found again, and repurposed over the years. I use the IFS functions available in the C runtime library, which I was happy to find out is now automatically available when you compile an RPG program. In years past, you had to make sure to include the binding directory QC2LE during your compile, but that now seems to be a standard. Just one less thing to remember.

So today we're going to just open the directory and read through it. Functionally, this won't be much more feature-rich than this:

   dcl-pi *n;

      iDir char(32) const;

      iFilter char(32) const;

   end-pi;

This is my setup. I'm going to get two things: a directory name and a filter. Please note a couple of obvious limitations here. First, I've made both of my input parameters variables of type char with a length of 32. That means that I can easily call this from a command line. As you'll see though, that means I'll have to use %trim later when accessing the APIs. This is important: The routines we use aren't at all forgiving of embedded or even trailing spaces. Remember to trim!

So the next thing I do is define the data structures that I'll be using. One data structure represents a directory entry. It's sort of like the catalog entry; it basically has the name and a couple of salient characteristics but little else. The next structure is the status data structure, and it contains a lot more: size, owner, timestamps, pretty much everything you need to know about the file itself. You can see the structures below along with the layouts I use.

In my program:

     dcl-ds dsDirEnt likeds(IFS_DirEnt) based(pDirent);

     dcl-ds dsStat likeds(IFS_Status);

In a separate copy book:

     dcl-ds IFS_DirEnt qualified template;

      reserved1 char(16);

      reserved2 uns(10);

      fileno   uns(10);

      reclen   uns(10);

      reserved3 int(10);

      reserved4 char(8);

      nlsinfo   char(12);

      namelen   uns(10);

      name     char(640);

     end-ds;

     dcl-ds IFS_Status qualified template;

      mode     uns(10);

      ino       uns(10);

      nlink     int(5);

      pad       char(2);

      uid       uns(10);

      gid       uns(10);

      size     int(10);

      atime     int(10);

      mtime     int(10);

      ctime     int(10);

      dev       uns(10);

      blksize   uns(10);

      alcsize   uns(10);

      objtype   char(12);

      codepage uns(5);

      reserved1 char(62);

      inogenid uns(10);

     end-ds;

These two structures provide all the information you need. These are my own reformatted versions of the IBM-supplied data structures. You can use theirs; they are in the file SYSSTAT in QRPGLESRC in library QSYSINC. There are definitely pros and cons to using the IBM structures, and don't let my preferences get in your way. I'm just a little happier this way (although I have also been considering changing from this format to one using the POS keyword; this would allow me to not have to define the unused portions of the data structureperhaps another day).

Next, I need to define the prototypes for the APIs I'll be calling. These definitions are in the same copybooks as the structures above.

     dcl-pr IFS_opendir pointer extproc('opendir');

      dirname pointer value options(*string);

     end-pr;

     dcl-pr IFS_readdir pointer extproc('readdir');

      pDir pointer value options(*string);

   end-pr;

     dcl-pr IFS_closedir extproc('closedir');

      pDir pointer value options(*string);

     end-pr;

     dcl-pr IFS_stat int(10) extproc('stat');

      pPath pointer value options(*string);

      pBuf pointer value;

     end-pr;

     dcl-c C_MODE_DIRMASK x'0001F000';

     dcl-c C_MODE_DIRVAL x'00004000';

I have my own prototypes for all of these routines. You may notice that, like my data structure definitions, my prototypes also start with the characters "IFS_". It's my own way of keeping everything together. Anyway, the routines above can be broken into two sets: the first three allow you to open, read, and close a directory, while the fourth one returns the status (really the attributes) of a specific file.

Using the Routines

Now it's time to actually use these routines to process a directory.

dcl-s hDir pointer;

   // Open directory, exit on error

    hDir = IFS_opendir(iDir);

   if hDir = *null;

      show('opendir: ' + %str(strerror(errno)));

      return;

   endif;

So, think of a directory as a file containing a list of all the files in the directory (a concept that isn't very far from the truth). First you open it, and then you read it. These routines work using something called a "handle," which is fairly common in C library routines. You attempt to open the directory, and if the open is successful, the opendir function returns a handle to the directory. If it fails, the handle comes back as null. This is what we see in the handful of lines of code above.

Note that, if an error occurs, I call a routine strerror that actually extracts the specific error. It's a common technique used by many functions in the C runtime library; I'll go into it in more detail in a subsequent article. But for now, you could just put out a message that says an error occurred on the open (usually this is because you specified a directory that doesn't exist). Now we can process the directory.

   // Spin through folder

   dou (pDirEnt = *null);

      // Get next directory entry, exit on null

      pDirEnt = IFS_readdir(hDir);

      if pDirEnt = *null;

        leave;

      endif;

Here is a typical DO loop. We “do” until we reach an end condition, but really the exit occurs after the DO loop. I use this all the time because it affords me a bit more flexibility with ITER, as we'll see in a moment. Here, I call IFS_readdir, which returns a pointer to a directory entry. If the value is null, then there are no more entries and I exit the loop. Otherwise, my directory structure (dsDirEnt, defined above) now points to the next entry in the folder.

      // Skip subdirectories

      wFile = %trim(%str(%addr(dsDirEnt.name)));

      IFS_stat( iDir + wFile:%addr(dsStat));

      if %bitand(dsStat.mode:C_MODE_DIRMASK) = C_MODE_DIRVAL;

        iter;

      endif;

This is why I like the top-loaded exit condition. First, I get the status data structure for the filename found in the directory entry. Then I use the %bitand function to see whether the file is a directory or not. If you're unfamiliar with the concept, do a little reading on bit masking. Basically, though, what this code does is isolate a set of the bits in the mode field and test them to see if the file is a directory. If it is, I use the ITER function to jump back to the top of the loop and get the next file.

      // Check for match and process

      if %scan( %trim(iFilter): wFile) > 0;

        ProcessFile( iDir: wFile);

      endif;

Now that I have a file, I see if it passes. The code above is a very arbitrary test: I just see if the value passed as the filter is found somewhere in the name of the file. If so, I process it. The tests can be as complex as needed; this is just an example.

   enddo;

    IFS_closedir(hDir);

   return;

I hope the rest of this is pretty self-explanatory. When I fall out of the loop (due to the LEAVE opcode up at the top), I close the directory handle and exit the program. That's really all there is to it.

Of course, there's still a whole bunch left that has to do with actually processing the file, and I'll get to that shortly.

A Warning on Proliferation

I have to mention one potential problem. The IBM i can get bogged down when there are too many stream files, especially in a single folder. I last ran into the issue a few years ago on a V6R1 system; the magic number was 16383 files in one folder. Personally, I don't recommend having that many files in a folder anyway. You can also have issues with user profiles, because every stream file is an object that must be owned and managed. If you start hitting performance issues, you may need to address your architecture. I usually do it by pulling files off of the IFS and into a CLOB file. You can refer to Part 1 and Part 2 of my article on BLOBs, CLOBs, and XML for information on how to move from the IFS to DB2 to control your stream files.

The IFS is a great addition to the IBM i; and the better you can process those files, the more impact the platform can make on your business systems.

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: