12
Wed, Jun
4 New Articles

TechTip: BLOBs Keep PDF, XLS, and Other Reports Safe in DB2, Part 2

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

In the first part of this TechTip series, I explained what a BLOB is and how it works. Now, I'll provide you with the tools to use this little-known and underestimated DB2 feature.

 

In the previous TechTip, I covered the BLOB basics, so now it's time to implement the archiving and retrieving operations in a reusable, yet simple, way.

 

First Things First; Let's Archive Something

I'll start with the archiving operation. If you remember the BLOB_IN sample program from the previous TechTip, it expected an ID, a file type, a comment and, of course, the file's full name and path in order to store it on a DB2 table (called REPORTS in this case). The Snd_File_To_Archive procedure expects the same input parameters, except for the ID, which will be the procedure's output. This way, the calling program doesn't have to generate a unique ID; the procedure takes care of that and returns the ID to the calling program, thus providing a simpler-to-use tool. If the returned ID is zero, it means the operation was not successful. It's a quick and easy way of having some control over the whole process without complicating things. Here's the procedure's complete source code:

 

     PSnd_File_To_Archive...                                

     P                 B                   EXPORT          

     DSnd_File_To_Archive...                                

     D                 PI             7 0                  

     * Input Parms                                        

     D P_FileName                 255A   Value            

     D P_Type                       10A   Value            

     D P_Comments                 255A   Value            

                                                            

     D W_ID           S             7 0 Inz(*Zeros)      

                                                            

     D W_File_In       S                   SQLTYPE(BLOB_FILE)

                                                            

                                                            

     // Store an object into the blob table                

     /FREE                                                  

       EXEC SQL   Select Max(Rpt_Id) + 1                    

                   Into :W_Id                              

                   From RptArchive/Reports;                

       If W_Id = *Zeros;                                    

         W_Id = 1;                                      

       EndIf;                                            

       W_File_In_FO   = SQFRD;                          

       W_File_In_NAME = %Trim(P_FileName);              

       W_File_In_NL   = %len(%trimr(W_File_In_NAME));    

                                                        

       EXEC SQL   Insert Into RptArchive/Reports        

                         Values (:W_ID, :P_Type, NOW(),  

                                 :P_Comments, :W_File_In);

                                                                

       // If the insert operation was successful, return the ID    

       If SQLCod = *Zeros;       

         Return W_Id;                                   

       Else;                                   

     // otherwise, return zeros to indicate something went wrong

         Return *Zeros;                     

       EndIf;                                                                                                   

     /END-FREE                                          

     PSnd_File_To_Archive...                            

     P                 E                                

 

Most of the code should be familiar because this procedure is heavily based on the first TechTip's BLOB_IN sample program. The only part that is really new is the SQL statement used to generate the unique ID. This ID is what the procedure returns if the "archiving" operation is successful. If it fails, then a zero is returned so that the calling program can proceed accordingly.

 

Well Now, What Was the Number of the File You Were Looking For?

 

To retrieve the file from the "Reports" table, I've created the Rtv_File_From_Archive procedure. Here's the procedure's complete source code:

       **************************************************************************

       * Store an IFS file into the BLOB table and return an unique ID          

       **************************************************************************

     PRtv_File_From_Archive...                                                

     P                 B                   EXPORT                              

     DRtv_File_From_Archive...                                                

     D                 PI             1A                                      

       * Input Parms                                                            

     D P_Id                          7 0 Value                              

     D P_FileName                 255A   Value                              

                                                                                

     D W_File_Out     S                  SQLTYPE(BLOB_FILE)                  

     D W_Success       S             1A                                      

                                                                                

       // Retrieve an object from the blob table                                

                                                                                

       /FREE                                                                    

       W_Sucess = '1';                                                        

       W_File_Out_FO   = SQFOVR;                                              

       W_File_Out_NAME = %Trim(P_FileName);                                    

       W_File_Out_NL   = %Len(%TrimR(P_FileName));  

                                                    

       EXEC SQL   Select Rpt_File1                  

                   Into :W_File_Out                

                   From RptArchive/Reports        

                  Where Rpt_Id = :P_Id;          

                                                    

       If SQLCod <> *Zeros;                        

         W_Success = '0';                            

       EndIf;                                      

     Return W_Success;    

                                                    

     /END-FREE                                    

     PRtv_File_From_Archive...                      

     P                 E                            

 

Again, the code should look familiar to those who read the first TechTip: this procedure was based on the BLOB_OUT sample program. It receives the unique ID of the file to be retrieved, writes it to the IFS path and file name indicated on the P_FileName parameter, and returns a success (or failure) indicator.

 

With these two procedures, you should be able to archive and retrieve files from the Reports DB2 table. Cool, isn't it?

 

Every Piece of Code Is Easier to Understand with an Example…or Two!

To consolidate all this information, let's review two very simple examples of these procedures in action. Let's begin by archiving a file with sample program TST_SND:

 

     *                                                            

     * This is a simple test program to demonstrate how to use the

     * Snd_File_To_Archive procedure                              

     *                                                            

     * Prototype definition                                      

     /Copy QCPYLESRC,DBMBLOB_PR                                  

     *                                                            

     * Function Parms                                              

     D P_FileName     S           255A   Inz                    

     D P_Type         S             10A   Inz                    

     D P_Comments     S           255A   Inz                    

                                                                    

     * Work variables                                            

     D W_ID           S             7 0 Inz                    

                                                                  

     /FREE                                                        

       P_FileName = '/Reports/Test.PDF';                          

       P_Type     = 'PDF';                                        

       P_Comments = 'Just a PDF test report';                      

 

     W_ID = Snd_File_To_Archive(P_FileName : P_Type : P_Comments);

                                                                  

     Dsply %Char(W_ID);                                          

                                                                  

     *InLr = *On;                                                

     /END-FREE                                                    

 

Not much to it, really. The program prepares the procedure's parameters and invokes it, storing the returned ID in the W_ID variable. In a real-life situation, you'd store this ID somewhere (and use more meaningful comments) to be able to find the archived file later.

 

Sample program TST_RTV provides an example of how the file can be retrieved:

 

     *                                                            

     * This is a simple test program to demonstrate how to use the

     * Rtv_File_From_Archive procedure                            

     *                                                            

     * Prototype definition                                      

     /Copy QCPYLESRC,DBMBLOB_PR                                  

     *                                                            

     * Function Parms                                            

     D P_ID           S             7 0 Inz                    

     D P_FileName     S           255A   Inz                    

                                                                  

     * Work variables                                            

     D W_OK           S             1A   Inz                    

                                                                    

     /FREE                                                        

       P_Id = 1;                                                  

       P_FileName = '/Reports/Test_Retrieved.PDF';                

                                                                  

       W_OK = Rtv_File_From_Archive(P_Id : P_FileName);            

                                                  

       If W_Ok = '1';                            

         Dsply 'File Successfully retrieved';      

       Else;                                      

         Dsply 'An error occurred';              

       EndIf;                                    

                                                  

       *InLr = *On;                              

     /END-FREE

 

Just like in the previous example, all that's required is to fill in the procedure's parameters, invoke it, and do something with the return code. In this case, if the procedure returns '1', then everything went according to plan. The file still exists on the Reports table, but a copy of it was now created on the path specified in the P_FileName parameters.

 

Final Thoughts

Note that the file and library names of the table with the BLOB column (RPTARCHIVE/REPORTS) are hardcoded on the SQL statements of both procedures. There are ways to circumvent this limitation, but I prefer to keep things simple! If you really want to integrate this into your application (in order to use your application's library and/or adjust the file name to follow your company's naming convention), remember to modify the SQL statements of the procedures to reflect those changes.

 

Be sure to copy the Reports folder from the downloadable source code zip file to your IFS's root. You'll also find a file with compilation instructions in the zip, but if you have any questions, remarks, or suggestions, feel free to contact me!

 

In the third and final part of this series, I'll revisit some older articles, providing more complex usage examples of the procedures presented here.

Rafael Victoria-Pereira

Rafael Victória-Pereira has more than 20 years of IBM i experience as a programmer, analyst, and manager. Over that period, he has been an active voice in the IBM i community, encouraging and helping programmers transition to ILE and free-format RPG. Rafael has written more than 100 technical articles about topics ranging from interfaces (the topic for his first book, Flexible Input, Dazzling Output with IBM i) to modern RPG and SQL in his popular RPG Academy and SQL 101 series on mcpressonline.com and in his books Evolve Your RPG Coding and SQL for IBM i: A Database Modernization Guide. Rafael writes in an easy-to-read, practical style that is highly popular with his audience of IBM technology professionals.

Rafael is the Deputy IT Director - Infrastructures and Services at the Luis Simões Group in Portugal. His areas of expertise include programming in the IBM i native languages (RPG, CL, and DB2 SQL) and in "modern" programming languages, such as Java, C#, and Python, as well as project management and consultancy.


MC Press books written by Rafael Victória-Pereira available now on the MC Press Bookstore.

Evolve Your RPG Coding: Move from OPM to ILE...and Beyond Evolve Your RPG Coding: Move from OPM to ILE...and Beyond
Transition to modern RPG programming with this step-by-step guide through ILE and free-format RPG, SQL, and modernization techniques.
List Price $79.95

Now On Sale

Flexible Input, Dazzling Output with IBM i Flexible Input, Dazzling Output with IBM i
Uncover easier, more flexible ways to get data into your system, plus some methods for exporting and presenting the vital business data it contains.
List Price $79.95

Now On Sale

SQL for IBM i: A Database Modernization Guide SQL for IBM i: A Database Modernization Guide
Learn how to use SQL’s capabilities to modernize and enhance your IBM i database.
List Price $79.95

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$0.00 Raised:
$

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: