23
Sat, Nov
1 New Articles

Enhance Your CGIDEV2 Application with Calendar Integration

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

Integrate your Web applications with your users' personal calendars.

 

I'll be the first to admit that I'm aging. How old am I? Well, that's a secret that I may divulge at the end of the article. But with age comes organization. Work days become hectic, and sometimes I need a reminder of what I'm supposed to do next. I'm sure some of your users need reminders at times too. That's where the concept of this article started.

 

Imagine this scenario. A user is on the phone with a customer, trying to resolve an issue. The user is logging the call on the system and indicates that she has promised to give a follow-up call in two days. Finally, the user puts a reminder on her personal calendar to call the customer back.

 

From Lotus Notes to Microsoft Outlook, email clients today include a calendar application. These calendar applications have built-in support for a file format named iCalendar. In the above scenario, the use of an iCalendar file could have eliminated the final step of manually adding the reminder to the user's personal calendar application.

 

The iCalendar file format is simply a plain-text file with an .ics extension. The file must always begin with BEGIN:VCALENDAR, and the last line of the file must always be END:VCALENDAR. Everything between the BEGIN and END lines represents the body of the iCalendar file.

 

Notice that the BEGIN and END statements are followed by the word VCALENDAR. The iCalendar file format is derived from the vCalendar file format. The VCALENDAR attributes were retained to maintain compatibility.

 

The basic file layout for an iCalendar file is illustrated in Figure 1.

 

BEGIN:VCALENDAR

VERSION:2.0

BEGIN:VEVENT

ORGANIZER:MAILTO:This email address is being protected from spambots. You need JavaScript enabled to view it.

DTSTART:20090803T080000

DTEND:20090803T083000

DTSTAMP:20090802T103300

DESCRIPTION:Details of your reminder go here.

SUMMARY:Subject for your reminder goes here.

BEGIN:VALARM

TRIGGER:-PT15M

ACTION:DISPLAY

DESCRIPTION:Alarm description goes here.

END:VALARM

END:VEVENT

END:VCALENDAR

Figure 1: This code illustrates the basic structure of an iCalendar file.

 

 

The BEGIN:VEVENT represents the beginning of the event. The DTSTART and DTEND attributes provide the starting and ending dates and times. The DTSTAMP shows the date and time the reminder was created. The DESCRIPTION and SUMMARY attributes provide a detailed description and a subject for the reminder.

 

The BEGIN:VALARM is the beginning of the reminder alarm attributes. In the above example, it is set to remind the user 15 minutes before the start time.

 

Figure 2 illustrates how to change the basic iCalendar file into a file that can be used in a CGIDEV2 Web application:

 

/$remindme-top

Content-type: text/calendar


BEGIN:VCALENDAR

VERSION:2.0

BEGIN:VEVENT

ORGANIZER:MAILTO:This email address is being protected from spambots. You need JavaScript enabled to view it.

DTSTART:/%reminddate%/T080000

DTEND:/%reminddate%/T083000

DTSTAMP:/%currentdate%/T/%currenttime%/

DESCRIPTION:/%note%/

SUMMARY:/%subject%/

BEGIN:VALARM

TRIGGER:-PT15M

ACTION:DISPLAY

DESCRIPTION:Alarm description goes here.

END:VALARM

END:VEVENT

END:VCALENDAR

Figure 2: Make these changes to the iCalendar file for use in CGIDEV2.

 

I've added a section name of remindme-top, as well as the content-type declaration for an iCalendar file. I've also replaced the starting date, ending date, current date, current time, description, and subject with variables. These variables will be populated in an RPG program.

 

The RPG program REMIND1 will display a Web page where the user can enter a subject, reminder date, and description. When the user submits the Web page, another RPG program will build an iCalendar file and allow the user to open the file. The file will open in the user's default program that handles .ics files. The source for the REMIND1 program is shown in Figure 3.

 

/copy qrpglesrc,hspecs

/copy qrpglesrc,hspecsbnd

h dftactgrp(*no) actgrp('REMIND1')


/copy qrpglesrc,prototype

/copy qrpglesrc,variables3

/copy qrpglesrc,usec

d IfsMultIndicators...

d                 ds

d  NoErrors                       n

d  NameTooLong                    n

d  NotAccessible                  n

d  NoFilesUsable                  n

d  DupSections                    n

d  FileIsEmpty                    n


/copy qrpglesrc,prolog3


/free

exsr RetrieveHtml;

exsr Process;

exsr Exit;


// Retrieve html from the IFS

begsr RetrieveHtml;

SetNoDebug(*on);

clrhtmlbuffer();

IfsMultIndicators = gethtmlifsmult('/htdocs/reminder.htm');

endsr;


// Process screen

begsr Process;

updhtmlvar('pgm':GetEnv('SCRIPT_NAME':qusec));

updhtmlvar('title':'Calendar and CGIDEV2 Integration');

updhtmlvar('randomstring':RandomString(20));

wrtsection('reminder-top');

endsr;


// Flush the html buffer to the browser and return

begsr Exit;

wrtsection('*fini');

*inlr = *on;

endsr;

Figure 3: Here's the source for the RPG program REMIND1.

 

Notice that the RetrieveHTML subroutine in the REMIND1 program loads the file REMINDER.HTM from the IFS. The source for the REMINDER.HTM is shown in Figure 4.

 

/$reminder-top

Content-type: text/html


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<html>

<head>

<title>Sample CGIDEV2 Applications "/%pgm%/"></title>

<script src="/js/prototype.js"></script>

<script src="/js/calendarimport.js"></script>

<link rel="stylesheet" href="/css/mc.css">

</head>


<body>

<table border="0" width="100%" cellpadding="3" cellspacing="0">

<tr>

<td align="left" valign="middle"><img src="/images/mclogosmall.jpg" align="middle" alt="McClenny Consulting"></td>

<td align="right">/%title%/</td>

</tr>

</table>

<br><br>

<p>This example will show how take information entered on a form, create a iCalendar file, and then import that file into your Microsoft Office Calendar. This example requires that you have an email client that supports iCalendar files.</p>

<p>Simply enter in a subject, reminder date, and the supporting details, then click the Go button. Please note that the date must be in MM/DD/YYYY format. If you enter an invalid date, then the program will default to today's date.</p>

<center>

<form action="#">

<input value="/%randomstring%/">

<table >

<tr>

<td align="left"><strong>Subject:</strong></td>

<td align="left"><input size="50" maxlength="50"></td>

</tr>

<tr>

<td align="left"><strong>Reminder Date:</strong></td>

<td align="left"><input size="15" maxlength="10">&nbsp;(MM/DD/YYYY)</td>

</tr>

<tr>

<td align="left"><strong>Details:</strong></td>

<td align="left"><textarea cols="50" rows="5"></textarea></td>

</tr>

</table>

<input value="Go" >

</form>

<br>

<p><a href="/index.pgm">Return to CGIDEV2 examples</a></p>

</center>

</body>

</html>

Figure 4: This is the REMINDER.HTM source used in the REMIND1 RPG program.

 

 

Figure 5 shows the results of running the REMIND1 program in your browser.

 

100709McClennyFigure5

Figure 5: This screen shot shows the Web page built in the REMIND1 RPG program. (Click image to enlarge.)

 

The REMINDER.HTM file contains two JavaScript functions in the header: prototype.js and calendarimport.js. Together, these two JavaScript functions are used to build the iCalendar file to be imported.

 

The function prototype.js is known as the Prototype JavaScript Framework. It is one of many JavaScript frameworks that can be used to ease the implementation of AJAX. This JavaScript function can be downloaded from the Prototype Web site at www.prototypejs.org.

 

The calendarimport.js function retrieves the values on the HTML form and calls another RPG program named REMIND2. Figure 6 shows the source for the calendarimport.js function.

 

function calendarimport() {

var xRandomString = $F('randomstring');

var xSubject = $F('subject');

var xRemindDate = $F('rdate');

var xNotes = $F('notes');


var url='remind2.pgm?subject=' + xSubject + '&note=' + xNotes +               '&reminddate=' + xRemindDate + '&randomstring=' + xRandomString;


new Ajax.Request(url , {method: 'get'});

window.open('/temp/' + xRandomString + '.ics');


return false;

}

Figure 6: Here's the source for the calendarimport.js JavaScript function.

 

 

The variables xRandomString, xSubject, xRemindDate, and xNotes are populated using the Prototype function $F. The $F function simply retrieves the values of the form fields in an HTML document. Notice that the form only has three visible input fields: subject, reminder date, and description. In the REMINDER.HTM, there is a fourth field that is hidden called randomstring. The program REMIND1 populates this hidden field with a random string of 20 characters using the CGIDEV2 RandomString procedure. This random string will become the name of the iCalendar file stored in the system.

 

The variable url is constructed to call the REMIND2 program, passing it the expected variables and contents entered on the form.

 

The Ajax.Request function is a Prototype function that can be used to call another RPG program. In this case, the url constructed in the prior line is called.

 

Finally, a new browser window is opened that will allow the user to open the iCalendar file.

 

The REMIND2 program called in the calendarimport.js JavaScript function will need to retrieve the iCalendar shell stored on the IFS, retrieve the values passed into the program  (subject, reminder date, notes, and the random string), populate the variables in the iCalendar shell, and then save the iCalendar file to the IFS. Figure 7 shows the source for the REMIND2 program.

 

/copy qrpglesrc,hspecs

/copy qrpglesrc,hspecsbnd

h dftactgrp(*no) actgrp('REMIND2')


/copy qrpglesrc,prototype

/copy qrpglesrc,variables3

/copy qrpglesrc,usec


d inpSubject      s             50a

d inpNote         s           1000a

d inpRemindDate   s             10a

d inpRandomString...

d                 s             20a

d FileName        s            100a

d WorkDate        s               d


d IfsMultIndicators...

d                 ds

d  NoErrors                       n

d  NameTooLong                    n

d  NotAccessible                  n

d  NoFilesUsable                  n

d  DupSections                    n

d  FileIsEmpty                    n


/copy qrpglesrc,prolog3


/free

exsr RetrieveHtml;

exsr Process;

exsr Exit;


// Retrieve html from the IFS

begsr RetrieveHtml;

SetNoDebug(*on);

clrhtmlbuffer();

IfsMultIndicators = gethtmlifsmult('/htdocs/remindme.ics');

endsr;


// Process input parameters from the screen.

begsr Process;

inpSubject = zhbgetvar('subject');

inpNote = zhbgetvar('note');

inpRemindDate = zhbgetvar('reminddate');

inpRandomString = zhbgetvar('randomstring');

monitor;

WorkDate = %date(inpRemindDate:*usa);

on-error;

WorkDate = %date();

endmon;

updhtmlvar('reminddate':%char(WorkDate:*iso0));

updhtmlvar('currentdate':%char(%date():*iso0));

updhtmlvar('currenttime':%char(%time():*iso0));

updhtmlvar('note':inpNote);

updhtmlvar('subject':inpSubject);

wrtsection('remindme-top');

endsr;


// Flush the html buffer to the browser and return

begsr Exit;

FileName = '/temp/' + %trim(inpRandomString) + '.ics';

rc = WrtHtmlToStmf(%trim(FileName));

*inlr = *on;

endsr;

Figure 7: The REMIND2 program builds the iCalendar file and saves it to the IFS.

 

One additional change is required in order to be able to open the iCalendar file. The configuration for the HTTP server will need to be changed so that it will recognize the .ics file. The content type of the iCalendar file is text/calendar. If this type is not already defined in the Apache configuration file, it will need to be inserted. Simply add the following line to your configuration file:

 

AddType text/calendar .ics

 

Integrating a Web application with a user's personal calendar can be an integral part of any successful application. By using CGIDEV2, the Prototype Framework, and an iCalendar file, it's never been easier.

 

Oh, and I almost forgot. At the time I'm writing this, I'm a youthful, but graying, 42.

Glenn McClenny has worked on IBM midrange systems since 1990 and focuses on Web applications that utilize IBM’s free CGIDEV2 service program.  Having earned dual degrees from N.C. State University in mathematics and education, Glenn co-founded McClenny Consulting in 1994.  Along with traditional green-screen programming, Glenn provides on-site and Web-based CGIDEV2 classes and can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it..

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: