20
Sat, Jul
2 New Articles

RPG Academy: BIF Up Your Code! Retrieve the Day of the Week with %DIFF

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

As you've learned, we can do some basic "date math" using the plus (+) and minus (–) operators. Let's expand on that by using the %DIFF BIF to retrieve the day of the week.

 

Like many other date-related RPG operations, adding or subtracting days, months, or years to a date can be a real pain. The previous article in this series introduced the %DATE BIF, which allows you to use the plus (+) and minus (–) operators instead of the ADDDUR and SUBDUR op codes. There's another BIF, called %DIFF, that allows you to discard these op codes completely by providing a way to calculate the difference between two dates.

 

Introducing the %DIFF BIF

%DIFF is a very versatile BIF because it can calculate the difference between two dates, two times, or two timestamps and return the result in days, months, or years (for the date data type) and hours, minutes, seconds, or milliseconds (for the time and timestamp data types). You can also calculate the difference between a date and a timestamp, but only the date portion of the timestamp is considered when the calculation is performed. Likewise, you can calculate the difference between a time and a timestamp; in this case, naturally, only the time portion of the timestamp is taken into account.

 

Let's use %DIFF to retrieve the day of the week of a given date in two steps. The first function, Clc_DayOfWeek, calculates the day of the week's "numeric value" (1 for Monday, 2 for Tuesday, and so on) using a variation of Dinh's Algorithm. The second function, Rtv_DayOfWeek, simply takes the result of the first function and returns the corresponding three-letter abbreviation of the weekday (MON, TUE, and so on). I could have built only one function, but as you'll see in the next article in this series, being able to calculate the number of days between weekdays can be useful. This will also show how to orchestrate functions, making the output of one the input of another.

 

The Clc_DayOfWeek Function

The function follows the same methodology used in previous articles, and it's fairly unremarkable:

 

*------------------------------------------------------------------------*

*   Day of the week (returns the day of the week of a given date as nbr) *

*------------------------------------------------------------------------*

P Clc_DayOfWeek   B                   Export                              

D Clc_DayOfWeek   PI            1P 0                                    

* Input parameters                                                      

D P_Date                         D   VALUE                              

                                                                          

* Work variables                                                        

D W_Return       S             1P 0 INZ(9)                              

D W_RefDate     S               D   INZ(D'0001-01-01')                  

                                                                          

* Check input parms                                                      

* P_Date                                                                

C                   TEST(E)                P_Date                        

C                   IF       %ERROR                                      

C                   RETURN   W_Return                                    

C                   ENDIF                                                

                                                                          

* If the input parm is ok, calculate the day of the week                

C                   EVAL    W_Return = %REM(%DIFF(P_Date : W_RefDate :  

C                                                   *DAYS) :              

C                                            7) + 1

                                                                          

* Return it                                                              

C                   RETURN   W_Return                                    

                                                                          

P Clc_DayOfWeek   E                                                      

 

The only statement worth discussing is the calculation of the day of the week: it uses %DIFF to calculate the number of days (specified by the *DAYS in the third parameter) between the input date (first parameter) and the reference date (second parameter, with the value of 0001-01-01). Then the resulting number of days is divided by seven (because that's the number of days a week has), and the integer remainder is returned using yet another BIF: %REM. The result is the "numeric value of the day of the week," as I explained before. The final "+1" is just to make the result more readable, making Monday day number 1, Tuesday day number 2, and so on.

 

The Rtv_DayOfWeek Function

This "numeric value of the weekday" is the input for the second function. This function is even simpler than the first:

 

*------------------------------------------------------------------------*

*   Day of the week (returns the day of the week of a given date in text)*

*------------------------------------------------------------------------*

P Rtv_DayOfWeek   B                  Export                              

D Rtv_DayOfWeek   PI             3A                                      

* Input parameters                                                      

D P_DayNbr                     1P 0 VALUE                                

                                                                          

* Work variables                                                        

D W_Return       S             3A   INZ(*Blanks)                        

                                                                          

* Check input parms                                                      

* P_DayNbr                                                              

C                   IF      P_DayNbr < 1 Or P_DayNbr > 7                

C                   RETURN   W_Return                                    

C                   ENDIF                                                

                                                                          

* If the input parm is ok, Return the corresponding text                

C                   SELECT                                                

* Monday                                                                  

C                  WHEN     P_DayNbr = 1  

C                   EVAL     W_Return = 'MON'

* Tuesday                                  

C                  WHEN     P_DayNbr = 2  

C                   EVAL     W_Return = 'TUE'

* Wednesday                                  

C                  WHEN     P_DayNbr = 3  

C                   EVAL     W_Return = 'WED'

* Thursday                                  

C                  WHEN     P_DayNbr = 4  

C                   EVAL     W_Return = 'THU'

* Friday                                    

C                  WHEN     P_DayNbr = 5  

C                   EVAL     W_Return = 'FRI'

* Saturday                                  

C                  WHEN     P_DayNbr = 6  

C                   EVAL     W_Return = 'SAT'

* Sunday                                    

C                  WHEN     P_DayNbr = 7  

C                   EVAL     W_Return = 'SUN'

* Error                                      

C                   OTHER                      

C                   EVAL     W_Return = *Blanks

C                   ENDSL                      

                                              

C                  RETURN   W_Return        

                                              

P Rtv_DayOfWeek   E                            

 

If you prefer the output to be the complete word instead of the abbreviation or want to return the weekday in another language, be sure to adapt the W_Return variable and the prototype interface accordingly.

 

Testing the Last Two Articles' Functions

If you read the previous article, you probably noticed that I neglected to include an example. Well, here you have some basic examples of the functions of these last two articles:

 

H DECEDIT(',') DATEDIT(*DMY.)                                            

                                                                          

*------------------------------------------------------------------------*

*   Variables                                                           *

*------------------------------------------------------------------------*

D W_ValidDate   S              D   INZ                                

D W_Day         S             2P 0 INZ(*Zeros)                        

D W_DayNbr       S             1P 0 INZ(*Zeros)                        

D W_WeekDay     S             3A   INZ(*Blanks)                        

                                                                          

*------------------------------------------------------------------------*

*   Copy Statements                                                     *

*------------------------------------------------------------------------*

* Date Operations                                                        

/Copy QCPYLESRC,DTE_OPS_PR                                              

                                                                          

C                   EVAL     W_ValidDate = %Date('2014-11-16')          

                                                                    

* Test LastDayOfMonth                                                

C                   EVAL     W_Day = LastDayOfMonth(W_ValidDate)    

* "W_Day" is now 30                                                

* Test Clc_DayOfWeek and Rtv_DayOfWeek                              

C                   EVAL     W_DayNbr = Clc_DayOfWeek(W_ValidDate)

C                   EVAL     W_WeekDay = Rtv_DayOfWeek(W_DayNbr)    

* "W_WeekDay" is now 'TUE'                                          

C                   EVAL     W_DayNbr = Clc_DayOfWeek(%DATE())    

C                   EVAL     W_WeekDay = Rtv_DayOfWeek(W_DayNbr)    

                                                                    

C                   EVAL     *INLR = *On                            

 

Just a couple of notes:

 

Because the LastDayOfMonth and Clc_DayOfWeek functions accept a date variable as input parameter, you can pass the %DATE BIF instead of a variable name. %DATE() without any parameters returns the system's current date.

 

I could do without the W_DayNbr variable altogether by calling the Clc_DayOfWeek function inside the call to Rtv_DayOfWeek like this: Rtv_DayOfWeek(Clc_DayOfWeek(W_ValidDate)). It's not the most readable way to write code and can make debugging a little bit harder, but it's possible. I prefer to write code keeping readability and maintainability in mind. However, in most object-oriented languages, calling methods (functions) inside other methods is common practice.

 

I hope these simple functions inspire you to write your own date-calculation functions. Here are a few ideas:

  • Calculate a due date
  • Calculate the number of Mondays a given month has
  • Calculate the number of work days until you retire (or don't; you might get depressed!)

That's all for now! You can download the source code for the date functions service program and test program here. The next article will be about time-related BIFs, using a fun example to demonstrate some of them. Meanwhile, comment away in the Comments section below or in the RPG-related LinkedIn groups where these articles typically pop up.

 

Rafael Victoria-Pereira

Rafael Victória-Pereira has more than 20 years of IBM i experience as a programmer, analyst, and manager. Over that period, he has been an active voice in the IBM i community, encouraging and helping programmers transition to ILE and free-format RPG. Rafael has written more than 100 technical articles about topics ranging from interfaces (the topic for his first book, Flexible Input, Dazzling Output with IBM i) to modern RPG and SQL in his popular RPG Academy and SQL 101 series on mcpressonline.com and in his books Evolve Your RPG Coding and SQL for IBM i: A Database Modernization Guide. Rafael writes in an easy-to-read, practical style that is highly popular with his audience of IBM technology professionals.

Rafael is the Deputy IT Director - Infrastructures and Services at the Luis Simões Group in Portugal. His areas of expertise include programming in the IBM i native languages (RPG, CL, and DB2 SQL) and in "modern" programming languages, such as Java, C#, and Python, as well as project management and consultancy.


MC Press books written by Rafael Victória-Pereira available now on the MC Press Bookstore.

Evolve Your RPG Coding: Move from OPM to ILE...and Beyond Evolve Your RPG Coding: Move from OPM to ILE...and Beyond
Transition to modern RPG programming with this step-by-step guide through ILE and free-format RPG, SQL, and modernization techniques.
List Price $79.95

Now On Sale

Flexible Input, Dazzling Output with IBM i Flexible Input, Dazzling Output with IBM i
Uncover easier, more flexible ways to get data into your system, plus some methods for exporting and presenting the vital business data it contains.
List Price $79.95

Now On Sale

SQL for IBM i: A Database Modernization Guide SQL for IBM i: A Database Modernization Guide
Learn how to use SQL’s capabilities to modernize and enhance your IBM i database.
List Price $79.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: