12
Fri, Jul
4 New Articles

How to Code Selective Prompting in a CL Program

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

Ted Holt explains how to add command prompting code that pauses a CL procedure and waits for the user to enter parameter values

Editor’s note: This article is excerpted from chapter 13 of Complete CL: Sixth Edition, by Ted Holt.

Selective prompting is one example of an advanced technique. With selective prompting, you activate the prompter for a command from within a CL procedure. In other words, a CL procedure can contain an instruction that causes the procedure to stop, display the command prompter for a particular command, and wait for the user to enter parameter values and press the Enter key. When the user presses Enter, the CL procedure continues to execute.

The key to selective prompting is a question mark (?) placed immediately before the command name. See Figure 1.

 

PGM

   DCL &a         *CHAR   2
   ?SNDMSG
   CALL pgm1 (&a)

ENDPGM

Figure 1: An example of selective prompting

The procedure shown in Figure 1 stops at the SNDMSG command and prompts for it as if you had keyed in SNDMSG at the command line and pressed the F4 key. The operator is prompted for the DSPMSG command (Figure 2). The difference is that when the operator presses Enter, the system not only executes the SNDMSG command, but executes the rest of the procedure as well.

How to Code Selective Prompting in a CL Program - Figure 2 

Figure 2: The SNDMSG command prompted from a CL procedure

A Common Mistake

When using selective prompting in your CL procedures, you must remember that the CL procedure stops and the command prompter appears. All function keys supported by the command prompter are active, including F3 (Exit) and F12 (Cancel). When the user presses F3 or F12, the command prompter issues an *ESCAPE message (CPF6801) to your CL procedure. Your CL procedure must always monitor for this message immediately following selective prompting.

The section of code shown in Figure 2 is incorrect because it has no provision for the F3/F12 keys. Figure 3 shows how this procedure should be coded.

PGM

   DCL &a         *CHAR   2

   ?SNDMSG
   MONMSG cpf6801 EXEC(RETURN)

   CALL pgm1 (&a)

ENDPGM

Figure 3: An example of selective prompting with correct provision for F3/F12

Now the procedure ends (executes RETURN) if the user presses F3 or F12 from the command prompter.

Message CPF6801 includes the name of the key pressed (F3 or F12) as message data. Therefore, your CL procedure can tell the difference. In other words, you can take one action or another depending on what key the user presses to remove the command prompter.

For example, Figure 4 shows how to code the procedure so that, if the user presses F12, the procedure skips the CALL to the program; if the user presses F3, the entire CL procedure ends.

PGM

   DCL &a         *CHAR   2

   ?SNDMSG

   /* If user presses F3, abort program */
   MONMSG cpf6801 CMPDTA('F3') EXEC(RETURN)

   /* If user presses F12, skip CALL to PGM1 */
   MONMSG cpf6801 EXEC(GOTO skip)

   CALL pgm1 (&a)
skip:
   *
   *
   *

ENDPGM

Figure 4: Processing an F3 or F12 request when using selective prompting

MONMSG compares the message data (either 'F3' or 'F12') against constant 'F3'. If they are equal, MONMSG performs a RETURN. Otherwise, it continues. The next MONMSG monitors again for CPF6801, but transfers control to label SKIP.

Making the Prompt Selective

In the preceding example, the system prompts for the SNDMSG command without asking for any particular parameter (which is the normal way). All parameters normally prompted for will be prompted for.

Selective prompting derives its name from the fact that you can control (or select) which parameters are prompted for and how. You perform selective prompting by putting special control character prefixes on the command’s parameter keywords. Table 1 lists the valid control characters.

How to Code Selective Prompting in a CL Program - Table 1

Notes

  • You can enter one or more spaces between the question mark and the name of the command.
  • You cannot enter any spaces between the selective prompt control characters (??, ?*, ?-) and the parameter keyword.
  • You must use keywords for the parameters you want to prompt selectively. Positional parameters cannot be used.
  • There are two other control character sets, which are used only by IBM in IBM-supplied commands.
  • If you press F3 or F12 from the prompter presented by selective prompting, the system sends escape message CPF6801. Your CL procedure must monitor for the message, using the MONMSG command, and must take appropriate action (such as canceling the procedure).
  • You can use variables to supply values to the parameters being prompted for. When the prompter appears, the parameter will have the value of the variable by default. If the user changes this value and presses Enter, the command is carried out using the new value, but the CL variable doesn’t change.

 

TED HOLT

Ted Holt is IT manager of Manufacturing Systems Development for Day-Brite Capri Omega, a manufacturer of lighting fixtures in Tupelo, Mississippi. He has worked in the information processing industry since 1981 and is the author or co-author of seven books. 


MC Press books written by Ted Holt available now on the MC Press Bookstore.

Complete CL: Fifth Edition Complete CL: Fifth Edition
Become a CL guru and fully leverage the abilities of your system.
List Price $79.95

Now On Sale

Complete CL: Sixth Edition Complete CL: Sixth Edition
Now fully updated! Get the master guide to Control Language programming.
List Price $79.95

Now On Sale

IBM i5/iSeries Primer IBM i5/iSeries Primer
Check out the ultimate resource and “must-have” guide for every professional working with the i5/iSeries.
List Price $99.95

Now On Sale

Qshell for iSeries Qshell for iSeries
Check out this Unix-style shell and utilities command interface for OS/400.
List Price $79.95

Now On Sale

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: