12
Tue, Nov
6 New Articles

Embedded Compiler Parameters in RPG IV

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

One of the most valuable enhancements RPG IV has over its predecessors is its ability to interpret CL compiler command parameters stored in the source member. This ability is found exclusively in RPG IV and does not require the purchase of any third-party tools.

Embedding compiler parameters serves two purposes: (1) It allows you or someone else to avoid the need to remember the compiler parameters when you're compiling the source member, and (2) it allows you to avoid prompting the compiler before submitting the compilation of the source member.

In RPG IV, compiler parameters may be embedded on the Header specification. Since the Header specification is open in positions 8 to 80, any compiler parameter may be specified. In addition, if you run out of room on one Header specification, simply start another one and continue to enter the desired keywords.

Before I describe some of the keywords you can specify on the Header specification, I need to describe how the Header specification is interpreted by the compiler.

Header Specification

The Header specification (officially referred to as the "Control specification") is the first source statement specified in an RPG program. The compiler needs a Header specification to control how the source member is compiled. But the Header specification is optional, so the compiler uses a default Header specification if none is specified in the source member itself.

The default Header specification may be stored in a data area named RPGLEHSPEC. This data area may appear in any library on your library list (that is, the library list in effect at the time you compile the source member). The data area must be type *CHAR, and it should be at least 80 bytes in length. It may be longer if it is necessary to specify additional keywords that take up more than 80 bytes.

To create a default Header specification data area named RPGLEHSPEC in QGPL with a length of 80 bytes, use the following CL command:

CRTDTAARA DTAARA(QGPL/RPGLEHSPEC) +                TYPE(*CHAR) LEN(80)

Once the data area is created, you may use the CHGDTAARA CL command to set the values of the various keywords whose settings you would like to standardize.

To set the values of the default keywords to use, specify them with the same syntax as the CHGCMDDFT command.

CHGDTAARA DTAARA(QGPL/RPGLEHSPEC) +    VALUE('BNDDIR(''QC2LE'') ACTGRP(''PICKLES'')')

The downside of using a default data area is that you don't get the accumulated effect one might expect from such a feature. That is, if you use a default data area and a Header specification, only the Header specification applies, not both. This cumulative capability would be a nice feature, but for now it's only a future objective.

Another default Header specification is shipped with the RPG compiler. This one is named DFTLEHSPEC and is shipped in the QRPGLE library. This data area may be used instead of one of your own creation. Again, use the CHGDTAARA CL command to set the default compiler parameter values in that data area. For example:

CHGDTAARA DTAARA(QRPGLE/DFTLEHSPEC) +    VALUE('BNDDIR(''QC2LE'') ACTGRP(''PICKLES'')')

The compiler searches for default CRTBNDRPG or CRTRPGMOD parameters in the following sequence:

1. A Header specification specified in the source member itself

2. The data area named RPGLEHSPEC somewhere on your library list

3. The data area named DFTLEHSPEC in QRPGLE

Once the compiler detects one of these things, it stops looking for the next item on the list. Therefore, if you specify a Header specification in your source code, neither of the data areas will be used to set compiler parameter defaults.

Setting RPG Compiler Defaults in Source

To specify the compiler parameters for any RPG IV source member, insert a Header specification at the top of the source member, and simply enter the keywords you wish to specify.

The keywords can be nearly any keywords from the CRTBNDRPG or CRTRPGMOD CL commands (with very few exceptions, one of which I'll discuss later in this article). However, you do not enter them the same way you would with the CL commands; because RPG IV is a programming language in itself, it has a set of valid literal values and special symbols; therefore, some of the values you specify must be specified as quoted values instead of simply text strings.

For example, the ACTGRP (activation group) parameter of the compiler commands would be specified as follows:

H  ACTGRP('QILE')

But on the CRTBNDRPG CL command, it would be specified without quotes:

CRTBNDRPG ...  ACTGRP(QILE)

One of the keywords that is not supported is the DBGVIEW keyword. This keyword may only be specified on the CRTBNDRPG and CRTxxxMOD commands. It would be helpful to be able to put this keyword in the Header specification and then condition it with compiler directives, but unfortunately, we cannot.

A keyword may be specified only once. However, you may specify multiple values for keywords when necessary. As with other areas of RPG IV, the colon (:) is used as the separator. For example, to specify three binding directory names, you'd do something like this:

H  BNDDIR('QC2LE' : 'TOOLKIT' : 'CGIDEV2')

There are three common mistakes developers make when specifying the values for compiler parameters:

1. They don't quote the parameter values.

2. They quote the parameter values but specify the value in lowercase.

3. They quote special values.

Here's an example of the first syntax error:

H  BNDDIR(QC2LE)

What's wrong? The value QC2LE is not known to RPG IV language, so it can't identify it. Therefore, the value must be enclosed in quotation marks.

Here's an example of the second syntax error:

H  BNDDIR('qc2le')

What's wrong? Since the value is quoted, the system looks for the value QC2LE with a lowercase name. Since QC2LE is an uppercase object name, the system never locates it.

Here's an example of the third syntax error:

H  DFTACTGRP('*YES')

What's wrong? Sometimes, people get carried away with the quotes. They think either everything is quoted or nothing is quoted. The good rule of thumb is that when an asterisk is used, don't bother quoting the value. Of course, this doesn't apply to the EXTFILE and EXTMBR keywords on the File specification.

Using the Conditional Directives

You can take advantage of RPG IV's conditional compiler directives and have even more fun with Header specification keywords. By entering a statement as illustrated below, you can control which keywords are used when compiling:

.....H  BNDDIR('QC2LE') ACTGRP('MARS')
..... /IF DEFINED(*CRTBNDRPG)
.....H  DFTACTGRP(*NO)
..... /ENDIF

In this example, the /IF conditional compiler directive is used to test if the source member is being compiled with the CRTBNDRPG command (PDM option 14). If so, it inserts a Header specification that overrides the DFTACTGRP parameter. This allows you to "punch in" PDM option 14 on the source member to compile it.

The keywords that may be used on the Header specification are listed in IBM's RPG manual or in Table 2.4 on pages 38 to 43 in my book The Modern RPG IV Language, Third Edition. These keywords have the same purpose and function as the keywords of the CRTBNDRPG and CRTRPGMOD commands. When a keyword is used on the Header specification, the corresponding keyword of the CRTBNDRPG and CRTRPGMOD commands is ignored.

Using the compiler keyword parameters on the Header specification can save you a lot of time when you need to recompile a source member. You can avoid errors and parameter setting conflicts that can arise. When used in conjunction with the conditional directives, the Header specification is a powerful ally in compiling your RPG IV source members.

Bob Cozzi has been programming in RPG since 1978. Since then, he has written many articles and several books, including The Modern RPG Language --the most widely used RPG reference manual in the world. Bob is also a very popular speaker at industry events such as RPG World (www.rpgworld.com) and is the author of his own Web site, www.rpgiv.com, and of the RPG ToolKit (www.rpgiv.com/toolkit), an add-on library for RPG IV 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: