102
RPLXLSSHT
–
Replace Excel worksheet names ............................................ 220
RSCDIR
–
Resource directory ........................................................................ 221
RTF
–
RTF options .......................................................................................... 222
RTVPRMSET
–
Retrieve Parameter Set ......................................................... 224
SIGNATURE - Digital signing options ............................................................. 225
SPLFCCSID
–
Spooled File CCSID ................................................................ 229
SPLIT - Split spooled file ................................................................................. 230
SPLITKEY
–
Split by key options .................................................................... 234
SPLITPOS - Split by position options .............................................................. 237
SPLITPAGE
–
Split file every n pages ............................................................ 239
STMFCODPAG
–
Stream File Code Page ...................................................... 240
TEXT
–
Text options ....................................................................................... 243
TITLE - Title for HTML or PDF ........................................................................ 248
TOFILE - To spooled file name ....................................................................... 249
COLUMNOPT
–
Column creation options ....................................................... 250
COLUMNPOS
–
Column positions ................................................................... 252
LINTYPES
–
Line types ................................................................................... 254
XLSADJUST
–
Adjust pages to ....................................................................... 257
XLSFIT
–
Fit pages to ..................................................................................... 258
XLSCOLUMNS
–
Excel columns .................................................................... 259
XLSPRINT
–
Excel print setup ........................................................................ 260
XLSPROTECT
–
Excel worksheet protection ................................................. 263
XLSPRPRTY
–
Document properties .............................................................. 265
RSTSPLF Command .......................................................................................... 267
FROMSTMF
–
From stream File ..................................................................... 267
NEWOWN
–
New owner ................................................................................. 267
OUTPTY
–
Output priority ............................................................................... 268
MRGPDF ............................................................................................................ 269
FROMPDF - PDF files to merge...................................................................... 269
TOPDF - Merged PDF file ............................................................................... 270
REPLACE - Replace existing PDF .................................................................. 270
PASSWORD - Merged PDF file security ......................................................... 270
NOTFOUND - File not found action ................................................................ 272
AUT - Public data authority ............................................................................. 272
ADDPDFSGN ..................................................................................................... 274
PDFFILE - PDF file ......................................................................................... 274
PDFPWD
–
Owner password .......................................................................... 274
CTFFILE - Certificate file ................................................................................. 274
CTFPWD
–
Certificate password .................................................................... 274
REASON
–
Reason for signing ....................................................................... 275
LOCATION - Location ..................................................................................... 275
CONTACT - Signing contact information ........................................................ 275
VISIBLE - Visible signature? ........................................................................... 275
PAGNBR - Show on page number .................................................................. 276
IMAGE - Display image file ............................................................................. 276
XCOORD - X coordinate ................................................................................. 276
YCOORD - Y coordinate ................................................................................. 276
WIDTH - Width ................................................................................................ 276
HEIGHT - Height ............................................................................................. 277
Report Definitions and Report Maps ................................................................... 278
Commands related to Report Definitions ............................................................ 279
CRTRPTDFN
–
Create Report Definition ........................................................... 279
131
REPORTNAME
–
Report definition name ....................................................... 279
LPI
–
Lines per inch ........................................................................................ 279
CPI
–
Characters per inch ............................................................................... 280
T
EXT ‘description’
........................................................................................... 281
CCSID - Spooled file CCSID ........................................................................... 281
DATFMT - Spooled file date format ................................................................. 281
DATSEP - Spooled file date separator ............................................................ 281
CURSYM - Spooled file currency symbol ........................................................ 282
DECPOINT - Spooled file decimal point .......................................................... 282
THOUSANDS - Spooled file 1000s separator ................................................. 282
CHGRPTDFN
–
Change Report Definition ......................................................... 283
CPYRPTDFN
–
Copy Report Definition .............................................................. 283
FROMREPORT
–
From report definition name ............................................... 283
TOREPORT
–
To report definition name ........................................................ 283
DLTRPTDFN
–
Delete Report Definition ............................................................ 283
REPORTNAME
–
Report definition name ....................................................... 283
CHKDEPMAP
–
Check dependent maps ........................................................ 283
DSPRPTDFN
–
Display Report Definition .......................................................... 283
RNMRPTDFN
–
Rename Report Definition ........................................................ 284
REPORTNAME
–
Report definition name ....................................................... 284
NEWREPORT
–
New report definition name .................................................. 284
RTVRPTDFN
–
Retrieve Report Definition ......................................................... 284
REPORTNAME
–
Report definition name ....................................................... 284
SRCFILE
–
Source file .................................................................................... 284
SRCMBR
–
Source member ........................................................................... 284
MBROPT
–
Source member ........................................................................... 284
SAVRPTDFN
–
Save Report Definition .............................................................. 284
REPORTNAME
–
Report definition name ....................................................... 285
TOSTMF
–
To stream file ................................................................................ 285
REPLACE - Replace existing stream file ........................................................ 285
AUT- Public data authority .............................................................................. 285
RSTRPTDFN
–
Restore Report Definition .......................................................... 285
REPORTNAME
–
Report definition name ....................................................... 286
FROMSTMF
–
From stream file ...................................................................... 286
REPLACE - Replace existing report ................................................................ 286
WRKRPTDFN
–
Work with Report Definition ..................................................... 286
DSNRPTDFN
–
Design Report Definition ........................................................... 286
REPORTNAME
–
Report definition name ....................................................... 286
SPLFNAME - Based on spooled file ............................................................... 286
JOB-Spooled file job ....................................................................................... 287
SPLNBR-Spooled file number ......................................................................... 287
ADDRPTLIN
–
Add Report Line ......................................................................... 287
REPORTNAME
–
Report definition name ....................................................... 288
LINENAME
–
Report line name....................................................................... 288
LINETYPE
–
Line type .................................................................................... 288
PAGERANGE
–
Can occur on page numbers ................................................ 288
LINERANGE
–
Can occur on line numbers ..................................................... 290
RULETYPE
–
Rule type .................................................................................. 290
RULEPTY - Rule evaluation priority ................................................................ 292
SECTION
–
Section name .............................................................................. 292
TEXT
–
Text ‘description’
................................................................................ 293
REPEAT
–
Depth of repeat group .................................................................... 293
147
LINERULES
–
Line rules ................................................................................. 293
CHGRPTLIN
–
Change Report Line ................................................................... 296
CPYRPTLIN
–
Copy Report Line ........................................................................ 296
RMVRPTLIN
–
Remove Report Line .................................................................. 296
DSPRPTLIN
–
Display Report Line .................................................................... 297
RNMRPTLIN
–
Rename Report Line .................................................................. 297
WRKRPTLIN
–
Work with Report Lines .............................................................. 297
REPORTNAME
–
Report definition name ....................................................... 297
SECTION
–
Report section name ................................................................... 297
ADDRPTITM
–
Add Report Item ......................................................................... 297
REPORTNAME
–
Report definition name ....................................................... 297
ITEMNAME
–
Report item name ..................................................................... 297
LINENAME
–
Report line name....................................................................... 298
SECTION
–
Report section name ................................................................... 298
CHARPOS
–
Character position ..................................................................... 298
CHARLEN
–
Character length ........................................................................ 299
ITEMTYPE
–
Item type ................................................................................... 299
TEXT
–
Text ‘description’
................................................................................ 299
DATATYPE
–
Data type .................................................................................. 299
NULLDTAOPT
–
Blank data option ................................................................. 299
DATFMT
–
Date format ................................................................................... 300
DATSEP - Spooled file date separator ............................................................ 300
CHGRPTITM
–
Change Report Item .................................................................. 300
CPYRPTITM
–
Copy Report Item ....................................................................... 301
RMVRPTITM
–
Remove Report Item ................................................................. 301
DSPRPTITM
–
Display Report Item .................................................................... 301
RNMRPTITM
–
Rename Report Item ................................................................. 301
WRKRPTITM
–
Work with Report Items ............................................................. 301
REPORTNAME
–
Report definition name ....................................................... 301
LINENAME
–
Report line name....................................................................... 301
ADDRPTSCT
–
Add Report Section ................................................................... 301
REPORTNAME
–
Report definition name ....................................................... 302
SECTION
–
Report section name ................................................................... 303
PARENT
–
Parent section name ...................................................................... 303
STARTLINE - Section start line name ............................................................. 303
STARTRULES
–
Section start rules ................................................................ 303
ENDLINE - Section end line name .................................................................. 305
ENDRULES
–
Section end rules ..................................................................... 306
LINENAMES
–
Lines included in section ........................................................ 306
CHGRPTSCT
–
Change Report Section ............................................................ 306
CPYRPTSCT
–
Copy Report Section ................................................................. 306
RMVRPTSCT
–
Remove Report Section ........................................................... 306
DSPRPTSCT
–
Display Report Section .............................................................. 306
RNMRPTSCT
–
Rename Report Section ........................................................... 306
WRKRPTSCT
–
Work with Report Sections ....................................................... 307
REPORTNAME
–
Report definition name ....................................................... 307
PARENT
–
Parent section name ...................................................................... 307
Commands related to Report Maps .................................................................... 308
CRTRPTXL
–
Create Report-to-Excel Map ........................................................ 308
MAPNAME
–
Report-to-Excel map name ....................................................... 308
REPORTNAME
–
Report definition name ....................................................... 308
DFTUSEAUT - Default use authority ............................................................... 308
150
DFTCHGAUT - Default change authority ........................................................ 308
TEXT
–
Text ‘description’
................................................................................ 309
GRPSEQOPT - Row group sequence option .................................................. 309
CHGRPTXL
–
Change Report-to-Excel map ...................................................... 309
CPYRPTXL
–
Copy Report-to-Excel map ........................................................... 309
FROMMAP
–
From Report-Excel map name .................................................. 310
TOMAP
–
To Report-Excel map ...................................................................... 310
DLTRPTXL
–
Delete Report-to-Excel map ......................................................... 310
DSPRPTXL
–
Display Report-to-Excel map ....................................................... 310
RNMRPTXL
–
Rename Report-to-Excel map ..................................................... 310
MAPNAME
–
Report Report-to-Excel map ..................................................... 310
NEWMAP
–
New Report-to-Excel map ........................................................... 310
RTVRPTXL
–
Retrieve Report-to-Excel map ...................................................... 310
MAPNAME
–
Report-to-Excel map ................................................................. 310
SRCFILE
–
Source file .................................................................................... 310
SRCMBR
–
Source member ........................................................................... 311
MBROPT
–
Source member ........................................................................... 311
WRKRPTXL
–
Work with Report-to-Excel maps ................................................ 311
ADDRPTXLR
–
Add Report-to-Excel Map Row Group ....................................... 311
MAPNAME
–
Report-to-Excel map name ....................................................... 312
ROWGRPNAME
–
Row group name .............................................................. 312
PARENT
–
Parent row group name ................................................................. 312
TEXT
–
Text ‘description’
................................................................................ 314
NEWGRPOPT - New row group option ........................................................... 314
SECTION
–
Report section name ................................................................... 314
LINENAME
–
Report line name....................................................................... 315
CHGRPTXLR
–
Change Report-to-Excel Map Row Group ................................ 315
CPYRPTXLR
–
Copy Report-to-Excel Map Row Group ..................................... 315
RMVRPTXLR
–
Remove Report-to-Excel Map Row Group ............................... 315
DSPRPTXLR
–
Display Report-to-Excel Map Row Group .................................. 315
RNMRPTXLR
–
Rename Report-to-Excel Map Row Group ............................... 315
WRKRPTXLR
–
Work with Report-to-Excel Map Row Groups ........................... 316
MAPNAME
–
Report-to-Excel map name ....................................................... 316
PARENT
–
Parent row group name ................................................................. 316
ADDRPTXLC
–
Add Report-to-Excel Map Cell ................................................... 316
MAPNAME
–
Report-to-Excel map name ....................................................... 316
ROWGRPNAME
–
Row group name .............................................................. 316
ROWNBR
–
Row number ................................................................................. 317
COLUMN
–
Column letter ................................................................................ 317
CONTENT
–
Cell content ................................................................................ 317
CELLITEM
–
Report item ................................................................................. 317
CELLTEXT
–
Cell text ..................................................................................... 318
MRGCELLS
–
Merge to cell ............................................................................ 318
CHGRPTXL
–
Change Report-to-Excel Map Cell ............................................... 319
CPYRPTXLC
–
Copy Report-to-Excel Map Cell ................................................. 319
RMVRPTXLC
–
Remove Report-to-Excel Map Cell ........................................... 319
DSPRPTXLC
–
Display Report-to-Excel Map Cell.............................................. 319
RNMRPTXLC
–
Rename Report-to-Excel Map Cell ........................................... 319
WRKRPTXLC
–
Work with Report-to-Excel Map Cells ....................................... 319
MAPNAME
–
Report-to-Excel map name ....................................................... 319
ROWGRPNAME
–
Row group name .............................................................. 319
ADDRPTXMLE (Add Report-to-XML Map Element) command .............................. 320
145
MAPNAME
–
Report-to-XML Map Name ......................................................... 320
ELEMENT
–
Element name .............................................................................. 320
PARENT
–
Parent element name .................................................................... 320
SEQNBR
–
Sequence number ........................................................................ 320
ITEMNAME- Report item ................................................................................ 320
TEXT
–
Text ‘description’
................................................................................ 321
NEWELMOPT - New element option .............................................................. 321
SECTION
–
Report section name ................................................................... 322
LINENAME
–
Report line name....................................................................... 322
CHGRPTXMLE
–
Change Report-to-Excel Map Element .................................. 322
CPYRPTXMLE
–
Copy Report-to-Excel Map Element ....................................... 323
RMVRPTXMLE
–
Remove Report-to-Excel Map Element .................................. 323
DSPRPTXMLE
–
Display Report-to-Excel Map Element .................................... 323
RNMRPTXMLE
–
Rename Report-to-Excel Map Element ................................. 323
WRKRPTXMLE
–
Work with Report-to-Excel Map Elements ............................. 323
MAPNAME
–
Report-to-Excel map name ....................................................... 323
PARENT
–
Parent element name .................................................................... 323
ADDRPTXMLA (Add Report-to-XML Map Attribute) command .............................. 324
MAPNAME
–
Report-to-XML Map Name ......................................................... 324
ELEMENT
–
Element name .............................................................................. 324
ATTRIBUTE
–
Attribute name ........................................................................... 324
SEQNBR
–
Sequence number ........................................................................ 324
ITEMNAME- Report item ................................................................................ 324
TEXT
–
Text ‘description’
................................................................................ 325
CHGRPTXMLA
–
Change Report-to-Excel Map Attribute .................................. 325
CPYRPTXMLA
–
Copy Report-to-Excel Map Attribute ....................................... 325
RMVRPTXMLA
–
Remove Report-to-Excel Map Attribute ................................. 325
DSPRPTXMLA
–
Display Report-to-Excel Map Attribute .................................... 325
RNMRPTXMLA
–
Rename Report-to-Excel Map Attribute ................................. 326
WRKRPTXMLA
–
Work with Report-to-Excel Map Attributes ............................. 326
MAPNAME
–
Report-to-Excel map name ....................................................... 326
ELEMENT
–
Element name .............................................................................. 326
CRTRPTXML
–
Create Report-to-XML Map ....................................................... 327
MAPNAME
–
Report-to- XML map name ........................................................ 327
REPORTNAME
–
Report definition name ....................................................... 327
DFTUSEAUT - Default use authority ............................................................... 327
DFTCHGAUT - Default change authority ........................................................ 327
TEXT
–
Text ‘description’
................................................................................ 328
ELMSEQOPT - Element sequence option ...................................................... 328
CHGRPTXML
–
Change Report-to-XML map .................................................... 328
CPYRPTXML
–
Copy Report-to-XML map ......................................................... 328
FROMMAP
–
From Report-XML map name ................................................... 328
TOMAP
–
To Report-XML map ....................................................................... 329
DLTRPTXML
–
Delete Report-to-XML map ........................................................ 329
DSPRPTXML
–
Display Report-to-XML map ...................................................... 329
RNMRPTXML
–
Rename Report-to-XML map ................................................... 329
MAPNAME
–
Report Report-to-XML map ....................................................... 329
NEWMAP
–
New Report-to-XML map ............................................................ 329
RTVRPTXML
–
Retrieve Report-to-XML map .................................................... 329
MAPNAME
–
Report-to-XML map ................................................................... 329
SRCFILE
–
Source file .................................................................................... 329
SRCMBR
–
Source member ........................................................................... 329
106
MBROPT
–
Source member ........................................................................... 330
WRKRPTXML
–
Work with Report-to-XML maps ............................................... 330
Worked Example: Using report definitions and maps ............................................. 331
SUPER SUN SEEDS
–
Customer Order Report .................................................... 331
1.
Create the Report Definition..................................................................... 331
2.
Design the Report Definition .................................................................... 331
3.
Define the different line types ................................................................... 332
4.
Define the report items for each line ........................................................ 343
5.
Define the report sections ........................................................................ 346
6.
Create a Report-to-XML Map ................................................................... 351
7.
Add attributes to Report-to-XML Map Elements ....................................... 354
8.
Use a Report-to-XML Map to generate an XML document ...................... 358
9.
Create a Report-to-Excel Map ................................................................. 358
10.
Add row groups to a Report-to-Excel Map............................................ 359
11.
Add cells Report-to-Excel Row Groups ................................................ 362
12.
Use a Report-to-Excel Map to generate an Excel file ........................... 363
Digital Signatures................................................................................................ 364
Commands related to Parameter Sets ................................................................ 367
CRTPRMSET
–
Create Parameter Set ............................................................... 367
PRMSETNAME
–
Parameter set name .......................................................... 367
CMDUSER
–
User running command ............................................................. 367
SPLF
- Spooled file name ........................................................................... 367
SPLUSER - Spooled user profile .................................................................... 368
SPLNBR - Spooled file number in job ............................................................. 368
OUTQ - Spooled file output queue .................................................................. 369
FORMTYPE - Spooled file form type .............................................................. 369
USRDTA - Spooled file user data.................................................................... 370
JOB - Spooled file job name ........................................................................... 370
PGM - Spooled file program name .................................................................. 370
PRIORITY - Evaluation priority........................................................................ 371
CMD - Command string .................................................................................. 371
DFTUSEAUT
–
Default use authority .............................................................. 372
DFTCHGAUT
–
Default change authority ....................................................... 372
TEXT
–
Text ‘description’
................................................................................ 373
Examples for CRTPRMSET ............................................................................ 373
CHGPRMSET
–
Change Parameter Set ............................................................ 374
CPYPRMSET
–
Copy Parameter Set ................................................................. 374
FROMPRMSET
–
From parameter set name ................................................. 374
TOPRMSET
–
To parameter set name ........................................................... 374
DLTPRMSET
–
Delete Parameter Set ................................................................ 374
DSPPRMSET
–
Display Parameter Set .............................................................. 374
RNMPRMSET
–
Rename Parameter Set ........................................................... 374
PRMSETNAME
–
Parameter set name .......................................................... 374
NEWPRMSET
–
New parameter set name ..................................................... 375
WRKPRMSET
–
Work with Parameter Set ......................................................... 375
CFGPRMSET
–
Configure Parameter Set .......................................................... 375
SAMPLESPLF
–
Sample spooled file ............................................................. 375
PRMSETNAME
–
Parameter set name .......................................................... 376
48
CoolSpools Spool Converter User Guide V6R1
Page:
10
www.ariadnesoftware.co.uk
Introduction
This introduction tells you just a little about what CoolSpools can do for you and will
give you a few ideas how you might like to put it to use in your company or
organization.
If you are upgrading from a previous version of CoolSpools, please read the
“Upgrade Notes” section of this document before switching live applications over to
running this version of the software.
If you’re already
familiar with earlier versions of CoolSpools, you may like to go
straight to the “What’s new in this release?” section of this document.
Many commercial companies and other organizations have a long and successful
association with the IBM system i (originally known as the AS/400 and also
previously known as the iSeries). System i users typically create a lot of printer
output or “spooled files”, whether in
terms of reports that are distributed internally or
of other documents that are sent to customers or trading partners.
Historically, pretty much the only thing you could do with a spooled file was print it on
paper and send it to your users or customers through the mail. Today, in many
environments, paper-based distribution of information is no longer acceptable, either
because of time, or cost, or simply because your users and customers expect their
information to be provided in a more usable format.
This is where CoolSpools comes in. You don’t need to throw away your traditional
system i applications
which output information in the form of spooled files. You don’t
even need to modify those applications in any way, other than to add a simple call to
the appropriate CoolSpools commands. CoolSpools will take the spooled files your
systems already produce and convert them to a format in which they can be
distributed, archived, accessed and published electronically, for example in the form
of Adobe PDF files or Excel spreadsheets,
Let's have a look in a bit more detail at CoolSpools can do for you.
What CoolSpools can do for you
Automated distribution of reports and documents
Are you still sending reports out on paper?
Maybe you take orders over the Web but still have to send invoices by snail-mail
because the billing system is an old AS/400 package?
Maybe your customers can order a catalogue or buy an insurance policy online, but
they still have to wait a day or so for the paperwork to arrive. Wouldn’t it be great to
be able to email the catalogue or the policy schedule to your customer within a few
minutes of the order having been placed?
PDF and other files created by CoolSpools can be e-mailed to users, colleagues and
customers, rather than sent out on paper. Not only does this save you money and
streamline your business processes, it also makes a statement about your
organization’s commitment to the era of e
-commerce.
Documents you may be interested
Documents you may be interested