07
Tue, May
2 New Articles

TechTip: Standardizing Indicator Usage in RPG IV

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

Since RPG IV was first released and particularly since the release of free-format RPG IV, standardization has become a popular issue. However, standardizing indicator usage with external files has not been a heavily covered topic.

Start with Standards

As with any attempt to standardize, name selection is important. In the past, I used the indicator range *IN70 through *IN79 for CHAINs. This is not necessary with RPG IV. I now leave these available for TEST operations and other opcodes. The code in Figure 1 shows one way to represent indicators and demonstrates how they are passed to external files (in this case, a subfile and a printer file):

0015.00 Fmyfile   if e k disk    UsrOpn  

0016.00 Fprtfile  o  e   Printer IndDs(Indicators) OflInd(*in99) 

0017.00 Fsubfile  cf e   WorkStn IndDs(Indicators)  

0018.00 F                        sfile(Sfl1:Sfl1Rrn)  

0019.00 F                        sfile(Sfl2:Sfl2Rrn)   

... ... ... ... ... ...  

0036.00 * Define the indicator data structure  

0037.00 D Indicators ds  

0038.00 D   Exit              3  3N  

0039.00 D   Prompt            4  4N  

0040.00 D   SubmitJob         6  6N  

0041.00 D   ToggleFold       10 10N  

0042.00 D   Cancel           12 12N  

0043.00 D   ClearSfl1        31 31N  

0044.00 D   DisplaySfl1      32 32N  

0045.00 D   ClearSfl2        41 41N  

0046.00 D   DisplaySfl2      42 42N  

0047.00 D   AvoidF10         88 88N inz(*off)  

0048.00 D   MoreRecords      90 90N  

0049.00 D   Overflow         99 99N  

Figure 1: This example shows how to use the indicator data structure INDICATORS.

The data structure, called Indicators, renames *IN03 to the variable Exit, indicative of the exit or F3 key. When standardizing indicators, it is natural to reserve *IN01 through *IN24 for CUA-compliant function keys F1 through F24.

Other indicators are used for functions such as clear subfile and overflow. When choosing names, choose wisely.

The Indicators data structure is passed to external display and printer files via the Indicator Data Structure (INDDS) keyword. The keyword INDARA needs to be coded in the source code for these files to allow the data structure to be "communicated" to the external files.

Note that "INDDS(Indicators)" can be passed to multiple files. Hence, the one data structure can be used in many files. And if standard indicators are used within the program itself, they can be defined in indicators as well! Defining indicators this way removes the need for comment sections explaining indicator usage.

Caveats

When standardizing the indicator data structure, it is important to remember that any variation from the norm requires that you create a new indicator data structure. Notice that the Indicators structure in Figure 1 uses two sets of indicators for SFLCLR and SFLDSP operations because there are two subfiles. In that case, a standard SFLCLR would not work. Trying to standardize multiple clears by creating a named range such as SFLCLR1, SFLCLR2, etc. is not recommended. Such a method removes the ability to easily associate a field name with a particular subfile. It would be better to copy the copy member directly into the code and modify as necessary.

Another item worth noting is that passing the Indicators data structure to a printer file does not seem to work with printer overflow indicators. It would be nice if the named indicator could be used on the OFLIND parameter for the printer file on the F-spec. Unfortunately, it does not work that way now. Perhaps it will in a future release. Until then, you need to set the numbered indicator by program logic. Still, you will note that I name the indicator in the Indicators data structure. I do this for clarity and for reference. My intent is that the Indicators data structure is the "one-stop shop" for indicator representation unless other oddities occur in the code. Maybe someday we'll be able to use the named indicator in the OFLIND parameter, and when that happens, the only changes to this code will be replacing every *IN99 reference with the name of the indicator.

The final consideration when generalizing the Indicators data structure is whether it will be used as a /COPY member or not. On the one hand, a /COPY member could be the most optimal use of a standardized structure in much the same way prototype /COPY members are. On the other hand, if multiple subfiles are the norm in your IT shop or if you commonly use multiple printer files, give some thought to whether such common situations can be incorporated into the standard indicator data structure. It may be deemed that a new data structure definition is required within the program. Or multiple indicator data structures could be used. There is nothing preventing either of these situations from occurring.

The Bottom Line

Ultimately, the advantage of an indicator data structure is that you can create one home for all indicators in most situations. The INDDS can be a very useful tool in coding RPG IV programs if you keep it simple, handy, useful, and efficient. Take the time to think through the standards and the methods intended for implementation, and RPG IV programs may become a little easier to maneuver and understand.

Vincent B. Goldsby has been an IBM midrange systems professional since 1987. Presently, he is a senior programmer analyst in Memphis, Tennessee. Vincent can be reached for comments and questions at This email address is being protected from spambots. You need JavaScript enabled to view it..

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$0.00 Raised:
$

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: