21
Thu, Nov
1 New Articles

File I/O Through Data Structures

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

How do you define frustration? I'm sure you could think of several definitions, but maybe one definition is, "having to run System/36 RPG on an AS/400." No external file definitions. No WRITE and UPDAT op codes. Endless lines of input and output specs. And, converting all those data files to native isn't something that can be accomplished overnight.

In this article, we'll look at another way to do I/O--using data structures. Not only will you learn some ways to spice up your S/36-style RPG code, you'll discover that this technique has some usefulness in native mode.

External Described and Program-Described Files

There are two ways to define file record layouts to the AS/400. The traditional method--defining the fields within program source code--still works as it did on earlier machines. In AS/400 terminology, such files are called program-described files.

You can also use DDS specifications to describe file layouts. Files built with DDS are called externally described files. HLL programs do not require that the fields be defined within program source code, if the externally described file is referenced with an 'E' in column 19 of the F-spec.

IBM has added a new wrinkle to program-described files that combines the best of both worlds. The result field of most I/O operations (CHAIN, WRITE, UPDAT, and various forms of READ) may contain a data structure name if factor 2 contains the name of a program-described file. Input operations place data from the file into the data structure. Output operations write data to the file from the data structure.

Look at the fragment of an RPG program in 1a. The program writes to a program-described file called SEQFL (sequential file), which will contain data of various formats. Factor 2 of the WRITE statements contains the name of the program-described file. The result fields are all data structures. The traditional way of writing this program would be to code the three record formats in output specs, and use EXCPT or the RPG cycle to output them.

Look at the fragment of an RPG program in Figure 1a. The program writes to a program-described file called SEQFL (sequential file), which will contain data of various formats. Factor 2 of the WRITE statements contains the name of the program-described file. The result fields are all data structures. The traditional way of writing this program would be to code the three record formats in output specs, and use EXCPT or the RPG cycle to output them.

Suppose SEQFL requires a header record at the top of the file and a trailer record at the end. We could add the output specs in 1b to the code in 1a. In other words, you can mix and match the two methods--via data structures and via output specs--to write to a program-described file. Putting the header and trailer in data structures is OK, but not necessary.

Suppose SEQFL requires a header record at the top of the file and a trailer record at the end. We could add the output specs in Figure 1b to the code in Figure 1a. In other words, you can mix and match the two methods--via data structures and via output specs--to write to a program-described file. Putting the header and trailer in data structures is OK, but not necessary.

In the first example, data structures eliminated output specs only. Let's look at an example that shows greater savings.

2a contains fragments of an interactive RPG program that does maintenance to a vendor master file. Data structure VNDREC is used to define the record layout of file VNDMAST, which has no input or output specifications in this program. The CHAIN operation puts the data into VNDREC. After the data has been changed and verified, the WRITE and UPDAT statements store it to disk. In this example, the number of input specs is the same, whether we use data structures or the traditional approach. But 12 lines of output specs have been eliminated. One nice thing about this is that program maintenance is reduced in the event that the record layout of VNDMAST changes. Rather than changing both input and output specs, you only change the data structure.

Figure 2a contains fragments of an interactive RPG program that does maintenance to a vendor master file. Data structure VNDREC is used to define the record layout of file VNDMAST, which has no input or output specifications in this program. The CHAIN operation puts the data into VNDREC. After the data has been changed and verified, the WRITE and UPDAT statements store it to disk. In this example, the number of input specs is the same, whether we use data structures or the traditional approach. But 12 lines of output specs have been eliminated. One nice thing about this is that program maintenance is reduced in the event that the record layout of VNDMAST changes. Rather than changing both input and output specs, you only change the data structure.

This example also shows that the DELET op code can be used with program- described files. No data structure name is needed in the result field, since data is not being written, but erased.

Externally Described Data Structures

You can make your S/36-type RPG programs more like native programs by describing file I/O data structures externally. 2b shows the DDS needed to define file VNDMASTDES (vendor master description), a file with the same record layout as VNDMAST. VNDMASTDES will not contain data. In fact, it doesn't have a member. When it is created you should use MBR(*NONE).

You can make your S/36-type RPG programs more like native programs by describing file I/O data structures externally. Figure 2b shows the DDS needed to define file VNDMASTDES (vendor master description), a file with the same record layout as VNDMAST. VNDMASTDES will not contain data. In fact, it doesn't have a member. When it is created you should use MBR(*NONE).

To instruct the RPG compiler to use the record layout of VNDMASTDES to describe VNDREC, you need to change the program as shown in 2c. The "E" in column 17 means that the data structure is externally described by the first record format of the file named in columns 21 through 30. This isn't RPG III coding, but it is more like RPG III than RPG II.

To instruct the RPG compiler to use the record layout of VNDMASTDES to describe VNDREC, you need to change the program as shown in Figure 2c. The "E" in column 17 means that the data structure is externally described by the first record format of the file named in columns 21 through 30. This isn't RPG III coding, but it is more like RPG III than RPG II.

Overcoming Limitations Of Externally Described Files

Externally described files are wonderful, but they have a couple of limitations. One is that you can't rename a field in output specs. The other is that you can't doubly define fields in input. Using data structures is one way to work around them.

The DDS for file WORKFL (work file) is given in 3a. 3b shows how that file would normally be used as an output-only file. But suppose we want to rename AMOUNT to AMT. One way to do that is shown in 3c. Even though WORKFL is defined by DDS, we can treat it as a program-described file and use WORKFL to describe the data structure used for I/O. Although WORKFL is an output-only file, it is defined in input specs, allowing fields to be renamed.

The DDS for file WORKFL (work file) is given in Figure 3a. Figure 3b shows how that file would normally be used as an output-only file. But suppose we want to rename AMOUNT to AMT. One way to do that is shown in Figure 3c. Even though WORKFL is defined by DDS, we can treat it as a program-described file and use WORKFL to describe the data structure used for I/O. Although WORKFL is an output-only file, it is defined in input specs, allowing fields to be renamed.

This is one method of renaming fields in output-only files. For another method, see the sidebar.

You may also add new fields to external definitions. In 3d, field TERR (territory) is defined as the first two characters in the data structure. As a rule I don't recommend this, since it could present a problem if the record layout of WORKFL were ever changed. It does, however, give a way to doubly define fields, as is often done in RPG II input specs.

You may also add new fields to external definitions. In Figure 3d, field TERR (territory) is defined as the first two characters in the data structure. As a rule I don't recommend this, since it could present a problem if the record layout of WORKFL were ever changed. It does, however, give a way to doubly define fields, as is often done in RPG II input specs.

A Few Requirements

We should mention a few other points before ending this treatment of file I/O through data structures. First, the record length coded in the F spec must equal the data structure length. They do not have to equal the actual record length, but they should not be shorter.

Second, these examples all deal with disk files. This technique will also work with files of other device types.

Third, don't forget that a field can appear in only one data structure. This is easy to forget, especially if you're used to coding the same field name in multiple record formats in the input and output specs.

Your Turn

I believe this technique will be of most benefit to those converting to the AS/400 from the S/34 or S/36. I use it in native mode from time to time to build multi-format files which I transmit to our corporate office or feed into a PC-based EDI package.

I've illustrated a few ways this technique can be put to work, but I suspect there are other ways I haven't thought of. Let me challenge you to give this technique a try. Find some effective ways to do I/O through data structures. Then write a follow-up article to this one to share what you've learned with the rest of us.

Sidebar:

Renaming a Field in an Externally Described Output File

RPG III/400 provides a way to rename fields of input and update files, but not of output files. Of course, you could build a logical file which renames fields and writes to that logical, but that's not necessary. Here's a simple way to rename a field in an externally defined, output-only file.

Assume file WORKFL has fields called CUSNBR, CUSNAM, AMOUNT and DUEDAT, and that we wish to rename AMOUNT to AMT. Even though WORKFL is to be treated as an output file, code it as input ("I" in column 15) with file addition allowed ("A" in column 66). Because WORKFL is an input file, you may rename AMOUNT in the input specs.

To make the program compile properly, code a dummy read. That's all there is to it.

FWRKFILE IF E DISK A FWRKREC I AMOUNTIN AMT ... C Z-ADDXAMT AMT C WRITEWRKREC ... CLRNLR READ WRKREC LR

Ted Holt is a programmer/analyst at Dana Corporation, a manufacturer of hydraulic pumps and motors in Corinth, MS. Ted can be reached via the Midrange Computing BBS or at (601) 287-1481.


File I/O Through Data Structures

Figure 1A Writing multiple record formats

 Figure 1a: Writing Multiple Record Formats FINVHDR IF E K DISK FINVDTL IF E K DISK FSEQFL O F 80 DISK ISEQFT1 DS 80 I I '01' 1 2 RECID1 I 3 70CUSNR I 8 120INVNR ISEQFT2 DS 80 I I '02' 1 2 RECID2 I 3 11 PARTNR I 12 160QTY I 17 232UPRICE ISEQFT3 DS 80 I I '03' 1 2 RECID3 I 3 142INVTTL ... C WRITESEQFL SEQFT1 ... C WRITESEQFL SEQFT2 C WRITESEQFL SEQFT3 ... 
File I/O Through Data Structures

Figure 1B Additional output defined in Output Specs

 Figure 1b: Additional Output Defined in Output Specs OSEQFL D 1P O 'BEGIN INVOICE' O T LR O 'END INVOICE' 
File I/O Through Data Structures

Figure 2A File maintenance using data structure I/O

 Figure 2a: File Maintenance Using Data Structure I/O F* VENDOR FILE MAINTENANCE THROUGH DATA STRUCTURE F* FVNDMAST UF F 44 3PI 1 DISK A FVND100D etc. WORKSTN IVNDREC DS I P 1 30VNDNBR I 4 18 VNDNAM I 19 32 VNDCTY I 33 34 VNDSTT I 35 44 VNDZIP ... C VNDNBR CHAINVNDMAST VNDREC 91 ... C WRITEVNDMAST VNDREC ... C UPDATVNDMAST VNDREC ... C DELETVNDMAST 
File I/O Through Data Structures

Figure 2B DDS for file VNDMASTDES

 Figure 2b: DDS For File VNDMASTDES A* VENDOR MASTER FILE -- FIELD DESCRIPTION A R VNDMASTDES TEXT('VENDOR MASTER') A VNDNBR 5 0 TEXT('VENDOR NUMBER') A VNDNAM 15 TEXT('VENDOR NAME') A VNDCTY 14 TEXT('CITY') A VNDSTT 2 TEXT('STATE') A VNDZIP 10 TEXT('ZIP CODE') 
File I/O Through Data Structures

Figure 2C Externally defining VNDMAST

 Figure 2c: Externally Defining VNDMAST F* VENDOR FILE MAINTENANCE THROUGH DATA STRUCTURE F* FVNDMAST UF F 44 3PI 1 DISK A FVND100D etc WORKSTN IVNDREC E DSVNDMASTDES ... C VNDNBR CHAINVNDMAST VNDREC 91 ... C WRITEVNDMAST VNDREC ... C UPDATVNDMAST VNDREC ... C DELETVNDMAST ... 
File I/O Through Data Structures

Figure 3A DDS for file WORKFL

 Figure 3a: DDS For File WORKFL A R WORKFLR TEXT('WORK FILE') A CUSNBR 5S 0 TEXT('CUSTOMER NBR') A CUSNAM 6 TEXT('CUSTOMER NAME') A AMOUNT 9 2 TEXT('DOLLAR AMOUNT') A DUEDAT 6 0 TEXT('DUE DATE -- YYMMDD') A K CUSNAM 
File I/O Through Data Structures

Figure 3B Fragment of RPG program

 Figure 3b: Fragment of RPG Program FWORKFL O E DISK ... C Z-ADDXTAMT AMOUNT C WRITEWORKFLR ... 
File I/O Through Data Structures

Figure 3C Renaming AMOUNT field

 Figure 3c: Renaming Amount Field FWORKFL O F 128 DISK IWORKDS E DSWORKFL 128 I AMOUNT AMT ... C Z-ADDXTAMT AMT C WRITEWORKFL WORKDS ... 
File I/O Through Data Structures

Figure 3D Adding a field to an external file definition

 Figure 3d: Adding a Field to an External File Definition IWORKDS E DSWORKFL 128 I 1 2 TERR 
TED HOLT

Ted Holt is IT manager of Manufacturing Systems Development for Day-Brite Capri Omega, a manufacturer of lighting fixtures in Tupelo, Mississippi. He has worked in the information processing industry since 1981 and is the author or co-author of seven books. 


MC Press books written by Ted Holt available now on the MC Press Bookstore.

Complete CL: Fifth Edition Complete CL: Fifth Edition
Become a CL guru and fully leverage the abilities of your system.
List Price $79.95

Now On Sale

Complete CL: Sixth Edition Complete CL: Sixth Edition
Now fully updated! Get the master guide to Control Language programming.
List Price $79.95

Now On Sale

IBM i5/iSeries Primer IBM i5/iSeries Primer
Check out the ultimate resource and “must-have” guide for every professional working with the i5/iSeries.
List Price $99.95

Now On Sale

Qshell for iSeries Qshell for iSeries
Check out this Unix-style shell and utilities command interface for OS/400.
List Price $79.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: