29
Fri, Nov
0 New Articles

Import CSV Files with File Correcting

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

Build your own user-friendly CSV file-upload programs.

 

Editor's note: This article is an excerpt from the new MC Press book Flexible Input, Dazzling Output with IBM i.

 

This chapter presents a user-friendly CSV file upload program. While the program itself is simple, it uses some interesting procedures to recover records with the most common user errors in the CSV file. In chapter 6, this program is used to send (via email) an MS Excel file with the records that couldn't be recovered, among other things. MS Excel file creation is explained in chapter 7, and the FTP transfer that puts the CSV file in the IFS is in chapter 1. It's advisable to read chapters 1, 2, and 3 before continuing.

 

In chapters 1 and 2, you learned how to automate file upload to your IBM i system using FTP. However, if the file doesn't arrive via email, someone from the IT department will still have to upload the file to the IFS, because the end-user won't do it or might delete something that shouldn't be deleted.

 

The program presented here provides you with a template, which will enable you to build your own user-friendly CSV file-upload programs. The program is simple, but it establishes some good practices that I really recommend that you follow.

 

Imagine the following scenario: your company receives a shipment of items to be logged into your inventory. Along with the shipment comes a CSV file that the end-user checks and, if necessary, changes by adding or removing records, changing item quantities, and so on. When the CSV and the shipment are in sync, it's time to log the items into the inventory. To do that, the user calls the INVIMP sample program, as shown in Figure 5.1.

 

082014RafaelFig05-01 

Figure 5.1: The main screen of the INVIMP program for logging inventory.

 

The user needs to put the CSV file in the folder indicated on the screen (C:\, in the example in Figure 5.1) and fill the File Name field with the CSV file name. Then, by pressing F20, the CSV file is transferred to the IFS, checked for errors, copied to a temporary physical file, and has its valid records logged into the company's inventory. The invalid records are written to an MS Excel file with the same structure as the input CSV file and sent, via email, to the user who ran the program. This allows the user to correct the errors, save the file as CSV, and upload it again.

 

Let's analyze the upload functionality step by step, starting with the program's user interaction. (The email functionality is discussed in the next chapter.)

Main Program Analysis

When the program is called, a few "behind the scenes" things happen. The folder where the CSV file is expected to be placed is dynamic, is stored in a data area, and needs to be shown on screen. The folder where the FTP script that will run a bit later on is also dynamic and—you guessed it—also stored in a data area. So, the first thing to do is to read those data areas and put the CSV file folder on screen. Even though the program is able to handle a long path, up to 207 characters, I advise you to keep it as short as possible. Otherwise, you might have problems with the FTP transfer (more on this later). After this, the program's main cycle can begin and follow its course until the user presses F3 to leave.

 

Here's the code for data area loading and preparing, and for the main cycle:

 

// Load the folder paths

ExSR Load_Paths;

 

// Main Loop

DoW *InKC <> *On;

 

// Show Main screen

ExFmt INVIMP01;

 

// Initialize Indicators/Messages

ExSR Init_Ind_Msg;

 

// Main process

Select;

When *InKC = *On;

   // Dummy - Exit Program

 

When *InKL = *On;

   // Cancel user input (clear screen fields)

   ExSR Cancel_Input;

 

When *InKU = *On;

   // Validate user input

   ExSr Vld_Screen;

   If (W_Screen = *Off);

     // Validate and Load file

     ExSr Vld_Load_File;

   EndIf;

 

Other;

   // Initialize Indicators/Messages

   ExSR Init_Ind_Msg;

   // Validate user input

   ExSr Vld_Screen;

EndSL;

 

EndDo;

 

// End Program

*InLR = *On;

 

Don't worry, I'll explain all the subroutines mentioned here as we follow the program's cycle.

 

(…)

 

The subroutine Load_Paths' code (not shown here) is dynamic enough to handle any path length, filling the necessary screen fields. After this, the screen is shown and the user can interact with the program. When F20 is pressed, subroutine Vld_Screen is invoked:

 

// ----------------------------------------------------------------------

// Subroutine: Validate user input

// ----------------------------------------------------------------------

BegSR Vld_Screen;

 

W_Screen = *Off;

 

// If the file name has been filled, show F20 function key

If FileName = *Blanks;

   W_Screen = *On;

   *In21 = *On;

Else;

   *In21 = *Off;

EndIf;

 

// The file extension must be .CSV

If %Scan('.CSV' : FileName) = *Zeros;

   W_Screen = *On;

   *In23 = *On;

Else;

   *In23 = *Off;

EndIf;

 

EndSR;

 

This subroutine checks if the file name was in fact filled in and if it ends with .CSV, because the file name length is important for the FTP transfer. The errors are handled "old school" with indicators that are linked to error messages on the display file. If everything is OK, subroutine Vld_Load_File is called to handle the CSV file's validation and transfer to the IFS:

 

// ----------------------------------------------------------------------

// Subroutine: Validate and Load file

// ----------------------------------------------------------------------

BegSR Vld_Load_File;

 

// Check if the process can continue

If W_Load_File = *On;

   // Retrieve the file load delay

   ExSr Rtv_Delay;

 

   If W_Load_File = *On;

     // Transfer the file for the CSV input folder to the IFS

     ExSr Transfer_File;

 

     If W_Load_File = *On;

       // Wait for the FTP transfer to end before trying to process

       ExSr Delay_FTP;

 

       // The delay required this workaround to prevent the screen

       // from going black until the end of the process

       WRITE INVIMPW04;

 

       // Copy the data from the CSV to the temporary physical file

       ExSR COPY_CSV_PF;

 

       IF W_Load_File = *On;

       // The delay required this workaround to prevent the screen

       // from going black until the end of the process

         WRITE INVIMPW05;

 

         // Load data to the inventory file

         ExSr Load_Inv_PF;

 

         If W_Load_File = *On;

           // Delete the CSV file from the IFS

           ExSr Del_CSV;

           // Show success screen

           // with a warning note in case one or more records couldn't

           // be processed

           If W_TotErr > *Zeros;

            TotErrMsg1 = 'However, ' + %Char(W_TotErr) + ' errors ' +

                         'were found.';

             TotErrMsg2 = 'Check the log file sent to your mailbox.';

             TotErrMsg3 = *Blanks;

 

           Else;

             TotErrMsg1 = *Blanks;

             TotErrMsg2 = *Blanks;

             TotErrMsg3 = *Blanks;

           EndIf;

           ExFmt INVIMPW02;

           // Initialize screen fields

           ExSr Init_Scrn_Fields;

         EndIf;

 

       Else;

         // Process screen errors

         ExSr Prc_Scrn_Errors;

       EndIf;

 

     Else;

       // Process screen errors

       ExSr Prc_Scrn_Errors;

     EndIf;

 

   Else;

     // Process screen errors

     ExSr Prc_Scrn_Errors;

   EndIf;

EndIf;

 

EndSR;

 

The first task it performs is transferring the file to the IFS, using FTP. Subroutine Transfer_File takes care of that:

 

// ----------------------------------------------------------------------

// Subroutine: Transfer the file for the CSV input folder to the IFS

// ----------------------------------------------------------------------

BegSR Transfer_File;

 

// Compose transfer path

W_PathScript = %Trim(PathFile1) + %Trim(PathFile2) + %Trim(PathFile3);

 

 

// Determine the system type (UAT or PRD) in order to set the correct

// transfer details

If ProductionSys;

   P_Cmdlin = 'STRPCCMD PCCMD(' + '''' + %Trim(W_ScriptFolder) +

               '\INVIMP\PRD_Transf_INV.BAT ' + %TRIM(FileName) +

              ' ' + '"' + %TRIM(W_PathScript) + '"' + '''' + ') +

               PAUSE(*NO)';

Else;

P_Cmdlin = 'STRPCCMD PCCMD(' + '''' + %Trim(W_ScriptFolder) +

             '\INVIMP\UAT_Transf_INV.BAT ' + %TRIM(FileName) +

             ' ' + '"' + %TRIM(W_PathScript) + '"' + '''' + ') +

             PAUSE(*NO)';

EndIf;

P_Cmdlen = %LEN(%TRIM(P_CmdLin));

 

// Run the FTP transfer

CALLP(E) $QCMDEXC(P_Cmdlin: P_Cmdlen);

 

IF %Error;

   // Show the error on screen

   W_Error_Nbr = 1;

   W_Load_File = *Off;

EndIf;

 

EndSR;

 

The subroutines uses function ProductionSys to determine if the program is running on a production system or a UAT (user acceptance test) system. Basically, it does this by reading a data area named DASYSTYPE and returning *On if its value is P. This is important, because if you have more than one IBM i system, each one will have its own system names, users, and passwords. That's why there are two batch files—you must customize each of them with your production and test credentials.

 

Finally, the FTP transfer takes place. This is achieved by opening a command line window with the STRPCCMD command. The problem is that the window is open, and the program resumes execution. Since the CSV file can take anywhere from a few seconds to a few minutes to transfer, it's necessary to wait for the transfer to complete before continuing. In other words, you need to delay the program's execution. That's what subroutines RTV_Delay and Delay_FTP do. I won't show every single subroutine here, so please check the downloadable source code that accompanies this book if you're curious about how this delay is done.

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

$

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: