19
Fri, Apr
5 New Articles

TechTip: Validating HTML Forms with Message Subfiles

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

I like message subfiles. As a user, I like them because they give me a good, easy overview of one or more errors that might have occurred on a screen. As a programmer, I like them because they offer great functionality and are pretty easy to handle once you get in the habit. So I have created a similar function using HTML, JavaScript, Cascading Style Sheets (CSS), and a CGI-RPG program. If you think this sounds interesting, please read on.

The CGI-RPG program is about 650 lines and because I have limited space here, I will not go into detail about every program line, subroutine and prototype in the code. You might find more clever ways to write the code and feel free to do so; the objective of the tip is to give you an idea of what you can do with a little HTML and JavaScript.

First, a few things must be in place in order to make it all work.

  1. Your i5 must be able to run and execute CGI programs.
  2. A little knowledge about HTML forms, JavaScript, and CSS will not do you any harm.
  3. My CGI library is named CGILIB. If you have something different, you have to do a search/replace in program FORM002 and insert your own library name. Search for "yourlib" and please note that the library name must be replaced in three places (including the compile instructions).
  4. To parse the input from the HTML form, I like to use the QZHBCGIPARSE API instead of the obsolete QTMHCVTDB and QTMHRDSTIN APIs. Instead of reinventing the wheel, download and compile program CGIPARSEZ. This great program was originally written by Craig Pelkie and was called CGIPARSE. I call my program CGIPARSEZ because you might already have a version of the program running, and I have made one small change in the original program because a counter was not reset in Craig's program, which caused trouble in my setup.
  5. The record length of your QRPGSRC source file must be at least 112 bytes. Please note that I store all my RPG programs in QRPGSRC. In this example, I also store the HTML skeleton member called FORM002H in QRPGSRC. If you want to change this to something else, make the appropriate changes on the F-spec in program FORM002.

Note: Throughout out the program, two prototypes are called repeatedly: MakeHTML writes the HTML to the browser using the QTMHWRSTOUT API. ReplaceIt replaces the keywords in the skeleton code in member FORM002H.
Below is a snippet of the code:


%%errorbox%%



The keyword %%errorbox%% in program FORM002 scans for and replaces some HTML code; in this case, this is where the dropdown box will be placed. FORM002 also uses other keywords, such as %%focus%% and %%err1%%. This is a very flexible way to write code. If you want the drop-down box somewhere else, simply move the line. The %% symbols indicate an invariant character, which means that it always has the same tagging, no matter what CCSID you use. (Yes, yes, I know about CCSID 420.) You can read more about invariant characters here.

When you have all the above in place, download programs FORM002 and HTML skeleton FORM002H into QRPGSRC in your CGI library. Compile FORM002 following the compile instructions in the header of the program. Then, open your browser of choice and enter the following URL:

http://your-server/cgi-bin/form002

The screen shown in Figure 1 will be displayed:

http://www.mcpressonline.com/articles/images/2002/Tech%20TipV400.jpg

Figure 1: This is a typical HTML form into which you enter data. (Click images to enlarge.)

This is a typical HTML form: You type information into the input fields and click Submit Data. And then, something will happen.

Try clicking Submit Data without entering anything in the form. This will call the CGI-RPG program, and the following will occur (Figure 2):

http://www.mcpressonline.com/articles/images/2002/Tech%20TipV401.jpg

Figure 2: Trying to "submit data" without entering data first generates a drop-down box.

As you see, all the fields change to yellow and a drop-down box appears on the screen. This is "my" message subfile.

If you select an entry in the drop-down box, the cursor will automatically jump to the field in error and you can start typing right away. If you already wrote something in the field, it will be selected too.

Let me briefly explain what happens: The first time the program is called, it checks whether the Submit Data button was pressed. If not, subroutine subrLoadForm is called. Member FORM002H will be opened and used as a skeleton to load the HTML form in the browser. Some search/replace will occur to prevent the drop-down box to be displayed and to place the cursor in the name input field. When you press Submit Data, FORM002 is called again. The HTML form is parsed, and because the Submit Data button was pressed, subroutines subrFindErrors and subrCrtHTMLreply are called. The subrFindErrors subroutine will find the fields in error and place an error message in an array, which will be used in subrCrtHTMLreply to build the drop-down box. In this program, the messages are hard-coded, but they should of course be retrieved from a message- or database file. That's the cycle of the program. There's nothing more to it.

The way I give the fields red borders and yellow backgrounds is by using the following CSS code:

 StyleID='style="border-color:#FF0000;border-right-width:2px;'
+'border-left-width:2px;border-style:solid;'
+'background-color:#FFFFC4;"';

If you do not like the colors or border types, change the code. The correct way would of course be to soft-code it and read the attributes from a database or data area.

To make the cursor jump to the field in error, I use the JavaScript OnChange event and places it on the

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: