Wed, Jun
4 New Articles

Storing Metadata the Profound UI Way

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

Discover the benefits of using RPG OA and JSON to store metadata in the display file.

Written by Scott Klement

Editor's note: This article introduces the white paper "Storing Metadata the Profound UI Way" available free from the MC White Paper Center.


While RPG Open Access is nothing new, there's still some confusion in the IBM i community as to what it is and how it's used. Additionally, there has also been much talk lately about Open Access metadata and how it should be leveraged with regard to RPG application modernization. In this white paper, I'll explain what Rational Open Access for RPG is all about, clarify what metadata is, and cover how metadata is related to Open Access. Then, I'll explain how Profound Logic stores metadata in the Profound UI Rich Display files and why we think it's the best solution for storing metadata.

What Is Rational Open Access?

Rational Open Access for RPG (or "RPG OA" for short) is a feature of the ILE RPG programming language on IBM i 6.1 or higher. It's provided by IBM and was first available in 2010. RPG OA makes it possible to attach a "handler" to an RPG F-spec so that when you use RPG's file opcodes (EXFMT, READ, WRITE, UPDATE, etc.), it will allow the "handler" to take control and handle the output.


In the example in Figure 1, the RPG program uses the EXFMT opcode to display a screen. Without the HANDLER keyword, the RPG compiler would generate code that calls a routine in the operating system, which outputs a 5250 display. But since I added HANDLER, the routine I specified will be called instead (a subprocedure named MYPROC in a service program named MYHANDLER).


That subprocedure can then use any technique it wants to handle the EXFMT code. The code in the handler could, for example, write output to a Web page, a Web service, or even a mobile device.                     



Figure 1: Simple example of using Open Access


With RPG OA, you can attach handlers to any type of file, including display files, disk files, and printer files.


At Profound Logic, we've developed a handler for creating Web or Mobile GUI display files. Our RPG OA handler interfaces with our JavaScript framework to provide a Rich Display File that can be viewed in a Web browser or a mobile application. Our handler is in a subprocedure named HANDLER in a service program named PROFOUNDUI, and is shown in Figure 2.



Figure 2: Using the Profound UI handler


With an existing RPG program, the F-spec is the only line of code you need to change. Once you've added the HANDLER keyword, all of your file operations on that file go through the handler, so the remainder of the RPG code will work exactly as it always has, even though the PROFOUNDUI handler is now writing a beautiful GUI screen for the user to work with. That's all RPG OA does: It adds the handler keyword to the RPG language, letting you replace traditional I/O with a handler. From the user's perspective, it's extremely simple. There's nothing to learn except one new keyword on the F-spec.

What Is Open Access Metadata?

Metadata is the data that the code inside the handler needs to do its job. To illustrate this, consider the DDS code in Figure 3 that was taken from a traditional display file.



Figure 3: DDS snippet taken from a traditional display file


In Figure 3, the RPG file I/O will put fields named *IN30 and PPRICE into a record. When that record is written to the display file, these fields will be written to the display file. How does the display file know it should use the Y keyboard shift? Or the J edit code? And how does it know whether the PR or UL display attribute should be applied to the PPRICE field? It knows that from the DDS keywords, of course! But these DDS keywords are not part of the data that is passed from the RPG program to the handler. Instead, they are stored in the green-screen display file itself. In a traditional green-screen display file, the DDS keywords are the "metadata," the data that the 5250 output routines in the operating system use to understand how to interpret the information provided in the record buffer in order to produce a display.


In a modern rich display, we cannot simply use the DDS keywords such as DSPATR and EDTCDE, keyboard shifts, and so forth. If we did that, our rich displays would be limited to the same features as the legacy 5250 displays are. So we need a more powerful method of storing our metadata, a method that we can extend to add new GUI features without waiting for IBM to add DDS keywords.

Want to Know More?

Download the free white paper "Storing Metadata the Profound UI Way" from the MC White Paper Center.


Scott Klement is…



Find out more at http://www.scottklement.com/.



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: