06
Wed, Nov
7 New Articles

Programming in ILE RPG - Defining Data Structures, Part I

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

In addition to named constants and standalone variables, you can define data structures, which are simply a means of organizing multiple variables within a single section of contiguous portions of memory. Miss the previous excerpts regarding using declarations?  Read each here: Part 1 & Part 2 & Part 3

Editor's Note: This article is excerpted from chapter 4 of Programming in ILE RPG, Fifth Edition.

Data structures can provide flexibility in your handling of data by letting you group variables into a logical structure, subdivide variables into subfields, and redefine variables with different data types or names. An RPG program can process the entire data structure as a unit or its subfields individually.

RPG uses three instructions to declare data structures:

  • Dcl-ds (Declare data structure)
  • Dcl-subf (Declare subfield)
  • End-ds (End data structure)

These instructions take the following form:

Programming in ILE RPG: Defining Data Structures, Part I - Figure 1

The following code illustrates a simple data structure definition:

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

The Dcl-ds (Declare data structure) instruction signals the beginning of a data structure. Following Dcl-ds, you can enter a name for the data structure, or you can use *N if the data structure is to be unnamed. The name is optional unless you plan to refer to the data structure as a whole elsewhere in your program. RPG treats named data structures as character strings, encompassing all their subfields. Data structure names follow the same rules as variable names.

Although you can enter the length of the entire data structure with the Dcl-ds instruction by using the Len keyword, Len is generally optional. If you omit it, the system derives the length of the structure as a whole from the lengths of its subfields. The maximum total length for a data structure is 16,773,104 bytes. You can also use the following Dcl-s instruction in the preceding example:

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

Defining Data Structure Subfields

The lines to describe subfields constituting the data structure follow the line with the Dcl- ds instruction. You define each subfield entry by giving it a name. It’s normal practice to indent the subfield definition to make the hierarchical layout of the data structure easily visible. The order of the subfields should represent their actual relative positions in the data structure. Following the subfield name, specify a data type keyword. Any data type allowed for standalone variables is also allowed for data structure subfields.

Programming in ILE RPG: Defining Data Structures, Part I - Note

In the unlikely event that the subfield’s name is the same as an RPG operation code (e.g., Dow, Read, Write, Return), you must code a Dcl-subf (Declare subfield) instruction preceding the subfield name. Otherwise, you need not use Dcl-subf for a subfield declaration.

The data structure definition must accurately represent the locations of its subfields. Normally, each subfield immediately follows the preceding subfield in the data structure. Occasionally, your program will encounter a data structure that does not use all the locations in the data structure and will skip those unneeded locations. Usually, this occurs only with data structures that are predefined by an application or by IBM. In that case, use the Pos (Position) keyword to specify the beginning location for a subfield:

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

The position must be between 1 and the length of the data structure. This data structure is 99 bytes, but only positions, 3, 12, 50, 90, 91, and 92 are used—as named indicators in specific positions.

Initializing Data Structures

Once you have defined the data structure subfields, you can initialize them by using the Inz keyword. The Inz keyword initializes entire data structures or data structure subfields. If you code Inz (with no value following it) on the Dcl-ds instruction, the program initializes all the subfields in the data structure with initial values appropriate to the subfields’ data types. If you do not code Inz on the Dcl-ds instruction, the entire data structure, including all its subfields, is initialized with blanks—unless you code individual Inz keywords for specific subfields.

Data structures are considered character variables regardless of the data types of their subfields. As a result, they contain blanks at the start of your program unless you explicitly initialize their subfields. You initialize a data structure globally when you include the Inz keyword in the data structure header line. This use of Inz automatically initializes all subfields in the entire data structure.

Specifying Inz on the Dcl-ds instruction initializes all subfields to the default value appropriate for their data types (e.g., all numeric subfields are set to zero, all character fields to spaces):

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

Without the Inz keyword, all the subfields are initially blank. The program ends abnormally if you try to perform arithmetic operations on Areacode, Exchange, or Localnbr without first initializing them.

Alternatively, you can initialize specific subfields of a data structure by including the Inz keyword as part of their definitions. To initialize a subfield to a value other than the default, you can include the desired value within parentheses following Inz. Although you can express this value as a literal or a named constant, it must fit the subfield’s data type. Moreover, it cannot be longer than the subfield nor have more decimal positions than the subfield (if the type is numeric).

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

In this example, Areacode and Localnbr are initially zero, Exchange is 555, and Name is blank. You can also combine data structure initialization with individual subfield initialization to obtain the same result:

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

Next time: More Defining Data Structures.  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: