21
Sat, Dec
3 New Articles

RPG Fundamentals Tip #1: Working with Cycle Main Programs

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

 

 

In cycle main programs, the compiler automatically includes the RPG cycle to provide program initialization and termination as well as ordered processing steps for file input and output (I/O).

 

Editor’s note: This article is excerpted from Programming in ILE RPG, Fifth Edition, chapter 14, “Building Modular Programs with Procedures.”

Up to now, all the RPG programs we’ve discussed [in this chapter] have been cycle main programs. A cycle main program has a main procedure implicitly specified in the main section of the program. In a cycle main program, the main procedure does not have a name; it is the main procedure by virtue of its location in the program code. A cycle main program includes a main source section (the main procedure), followed by zero or more subprocedure sections. The main procedure is everything before the first Dcl-proc instruction. You need not code anything special to define the main procedure. It does not begin with a Dcl-proc instruction or end with an End-proc instruction. The cycle main program is so called because the compiler automatically includes the RPG cycle to provide program initialization and termination as well as ordered processing steps for file input and output (I/O). Most traditional RPG programs are cycle main programs.

To understand the basic coding requirements for a cycle main program, let’s look at an example. The following program demonstrates how to code a main procedure and include the example Celsius subprocedure within the same source, an architecture sometimes called a local procedure. Although the program is complete as shown, we have abbreviated it to concentrate those lines that relate to procedures.

// ----------------------------------------------------

//

// Program – THISPGM – Displays Celsius temperature and

//                     corresponding water state

//

// ----------------------------------------------------

// ------------------------- Cycle main procedure PR/PI

Dcl-pr Thispgm Extpgm;

  *N Int(5);

End-pr;

Dcl-pi Thispgm;

  Englishtemp Int(5);

End-pi;

// ----------------------------------------- Prototypes

Dcl-pr Celsius Int(5);

  *N Int(5);

End-pr;

// ----------------------------------- Global variables

Dcl-s Message    Char(50);

Dcl-s Metrictemp Int(5);

Dcl-s State      Varchar(8);

// ------------------------------------- Main procedure

Metrictemp = Celsius(Englishtemp);

Select;

  When Metrictemp < 0;

    State = 'solid';

  When Metrictemp = 0;

    State = 'freezing';

  When Metrictemp = 100;

    State = 'boiling';

  When Metrictemp > 100;

    State = 'gaseous';

  Other;

    State = 'liquid';

Endsl;

Message = 'At ' + %Char(Englishtemp) + ' degrees (' +

          %Char(Metrictemp) + ' Celsius), water is ' +

          State + '.';

Dsply Message;

*Inlr = *On;

Return;

// ----------------------------------------------------

//

// Procedure – Celsius – Converts Fahrenheit to Celsius

//

Dcl-proc Celsius;

  // ------------------------------ Procedure interface

  Dcl-pi *N Int(5);

    Fahrenheit Int(5);

  End-pi;

  // ---------------------------------- Local variables

  Dcl-s Temperature Int(5);

  Eval(H) Temperature = (5/9) * (Fahrenheit - 32);

  Return Temperature;

End-proc Celsius;

Notice the declarations in this program under the Global variables comment for Message, Metrictemp, and State. Those variables, which you define before the main procedure, have a global scope and can be accessed from anywhere in the compile unit. If you have a need to do so, the Celsius subprocedure can also process any of those variables as well as the Englishtemp parameter, which is also global. The main procedure in a cycle main program cannot declare local variables or access a subprocedure’s local variables.

Tip: Generally, you should define variables with the narrowest scope that will accomplish your program’s goal. Instead of accessing global variables in a subprocedure, you should pass parameters to share information between the main procedure and any subprocedures. In a large program consisting of many modules, this practice helps avoid confusion and errors and makes your programs easier to maintain.

The main procedure of this program accepts one parameter, Fahrenheit, and then executes the Celsius subprocedure to convert that value to Celsius. It then assigns a (sea level) state based on the temperature and builds a message along the lines of “At 20 degrees (-7 Celsius), water is solid.” Finally, the Dsply (Display Message) operation shows the message on the workstation that is running the program (or sends the message to the job log).

The Celsius subprocedure is coded following the main procedure. In a cycle main program, the main procedure code ends once it encounters the first subprocedure. The main procedure code should end with *Inlr set to *On to ensure proper cleanup after the program has completed. The cycle then automatically closes files, unlocks data areas, and frees memory used by the program.

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: