04
Wed, Dec
6 New Articles

Programming in ILE RPG - Defining Data Structures, Part II

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

Overlapping Subfields. Miss the previous excerpt on Data Structure? Read it here: Part I.

The locations of subfields within a data structure can overlap, and the same position within a data structure can fall within the location of several subfields. A data structure declaration can use two keywords, Pos (Position) and Overlay, for these purposes.

To illustrate the concept of overlapping, or defining subfields within subfields, the following example assumes your program contains variables Firstname (15 bytes) and Phone (10 digits). The program needs to work with just the initial of the first name and with the area code, exchange, and local portions of the phone number as separate data items. Data structures let you easily access the data that way.

The Overlay keyword indicates that Initial is to be a part of Firstname rather than a subfield adjacent to it. In the preceding code, subfield Initial contains the first letter of the value of Firstname. If you code a position with the Overlay keyword, the position signals the location in the subfield where the overlay should begin. Phone is divided into three pieces accessible through subfields Areacode, Exchange, and Localnbr. Because Areacode, Exchange, and Localnbr share common space with Phone in the unnamed data structure, if your program alters the value of any one subfield, the overlapping subfields reflect that change. You can also use the Pos keyword to indicate the starting position of each subfield relative to the data structure itself:

Programming in ILE RPG - Defining Data Structures, Part II - Figure 2

The Overlay keyword also supports the special value *Next. Specifying *Next instead of a position begins a subfield at the next available position of the overlaid subfield field. The following code reworks the Phone example by using *Next:

Programming in ILE RPG - Defining Data Structures, Part II - Figure 3

When you use the Overlay keyword, the data name within the parentheses must be a subfield already defined within the current data structure. The subfield being defined must be completely contained within the subfield.

You can use Overlay to redefine subfields in a data structure with different names or data types, or both. In the following example, subfield Basedate is a native date, but Basechar is a character subfield. Both subfields occupy the same location in the data structure. If your program changes the value of one subfield, it also changes the value of the other one.

Programming in ILE RPG - Defining Data Structures, Part II - Figure 4

Externally Described Data Structures

The data structures discussed up to now are program-described data structures. The entire data structure description (i.e., all the subfields) is explicitly described in the program. RPG also supports externally described data structures similar to the way it handles externally described data files. The subfields in an externally described data structure follow the layout of an existing file—the subfields in the data structure have the same names, locations, and data attributes as the record format. Externally described data structures might be useful when you want to use a data structure in several different programs, when your company’s standards dictate the use of specific data structures, or when you need a data structure to mimic the layout of an existing file’s record format.

Recall from previous chapters the record layout for the example Customers file (see Figure 4.1). Here’s an example of an externally described data structure based on that file’s layout:

Programming in ILE RPG - Defining Data Structures, Part II - Figure 5

Often, the name of an externally described data structure is the same as the file upon which the data structure is based. The Ext (External) keyword tells the compiler that this data structure is externally described. Ext must be the first keyword following the data structure name. Because the compiler automatically acquires the subfields from the Employees file, it is not necessary to code any subfields for the data structure—all the fields in the file become subfields in the data structure. Notice that, because you need not explicitly list any subfields, the End-ds instruction can appear on the same line as the Dcl-ds instruction.

Programming in ILE RPG - Defining Data Structures, Part II - Figure 6

Figure 4.1: Customers file record layout

If the name of the data structure does not match the name of the file upon which it is based, the data structure definition requires the Extname (External name) keyword to explicitly name the file:

Programming in ILE RPG - Defining Data Structures, Part II - Figure 7

or (omitting Ext):

Programming in ILE RPG - Defining Data Structures, Part II - Figure 8

You can code additional program-described subfields following the data structure header, and you can use Overlay to describe subfields that overlap existing subfields in the data structure:

Programming in ILE RPG - Defining Data Structures, Part II - Figure 9

If you want the name of a subfield to be different from the name of the field in the external file, you can use the Extfld (External Field) keyword to associate the subfield name with the file’s field name:

Programming in ILE RPG - Defining Data Structures, Part II - Figure 10

To initialize an externally described data structure, use the Inz keyword. To initialize the subfields to their default values as indicated in the external file’s definition, specify Inz(*Extdft):

Programming in ILE RPG - Defining Data Structures, Part II - Figure 11

You can override the external default for one or more subfields by listing them with their own Inz keyword:

Programming in ILE RPG - Defining Data Structures, Part II - Figure 12

Qualified Data Structures

Normally, an RPG program can refer to the individual subfields in a data structure by their simple names. Those names must be unique; that is, you cannot typically have multiple data structures with identically named subfields. A qualified data structure lets you ignore that rule. When you include the Qualified keyword on a data structure header line, you create a qualified data structure.

The Qualified keyword indicates to the compiler that you will refer to the subfields in the data structure by their qualified name (i.e., the data structure name followed by a period and the subfield name). If the Qualified keyword is not used, you will refer to the subfields by their simple name, and that name must be unique. Qualified data structures can be program described or externally described, and they must be named data structures. The following examples illustrate how to define qualified data structures:

Programming in ILE RPG - Defining Data Structures, Part II - Figure 13

In these examples, the RPG program must refer to subfields Customer.Name or Vendor. Name to refer to the Name subfield in either the Customer data structure or the Vendor data structure. Notice that the subfields can have identical names even if they don’t have identical data attributes. In the previous examples, Customer.Id is a five-digit zoned numeric field and Vendor.Id is a seven-character field. The data structures need not have identical subfields, and the subfields need not be in the same order in each data structure. You can use qualified subfield names almost anywhere in the program that allows a variable name.

Programming in ILE RPG - Defining Data Structures, Part II - Figure 14

What to learn more now?  Buy Programming in ILE RPG, Fifth Edition at the MC Press Bookstore today!

James Buck
Jim Buck's career in IT has spanned more than 35 years, primarily in the college education, manufacturing, and healthcare industries. Past president (13 years) of the Wisconsin Midrange Computer Professional Association, he has served on several teams developing IBM and COMMON certification tests. Jim has co-authored several IBM i textbooks with Bryan Meyers that are used by many companies and in colleges worldwide. Other accomplishments include: recipient of the 2007 IBM System i Innovation - Education Excellence Award, 2014 COMMON President's Award, and 2013/2016/2017 IBM Champion - Power Systems.

Jim is the president and founder of imPower Technologies, where he provides professional IBM i training and consulting services. He is active in the IBM i community, working to help companies train their employees in the latest IBM technologies and develop the next generation of IBM i professionals.

MC Press books written by Jim Buck available now on the MC Press Bookstore.

Control Language Programming for IBM i Control Language Programming for IBM i
Master the A-Z of CL, including features such as structured programming, file processing enhancements, and ILE.
List Price $79.95

Now On Sale

Mastering IBM i Mastering IBM i
Get the must-have guide to the tools and concepts needed to work with today's IBM i.
List Price $85.95

Now On Sale

Programming in ILE RPG Programming in ILE RPG
Get the definitive guide to the RPG programming language.
List Price $95.95

Now On Sale

Programming in RPG IV Programming in RPG IV
Understand the essentials of business programming using RPG IV.
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: