System i CGI Toolkits

Size: px

Start display at page:

Download "System i CGI Toolkits"

Marcia Hardy
6 years ago
Views:

1 System i CGI Toolkits Bradley V. Stone Topics Where to Start What You Need to Know Toolkit Concepts How Does a Toolkit Help Me? Toolkit Functionality The Template and Substitution Variables The Toolkit in Action Examples e-rpg SDK and CGIDEV2 Which is Right for You? Closing Thoughts e-rpg and Toolkit Benefits Resources Books, Training Manuals and Toolkits to Get You Started or Take you Further

2 Where to Start True or False: A web toolkit (any kind) is a great way to learn how to create web applications. Where to Start Answer: It depends on: Previous Experience Willingness to Learn Available Team Members and Resources

3 Where to Start What you Need to Know Using a toolkit doesn t mean you don t have to learn! The Integrated File System (IFS) Integrated Language Environment (ILE) Web Server Configuration Web Programming Concepts Templates and Replacement Variables Team Roles Where to Start The Integrated File System (IFS) Different from the Library/File file system we are used to Similar to Windows or Unix file systems Used to store static web pages, JavaScript, Stylesheets, Templates, etc. Used to store Apache configuration files Access through green screen, FTP, Windows Explorer

4 Where to Start Integrated Language Environment RPG Toolkits consist mainly of ILE subprocedure calls Integration is fairly painless in most cases (H-Specs for compiler options, /COPYs for prototype definitions, etc) Toolkits are a great introduction to what can be done with ILE, something every RPG programmer should be focusing on! Trick yourself into learning ILE! Where to Start Web Server Configuration Most toolkits will set up a basic configuration for you Using a toolkit doesn t mean you must use the configuration it creates Future server updates (ie Virtual Hosts, SSL, new paths, directories, Security, etc) Additional Servers (ie Development, Test, Production)

5 Where to Start Web Programming Concepts Understanding the basics of web programming will further help you utilize the functionality of any toolkit! How CGI programs create dynamic output How CGI programs read input What other data is available (ie Environment Variables) Web Page Design (HTML, Stylesheets, JavaScript, SSI, etc) Where to Start Team Roles Core functionality of application Business Rules Database Administration Web page design Web page functionality Graphic Artist?

6 Where to Start Templates and Repl. Variables How templates work Where templates are stored How template sections work How replacement variables work Efficient use of templates and sections! (Don t put all your data in one template or section!) Toolkit Concepts How Does a Toolkit Help Me? Removes Most if not All HTML from your RPG programs Allows updates of web applications without re-compilation of programs Easy to use functions to create dynamic web pages Allows separation of display and business layers Increases productivity Can be used for functionality other than web pages!

7 Toolkit Concepts How a Toolkit Does NOT Help A toolkit is a HUGE help, but it alone will NOT help you to become a better web application programmer. You still need to learn the basics of: Web Server Configuration Web Application Design Web Application Functionality CGI Programming Toolkit Concepts How Does it Work? Template contains your basic web page layout divided into sections Template is loaded into application Substitution variables inside the template are replaced with actual data Sections of data are written to the browser Repeat until the entire page is complete!

8 Toolkit Functionality The Template Contains the basic layout of your web page separated into sections Created and stored externally from your program Similar to external DDS for printouts or green screens Stored in a PF or Stream File in the IFS Not only used for Web Pages! The Template An Example /$top Content-type: text-html Top section including HTTP Headers <html> <body> We will count from 1 to /%end%/ /$count Current count: /%count%/ /$end </body> </html> Looping Section End Section

9 Toolkit Functionality Substitution Variables Used to place dynamic data into your web page Variables are replaced with real data from your application Makes your web pages dynamic As your data changes, the web page changes Substitution Variables An Example /$top Content-type: text-html <html> <body> We will count from 1 to /%end%/ /$count Current count: /%count%/ /$end </body> </html> end variable to be replaced with a value count variable to be replaced with value on each iteration

10 Toolkit Functionality How Storage is Used Template Data Working Buffer Web Output Data is loaded From the template into a Working Buffer Data is manipulated in the Working Buffer (sections are loaded, replacement variables are substituted with data, etc) Data is written from the Working Buffer to the web page Process repeats until entire page is built Toolkit Functionality Basic Functions Initialization or Startup Loading a template and/or section Reading input from the browser Placing data into the output Writing the output to the browser Creating Cookies Retrieving Cookie data End Processing

11 Toolkit Functionality Initialization Used to set up the environment Clears buffers, starts everything fresh CGIDEV2: ClrHTMLBuffer erpg SDK: #startup Examples: Callp ClrHTMLBuffer Callp #startup Toolkit Functionality Load Template Loads template into buffer Prepares template data to be written to output CGIDEV2: GetHTMLIfs erpg SDK: #loadtemplate Examples: Callp GetHTMLIfs( /path/file.ext ) Callp #loadtemplate( file.ext )

12 Toolkit Functionality Load Section erpg SDK only Loads a section into the working buffer #loadsection(section) Example: Callp #loadsection( detail ) Toolkit Functionality Read Input Reads data in from web form Normally read in by field name CGIDEV2: ZhbGetVar(fieldname) erpg SDK: #getdata(fieldname) Examples: Eval firstname = ZhbGetVar( firstname ) Eval firstname = #getdata( firstname )

13 Toolkit Functionality Replace Data Used to replace fields in template with actual data The main function that makes your web pages dynamic CGIDEV2: UpdHTMLVar(field:data) erpg SDK: #replacedata(string:data) Examples: Callp UpdHTMLVar( name :firstname) Callp #replacedata( /%name%/ :firstname) Toolkit Functionality Write Section Writes data from buffer to output Output can be web, file, or both CGIDEV2: WriteSection(section) erpg SDK: #writesection Examples: Callp WriteSection( detail ) Callp #writesection

14 Toolkit Functionality Write Section Cont Writing output to a file: CGIDEV2: * Normal Processing, replacements, etc. eval rc = WrtHTMLToStmf( /output/file.ext ) erpg SDK: CallP #setwriteto(w_file) CallP #openoutfile('test2.test') * Normal Processing, replacements, etc. CallP #writesection Toolkit Functionality Build a Cookie Builds a string containing cookie data Data is replaced in template CGIDEV2: CrtCookie(name:value:rc:domain:path:[..]) erpg SDK: #buildcookie(name:value:[..]) Examples: Eval cookie = CrtCookie( id :userid) Eval cookie = #buildcookie( id :userid)

15 Toolkit Functionality Retrieve a Cookie Retrieves cookie data by name Simplifies process! CGIDEV2: GetCookieByName(cookie) erpg SDK: #getcookie(cookie) Examples: Eval id = GetCookieByName( id ) Eval id = #getcookie( id ) Toolkit Functionality End Processing Writes remaining data to web page (flushes any buffers) Performs cleanup CGIDEV2: wrtsection('*fini') erpg SDK: #cleanup Examples: Callp wrtsection( *fini ) Callp #cleanup

16 The Toolkit in Action Examples The best way to comprehend a concept is to see it in action! Native CGI (with API Wrappers) vs. Toolkit Looping, Table, and Input Toolkit Examples More examples online The Toolkit in Action Native CGI vs. Toolkit eval WrtDta = %trim(httpheader) + NewLine + NewLine CALLP #WrStout(WrtDta) eval Method = #GetEnv2( REQUEST_METHOD ) If (Method = 'POST') eval RcvRec = #CGIParse('-init') CALLP #PutEnv(RcvRec) endif eval WrtDta = '<html><body>' + 'First=' + %trim(firstname) + ' ' + Last=' + %trim(lastname) + '</body></html>' + NewLine CALLP #WrStout(WrtDta) eval *INLR = *on eval FirstName = #CGIParse('-value firstname') eval LastName = #CGIParse('-value lastname')

17 The Toolkit in Action Native CGI vs. Toolkit Cont Content-type: text/html <html><body> First=/%fname%/ Last=/%lname%/ </body> </html> Callp #startup Callp #loadtemplate( input.erpg ) Eval FirstName = #getdata( firstname ) Eval LastName = #getdata( lastname ) Callp #replacedata( /%fname%/ : FirstName) Callp #replacedata( /%lname%/ : LastName) Callp #writesection Callp #cleanup Eval *INLR = *ON The Toolkit in Action A Looping Example (CGIDEV2) (local) Template Source RPG Source This application shows the basic functionality behind using a toolkit and using replacement variables and repeating sections.

18 The Toolkit in Action A Looping Example (erpg SDK) (local) Template Source RPG Source Standard HTML Header This example is the same as the previous, only using erpg SDK instead of CGIDEV2. The Toolkit in Action A Table Example (CGIDEV2) Shopping Basket Example Template Source RPG Source This example shows a more involved example displaying the contents of a shopping cart.

19 The Toolkit in Action An Input Example Template Source RPG Source This example shows the basics behind reading input from a web page using a toolkit. The Toolkit in Action Cookie Creation mples/cookie1main.html Template RPG Source This example shows the basics behind creating a cookie using a toolkit.

20 The Toolkit in Action Cookie Retrieval mples/cookie2main.html Template RPG Source This example shows the basics behind retrieving a cookie using a toolkit. The Toolkit in Action Creating Dynamic Program SAMP in library BVSTOOLS (Green Screen) Template RPG Source This example shows how a toolkit can be used for creating dynamic files other than HTML. In this case it creates a dynamic message.

21 The Toolkit In Action Online Examples CGIDEV2 examples can be found at Click on Deliverables in left hand column Click on RPG CGI Programming Toolset (CGIDEV2) More examples from erpg PowerTools: Stone on CGIDEV2 at /erpg/ erpg SDK examples can be found at erpg SDK and CGIDEV2 Which is Right for You? General Comparison Installation Service Programs Templates and Variables Basic Program Flow Performance

22 erpg SDK and CGIDEV2 General Comparison erpg SDK Created and supported by Bradley V. Stone () Available at Apache Only Includes Example Source and Templates Closed Source and Purchased Registration with free trial CGIDEV2 Created by Mel Rothman of IBM Supported by Giovanni Perotti and Mel Rothman Available at Classic or Apache Includes Example Source and Templates Free of charge erpg SDK and CGIDEV2 Installation erpg SDK Download from (about 1.5 meg, temporary key required) Upload Save File to iseries Restore ERPGSDK library Run SETUP command (restores objects, directories, creates new HTTP Config) Start HTTP Server CGIDEV2 Download from (about 8 meg, registration required) Upload Save File to iseries Restore CGIDEV2 library Run 1 st install Program (Regenerate Programs) Run 2 nd install Program (Restore /cgidev2 directory and update existing HTTP Config) Start HTTP Server

23 erpg SDK and CGIDEV2 Service Programs erpg SDK Seven total service programs, each with a specific function and a single module Each service program contains operation specific functionality Date, String, IFS, Library List, Messaging and CGI subprocedures are separately usable CGIDEV2 One service program containing 17 or more modules Generic subprocedures could be used separately including the entire service program or by recompiling specific modules into separate service programs erpg SDK and CGIDEV2 Templates and Variables erpg SDK Section delimiters can be set globally or in program Replacement functions replace anything, not just delimited data, no need for setting delimiters Replacement affects only loaded section, not entire template Allows default input and output directories to be set with a simple command (good for different environments, ie test/production) CGIDEV2 Section delimiter is set in program (defaults can be changed in source) Replacement delimiters are set in program (defaults can be changed in source) Replacement affects all variables in entire template Fully qualified path to templates and output files specified in program source

24 erpg SDK and CGIDEV2 Basic Program Flow erpg SDK Initialization Read Input Load Template Load Section by Name (Optional) Replace Variable(s) Write Section End Processing CGIDEV2 Initialization Read Input Load Template Replace Variable(s) Write Section By Name End Processing erpg SDK and CGIDEV2 Performance Looping program that replaces one variable per iteration (iteration count is read from input) Execution time is from beginning until end of application

erpg SDK and CGIDEV2 Performance Cont Model 170 V5R2 Execution Time (in Seconds) 90 80 70 60 50 40 30 20 10 0 erpg SDK

25 erpg SDK and CGIDEV2 Performance Cont Model 170 V5R2 Execution Time (in Seconds) erpg SDK CGIDEV Number of Iterations erpg SDK and CGIDEV2 Performance Cont Model 520 V5R4

Closing Thoughts e-rpg and Toolkit Benefits Use existing skill set Very small learning curve Easy on resources Split up business and presentation layers No more hard-coding HTML!

26 Closing Thoughts e-rpg and Toolkit Benefits Use existing skill set Very small learning curve Easy on resources Split up business and presentation layers No more hard-coding HTML! Not just for web pages! RPG is Still Cool! Resources e-rpg Books Great starting book Covers topics ranging from HTML to JavaScript Covers AS/400 APIs Includes Examples and Source

Resources Books Cont CGIDEV2 Toolkit Training Course Hours of

27 Resources Books Cont Follow up to first erpg book Contains more in depth materials and examples Chapters on dynamic SQL and ILE Resources Books Cont CGIDEV2 Toolkit Training Course Hours of Labs and Self-Study materials From installation to creating applications

28 Resources Books Cont erpg Training Manual Brand New Material! Updated information including Powered by Apache HTTP Configuration Great starting book for any web programming plan Self-Paced Training and Labs Resources e-rpg Books and Training Manuals /erpg/ Web400-L Mailing List: The CGIDEV2 Toolkit The erpg SDK

This is a sample chapter from Brad Stone s training e-rpg Powertools Stone on CGIDEV2 Get your copy of this important training now.

Stone on CGIDEV2 This is a sample chapter from Brad Stone s training e-rpg Powertools Stone on CGIDEV2 Get your copy of this important training now. With Stone on CGIDEV2 RPG programmers quickly learn