13
Wed, Nov
5 New Articles

Oh, Those Pesky Character Sets

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

Did you know that national language support, or character sets (CCSIDs), behave differently than you might expect? If you have an RPG IV source member that you compile in the U.S., it likely uses CCSID 37 as the CCSID for the resulting *MODULE object. Why? Because that's what the source file member's CCSID is.

But what if that same module is placed into a program or service program that is run in Italy, India, Spain, or a South American country?

When a program or service program is run, the fields in it contain data. That data normally originates from a file input operation or from the user typing the data into the user interface. The data, when stored in the fields in the program, is in the CCSID of the job running the program. This may not be the same CCSID used to create the program.

So far this isn't too interesting...until you discover that literals stored in named constants, stored in initial values of fields, or hard-coded in the Calc specs are stored in the CCSID of the *MODULE object—that is, the CCSID of the source member that was compiled to create the module.

Why is this a possible problem? Because if you have certain symbols in your named constants or literals that are being compared to data in fields, that comparison could fail.

Certainly, this isn't a bug in the compiler—there has to be some method of storing literals—but it should be more obvious, and that's what we'll address today.

Take the following example RPG IV source code:

     D mySymb          C                   Const('@#$&')
     D myField         S             10A
     D nPos            S             10I 0

     C                   eval      nPos = %check(mySymb:myField)

If you run this routine on the iSeries box on which it is compiled, everything will work as expected. But if you move it to another system, one with a different CCSID, it may work differently. Why? Because if the content of MYFIELD is created by reading the information from a database file or from user-entered data, the CCSID of those files may not be the same as the one used to compile the program. Therefore, if the user enters a pound sign (#), it may not have the same bit pattern as the pound sign stored in the MYSYMB named constant.

The pound sign(#), "at" sign (@), dollar sign ($), ampersand (&), and many other symbols are not irreverent characters. This means they may or may not exist in other CCSIDs. If they do exist, they may have a different bit pattern than that of the named constants in your program.

The original literals for @, #, $, and & are stored in the program in CCSID 37 if the program is compiled in North America. But a user from Italy, for example, may be using a CCSID of 280 for the job.

For example, @ and # are hex codes X'7C' and X'7B', respectively, in CCSID 37, but in CCSID 280, they are hex codes X'B5' and X'B1', respectively. So if, for example, you're scanning for @ in a field to look for an email address, guess what? It won't be correctly located.

The solution is sort of interesting, but not obvious.

First, you might think all you have to do is move the @ to a field. Nope. That's not the answer. Any literal is stored in the CCSID of the *MODULE, whether it is used in a quoted string on the Calc specs, inside a CONST keyword when defining a named constant, or as the initial value on the INZ keyword when defining a field.

The next idea you might have is to use iconv(). (See "Converting Between Character Sets" for more information.) You might think, as I originally did, that if you convert a field containing the data to the target CCSID, it should be OK. But again, the problem is knowing the CCSID of the *MODULE. The only way to know that is to call the QBNLPGMI API to list the modules in the program, find the one you're in, and link-list to the entry for that module, and then look in positions 213 to 216 (which have a 10i0 value) of the entry for the module's CCSID. Needless to say, this isn't a good solution.

I came to the conclusion that the only way to do this kind of thing was to create a file in CCSID 37on my North American CCSID 37 machine, store all the characters in it, and then ship that file with my programs. Of course, I wasn't too excited about that.

Then, suddenly, I had an epiphany. As I was updating my book The Modern RPG IV Language, I was working on the information about the %UCS2 built-in function. One of the benefits of the %UCS2 implementation is that you can use that built-in function on the Definition specifications. For example, you can specify %UCS2 as the initial value for a field or named constant. Here's an example:

     D mySymbs         S             10C   Inz(%UCS2('@#$&')) 
     D myLocalSymbs    S             10A

What's the big deal, you ask? Well, this causes the field MYSYMBS to be declared with its initial value set to the UCS2 string in the UCS2 character set, which is CCSID(13488).

It turns out that our friendly and reliable %CHAR built-in function will then allow us to convert the data in the UCS2 field into the CCSID of the job running the program.

All I have to do is add one line of code to convert from UCS2 to the CCSID of the job, as follows:

     C                   eval      myLocalSymbs = %char(mySymbs) 

Now I've got my special characters stored in a "real" field in the CCSID of the job. I can do a %CHECK, %SCAN, or whatever I want, and I won't have the bit-pattern-matching problems we saw earlier.

Whew!

For your convenience, I've set up two Web pages that allow you to look at or compare text in different CCSIDs. The first is my EBCDIC-to-ASCII table. This page illustrates all 256 bit patterns for a character and shows you the hexadecimal values for EBCDIC, PC ASCII, and several other character sets. The second is an AJAX-based Web page that displays the hexadecimal value for any text you type in. The kicker is that you get to specify the CCSID value of the data that is displayed. For example, you can type in "The quick brown fox" and ask that it be displayed in CCSID 819. Of course, the textual data shown in the Web browser is in the CCSID of the browser, but the hexadecimal representation is in the target CCSID.

Problem solved. Finally!

Bob Cozzi is a programmer/consultant, writer/author, and software developer of the RPG xTools, a popular add-on subprocedure library for RPG IV. His book The Modern RPG Language has been the most widely used RPG programming book for nearly two decades. He, along with others, speaks at and runs the highly-popular RPG World conference for RPG programmers.

BOB COZZI

Bob Cozzi is a programmer/consultant, writer/author, and software developer. His popular RPG xTools add-on subprocedure library for RPG IV is fast becoming a standard with RPG developers. His book The Modern RPG Language has been the most widely used RPG programming book for more than a decade. He, along with others, speaks at and produces the highly popular RPG World conference for RPG programmers.


MC Press books written by Robert Cozzi available now on the MC Press Bookstore.

RPG TnT RPG TnT
Get this jam-packed resource of quick, easy-to-implement RPG tips!
List Price $65.00

Now On Sale

The Modern RPG IV Language The Modern RPG IV Language
Cozzi on everything RPG! What more could you want?
List Price $99.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: