22
Mon, Apr
1 New Articles

The API Corner: More on Sending Messages from an Application Program

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

Learn how to send program messages based on an API error code structure.

 

In the previous article, "Inform Users of Problems by Sending Error Messages from Application Programs," the Send Program Message (QMHSNDPM) API was used to send a user error message indicating that a severe error had been encountered. In this article, the QMHSNDPM API will also be used, but now to send a system-related error message followed by a user error message.

 

As a review, back in "What to Do with Messages in the Application Program," we saw how to call a system API with the sending of error messages disabled. The scenario used was determining if an object existed by calling the Retrieve Object Description (QUSROBJD) API and, if an error was returned in the API error code data structure, handling the error in an appropriate way. The code shown at that time was this:

 

  RObjD(QUSD0100 :%size(QUSD0100) :'OBJD0100' :QualName :Type :ErrCde);

  if ErrCde.Common.QUSBAVL > 0;                                       

     select;                                                          

        when ErrCde.Common.QUSEI = 'CPF9801';                          

             // Create the user space                                 

        when ErrCde.Common.QUSEI = '???????';                       

             // Additional error checks that I will handle          

        other;                                                       

             // Something more than I expected so send 

             // appropriate message(s) and end         

     endsl;                                                         

  endif;                                                             

                                                                    

  // Continue processing and eventually end the program normally    

 

In the previous SELECT structure, the first WHEN operation is checking the Exception ID of the API error code structure for CPF9801 – Object &2 in library &3 not found. This error message is related to an expected condition, and the program will create the object when necessary. No message to the user of the program is necessary.

 

The second WHEN operation is intended to check for exception IDs that may indicate an environmental problem rather than an application program failure. Reviewing the documentation for the Retrieve Object Description (QUSROBJD) API, the following errors might fall into this category and will be used to replace the '???????' literal used in the earlier article.

  •         CPF9802 – Not authorized to object &2 in library &3     
  •         CPF9810 – Library &1 not found     
  •         CPF9820 – Not authorized to use library &1      

 

When any of these errors are encountered, the application program will send the CPF message as a diagnostic followed by the application error message APP0002 as an escape. Here's the code to do this:

 

dApp0002          ds                  qualified  

d PgmName                       10               

dLen_MsgDta       s             10u 0       

        when ((ErrCde.Common.QUSEI = 'CPF9802') or     

              (ErrCde.Common.QUSEI = 'CPF9810') or     

              (ErrCde.Common.QUSEI = 'CPF9820'));      

             if ErrCde.Common.QUSBAVL < %size(QUSEC);              

                Len_MsgDta = 0;                                    

             else;                                                 

                Len_MsgDta = ErrCde.Common.QUSBAVL - %size(QUSEC); 

             endif;                                                

             SndMsg( ErrCde.Common.QUSEI :'QCPFMSG   *LIBL'        

                    :ErrCde.ErrMsgTxt :Len_MsgDta                  

                    :'*DIAG' :'*PGMBDY' :1 :MsgKey :QUSEC);        

             App0002.PgmName = PSDS.PgmName;                       

             SndMsg( 'APP0002' :'APPLMSGF  QGPL' :App0002          

                    :%size(App0002) :'*ESCAPE' :'*PGMBDY' :1       

                    :MsgKey :QUSEC);                               

 

Similar to how message description APP0001 was used in the previous article, the APP0002 error message has replacement data representing the name of the program. This is defined using the data structure App0002. The APP0002 message description is created using this command:

 

ADDMSGD MSGID(APP0002) MSGF(QGPL/APPLMSGF) +

 MSG('Severe error found by program &1. Notify your system administrator.') +

 SECLVL('This error indicates an environmental problem. Review the job log +

 for previous error(s) and correct them.') FMT((*CHAR 10))

 

A new variable, Len_MsgDta, is also defined. This variable is used to specify the length of the message replacement data to be used when sending the CPF error message. The length of the message replacement data is determined by examining the Bytes Available field of the API error code structure (ErrCde.Common.QUSBAVL). When a message has no replacement data, the Bytes Available field will be set to 15; otherwise, Bytes Available will be set to the length of the replacement data plus 16 bytes (to account for the Bytes Provided, Bytes Available, Exception ID, and Reserved field of the QUSEC base structure). For this reason, the application first examines ErrCde.Common.QUSBAVL and if less than 16 (the size of the QUSEC base structure) sets Len_MsgDta to 0. Otherwise, Len_MsgDta is set to the value of Bytes Available less 16.

 

The application program now sends the CPF error message reported by the API to the job log as a diagnostic message. The one assumption being made here is that the message description is in the message file QCPFMSGF. For system APIs, this is generally a safe assumption. APIs provided by other program products may use a different message file, which would require a change to the second parameter value passed to the QMHSNDPM API.

 

Having sent the CPF error message, the application now records the name of the application program in the App0002 data structure and sends message description APP0002 as an escape message to the caller of the application program. If the application has been called from the command line and library SOMELIB does not exist, the user will see these two messages:

 

Library SOMELIB not found.                                            

Severe error found by program ROBJD. Notify your system administrator.

 

The system administrator would then authorize the (presumably new) user to the library SOMELIB.

 

The OTHER operation catches all other error messages reported back to the application program from the QUSROBJD API. For these error situations, the application again sends the CPF message to the job log as a diagnostic, but now sends message APP0001 (rather than APP0002) as an escape as these "other" errors are more associated with failures within the application program (or the job itself). The mechanics of sending these messages is essentially the same as seen in the previous WHEN logic.

 

The pertinent parts of the application program are provided below.

 

dRObjD            pr                  extpgm('QSYS/QUSROBJD')         

d Receiver                       1    options(*varsize)               

d LenReceiver                   10i 0 const                           

d Format                         8    const                           

d ObjName                       20    const                           

d ObjType                       10    const                           

d ErrCde                              likeds(QUSEC) options(*nopass)  

d ASP                            1    const options(*varsize :*nopass)

                                                                      

dSndMsg           pr                  extpgm('QSYS/QMHSNDPM')         

d MsgID                          7    const                           

d QualMsgF                      20    const                           

d MsgDta                     65535    const options(*varsize)         

d LenMsgDta                     10i 0 const                           

d MsgType                       10    const                           

d CallStackEntry             65535    const options(*varsize)         

d CallStackCntr                 10i 0 const                       

d MsgKey                         4                               

d QUSEC                               likeds(QUSEC)              

d LenCSE                        10i 0 const options(*nopass)     

d CSEQual                       20    const options(*nopass)     

d DSPWaitTime                   10i 0 const options(*nopass)     

d CSEType                       10    const options(*nopass)     

d CCSID                         10i 0 const options(*nopass)     

                                                                  

 /copy qsysinc/qrpglesrc,qusrobjd                                

 /copy qsysinc/qrpglesrc,qusec                                   

                                                                 

dQualName         ds                                             

d Name                          10    inz('SOMEOBJ')             

d Lib                           10    inz('SOMELIB')             

                                                                 

dPSDS            sds                  qualified                  

d PgmName               334    343                            

                                                              

dErrCde           ds                  qualified               

d Common                              likeds(QUSEC)           

d ErrMsgTxt                    512                            

                                                              

dApp0001          ds                  qualified               

d PgmName                       10                            

                                                              

dApp0002          ds                  qualified               

d PgmName                       10                            

                                                               

dType             s             10    inz('*USRSPC')          

dMsgKey           s              4                            

dLen_MsgDta       s             10u 0                         

                                                               

 /free                                                        

                                                                      

  QUSBPRV = 0;                                                         

  ErrCde.Common.QUSBPRV = %size(ErrCde);                              

                                                                      

  RObjD(QUSD0100 :%size(QUSD0100) :'OBJD0100' :QualName :Type :ErrCde);

  if ErrCde.Common.QUSBAVL > 0;                                       

     select;                                                          

        when ErrCde.Common.QUSEI = 'CPF9801';                         

             // Create the user space                                  

        when ((ErrCde.Common.QUSEI = 'CPF9802') or                    

              (ErrCde.Common.QUSEI = 'CPF9810') or                    

              (ErrCde.Common.QUSEI = 'CPF9820'));                     

             if ErrCde.Common.QUSBAVL < %size(QUSEC);                 

                Len_MsgDta = 0;                                       

             else;                                                    

                Len_MsgDta = ErrCde.Common.QUSBAVL - %size(QUSEC);    

             endif;                                                   

             SndMsg( ErrCde.Common.QUSEI :'QCPFMSG   *LIBL'         

                    :ErrCde.ErrMsgTxt :Len_MsgDta                   

                    :'*DIAG' :'*PGMBDY' :1 :MsgKey :QUSEC);         

             App0002.PgmName = PSDS.PgmName;                        

             SndMsg( 'APP0002' :'APPLMSGF  QGPL' :App0002           

                    :%size(App0002) :'*ESCAPE' :'*PGMBDY' :1        

                    :MsgKey :QUSEC);                                

        other;                                                      

             if ErrCde.Common.QUSBAVL < %size(QUSEC);               

                Len_MsgDta = 0;                                      

             else;                                                  

                Len_MsgDta = ErrCde.Common.QUSBAVL - %size(QUSEC);  

             endif;                                                 

             SndMsg( ErrCde.Common.QUSEI :'QCPFMSG   *LIBL'         

                    :ErrCde.ErrMsgTxt :Len_MsgDta                   

                    :'*DIAG' :'*PGMBDY' :1 :MsgKey :QUSEC);         

             App0001.PgmName = PSDS.PgmName;                        

             SndMsg( 'APP0001' :'APPLMSGF  QGPL' :App0001       

                    :%size(App0001) :'*ESCAPE' :'*PGMBDY' :1    

                    :MsgKey :QUSEC);                            

     endsl;                                                     

  endif;                                                         

                                                                

  *inlr = *on;                                                  

  return;                                                       

                                                                 

 /end-free                                                      

You should now have a good feel for how to send messages using the Send Program Message API. In the future, we'll look at other capabilities of the message-handling APIs.

 

In the meantime, if you have any API questions, send them to me at This email address is being protected from spambots. You need JavaScript enabled to view it.. I'll see what I can do about answering your burning questions in future columns.

Bruce Vining

Bruce Vining is president and co-founder of Bruce Vining Services, LLC, a firm providing contract programming and consulting services to the System i community. He began his career in 1979 as an IBM Systems Engineer in St. Louis, Missouri, and then transferred to Rochester, Minnesota, in 1985, where he continues to reside. From 1992 until leaving IBM in 2007, Bruce was a member of the System Design Control Group responsible for OS/400 and i5/OS areas such as System APIs, Globalization, and Software Serviceability. He is also the designer of Control Language for Files (CLF).A frequent speaker and writer, Bruce can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it.. 


MC Press books written by Bruce Vining available now on the MC Press Bookstore.

IBM System i APIs at Work IBM System i APIs at Work
Leverage the power of APIs with this definitive resource.
List Price $89.95

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$0.00 Raised:
$

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: