07
Thu, Nov
10 New Articles

Make DB2 Data Downloads Easy with Start CGI SQL Session (STRCGISQL)

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

If you have ever needed to download DB2/400 data to your PC and view the data in MS Excel, as an HTML document, as a simple XML document, or just as a text file, you know how tricky this task can be. As a System i developer, I spend much of my time downloading information from the big box to the small box on my desktop. As much as I love the System i, all my best productivity tools are still on my PC. I do all my number crunching in Excel, my emailing in Outlook, my presentations in PowerPoint, and my text editing work in Edit Plus. When I need data from my DB2/400 database (which is all the time), I still jump through hoops to download the data. The basic drill is something like this: I use my handy dandy STRSQL command to select the information I need from the database. Then, after I get the SQL statement working the way I want, I change the session attributes and send the Select Output to a file. Next, I jump to my PC and open a new document in Excel and create a new database query using the Client Access ODBC driver that points to the library holding my SQL output. Finally, I select the file and download it to my Excel spreadsheet. Ta da! Isn't technology amazing?

This multi-step process can be accomplished many different ways, some easier and some harder. One could use the Client Access add-ins to pull the data, use the CPYTOIMPF command to copy the file to the IFS, or link directly to the physical files and use a third-party SQL utility. All approaches are fine, but none of them are one-step, completely free, and completely customizable with source included.

Allow me to introduce STRCGISQL. STRCGISQL is an RPG ILE Common Gateway Interface (CGI) program that communicates with the System i HTTP server to deliver real-time DB2/400 data to the Web. The program attempts to mimic the Start SQL (STRSQL) Interactive Session command by allowing the user to perform all the same Select Only functions using a Web browser. Since Web browsers are installed on most PCs, there is no need for third-party software, emulation software, or System i command-line access. The user is able to enter an SQL Select statement, press the Submit button, and get the results of the SQL returned to the browser in the form of an Excel spreadsheet, HTML, text, or XML.

How STRCGISQL Works

STRCGISQL is totally self-contained and needs no additional programs or HTML code. It generates its own HTML input forms and returns its own HTML response. This CGI program is invoked by the System i HTTP server each time a user sends a request to its URL. The request to the HTTP server contains the program parameters selected by the user in the HTML form, and these parameters define the task that the program will perform.

The first time the user requests the STRCGISQL program (with no parameters) a Start CGI SQL prompt is displayed (see Figure 1).

http://www.mcpressonline.com/articles/images/2002/STRCGISQL%20Article%20v610250600.png

Figure 1: The first time you request the STRCGISQL program, you'll get a Start CGI SQL prompt. (Click images to enlarge.)

STRCGISQL Technical Description

STRCGISQL consists of three components: STRCGISQL (the main program module), SCS_PROTO (the source member containing prototypes), and PSCSPARM (a physical file for parsing the parameters passed to the program). All the programming logic, procedures, and functions are contained within STRCGISQL. The program has four main processing tasks: process the parameters, process the SQL statement, build the work files, and return the results.

Process the Parameters

The parameters that are passed to the STRCGISQL program are the heart of its processing. These parameters are defined by the fields in physical file PSCSPARM. The APICvtDB function (QTMHCVTDB API) parses the data from the input request buffer to an externally described data structure based on file PSCSPARM. The program then moves the data structure values to the file fields and writes a new record. If the SQLSTM parameter is *Blanks, then the SQL prompt returns to the browser. Otherwise, the SQL statement is processed.

Process the SQL Statement

Processing the SQL statement involves all the elements required to process dynamic SQL statements and is a bit more complex than writing an embedded SQL statement for an existing application. When processing the SQL statement dynamically, one never knows what the statement will contain and how the output will look. Because of this, the input requires a syntax check and the output file must be built to obtain the results on the fly.

The first step involves using the SQL PREPARE statement to dynamically prepare the SQL statement for processing. The PREPARE also flags the error (SQLCOD) if the SQL syntax is incorrect. The next step is to implement the SQL DESCRIBE statement, which obtains information that describes the SQL statement. This information loads into a data structure (SQLDA$) for use in the RPG program. The data structure contains all the field-level information that the program requires to enable it to build the output files and the SQL statement for returning the results of the SQL statement.

Build the Work Files

The STRCGISQL program loopds through the SQLDA$ data structure in subroutine BldCrtTblSQL to get the field information (names and type) and piece it together into a SQL CREATE TABLE command string. The SQL EXECUTE IMMEDIATE command executes the string and creates a new table in QTEMP called DATAOUT. The DATAOUT table possesses the exact record format required to hold the result of the SQL statement. This being the case, all that's required is a simple SQL INSERT INTO command in subroutine LoadWrkFile to load the results of the SQL statement into the DATAOUT file.

The other file created is the SQLOutput file, a flat physical file that holds the formatted result for return to the browser.

Return the Result

The result data is now safely stored in the DATAOUT file. The only thing left to do is format the data into the requested output. To accomplish this, build another SQL SELECT statement in subroutine BldxxxSelSQL (where xxx is CSV, HTM, TXT, or XML), execute the statement to insert the formatted data into the output file in subroutine LoadOutput, and send the formatted data back to the HTTP server in subroutine SndxxxOutput (where xxx is CSV, HTM, TXT, or XML).

The BldxxxSelSQL and SndxxxOutput subroutines have specific formatting controls to return the data to the Web browser as a CSV document (Figure 2), an HTML document (Figure 3), a TXT document (Figure 4), or an XML document (Figure 5).

http://www.mcpressonline.com/articles/images/2002/STRCGISQL%20Article%20v610250601.png

Figure 2: The data is returned as a CSV document.

http://www.mcpressonline.com/articles/images/2002/STRCGISQL%20Article%20v610250602.png

Figure 3: The data is returned as an HTML document.

http://www.mcpressonline.com/articles/images/2002/STRCGISQL%20Article%20v610250603.png

Figure 4: The data is returned as a text document.

http://www.mcpressonline.com/articles/images/2002/STRCGISQL%20Article%20v610250604.png

Figure 5: The data is returned as an XML document.

Easy Does It

This program was created to be easy to understand and easy to customize. It may be lacking some bells and whistles, but you can modify it. The only limitations are your imagination and time. Good luck, and use it well.

More Info about CGI programming

For more information about configuring your system to run CGI programs, go to This email address is being protected from spambots. You need JavaScript enabled to view it..

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: