24
Wed, Jul
0 New Articles

Synchronize Your Source Files

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

Use the WinMerge graphical compare and merge utility to aid with the synchronization of RPG and other i/OS source members.

 

One of the dreaded drudgeries of RPG programming is retrofitting custom modifications to application software. You know the sordid story. You've made modifications to a vendor application for the past several years, and now it's time to upgrade said software. Welcome to the challenge of putting all your changes into a new set of source code. You can enlist the help of good ol' SEU option 54 to compare two source members and generate an ugly printout of the differences. Or you can use a graphical, user-friendly tool like WinMerge!

 

WinMerge is a free open-source utility available at http://winmerge.org/. It is similar to the SEU option 54 in that it tries to "align" the similarities between two source members and highlight differences between them. Plus, WinMerge has the following great features:

 

  • The ability to show files side by side so that the differences can be viewed easily
  • A toolbar that allows you to quickly navigate to the next or previous difference in a source member and merge differing lines of source between the files
  • A "Location Pane" (on the left) that gives a quick overview of where the differences lie among two files (handy for large files)
  • A "Diff Pane" (at the bottom) that shows the differences between the current source lines
  • Highlighting for specific portions of the line that are changed, such as a variable length or a keyword on an RPG D-spec

 

030211SansoFigure1

Figure 1: This picture shows WinMerge comparing two RPG files. (Click images to enlarge.)

 

I've used WinMerge frequently over the past year to compare SQL Server T-SQL and C# source files. I recently decided to try it for IBM i projects as well. It's not limited to the RPG programming language, so any source members are theoretically "alignable" with WinMerge, including traditional programming languages (C, C++, COBOL, Java, CL, and DB2 SQL files) as well as specialized text files (HTML, XML, display files, printer files, workstation customizing objects, and sort sequence tables).

 

The real power of WinMerge is its ability to let the user quickly review and merge changes with the click of a mouse. I never liked relying on modification markers or source line date stamps when comparing source file members. Inevitably, some markers would be forgotten, and sometimes dates would be erased. WinMerge shows a "bird's eye" view of all differences in the "location pane" and allows you to navigate among differences with the click of a button.

 

When you have to fix something manually, the original code file is right there to review. If the changes in the original file (whether an insert, update, or delete) can be brought over to the new file "as is," a click of a button will do it for you. That makes life easy!

 

To use WinMerge, simply download it, install it, and run it. You'll be prompted to select two files to compare and voila! You're on your way to synchronization paradise.

Editing Stream Files on the Integrated File System (IFS)

When working on the IBM i/OS, it is now common to store source files on a local PC or the IFS. In the case of IFS storage, you can reference the file members to open using a mapped drive or using a fully qualified UNC name.

 

If you need help understanding how to make an IBM i resource such as an IFS folder available as a mapped drive, see the references at the end of this tip.

Directly Editing Source File Members

Many shops still store legacy code in source file members. Fortunately, the IFS allows access to these members via a special file system called QSYS.LIB. Using NetServer, I was able to map a drive on my Windows machine directly to a source library using the following steps:

 

  1. Create a share in NetServer using the i5/OS NetServer configuration utility in System i Navigator (found under Network>Servers>TCP/IP). The path name for the share should map to /QSYS.LIB/MYLIB.LIB where MYLIB is the name of your library containing the source files. I typically name my share the same as my library.
  2. Within the Text Conversion tab for the share, check the Allow Text File Conversion checkbox, enter a file extension type of mbr and click Add. This option will take care of the EBCDIC-ASCII character conversion issues inherent when working on a source file.

    030211SansoFigure 2
    Figure 2: Here's the window for text conversion.

  3. Once you have a share mapped, you can map a drive directly to your i/OS library. Bear in mind that you can only edit objects within source files that have a suffix of mbr (the standard suffix for source file members.)
  4. The ability to edit source members from mapped drives opens up the possibility of synchronizing source code between different libraries or even different systems.

 

Noteworthy Items for the "i"

  • When saving a file, WinMerge normally makes a backup copy with an appended extension of .bak. However, because of the naming limitations of source file members (10 characters), WinMerge can't create this backup file when editing in the QSYS.LIB file system.
  • Remember that member names are case-sensitive (all uppercase).  For example, if you have drive S: mapped to \\iSeries\MYLIB, your file name will need to look something like this: S:\QRPGLESRC.FILE\MYRPGPGM.MBR.
  • When saving a member directly to a source file, the member description is removed.
  • RPG code generated by tools such as Synon often create a large volume of dynamically named variables and subroutines. These variable names can change between source revisions. When this happens, the before and after pictures of the source code cannot always be aligned correctly, which detracts from the tool's ability to accurately show what has changed.
  • Fixed-length source members can be a pain to work with!  If you accidentally insert extraneous spaces at the end of a line, WinMerge will not be able to save. Further, WinMerge (through no fault of its own) doesn't return a clear message as to why it couldn't save the changed member.
  • Sometimes major source changes render the compare and merge utility ineffective. A good example of this occurs when fixed-format RPG is converted to free-form. The comparison utility will not do a good job of comparing C specs between these two versions.
  • Generally, I try to keep source changes minimal to maximize WinMerge's ability to align the members appropriately. However, this is not always possible.
  • For many file types, I've found that it's best to turn on the Ignore Whitespace option. Otherwise, there are just too many superfluous differences reported.

 

WinMerge isn't the only tool available in this arena. If you find it doesn't meet your needs, seek out another. WDSc and RDi developers will be happy to know that SoftLanding offers a free plug-in to aid IBM i developers with the compare and merge process as well.

 

The bottom line is that RPG developers no longer need to suffer when retrofitting legacy code. The cavalry of mature file comparison tools is here!

References

"TechTip: Map Your Network Drives to the IBM i"

as/400, os/400, iseries, system i, i5/os, ibm i, power systems, 6.1, 7.1, V7,

Michael Sansoterra is a DBA for Broadway Systems in Grand Rapids, Michigan. He can be contacted at This email address is being protected from spambots. You need JavaScript enabled to view it..


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: