04
Wed, Dec
6 New Articles

Practically Rational: User-Defined Templates

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

Rational Developer for the IBM i makes programmers more productive, and this technique is one way to make Rational more productive!

 

I use Rational Developer for the IBM i (RDi) a lot. I use it every working day, and I can't imagine trying to program without it. On those occasions when I am forced to rely on SEU, I find my fingers flailing away at key combinations that I use almost without thinking in Rational and muttering a bit under my breath. But even when using Rational, I'm always looking for new shortcuts to make my life easier. I'd like to share one that has begun to really save me time and has great potential for expansion as time goes on.

 

Templates as Time-Savers

RDi has a little-used (by me, anyway) feature called a template that hearkens all the way back to WDSC. The template concept is actually quite common in most other languages, but it really hasn't lent itself well to RPG. That may be at least partially due to the columnar nature of RPG prior to free-form syntax; because they sometimes substitute text, template techniques are more suited to free-form coding than fixed columns. But now that we do have free-form RPG in all specifications, I think you may find a lot more use for templates in the future.

 

A template is in essence a predefined chunk of code that can be easily inserted into your program source. RDi has two varieties of predefined code: templates and snippets. Snippets are more complex and in some ways more powerful; I'll leave them for another day. Templates are very simple: you specify the code that will be inserted and also define where you want the cursor to be positioned within that chunk of code. The cursor positioning comes in handy with multi-line templates that have some common lines at the beginning. I'm going to use a single-line template for the purposes of this article, so the cursor isn't as important.

 

Let's walk through adding the template first so you can see how it's done. First, bring up the Preferences panel. If you're unfamiliar with Preferences, you need to get familiar with them; they're the primary way that you can configure RDi to work the way that best suits you. Using the main menu, select Windows > Preferences to bring up the panel in Figure 1.

 

080515PlutaFigure1

Figure 1: This is the Preferences window, the place where you configure all of RDi.

 

In another article, I'll introduce you to many of the more important preferences and also explain how to navigate the Preferences panel when you’re trying to find something. But for expediency, I'll just tell you how to get there: expand Remote Systems; then, below that, expand Remote Systems LPEX Editor, then IBM i Parser, then finally ILE RPG. Then click on Templates, and the dialog will look something like Figure 2 (you may have to resize the window to make it match my example).

 

080515PlutaFigure2

Figure 2: A bit of drilling will take you to the ILE RPG Templates page.

 

Now you can add a template. Notice I'm not yet telling you a lot about what templates do: that will come in a moment. Let's get this one entered. Hit the New button to bring up the New Template dialog.

 

080515PlutaFigure3

Figure 3: This is the New Template dialog with the values filled in for my CTL-NEW template.

 

The dialog will be mostly empty with the Context set to FREE-FORM. Fill in the values for Name, Description, and Content as shown. The name is important: the first characters are used to find the templates, as we'll see in the execution example. You may recognize this as a completely free-form control specification (i.e., the specification formerly known as an H-Spec). Nearly every program I write has this specification, the only difference being the activation group. I use either *NEW or *CALLER. You may also notice the option(*srcstmt:*nodebugio) keyword; I use that in every program. The first value, *SRCSTMT, makes sure that error and debug messages always report the source code line number rather than the internal compiler line number that you only ever see in compile listings. The second stops me from having to step through every generated move when I CHAIN to a file in debug mode. Both make my life much easier when debugging.

 

As I noted, I use the *NEW/*CALLER technique; for more on that please refer to an article I wrote a while back on activation groups. That means that in addition to CTL-NEW, I should probably add a template for CTL-CALLER. You can do that exactly the same way.

 

080515PlutaFigure4

Figure 4: Use the same dialog to add another template, this time for ACTGRP(*CALLER).

 

I know that some people also like using named activiation groups. Let's do that so that I can show an example of the cursor-positioning keyword.

080515PlutaFigure5

Figure 5: This version of the template uses ${cursor} to position the cursor after insertion.


The last template shows the use of the special value ${cursor} to position the cursor. We'll see how that works in the next couple of paragraphs as we actually use the templates in a new source member.

 

Using a Template

To use the new templates, create a new source member of type RPGLE (or SQLRPGLE; free-form RPG templates work in both types of source members). Position yourself in the first line as shown, type "CTL" and hit the universal content-assist key Ctrl+Space (that is, hold down the Ctrl key and press space).

 

080515PlutaFigure6

Figure 6: RDi searches its internal list and also the templates for something that matches what you've typed.

 

When you trigger content assist, RDi builds a list of things that match the characters you've typed. Content assist is actually a bit more intelligent than that and examines the entire line to find context for the search, but in this particular case you've only typed a few characters, so all it does is find them. It will search its internal list looking for things that match (which is why the first entry in the list is the ctl-opt keyword itself) as well as the templates. At this point, you can now select either the standard ctl-opt keyword or one of our predefined templates. If you select CTL-NEW, you will see the version with actgrp(*new). Let's pick CTL-NONE, though, to see what happens.

 

080515PlutaFigure7

Figure 7: The template is inserted wth the cursor positioned for you to type in the activation group.

 

As you can see, the line is inserted but without an activation group (which causes the editor to complain). The cursor is positioned within the ACTGRP keyword so that you can type in the activation group and move on to the next line.

 

I hope you can see how much this can save you time. Not only does it insert the line quickly, it keeps you from having to remember the various keywords and their values (personally, I always have a problem remembering that the keyword is OPTION on the ctl-opt but OPTIONS on parameter definitions inside a DCL-PI). It's especially powerful when you tend to do the same thing over and over again.

I hope this gives you a taste of how templates can help your programming. We'll look at more time-saving features in upcoming articles.

 

Joe Pluta

Joe Pluta is the founder and chief architect of Pluta Brothers Design, Inc. He has been extending the IBM midrange since the days of the IBM System/3. Joe uses WebSphere extensively, especially as the base for PSC/400, the only product that can move your legacy systems to the Web using simple green-screen commands. He has written several books, including Developing Web 2.0 Applications with EGL for IBM i, E-Deployment: The Fastest Path to the Web, Eclipse: Step by Step, and WDSC: Step by Step. Joe performs onsite mentoring and speaks at user groups around the country. You can reach him at This email address is being protected from spambots. You need JavaScript enabled to view it..


MC Press books written by Joe Pluta available now on the MC Press Bookstore.

Developing Web 2.0 Applications with EGL for IBM i Developing Web 2.0 Applications with EGL for IBM i
Joe Pluta introduces you to EGL Rich UI and IBM’s Rational Developer for the IBM i platform.
List Price $39.95

Now On Sale

WDSC: Step by Step WDSC: Step by Step
Discover incredibly powerful WDSC with this easy-to-understand yet thorough introduction.
List Price $74.95

Now On Sale

Eclipse: Step by Step Eclipse: Step by Step
Quickly get up to speed and productivity using Eclipse.
List Price $59.00

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: