29
Fri, Nov
0 New Articles

HOT TIPS: CL (8 Tips)

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

Creating an Auto-refresh Screen in CL

I wanted to monitor my network information and display it on a screen which would update itself automatically without any user intervention. I was able to accomplish this by employing the following technique.

1. Use the Override Display File (OVRDSPF) command to assign a maximum Wait Record (WAITRCD) time. Normally, this value is *NOMAX, which makes the file wait until a user presses Enter.

2. Write and read the display file record with the Send Receive File (SNDRCVF) command and specify WAIT(*NO). This causes the system to not wait for input from the user. Instead, the program continues to process the commands that follow the SNDRCVF command.

3. Code a WAIT command to cause the program to wait the number of seconds specified by the WAITRCD keyword of the OVRDSPF command executed previously. The WAIT command issues message CPF0889 when the WAITRCD time of the display file expires. Monitor for this message and when it is detected, redisplay the record. The following partial CL code illustrates this technique

 . . . OVRDSPF FILE(SCREENFM) WAITRCD(30) . . . LOOP: SNDRCVF RCDFMT(DELAY) WAIT(*NO) IF COND(&IN12) THEN(GOTO + CMDLBL(ENDPGM)) WAIT MONMSG MSGID(CPF0889) EXEC(GOTO + CMDLBL(LOOP)) . . . ENDPGM: ENDPGM 

Self-submitting CL Programs

If you have ever been frustrated with the need to write two programs in order to submit a job to a job queue (one program to submit the job and another to perform the task), take heart.

You can write one program that can submit itself to batch by retrieving the type of job environment in which the job is running. This is accomplished by using the Retrieve Job Attribute (RTVJOBA) command to obtain the job type. A CL variable receives a one-character value representing the environment of the job. A character value of 0 indicates that the job is running as a batch job, and a 1 indicates an interactive job. The variable must be a character variable with a minimum length of 1 character.

To illustrate, look at the program below. It submits itself to the job queue or runs interactively, depending on the response by the operator. When the job is called initially, it is running interactively. If the operator types a Y option to the question, then the program submits itself to the job queue and returns. Now the job is running in batch and the job's TYPE attribute is 0. This time, the program does not present the prompt screen to the operator. Instead, it branches over this and goes to label EXEC where the processing occurs.

 PGM1: PGM PARM(&PARM1 &PARM2 &PARM3) DCL VAR(&JOBTYPE) TYPE(*CHAR) LEN(1) DCLF FILE(OPTIONS) RTVJOBA TYPE(&JOBTYPE) IF COND(&JOBTYPE *EQ '0') THEN(GOTO + CMDLBL(EXEC)) /* Present options display */ SNDRCVF SBMJOB CMD(CALL PGM(PGM1) PARM(&PARM1 + &PARM2 &PARM3)) + JOB(REPORT) JOBQ(QBATCH) RETURN /* Generate report */ EXEC: (etc.) ENDPGM 

Display Status Messages in Reverse Image

To display status messages in reverse image, define two single-character fields to hold the hex code for display attributes: one to contain the reverse-image attribute byte and one to contain the normal attribute byte. Then, concatenate these fields with your message field, as the following partial program illustrates.

 DCL VAR(&REVERSE) TYPE(*CHAR) LEN(1) VALUE(X'21') DCL VAR(&NORMAL) TYPE(*CHAR) LEN(1) VALUE(X'20') SNDPGMMSG MSGID(CPF9898) MSGF(QCPFMSG) + MSGDTA(&REVERSE *CAT &MSG *CAT &NORMAL) + TOPGMQ(*EXT) MSGTYPE(*STATUS) 

Copying Multiple-format Files to Tape

The Copy to Tape (CPYTOTAP) command does not allow you to copy all record formats in a multiple-record logical file. To get around this limitation, use Copy File (CPYF) with an Override Tape File (OVRTAPF) command. For example, two physical files (a transaction header and detail) described by a logical file called HDRDTL could be copied to tape with the following commands.

 OVRTAPF FILE(QTAPE) DEV(TAP01) VOL(*NONE) BLKLEN(80) + ENDOPT(*UNLOAD) CPYF FROMFILE(HDRDTL) TOFILE(QTAPE) MBROPT(*REPLACE) + RCDFMT(*ALL) 

Flexible Library References

Some commands such as Create Duplicate Object (CRTDUPOBJ) require a library name, but hard-coding a library name in a CL program is something you should try to avoid. A better method is to use the RTNLIB parameter of the Retrieve Object Description (RTVOBJD) command to retrieve the library name. For example, to retrieve the library where WKFILE resides, use the RTVOBJD command as follows:

 RTVOBJD OBJ(WKFILE) OBJTYPE(*FILE) RTNLIB(&LIB) 

The value in the RTNLIB parameter could then be used in any command including those that require a library name to specify the library. The WKFILE file could be moved to any library in your library list and any program that uses the above command would still work-no program changes would be required. The library where the file exists could even be renamed without affecting the programs.

Beware of Changed Commands-Part I

This tip is for consultants and software developers who have to write CL programs that must run on someone else's (your customer's) machine.

An interesting feature of S/38 and AS/400 CL procedures is that, even though they are compiled, each command is interpreted when run, and the current default values for that command are substituted into the command. This can lead to unexpected errors if someone changes any of the defaults for any of the IBM- supplied commands using the Change Command Default (CHGCMDDFT) command.

To avoid this pitfall when creating CL procedures that must run at other sites, prompt each command in SEU by pressing F4=Prompt with the cursor on that line; then, press F10=Additional Parameters. Type over the first character of each default value with the same character. This will cause the "modified data tag" for that field to be turned on so that when you press Enter, that "key- word(value)" will be included in the statement.

What this technique does, in effect, is allow you to supply all of the "defaults" with the default values you expect. Hence, at run-time, the values are already supplied at the user's site, so there are no defaults to be plugged in-no more nasty surprises!

Date Validation in CL

The easiest way to validate dates in CL is to use the Convert Date (CVTDAT) command. If the command fails, it's because the date is invalid. For example:

 . . . CVTDAT DATE(&DATE) TOVAR(&DATE) FROMFMT(*MDY) + TOFMT(*MDY) TOSEP(*NONE) MONMSG MSGID(CPF0000) EXEC(DO) CHGVAR VAR(&IN70) VALUE('1') /* Error indicator */ GOTO CMDLBL(ERROR) /* Redisplay */ ENDDO . . . 

In this case, the from-format and to-format are the same, so no conversion takes place. However, an exception message will be sent if the variable &DATE does not contain a valid date.

Decompile CL Programs

If you inadvertently delete the source code of a compiled CL program, you can retrieve the source (minus comments) with the Retrieve CL Source (RTVCLSRC) command. (Of course, if you had a good backup of the source, you would most likely want to restore the source from the backup copy.) The command's format is:

 RTVCLSRC PGM(library/compiled_program_name) + SRCFILE(library/QCLSRC) SRCMBR(source_program_name) 

This process will only work if the Allowed Retrieve Source parameter of the original CL program has a value of '*YES' which is the default value for the Create CL Program (CRTCLPGM) command.

Bruce Vining

Bruce Vining is president and co-founder of Bruce Vining Services, LLC, a firm providing contract programming and consulting services to the System i community. He began his career in 1979 as an IBM Systems Engineer in St. Louis, Missouri, and then transferred to Rochester, Minnesota, in 1985, where he continues to reside. From 1992 until leaving IBM in 2007, Bruce was a member of the System Design Control Group responsible for OS/400 and i5/OS areas such as System APIs, Globalization, and Software Serviceability. He is also the designer of Control Language for Files (CLF).A frequent speaker and writer, Bruce can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it.. 


MC Press books written by Bruce Vining available now on the MC Press Bookstore.

IBM System i APIs at Work IBM System i APIs at Work
Leverage the power of APIs with this definitive resource.
List Price $89.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: