29
Fri, Nov
0 New Articles

Converting Data

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

The need to convert between PC ASCII and EBCDIC is pretty widespread, and I'm always getting emails asking for a way to do this type of conversion. Of course, my first suggestion is to use the RPG xTools ToAscii() and ToEbcdic() subprocedures. They use a higher-speed and less-restrictive method to do the conversion than the alternative method I'll present here.

Of course, not everyone has RPG xTools (I hope most of you do something about that this coming year), so I decided to provide a solution I've had since back in the days of System/38. QDCXLATE is an API that has been around for about 20 years. IBM changed the name to QTBXLATE, but nobody seemed to pick up on that, so IBM now supports calling it by either name.

Unlike other methods, QDCXLATE uses a table stored in QUSRSYS, QSYS, or a user-specified library name.

QDCXLATE has an unconventional parameter list. Since it was created back when APIs were not really part of OS/400, the developers didn't really have a set of standards to follow. These early pre-APIs include QCMDEXC, QCMDCHK, QCLSCAN, QDCXLATE, and a few others.

To make this function work effectively and make it easy to call, I've created a simple wrapper procedure for it. This procedure allows you to pass in the data to be converted, along with the length of the data. Optionally, you may override the translation table being used to do the translation. If you don't specify a translation table, the default is to convert the input data to ASCII using the QASCII table in QSYS.

The procedure name is CVTDATA (convert data), and it accepts four parameters:

  • szData—The input data. Specify any character variable up to 32K in length. The data in this field will be converted in place. This means the data in the field itself will be translated.
  • nLen—The length of the input data specified on parameter 1. Specify the length of the data or the length of the field. Remember, if you want trailing blanks to be converted, specify the length of the field. If you do not want the trailing blanks, specify the length of the data by wrapping %trimR(var) in a %LEN() function as follows: %len(%trimR(myData))
  • szTable (optional)—The name of the translation table to be used to convert the data. By default, QASCII in QSYS is used. While any translation table may be specified, the two primary tables that are specified for this parameter are QASCII (to convert to ASCII) and QEBCDIC (to convert to EBCDIC).
  • szTableLib (optional)—The library name of the translation table specified on parameter 3. If no library name is specified, QUSRSYS is searched, and then QSYS is searched, and then the library list is searched.

To call this procedure, you need to /INCLUDE or /COPY the prototype for the CVTDATA procedure. I've included the prototype in the source code and highlighted the starting and ending prototype statements.

The return value is 0 if everything goes fine, and -1 if an error is detected during the translation.

Calling CVTDATA

To call the CVTDATA procedure, you need to pass in the data to be converted and the length of the data. Nothing else is required. The input data will be converted to ASCII. Here is an example:

callp     CvtData(myData:%len(myData))

In this example, the data in the field MYDATA is convert to ASCII. Note that since I'm passing in %LEN(MYDATA), the entire field is converted. Had I passed in %LEN(%TRIMR(MYDATA)), then only the data would be converted, not the trailing blanks.

To convert this data back to EBCDIC, you would call the CVTDATA procedure and specify the QEBCDIC value for the third parameter, as follows:

callp     CvtData(myData:%len(myData):'QEBCDIC')

Note that the translation table is quoted.

To more fully illustrate how this procedure works, I wrote a short test program that illustrates its functionality:

      OPTION(*NODEBUGIO:*SRCSTMT)
      /IF   DEFINED(*CRTBNDRPG)
      DFTACTGRP(*NO)
      /ENDIF

      /COPY NEWSLETTER/QCPYSRC,CVTDATA

     D myData          s             32A   Inz('Robert Cozzi, Jr.')
     D e_Data          s             32A
     D a_Data          s             32A

     C                   eval      *INLR = *ON
      **  To ASCII
     C                   callp     CvtData(myData:%len(myData))
     C                   eval      a_Data = myData
      **  To EBCDIC
     C                   callp     CvtData(myData:%len(myData):'QEBCDIC')
     C                   eval      e_Data = myData
     C                   return

In this test program, the field MYDATA is convert to ASCII. The resulting ASCII data is then copied to the field named A_DATA. Then MYDATA is converted (from ASCII) back to EBCDIC. The EBCDIC data is copied to the field named E_DATA.

Put this program in debug mode and set break points just after each of the two CALLP statements. Then, inspect the MYDATA field and the content of the A_DATA and E_DATA fields.

The CVTDATA subprocedure source code is illustrated below.

     H NOMAIN  OPTION(*NODEBUGIO:*SRCSTMT)
      **  -------START-PROTOTYPE -- COPY to QCPYSRC/CVTDATA  --------
     D CvtData         PR            10I 0
     D  szData                    32767A   OPTIONS(*VARSIZE)
     D  nLen                         10I 0 Const 
     D  szTable                      10A   Const OPTIONS(*NOPASS)
     D  szTableLib                   10A   Const OPTIONS(*NOPASS)
      **  -------END-PROTOTYPE---------------------------------------

     P CvtData         B                   Export
     D CvtData         PI            10I 0
     D  szData                    32767A   OPTIONS(*VARSIZE)
     D  nLen                         10I 0 Const
     D  szTable                      10A   Const OPTIONS(*NOPASS)
     D  szTableLib                   10A   Const OPTIONS(*NOPASS)

     D dftAscii        C                   Const('QASCII')
     D dftEBCDIC       C                   Const('QEBCDIC')
     D MAX_LENGTH      C                   Const(32767)

     D Qdcxlate        PR                  ExtPgm('QDCXLATE')
     D  dataLen                       5P 0 Const 
     D  cvtData                   32767A   OPTIONS(*VARSIZE
     D  xlateTable                   10A   Const 
     D  xlateTableLib                10A   Const OPTIONS(*NOPASS)

     D xlateTable      DS
     D  tblName                      10A   Inz(dftAscii)
     D  tblLib                       10A

      **  Only 32k can be converted with QDCxLate
     C                   if        nLen > MAX_LENGTH
     C                   return    -1
     C                   endif
      **  User-specified xlate table or library name
     C                   if        %Parms >= 3
     C                   if        szTable <> *BLANKS
     C                   eval      tblName = szTable
     C                   if        %Parms >= 4
     C                   if        szTableLib <> *BLANKS
     C                   eval      tblLib = szTableLib
     C                   endif
     C                   endif
     C                   else
     C                   eval      xlateTable = dftASCII
     C                   endif
     C                   endif
      ** Call QDCxLate to do the conversion
     C                   if        tblLib <> *BLANKS
     C                   callp(e)  qdcXLate(nLen : szData : tblName : tblLib )
     C                   else
     C                   callp(e)  qdcXLate(nLen : szData : tblName )
     C                   endif
     C                   if        %ERROR
     C                   return    -1
     C                   endif

     C                   return    0
     P CvtData         E

To compile this source code, you can use PDM option 15 to compile the source member, or you can use the CRTRPGMOD command to create a *MODULE:

CRTRPGMOD MODULE(RPGLAB/CVTDATA)  +
  SRCFILE(RPGLAB/QRPGLESRC)  DBGVIEW(*SOURCE)

Then, it's up to you whether you want to leave it as a module or subsequently store it in a *SRVPGM with other subprocedures.

To compile the example program that uses CVTDATA, first copy the prototype to source member QCPYSRC in your library; then, specify that source member on a /COPY statement in the program's source.

The CRTRPGMOD and CRTPGM statements to compile the test program are as follows:

CRTRPGMOD MODULE(RPGLAB/TESTCVT)  +
  SRCFILE(RPGLAB/QRPGLESRC)  DBGVIEW(*SOURCE)

CRTPGM PGM(RPGLAB/TESTCVT)  +
   MODULE(RPGLAB/TESTCVT   RPGLAB/CVTDATA)

My hope is that this helps those who need this kind of functionality. I'd also like to thank all of you for a successful year here at MC RPG Developer (yes I know, most of you didn't know that was the name of this newsletter). In the year ahead, I hope to continue to provide MC RPG Developer for free to all of you. Tell your friends about MC RPG Developer and help us keep it coming to your inbox in 2006.

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: