29
Fri, Nov
0 New Articles

Indicatorless Function Keys

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

Brief: Indicators were never meant for human consumption. Anyone who tries to interpret a program that uses them, without some kind of supplemental documentation, knows why indicators should be avoided whenever possible. Replacing indicators with meaningful variable names can make a programmer's life much easier. In this article, you'll learn how you can eliminate function key indicators.

Quite possibly the worst part of programming an IBM midrange computer is using indicators. With RPG, COBOL, C or even CL, indicators are still the only way of communicating certain attributes to a display or printer file. What does indicator 01 mean? Is it being used to condition attributes such as highlighting, underlining, reverse image or field protect? Is the indicator assigned to a function key (also known as a command key) and if so, what function key does indicator 01 represent? F1? F24? Roll Up? Interpreting indicator meaning typically requires extra effort. You must often refer to the display or printer file source member to determine the meaning of an indicator.

You can employ a better method that uses no indicators (not even indicators KA through KZ in RPG) to handle function keys in your programs. The method allows for easier reading within your program, defines the Roll keys as well as Print and Help, and explicitly defines the Enter key! It is very easy to learn, set up and use-you can even modify existing programs to use the same technique. In this article, I'll show you how to use the technique in RPG and COBOL.

The Typical Scenario

Sadly, traditional programming methods have retained the use of indicators, even though techniques to program function keys without indicators have existed for years.

Using function keys within an interactive program is an example of communicating through indicators. Typically, as a programmer designs a display file, he defines an indicator to represent a function key. Then, as he designs the program, he includes a statement that checks to see if any of the function key indicators are on every time a screen format is read.

There is nothing wrong with checking to see which function key has been pressed. I just have a problem with function keys identified through indicators. No matter how logically or (heaven forbid!) arbitrarily you assign indicator numbers to represent function keys, your programs are all susceptible to the same two pitfalls.

o First, the Enter key is implied. What if your program finds no activated indicator as it tries to determine which function key was pressed? The program assumes the user pressed Enter. Suppose you define F8 in your display file but forget to specify what happens in your program if the indicator associated with F8 is on. If a user presses F8, the program responds as if the Enter key has been pressed.

o Second, the traditional function key indicator opens the door for a lot of guesswork about exactly which key the indicator represents. The method covered here presents more explicit, intuitive information about function keys. For example, instead of coding an RPG statement that checks the status of *IN25, why not check whether the function key is equal to ROLLUP?

The RPG statement in 1 implies testing to see if the Roll Up key was pressed. More importantly, no indicator is being used because CFKEY and ROLLUP have special meaning to the program. Let's look at how we can accomplish this.

The RPG statement in Figure 1 implies testing to see if the Roll Up key was pressed. More importantly, no indicator is being used because CFKEY and ROLLUP have special meaning to the program. Let's look at how we can accomplish this.

COBOL and RPG can access information about files used within a program, including a display file. The information is supplied by OS/400 in what is known as the I/O feedback area. RPG retrieves the I/O feedback area through the File Information Data Structure or INFDS. COBOL retrieves it through the ACCEPT statement using the mnemonic-name from the SPECIAL-NAMES paragraph. The Attention InDicator (AID) byte of the I/O feedback area indicates which function key was pressed during the last read of the display file.

RPG Coding

In order to use function keys in RPG without the use of indicators, you must:

1. Add a continuation line to your WORKSTN F-spec on the line immediately after the line which declares the display file. Specify the name of the INFDS you will use. 2 illustrates the assignment of the name DSPFDS.

1. Add a continuation line to your WORKSTN F-spec on the line immediately after the line which declares the display file. Specify the name of the INFDS you will use. Figure 2 illustrates the assignment of the name DSPFDS.

2. Define the INFDS within the I-specs of the program and define a subfield for the AID byte (posi-tion 369), as illustrated in 3.

2. Define the INFDS within the I-specs of the program and define a subfield for the AID byte (posi-tion 369), as illustrated in Figure 3.

3. Define constant values to represent each of the 28 function keys, as illustrated by the partial list in 4. Use the table in 5 to determine the hex value for the function keys you need to define. It is much easier to create this portion as a separate member and include it into your RPG program with the /COPY command at compile time.

3. Define constant values to represent each of the 28 function keys, as illustrated by the partial list in Figure 4. Use the table in Figure 5 to determine the hex value for the function keys you need to define. It is much easier to create this portion as a separate member and include it into your RPG program with the /COPY command at compile time.

4. Declare the desired function keys within your display file DDS (CAxx or CFxx), but do not assign an indicator to them. If you are modifying existing display files, remove the indicators that have been assigned to your function keys. I find it easiest to declare that all function keys are valid within the display file and then, within the program, display an error message for function keys that are not used.

6 illustrates how your RPG program might look. Based upon the function key pressed, the program performs a designated subroutine. For example, if Roll Up is pressed, then the NXTPAG subroutine is performed. If Roll Down is pressed, then the PRVPAG subroutine is performed. The Enter key (FENTER) is considered a valid function key, and a subroutine is set up for invalid function keys (BADFKY). Because I defined all function keys in the display file, the program must handle function keys that have no purpose.

Figure 6 illustrates how your RPG program might look. Based upon the function key pressed, the program performs a designated subroutine. For example, if Roll Up is pressed, then the NXTPAG subroutine is performed. If Roll Down is pressed, then the PRVPAG subroutine is performed. The Enter key (FENTER) is considered a valid function key, and a subroutine is set up for invalid function keys (BADFKY). Because I defined all function keys in the display file, the program must handle function keys that have no purpose.

COBOL Coding

Using function keys in a COBOL program without indicators also involves four steps:

1. Immediately after the OBJECT-COMPUTER line in your ENVIRONMENT DIVISION, key in the statement shown in 7 beginning in Area A. The statement relates the IBM I-O-Feedback name to a user-defined mnemonic-name.

1. Immediately after the OBJECT-COMPUTER line in your ENVIRONMENT DIVISION, key in the statement shown in Figure 7 beginning in Area A. The statement relates the IBM I-O-Feedback name to a user-defined mnemonic-name.

2. In the WORKING-STORAGE SECTION, key the first three statements shown in 8 followed by the function key definitions illustrated by the partial list. Use the table in 5 to determine the hex value for the function keys you need to define. Some of the suggested names for function keys shown in 5 are prefaced with the letter F to avoid using COBOL reserved words. You may find it easier to create a separate member within your source file for all of the information within DISPLAY-FILE-INFO and then use the COBOL COPY statement to copy it into your source code at compile time.

2. In the WORKING-STORAGE SECTION, key the first three statements shown in Figure 8 followed by the function key definitions illustrated by the partial list. Use the table in Figure 5 to determine the hex value for the function keys you need to define. Some of the suggested names for function keys shown in Figure 5 are prefaced with the letter F to avoid using COBOL reserved words. You may find it easier to create a separate member within your source file for all of the information within DISPLAY-FILE-INFO and then use the COBOL COPY statement to copy it into your source code at compile time.

3. Every time the display file is read, you must follow the READ statement with the statement shown in 9 (begin the statement in Area B). This statement loads the AID byte into the FUNCTION-KEY variable defined in the WORKING- STORAGE SECTION.

3. Every time the display file is read, you must follow the READ statement with the statement shown in Figure 9 (begin the statement in Area B). This statement loads the AID byte into the FUNCTION-KEY variable defined in the WORKING- STORAGE SECTION.

4. Step 4 is identical to item 4 in the RPG coding.

When you have finished coding the SPECIAL-NAMES, WORKING-STORAGE SECTION and ACCEPT statements into your program, you may begin testing function keys without indicators. 10 contains an example of how you might code your COBOL program to sense the function keys.

When you have finished coding the SPECIAL-NAMES, WORKING-STORAGE SECTION and ACCEPT statements into your program, you may begin testing function keys without indicators. Figure 10 contains an example of how you might code your COBOL program to sense the function keys.

Improve Program Readability

Testing the AID byte instead of using indicators within your program has several advantages. The biggest advantage is that the program becomes self- documenting. The program is easier to read because the unintuitive "mapping" of indicator numbers to function keys is replaced by explicit words that correspond with the function key name. To find out more about reducing indicator usage, see "Run-time Screen Attributes," MC, May 1994.

Wayne Johnson is president of Multiple Computer Directions, Inc. in Conyers, Georgia.


Indicatorless Function Keys

Figure 1 Testing for Rollup Key

 *. 1 ...+... 2 ...+... 3 ...+... 4 ...+... 5 ...+... 6 ...+ C CFKEY IFEQ ROLLUP 
Indicatorless Function Keys

Figure 2 Defining the File Information Data Structure in RP

 *. 1 ...+... 2 ...+... 3 ...+... 4 ...+... 5 ...+... 6 ...+ F KINFDS DSPFDS 
Indicatorless Function Keys

Figure 3 Defining the INFDS AID Byte in RPG

 *. 1 ...+... 2 ...+... 3 ...+... 4 ...+... 5 ...+... 6 ...+ IDSPFDS DS I 369 369 CFKEY 
Indicatorless Function Keys

Figure 4 Defining Constants to Represent Possible AID Byte

 *. 1 ...+... 2 ...+... 3 ...+... 4 ...+... 5 ...+... 6 ...+ I*====================================================* I* DEFINE THE AID BYTE CONSTANT VALUES. USE WITHIN A * I* PROGRAM TO CHECK FOR COMMAND FUNCTION KEYS RATHER * I* THAN USING INDICATORS. * I*====================================================* I X'31' C F01 I X'32' C F02 * . * . * . 
Indicatorless Function Keys

Figure 5 Hex Code Values Returned by Function Keys Through

 UNABLE TO REPRODUCE GRAPHICS 
Indicatorless Function Keys

Figure 6 Partial RPG Code to Sense Aid Byte Value

 *..1....+....2....+....3....+....4....+....5....+....6....+ C CFKEY DOUEQF03 C EXFMTSCREEN * C CFKEY CASEQFROLLU NXTPAG C CFKEY CASEQFROLLD PRVPAG C CFKEY CASEQF05 REFRSH C CFKEY CASEQF12 CANCEL C CFKEY CASEQFENTER VERIFY C CAS BADFKY C ENDCS C ENDDO 
Indicatorless Function Keys

Figure 7 Relate I-O-FEEDBACK to User-defined Mnemonic-name

 SPECIAL-NAMES. I-O-FEEDBACK IS I-O-FEEDBACK-AREA. 
Indicatorless Function Keys

Figure 8 Defining the AID Byte in COBOL

 01 DISPLAY-FILE-INFO. 05 FILLER PIC X(146). 05 FUNCTION-KEY PIC X. 88 F01 VALUE X'31'. 88 F02 VALUE X'32'. 88 F03 VALUE X'33'. . . . 
Indicatorless Function Keys

Figure 9 Load AID Byte to Variable in COBOL

 ACCEPT DISPLAY-FILE-INFO FROM I-O-FEEDBACK-AREA. 
Indicatorless Function Keys

Figure 10 Partial COBOL Code Example to Sense Function Keys

 EVALUATE TRUE WHEN F03 STOP RUN WHEN FENTER PERFORM PROCESS-DATA WHEN OTHER PERFORM UNKNOWN-FKEY END-EVALUATE. 
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: