02
Sat, Nov
2 New Articles

TechTip: Work with CGI Spooled Files (WRKCGISPLF)

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

If you've ever needed to save a spooled file on your PC, email a spooled file, or simply view the printed version of the spooled file, you know how difficult and time-consuming it can be. Typically, you would have to convert the spooled file on the iSeries/400 to a PC stream file on the IFS using a conversion program and then copy the PC file from the IFS directory to your local PC using emulation software. Other options might be to use a third-party spooled file viewer or email utility that matches your specific need.

I face this problem on a daily basis and, while I can perform all the command line tasks to get spooled files to my PC, most of my users can't. With this in mind, I felt that there needed to be an easier way for end users and developers to access iSeries/400 spooled files on their PCs. While developing a Web-enabled report for a client, I came up with the idea for the Work with CGI Spooled Files (WRKCGISPLF) program, which you can download by clicking here.

WRKCGISPLF is an RPG IV Common Gateway Interface (CGI) program that communicates with the iSeries/400's HTTP server to deliver real-time iSeries/400 data to the Web. The program attempts to mimic the iSeries/400's Work with Spooled Files (WRKSPLF) command by allowing the user to perform all the same "display only" spooled file functions using a Web browser. Since Web browsers are installed on most PCs, there is no need for third-party software, emulation software, or iSeries/400 command line access. The user is able to view the list of spooled files by User Name, Output Queue, and/or User Data. From the list of spooled files, that user is able to view the spooled file in HTML format or PDF format.

How WRKCGISPLF Works

WRKCGISPLF is totally self-contained and needs no additional programs or HTML code. WRKCGISPLF generates its own HTML input forms and returns its own HTML response. This CGI program is invoked by the iSeries/400's 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 WRKCGISPLF program (with no parameters), a Work with CGI Spooled Files prompt is displayed (see Figure 1).

http://www.mcpressonline.com/articles/images/2002/WRKCGISPLF%20-%20ArticleV400.png

Figure 1: This screen is the Work with CGI Spooled Files prompt.


The prompt contains the same parameters that are included in the WRKSPLF command. Entering data into the text boxes gives the user the ability to select spooled files by User, Output Queue, and/or User Data. Pressing the Get Spooled Files button presents the user with a list of spooled files that meet the selection criteria (see Figure 2).

http://www.mcpressonline.com/articles/images/2002/WRKCGISPLF%20-%20ArticleV401.png

Figure 2: This screen provides the user with a list of spooled files that meet the selection criteria.


On the right side of each spooled file in the list are two HTML hyperlinks. The first hyperlink, HTML, displays the spooled file as an HTML document. The second hyperlink, PDF, displays the spooled file as an Adobe Acrobat document. By using the menu options available to the browser or the Acrobat Reader, the user is able to save the document to the PC hard drive.

WRKCGISPLF Technical Description

WRKCGISPLF consists of three components: WRKCGISPLF (the main program module), WSC_PROTO (the source member containing prototypes), and PWCSPARM (a physical file for parsing the parameters passed to the program). All the programming logic, procedures, and functions are contained within WRKCGISPLF. The program has four main processing tasks: process the parameters, list the spooled files, build the HTML document, and build the PDF document.

1) Process the Parameters

The parameters that are passed to the WRKCGISPLF program are the heart of its processing. These parameters are defined by the fields in physical file PWCSPARM. The APICvtDB function (QtmhCvtDb API) is used to parse the data from the input request buffer to an externally described data structure based on file PWCSPARM. The program then moves the data structure values to the file fields and writes a new record.

2) List the Spooled Files

Using the parameters that are passed to the program (specifically User, Output Queue. and User Data), the SndSplLst procedure generates the list of spooled files. The SndSplLst procedure uses the QUSLSPL API to load the selected list of spooled files into a temporary user space. As each spooled file entry is retrieved from the user space, the QUSRSPLA API is called to retrieve additional spooled file attributes that are loaded into data structure SplDataOut. Each spooled file entry is wrapped in HTML with the associated tags that hyperlink back to the CGI program for the HTML and PDF document requests. The HTML entry is then sent back to the HTTP server using the APIStdOut function (QtmhWrStout API).
When the program receives a request to display the spooled file as an HTML document, the $ProcHTML subroutine is executed. This subroutine copies the selected spooled file into SplOutput using the Copy Spooled Files (CPYSPLF) command, loops through the file, wraps the records in HTML, and delivers it to the user.

3) Build the HTML Document

 

4) Build the PDF Document

When the program receives a request to display the spooled file as a PDF document, the $ProcPDF subroutine is executed. This subroutine processes the same as the $ProcHTML subroutine, but it uses the PDF functions to build a proper PDF document. Each PDF document consists of four parts: the header (function PDFHeader), the body (function PDFPages), the cross-reference table (function PDFCrossRef) and the trailer (function PDFTrailer).

Compiling the Objects

CRTPF FILE(your_Lib_name/PWCSPARMS)
CRTRPGMOD PGM(your_Lib_name/WRKCGISPLF)
CRTPGM PGM(your_Lib_name/WRKCGISPLF)
MODULE(WRKCGISPLF)
BNDSRVPGM(QHTTPSVR/QZHBCGI)

Steven Goetjen is an independent consultant in New York with over 15 years of industry experience on IBM midrange systems and PC systems. He can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it..

Steven Goetjen

Steven Goetjen is an accomplished IS professional with years of technical and business experience managing projects and teams in consulting firms and major financial institutions. He can be reached at www.linkedin.com/in/StevenGoetjen.  

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: