Mon, Jul
2 New Articles

It's Just Another Day, But Do You Know What Your Reports Are Doing?

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

Like magic, custom reports and critical files in various formats appear each day in user's folders, portals, print queues, and email. But if they didn’t run one day soon, would anyone know why?


Programmers are taught early in their career to simplify program maintenance by carefully documenting their work. Companies invest significant time and money developing business continuity and disaster recovery plans in the hope they can minimize risk and reduce recovery time if the enterprise is threatened. But many of these same organizations never document their reports and reporting processes. Knowledge of these practices is frequently overlooked until the environment changes and someone stops receiving a report or file they rely on to monitor and guide their daily operations. That's a bit too late.


Over the many years I've worked for a company that provides reporting and business intelligence software, I've heard a wide range of reasons for this documentation oversight. Of course, the most common response is, "We don't have time." But there are other less-obvious reasons. Reports are often developed by power users and analysts outside the information technology department. These staff members were probably never asked or trained to document their work. Database and application development managers can argue that reports that read, but don't change, the database aren't their responsibility. Programmers may not view the logic embedded in queries and report programs as "code" that will require maintenance over time. We also know there are some who believe "queries" aren't sufficiently complex enough to warrant documentation. Anyone with this belief hasn't yet been asked to redesign or debug a complex query.

Companies that haven't documented their reports and reporting process typically get by without too many problems until the few people with in-depth knowledge aren't around to keep things running. There's no reason to wait for that day.

A definition of what we consider a "report" is important because the term has evolved over time. A narrow definition that looks only at spool file output is inadequate. Here is a more helpful definition for the sake of this discussion: a job that runs on a recurring basis that queries, outputs, exports, or transfers data and is not part of a supported application system. We'll assume any reports built into a vendor or internally developed and supported application will be maintained as part of that system. Our focus here is on all the other reports and reporting processes your company has created to support daily operations.

Your company's unique reports and reporting processes may include output generated by compiled programs, IBM Query/400 queries, queries written with third-party query and reporting solutions, SQL and PHP scripts, PC file transfers, and sometimes nightly transfers to other servers and databases. Knowing if and how your organization uses each of these methods and possibly others is critical so that you can locate all the elements that make up your reporting infrastructure. So what information do you need?


Report and reporting process documentation should illuminate your company's reporting on multiple levels.


  • Report Usage—Documentation that identifies what reports are being run, who runs them, when they were last run, how often they are run, and whether they are being initiated from a job-scheduling utility or other automated process. You may have numerous CL programs that initiate reports. Try to review report usage over a timeframe that reflects your company's business cycle (weekly, monthly, quarterly, etc.) as some critical reports may only be run periodically.

  • Report Design—Documentation of individual reports to show tables joined, columns used, calculations, selects, sorts, summaries, output type, and output destinations (print, display, database table, IFS folder, etc.). Your ability to generate this information depends in part on your development tools and methods. Companies using IBM Query/400 should look into using the Print_Query_Definition stored procedure or the more complete IBM Query/400 Discovery Tool to generate documentation of their Query/400 object libraries, tables, columns, selection criteria, and result fields. If you use third-party solutions, ask your software vendors for advice on how to generate this information.

  • Database Access—Documentation showing what reports access what tables and columns so that you can cross-reference database changes in a new application software release with the reports that access them and identify those that should be tested. Hopefully, you can output this information to a database table so that you can look at it in various ways via queries or a program documentation utility.

  • Report Origin—Documentation identifying who the report developers are, when a report was created, who last changed it, and when it was last changed. Depending on your regulatory environment or company policy, you may need to enforce change-management controls over some reports. If so, you may want to investigate query and report-writing solutions that allow you to maintain an audit trail of your changes and copies of previous report definitions.

  • Report Dependencies—Documentation identifying reports that require output from other jobs or initiate other processes such as exit programs, other reports, file transfers, and email messages when finished. Business users commonly work around query tool limitations by writing queries that must be run sequentially to generate temporary files required to produce a single report. Don't assume the last job in the sequence is all you need to understand.

  • Report Integration—Documentation identifying internally developed reports that are executed from application menus, web pages, or portals. Even vendor-supported ERP systems may have links to custom reports that are not part of the vendor's supported release.

  • Data Transfers—If applicable in your environment, documentation of the jobs that extract and transfer data from your online transaction processing (OLTP) database to a data warehouse. This topic is outside the scope of this article. We only mention it because we've received calls from customers who discovered their nightly data transfer had failed but had no documentation to help them identify the jobs they needed to test, change, or run.

Reports and reporting processes are an integral part of operations. As reporting and business intelligence (BI) software extends to more users and use of data-driven analytics gains momentum, companies should invest the time required to create and maintain thorough documentation of their custom reports and reporting processes. Operating without report and report-processing documentation is a significant and costly oversight that is easily avoided.


Bill Langston

Bill Langston is the Director of Marketing for New Generation Software, Inc. (NGS), a developer of query, reporting, and business intelligence software for the IBM i. He has worked closely with IBM i customers, business partners, and software developers supporting IBM midrange and Power Systems business application software for over 30 years. He can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it..



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: