02
Sat, Nov
2 New Articles

Tips and Techniques: Qualifying Database Field Names

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

Qualifying a data structure can be a fun and effective coding practice, but did you know that with OS/400 V5 you can qualify database field names just like data structures? In V5, IBM added the capability to the File specification to include a data structure name for the PREFIX keyword. This means that the file will read into the data structure automatically. Let's see how this works.

First, a traditional PREFIX keyword is used on the File specification as follows:

FCUSTMAST  UF   E           K DISK    PREFIX(CM_)

Of course, this causes all the fields in the CUSTMAST file to be renamed to their original field names and adds the prefix CM_ to those field names. For example, the field named CSTNBR becomes CM_CSTNBR.

In V5, IBM enhanced the PREFIX keyword so that you could specify a data structure name. This coincided with the introduction of QUALIFIED data structures, which is a good thing, because only QUALIFIED data structures may be used on the PREFIX keyword.

This enhancement does not necessarily require you to rename the fields of the database file; instead, it allows you to qualify the field names to a data structure name, with or without renaming the fields.

The new PREFIX keyword syntax is as follows:

FCUSTMAST  UF   E           K DISK    PREFIX('CM.')

Note the subtle difference in the parameter specified on the PREFIX keyword. It is now 'CM.' instead of the simple CM_ prefix.

When a period is used at the end of the prefix string, the compiler assumes you are going to declare a data structure with the same name as the prefix string, so it generates code to cause the database fields to be qualified to that data structure.

Since the period is not a valid character for names, the PREFIX keyword is enhanced so that you may enclose the prefix in quotes. Quoting is required for data structure qualifications and is optional for the traditional prefix operations. So as of V5, the following are equivalent statements:

FCUSTMAST  UF   E           K DISK    PREFIX(CM_)

FCUSTMAST  UF   E           K DISK    PREFIX('CM_')

To allow the file's field names to be qualified to a data structure requires more than just the PREFIX keyword, however. You must also specify a data structure specification. That data structure should be externally described, based on the same database file name as declared on the File specification. For example:

0001 FCUSTMAST  UF   E           K DISK    PREFIX('CM.')
0002 D CM            E DS                  ExtName(CUSTMAST)
0003 D                                     QUALIFIED

Line 1 in the previous example declares the file named CUSTMAST as an externally described file and indicates via the PREFIX keyword that the fields in that database file are to be qualified to the 'CM.' prefix. This indicates three things: A data structure is declared elsewhere in the program, it is named CM, and it is externally described.

Line 2 declares the data structure named CM as an externally described data structure based on the CUSTMAST database file. This means all the fields of the CUSTMAST file will be used as data structure subfields for the CM data structure.

The new QUALIFIED keyword (line 3) is used to cause the CM data structure to be declared as a qualified data structure. Qualified data structures require their subfields to be connected to their parent data structure name using a period.

Since the CM data structure is qualified and the subfield names are the same as those of the CUSTMAST file, the PREFIX keyword (line 1) allows you to read a record into the CM data structure and then refer to the subfields of that data structure in order to access the data from the CUSTMAST file.

Here's an example of how to access the subfields in the CM data structure:

C                   Exfmt     Prompt
C     MYKEY         Chain     CustRec
C                   eval      cm.City = City
C                   eval      cm.state= State
C                   eval      cm.country = Cntry

The compiler automatically reads the data from the CUSTMAST file into the CM data structure, so no resulting field is necessary on the CHAIN opcode. In fact, when this technique is being used, the only way to access the fields of the CUSTMAST file is through the qualified name syntax.

Bob Cozzi is a programmer/consultant, writer/author, and software developer. His popular RPG xTools add-on subprocedure library for RPG IV is fast becoming a standard with RPG developers. His book The Modern RPG Language has been the most widely used RPG programming book for more than a decade. He, along with others, speaks at and produces the highly popular RPG World conference for RPG programmers.

BOB COZZI

Bob Cozzi is a programmer/consultant, writer/author, and software developer. His popular RPG xTools add-on subprocedure library for RPG IV is fast becoming a standard with RPG developers. His book The Modern RPG Language has been the most widely used RPG programming book for more than a decade. He, along with others, speaks at and produces the highly popular RPG World conference for RPG programmers.


MC Press books written by Robert Cozzi available now on the MC Press Bookstore.

RPG TnT RPG TnT
Get this jam-packed resource of quick, easy-to-implement RPG tips!
List Price $65.00

Now On Sale

The Modern RPG IV Language The Modern RPG IV Language
Cozzi on everything RPG! What more could you want?
List Price $99.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: