02
Sat, Nov
2 New Articles

Use String Manipulation Built-In Functions to Process External Files

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

With the right RPG tools, you can make the most challenging data manipulation project fun.

 

Dealing with interface files from external systems is always an involved exercise in data validation. It's also a prime opportunity for using the string manipulation built-in functions (BIFs) available in RPG ILE.

 

Suppose you receive from an external system a file that is not available in an XML format, so you are required to process an ASCII text file. You have to be able to handle it and process it, especially if it contains data that generates revenue. You don't want to reject or misinterpret a single record, so you need to process that data and convert it into a usable format.

 

Here are some string manipulation BIFs that we will be using in our data-processing example program:

 

  • %TRIM(string)--This function returns a string that is the result of removing the leading and trailing blanks from the string passed in as the TRIM parameter.

 

  • %TRIML(string)--This function returns a string that is the result of removing only the leading blanks from the string passed in as the TRIML parameter.

 

  • %TRIMR(string)--This function returns a string that is the result of removing only the trailing blanks from the string passed in as the TRIMR parameter.

 

  • %SUBST(string:start{:length})--%SUBST returns a portion of the string that is passed in as the parameter. It will start at the position indicated in the second parameter. If the third parameter is not specified, it will return the portion from the starting position to the end of the string. If the third parameter is specified, it will return the part of the string from the starting position to include the number of characters specified in the third parameter. The first character position of the string parameter has a starting index value of 1. You could also use the %SUBST function on the left side of the EVAL statement to set a specific set of bytes within the character string.

 

  • %XLATE(from-characters: to-characters: string{: start position})--The %XLATE BIF will translate all instances of the from-characters specified in the first parameter into the to-characters specified in the second parameter. The value returned will have the character translations performed on the string that is passed in the third parameter. You can optionally specify the starting position of the translations.

 

  • %CHECK(comparator: base {:start})--%CHECK is used to check the characters of the base string to make sure that all of the base characters are contained within the comparator. If all of the characters in the base are contained within the comparator, the result will be zero. If a character is found in the base that is not contained in the comparator, the position of the first character in the base that is not contained in the comparator will be returned.

 

  • %CHECKR(comparator: base {:start})--%CHECKR isthe same as %CHECK except that it goes from right to left instead of left to right. This is good for finding unspecified characters from the back of the string.

 

Here is a simple program that emulates a worst-case file record read without the file input/output complexities to distract from the main objective of string manipulation. I've created a simple string to represent a read operation that acts as a single line of data from an external file.

    

D inputBytes      S             42A

 

D subBytes        S             10A

 

D numberBytes     S             10A

 

D junkInBytes     S             10A

 

D junkOutBytes    S             10A

 

D displayBytes    S             52A

 

D posi            S             10I 0

 

D*   XLATE STRUCTURE FOR LOWER TO UPPER CASE CONVERSION + X'3A' FOR E'*

 

D lc              S             27A 

D uc              S             27A  

 /free

 

  // Lowercase and Uppercase Characters

 

  lc = 'abcdefghijklmnopqrstuvwxyz';

 

  uc = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';

 

  // ALSO include conversion of Acute Accent "E'" to "E" in Cafe' ***

 

  lc = %TRIM(LC) + X'3A';

 

  uc = %TRIM(UC) + 'E';

 

  junkInBytes = ':"''-,';

 

  junkOutBytes = '     ';

 

  numberBytes = '1234567890';

 

  inputBytes = '   319 '

 

             + 'Caf' + X'3A'

 

             + ', "Double" ''Quotes'':'

 

             + ' 1208-0807    ';

 

  displayBytes = '[' + inputBytes + ']';

 

  DSPLY displayBytes;

 

 

In the string, you can see spaces at the beginning and end of the string, an acute accent e, double quotes, single quotes, a colon, and a hyphen between the last numbers just for good measure.

 

When %trim is executed, you will see that both the leading and trailing blanks were removed.

 

  // trim

 

  displayBytes = '%trim['

 

               + %trim(inputBytes)

 

               + ']';

 

  DSPLY displayBytes;

 

 

When %trimR is executed, only the trailing blanks are removed.

 

  // trimR

 

  displayBytes = '%trimR['

 

               + %trimR(inputBytes)

 

               + ']';

 

  DSPLY displayBytes;

 

 

When %trimL is executed, only the leading blanks are removed.

 

  // trimL

 

  displayBytes = '%trimL['

 

               + %trimL(inputBytes)

 

               + ']';

 

  DSPLY displayBytes;

 

 

Using a combination of %check and %trimL, we are able to retrieve the first numeric value, which could have possibly been passed as a number in a right-justified field.

 

  // Using Check to get the Front Number.

 

  posi = %check(numberBytes:%trimL(inputBytes));

 

  subBytes = %subst(%trimL(inputBytes):1:posi);

 

  displayBytes = 'Front # ['

 

               + %trim(subBytes)

 

               + ']';

 

  DSPLY displayBytes;

 

 

Using a combination of %checkR and %trimR, we can retrieve the last numeric value, which could have possibly been passed as a number in a left-justified field.

 

 

  // Using CheckR to get the Back Number.

 

  posi = %checkR(numberBytes:%trimR(inputBytes));

 

  subBytes = %subst(%trimR(inputBytes):posi+1);

 

  displayBytes = 'Back # ['

 

               + %trim(subBytes)

 

               + ']';

 

  DSPLY displayBytes;

 

 

Retrieving the numbers at both the front and back of the string, the %subst BIF was used to pull the specified characters from the main string.

 

The lc->UC line shows the %xlate BIF providing one means of converting all of the lowercase letters to uppercase, with an additional conversion for the acute accent e.

 

  // XLATE to UPPER Case

 

  displayBytes = 'lc->UC['

 

               + %xlate(lc:uc:inputBytes)

 

               + ']';

 

  DSPLY displayBytes;

 

 

The junk line shows the %xlate BIF in action again, removing any characters that you may find undesirable in your database when bringing the information in. Of course, junk is in the eye of the developer, so your list of undesirable characters may differ.

 

 

  // Strip the Junk

 

  displayBytes = 'junk['

 

               + %xlate(junkInBytes:junkOutBytes:inputBytes)

 

               + ']';

 

  DSPLY displayBytes;

 

 

And the clean line has the kitchen sink thrown at it, where all of the modifications were applied to the data to provide the intended clean results.

 

  // All Cleaned Up

 

  displayBytes = 'clean['

 

               + %trim(%xlate(lc:uc:

 

                 %xlate(junkInBytes:junkOutBytes:inputBytes)))

 

               + ']';

 

  DSPLY displayBytes;

 

  *inlr = *ON;

 

 /end-free

 

The Output

After running the program, you will see this output :

 

 > call mcpress

     DSPLY  [   319 Caf , "Double" 'Quotes': 1208-0807 ]

     DSPLY  %trim[319 Caf , "Double" 'Quotes': 1208-0807]

     DSPLY  %trimR[   319 Caf , "Double" 'Quotes': 1208-0807]

     DSPLY  %trimL[319 Caf , "Double" 'Quotes': 1208-0807 ]

     DSPLY  Front # [319]

     DSPLY  Back # [0807]

     DSPLY  lc->UC[   319 CAFE, "DOUBLE" 'QUOTES': 1208-0807 ]

     DSPLY  junk[   319 Caf    Double   Quotes   1208 0807 ]

     DSPLY  clean[319 CAFE   DOUBLE   QUOTES   1208 0807]    

 

When the strings are displayed, they are surrounded by brackets to identify any leading and trailing blanks. In the final line of the output, you will see the results of applying all of the string manipulations, ending up with only the shiny, happy characters that will be entered into the database.

 

You may laugh, but I have actually had files that contained every one of these instances in a single file! No lie! But I am not one to say that it can't be done, so I did what I had to do.

Download the Code

You can download the code used in this article--as well as the fixed-format version--by clicking here.

The Right Tools for the Job

With the right RPG tools, you can take the most challenging data and make a fun project out of it.

 

Thomas Snyder

Thomas Snyder has a diverse spectrum of programming experience encompassing IBM technologies, open source, Apple, and Microsoft and using these technologies with applications on the server, on the web, or on mobile devices.

Tom has more than 20 years' experience as a software developer in various environments, primarily in RPG, Java, C#, and PHP. He holds certifications in Java from Sun and PHP from Zend. Prior to software development, Tom worked as a hardware engineer at Intel. He is a proud United States Naval Veteran Submariner who served aboard the USS Whale SSN638 submarine.

Tom is the bestselling author of Advanced, Integrated RPG, which covers the latest programming techniques for RPG ILE and Java to use open-source technologies. His latest book, co-written with Vedish Shah, is Extract, Transform, and Load with SQL Server Integration Services.

Originally from and currently residing in Scranton, Pennsylvania, Tom is currently involved in a mobile application startup company, JoltRabbit LLC.


MC Press books written by Thomas Snyder available now on the MC Press Bookstore.

Advanced, Integrated RPG Advanced, Integrated RPG
See how to take advantage of the latest technologies from within existing RPG applications.
List Price $79.95

Now On Sale

Extract, Transform, and Load with SQL Server Integration Services Extract, Transform, and Load with SQL Server Integration Services
Learn how to implement Microsoft’s SQL Server Integration Services for business applications.
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: