12
Sat, Oct
6 New Articles

Emulate Object-Oriented Programming in ILE RPG, Part II

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

Now, we'll take the concept to the next level by using prototyped subprocedures.

 

In a previous article, we explored how nested data structures can help to emulate the way object-oriented programming languages access information. This time, I'd like to take the concept a step further by illustrating how to extend the object-oriented concept within ILE RPG by creating prototyped subprocedures that return nested data structures to the calling program. 

First, the Data

This concept is best illustrated using a data set that's probably something similar to what you work with every day, which is basic customer order data. The table below contains a list of tables that will be used in our example:

 

Example Database Tables

Table Name

Description

ORDHDR

Order header data

ORDDTL

Order line details

ORDHNOTE

Header-level order notes

ORDDNOTE

Detail-level order notes

 

This data includes header-level information such as an order number, an order date, and customer bill-to and ship-to information. This would also include detail information such as item numbers, quantity ordered, and unit price information. In addition to that, you may also have order notes at both the header and detail levels. Figure 1 contains a graphical representation of how the data in each of these tables is related. 

 

100108FaustFigure1.JPG

Figure 1: This example illustrates how our data is organized.

 

To get the full view of how the data works, see the table below for a breakdown of the file layouts for each of our sample tables.

 

Sample Table Fields

Table

Field Name

Description

ORDHDR

OHORDN

Order number

ORDHDR

OHORDT

Order date

ORDHDR

OHCUSN

Bill-to customer number

ORDHDR

OHSHTO

Ship-to customer number

ORDHDR

OHSHDT

Ship date

ORDHDR

OHSTAT

Order header status

ORDDTL

ODORDN

Order number

ORDDTL

ORLINE

Order line number

ORDDTL

ORITEM

Item number

ORDDTL

OROQTY

Order quantity

ORDDTL

ORSQTY

Shipped quantity

ORDDTL

ORUPRC

Unit price

ORDDTL

ORLSTS

Order line status

ORHNOTE

NHORDN

Order number

ORHNOTE

NHSEQN

Note sequence

ORHNOTE

NHTEXT

Note text

ORDNOTE

NDORDN

Order number

ORDNOTE

NDLINE

Order line number

ORDNOTE

NDSEQN

Note sequence

ORDNOTE

NDTEXT

Note text

 

Note that each of the tables can be related to one another by the order number, and in the case of the detail records, the order number and line number.

And Then the Code

Using current programming concepts, your programs probably access each of these files using CHAIN and/or SETLL/READE operations, like the example shown here:

 

...

/free

    Chain OrdKy OrdHdr;

  

    if %found;

      Setll OrdKy OrdDtl;

      Reade OrdKy OrdDtl;

      Dow not %eof(OrdDtl);

        // detail line processing

         Setll ordlnky dtNotes;

         Reade Ordlnky dtNotes;

          Dow not %eof(dtNotes);

              // detail notes processing

              Reade Ordlnky dtNotes;

            Enddo;

        Reade OrdKy OrdDtl;

      Enddo;

      Setll ordlnky dtNotes;

      Reade Ordlnky dtNotes;

        Dow not %eof(dtNotes);

         // header notes processing

        Reade Ordlnky dtNotes;

       Enddo;

    Endif;

/end-free

...     

 

This example uses some pretty standard RPG concepts to read the data from the order tables and perform additional processing. 

 

Wouldn't it be nice, though, to be able to deal with all of the components of your order data using a single object? This can really make your programming tasks much easier because any program that needs to access this same information can utilize a single object that will handle all of the data access for you. 

 

Implementing the "object-oriented" subprocedures that we're discussing here is really as simple as encapsulating the data access code, like that shown above, into a single service program. These subprocedures can then be called from any programs that need access to that data. For purposes of our example, let's imagine that we would create two subprocedures. 

 

  • GetOrder(orderNumber) retrieves the order data for the supplied order.
  • PutOrder(order_DS) creates or updates an order using the supplied data.

 

The GetOrder subprocedure returns a nested data structure that contains header- and detail-level data from all of our order tables using the standard RPG techniques described earlier, but it returns this data to the caller in a single step through the nested data structures shown below.

 

 

dOrdData          DS                  Qualified                        

d  Number                        8  0                                   

d  CreateDate                     d                                    

d  ShipDate                       d                                    

d  Value                        15  5                                  

d  LineCount                     5  0                                  

d  Status                        1a                                    

d  BillTo                             likeds(CustomerDS)               

d  ShipTo                             likeds(CustomerDS)               

d  Notes                              likeds(NotesDS) dim(10)          

d  Line                               likeds(OrdDtl) dim(99)           

                                                                       

dOrdDtl           DS                  Qualified                        

d ItemNumber                    15a                                    

d ItemDesc                      50a                                    

d OrderQuantity                 15  5    

d ShipQuantity                  15  5                                  

d UnitPrice                     15  5                                  

d LineValue                     15  5                                  

d LineStatus                     1a                                     

d Notes                               likeds(NotesDS) dim(10)          

                                                                       

dCustomerDS       DS                  Qualified                        

d Number                         8  0                                  

d Name                          35a                                    

d Address                       35a                         

d City                          20a                          

d State                          2a                         

d ZipCode                       10a                         

d PhoneNumber                   10a                         

                                                             

dNotesDS          DS                  Qualified             

d Text                          50           
                                                                                    

 

Notice that we've actually defined four data structures here. Three of these exist simply to be nested within the OrdData structure, which will be returned as the result of the GetOrder subprocedure. The OrdDtl data structure defines the fields that relate to the order lines. The LineValue field here is a calculated field based on the order quantity multiplied by the unit price. You'll also notice that this structure also contains a "likeds" for the NotesDS data structure, which contains note details. 

 

By including the dim(10) keyword, we identify that each order line can have up to 10 note lines. This same data structure is included in the OrdData data structure to store the order header note data.

 

We include two copies of the CustomerDS data structure. These will be used to return bill-to and ship-to customer data. Note that the name and address fields are not part of the data we defined earlier. These fields, along with the ItemDesc field on the order detail data structure, are retrieved from master files.  This means that when all is said and done, our subprocedure is actually returning data from at least six database tables in a single statement.

 

We also include several other calculated fields, including the line count and order value fields.

 

Note that each of our statements includes the "Qualified" keyword to indicate that all access to the fields contained within that data structure needs to be specified in a fully qualified manner.   

 

To associate our newly defined OrdData structure with the GetOrder subprocedure, we use the following prototype:

 

dGetOrder         PR                  likeds(OrdData)

d OrderNumber                8  0       

 

The likeds keyword identifies that the value returned by this subprocedure should mimic the OrdData data structure.   

 

The result is that, within a program that utilizes the GetOrder subprocedure, we can load all of our order data in a single statement, as shown below:

 

 /free

    Order = GetOrder(OrdNum);

 /end-free

 

In this example, the Order variable would first be defined as a data structure with the likeds(OrdData) keyword on the data structure definition. Once that's done, after calling the GetOrder subprocedure, we can access the order data using the variables shown below:

 

order.number          

order.orderdate       

order.value           

order.shipdate        

order.billto.number   

order.billto.name     

order.billto.address  

order.billto.city     

order.billto.state    

order.billto.zipcode  

order.shipto.number   

order.shipto.name     

order.shipto.address  

order.shipto.city     

order.shipto.state    

order.shipto.zipcode  

order.linecount

order.notes(x).text

order.lines(x).itemnumber

order.lines(x).OrderQuantity

order.lines(x).ShipQuantity

order.lines(x).UnitPrice

order.lines(x).ItemDesc

order.lines(x).LineValue

order.lines(x).notes(y).text

 

Each order line and/or note line can be accessed by providing a value within the parentheses that reflects the line number and/or sequence number related to the specific detail line or note sequence to be retrieved.

 

Similarly, the PutOrder subprocedure is used to create the data in all of these tables. The difference here is that we provide the OrdData data structure as the input parameter to the subprocedure and allow the subprocedure to disassemble the order data and create/update records in each of the database tables. Below is an example of how this subprocedure would be called to create a new order: 

 

dNewOrder         DS                  likeds(OrdData)

/free

    Clear NewOrder;

    NewOrder.BillTo.Number = 12345;

    NewOrder.ShipTo.Number = 12346;

    NewOrder.LineCount = 1;

    NewOrder.Line(1).ItemNumber = 'ABC123';

    NewOrder.Line(1).OrderQuantity = 24;

    NewOrder.Line(1).UnitPrice = 9.95;

    NewOrder.Line(1).Notes(1).Text = 'Ship this item right away!';

  

    PutOrder(NewOrder);

 /end-free

 

In this example, we define our data structure NewOrder to be a copy of the OrdData data structure. We start by clearing this new data structure, and then we populate the required data. Remember that we assume that the PutOrder subprocedure will contain all of the logic to determine whether this is an existing order or a new order and to react accordingly in each circumstance.

 

Note that this routine would also need to have data validation logic built in to verify that the data provided was valid and followed business rules.

 

Below is another example that shows how the GetOrder and PutOrder subprocedures might be combined to update an existing order by adding a line:

 

D Order           DS                  likeds(OrdData)

/free

    Order = GetData(OrdNum);

    Order.Line(LineCount + 1).ItemNumber = NewItem;

    Order.Line(LineCount + 1).OrderQuantity = NewQty;

    Order.Line(LineCount + 1).UnitPrice = ItemPrice;

    PutOrder(Order);

 /end-free

Again, this example assumes that the PutOrder subprocedure will include logic to realize that this is an existing order (probably based on the fact that our data structure includes an order number). It then updates that order rather than create a new one. 

Finally...the Fine Print

The biggest caveat when implementing this concept is the 65535 character limitation for a data structure. Since ultimately an RPG data structure is handled like a giant character field, you can only define a data structure whose largest possible size (including all possible array elements) is no more than 65535 characters. In the case of our example OrdData data structure, we are just under that limitation at 62763 characters. That issue aside, utilizing this concept can completely change the way you write applications by changing from a "data file-centric" approach to an object-oriented approach to how your applications access data.

Mike Faust

Mike Faust is a senior consultant/analyst for Retail Technologies Corporation in Orlando, Florida. Mike is also the author of the books Active Server Pages Primer, The iSeries and AS/400 Programmer's Guide to Cool Things, JavaScript for the Business Developer, and SQL Built-in Functions and Stored Procedures. You can contact Mike at This email address is being protected from spambots. You need JavaScript enabled to view it..


MC Press books written by Mike Faust available now on the MC Press Bookstore.

Active Server Pages Primer Active Server Pages Primer
Learn how to make the most of ASP while creating a fully functional ASP "shopping cart" application.
List Price $79.00

Now On Sale

JavaScript for the Business Developer JavaScript for the Business Developer
Learn how JavaScript can help you create dynamic business applications with Web browser interfaces.
List Price $44.95

Now On Sale

SQL Built-in Functions and Stored Procedures SQL Built-in Functions and Stored Procedures
Unleash the full power of SQL with these highly useful tools.
List Price $49.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: