Home > AS/400 Tips > iSeries programmer tips > RPG documentation made easy
iSeries 400 Tips:
EMAIL THIS
 TIPS & NEWSLETTERS TOPICS 

ISERIES PROGRAMMER TIPS

RPG documentation made easy


Benito Abraham
11.01.2004
Rating: -2.57- (out of 5)


Digg This!    StumbleUpon Toolbar StumbleUpon    Bookmark with Delicious Del.icio.us   


Using a simple Client Access data transfer you can select which lines from a RPG source send to a *.txt file in order to document it. In this case I have chosen comment and begsr/endsr lines. I find this very helpful and easy.

In order to work properly you have to replace the following fields by their values

------------
HOSTAME
LIBRARY
FILE
MEMBER
------------

 
[DataTransferFromAS400]
Version=1.0
[HostInfo]
HostName=HOSTNAME
HostFile=LIBRARY/FILE(MEMBER)
[ClientInfo]
OutputDevice=2
PCFileType=1
PCFile=D:My DocumentsMy Received Filessource.txt
CrtOpt=1
SaveFDF=1
FDFFile=D:My DocumentsMy Received Filessource.FDF ConvType=0
FileOps=7
ASCIITruncation=1
[SQL]
Select=substr(srcdta, 7, 70)
Where=substr(srcdta, 7, 1) = '*' or substr(srcdta, 28, 5) in ('BEGSR',
'ENDSR')
OrderBy=
GroupBy=
Having=
JoinBy=
SQLSelect=
EnableGroup=0
MissingFields=0
[Options]
IgnoreDecErr=1
TimeSep=[:]
TimeFmt=HMS
DateSep=[/]
DateFmt=MDY
DecimalSep=.
SortSeq=0
SortTable=
Lang=0
LangID=
[HTML]
AutoSize=0
OverWrite=1
Charset=windows-1252
ConvInd=0
Title=
IncDateTime=0
DateTimeLoc=0
TabAlign=0
TabRows=2
TabCols=2
TabBW=1
TabCS=1
TabCP=1
TabWidth=100
TabWidthP=0
TabMap=1
CapAlign=0
CapStyle=1
CapSize=6
CapIncNum=0
Caption=
RowAlignHdrV=0
RowAlignHdrH=0
RowAlignGenV=0
RowAlignGenH=0
RowSytleHdr=1
RowStyleGen=1
CellAlignT=0
CellAlignN=0
CellWrap=1
CellSize=6
UseTemplate=0
Template=
TemplateTag=
[Properties]
Check4Untrans=0
Convert65535=0
UseAlias=1
Notify=1
SQLStmt=0
AutoRun=0
AutoClose=0 

Note: This is a simple file transfer, there are three tricks you should be aware of:

a) It reads a member from a source pf.

b) It uses the file transfer's facility to select certain records using a SQL select statement.

c) If you'd like to document not all the comments but just some of them you could create your own criteria and only select those that match it (i.e.: only those lines with '*.' will be documented, so the only thing that you need to do is to change the SQL where clause).

Please see this example of the documentation as it, and the file transfer itself.

==================================
MORE INFORMATION ON THIS TOPIC
==================================

The Best Web Links: tips, tutorials and more.

Ask your programming questions--or help out your peers by answering them--in our live discussion forums.

Ask the Experts yourself: Our application development gurus are waiting to answer your programming questions.


Rate this Tip
To rate tips, you must be a member of Search400.com.
Register now to start rating these tips. Log in if you are already a member.




Digg This!    StumbleUpon Toolbar StumbleUpon    Bookmark with Delicious Del.icio.us   



RELATED CONTENT
iSeries CL programming
Taking advantage of CL advancements, starting with V5R3
Checking in on your IBM i authorization lists
Running PHP open source applications: NOBODY needs authority
Simplify the process of converting a spool file from iSeries into an Excel spreadsheet
CL program for daily backups
An automated CL method of moving a query from AS/400 to Excel
Changing user password expiration
Eight steps for creating program documentation using AS/400 utilities
DAYSPAST CLLE program for AS/400: Compares object creation date with today's date
Advanced Job Scheduler help

iSeries programmer tips
Enhancing RPG with external SQL stored procedures
Tracking data changes on IBM i with triggers
Introduction to SQLRPGLE on IBM i: Making a report
Implementing a browser interface in COBOL: Displaying database fields
Taking advantage of CL advancements, starting with V5R3
TAATOOL: Useful tools for programmers on IBM i
Implementing a browser interface in COBOL: Creating your graphic Web page
Implementing a browser interface in COBOL: Getting started
Making the most of RPG data handling on IBM i
Groovy programming on IBM i

Application Development
iSeries calling an .exe
Top 10 programmer tips
Formatted work job scheduler
Convert system date and time
Mixing free format code with embedded SQL
SQL update a field in one file from a field in another file
Webcasts for iSeries programmers
Programming advice from the pros
Easy code copying via the drag and drop method
Setting FTP time-outs

RELATED RESOURCES
2020software.com, trial software downloads for accounting software, ERP software, CRM software and business software systems
Search Bitpipe.com for the latest white papers and business webcasts
Whatis.com, the online computer dictionary

DISCLAIMER: Our Tips Exchange is a forum for you to share technical advice and expertise with your peers and to learn from other enterprise IT professionals. TechTarget provides the infrastructure to facilitate this sharing of information. However, we cannot guarantee the accuracy or validity of the material submitted. You agree that your use of the Ask The Expert services and your reliance on any questions, answers, information or other materials received through this Web site is at your own risk.



iSeries Security - Security Tools, Physical Security and System Security
HomeNewsTopicsITKnowledge ExchangeTipsBlogsAsk the ExpertsMultimediaWhite PapersProducts
About Us  |  Contact Us  |  For Advertisers  |  For Business Partners  |  Site Index  |  RSS
SEARCH 
TechTarget provides technology professionals with the information they need to perform their jobs - from developing strategy, to making cost-effective purchase decisions and managing their organizations' technology projects - with its network of technology-specific websites, events and online magazines.

TechTarget Corporate Web Site  |  Media Kits  |  Site Map




All Rights Reserved, Copyright 1999 - 2009, TechTarget | Read our Privacy Policy
  TechTarget - The IT Media ROI Experts